diff --git a/_data/versioned/latest/index/quarkus.yaml b/_data/versioned/latest/index/quarkus.yaml index abba685e022..10179fae7ae 100644 --- a/_data/versioned/latest/index/quarkus.yaml +++ b/_data/versioned/latest/index/quarkus.yaml @@ -205,6 +205,18 @@ types: id: security-openid-connect-client-reference type: reference url: /guides/security-openid-connect-client-reference + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + filename: security-openid-connect-client-registration.adoc + summary: "Typically, you have to register an OIDC client (application) manually in your OIDC provider’s dashboard." + categories: security + topics: + - security + - oidc + - client + extensions: + - io.quarkus:quarkus-oidc-client-registration + type: reference + url: /guides/security-openid-connect-client-registration - title: OpenID Connect (OIDC) configuration properties filename: security-oidc-configuration-properties-reference.adoc summary: "As a Quarkus developer, you configure the Quarkus OpenID Connect (OIDC) extension by setting the following properties in the src/main/resources/application.properties file." @@ -621,6 +633,11 @@ types: id: security-basic-authentication-howto type: howto url: /guides/security-basic-authentication-howto + - title: Frequently asked questions about writing extensions + filename: extension-faq.adoc + id: extensions-faq + type: howto + url: /guides/extension-faq - title: Quarkus Security with Jakarta Persistence filename: security-jpa.adoc summary: You can configure your application to use Jakarta Persistence to store users' identities. @@ -2685,6 +2702,18 @@ types: - io.quarkus:quarkus-smallrye-openapi type: guide url: /guides/openapi-swaggerui + - title: Using OpenTelemetry Logging + filename: opentelemetry-logging.adoc + summary: This guide explains how your Quarkus application can utilize OpenTelemetry Logging to provide distributed logging for interactive web applications. + categories: observability + topics: + - observability + - opentelemetry + - logging + extensions: + - io.quarkus:quarkus-opentelemetry + type: guide + url: /guides/opentelemetry-logging - title: Using OpenTelemetry Metrics filename: opentelemetry-metrics.adoc summary: This guide explains how your Quarkus application can utilize OpenTelemetry to provide metrics for interactive web applications. @@ -2742,13 +2771,7 @@ types: url: /guides/native-and-ssl - title: Using Security with .properties File filename: security-properties.adoc - summary: This guide demonstrates how your Quarkus application can use a .properties file to store your user identities. - categories: security - topics: - - security - - identity-providers - extensions: - - io.quarkus:quarkus-elytron-security-properties-file + summary: Quarkus provides support for properties file-based authentication intended for development and testing purposes. type: guide url: /guides/security-properties - title: Using Security with JDBC diff --git a/_data/versioned/latest/index/relations.yaml b/_data/versioned/latest/index/relations.yaml index 9196f6f4340..90263d639a5 100644 --- a/_data/versioned/latest/index/relations.yaml +++ b/_data/versioned/latest/index/relations.yaml @@ -1720,6 +1720,10 @@ url: /guides/logging type: reference matches: 2 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 2 - title: Collect metrics using Micrometer url: /guides/telemetry-micrometer-tutorial type: tutorial @@ -2340,6 +2344,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -2416,10 +2424,6 @@ url: /guides/security-openid-connect-multitenancy type: howto matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -8079,6 +8083,10 @@ url: /guides/opentelemetry type: reference matches: 1 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 1 - title: Using OpenTelemetry Metrics url: /guides/opentelemetry-metrics type: guide @@ -9600,6 +9608,10 @@ url: /guides/centralized-log-management type: guide matches: 2 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 2 - title: Collect metrics using Micrometer url: /guides/telemetry-micrometer-tutorial type: tutorial @@ -9830,6 +9842,10 @@ url: /guides/opentelemetry type: reference matches: 1 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 1 - title: Using OpenTelemetry Metrics url: /guides/opentelemetry-metrics type: guide @@ -10631,6 +10647,10 @@ url: /guides/opentelemetry type: reference matches: 1 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 1 - title: Using OpenTelemetry Metrics url: /guides/opentelemetry-metrics type: guide @@ -10699,6 +10719,10 @@ url: /guides/telemetry-opentracing-to-otel-tutorial type: tutorial matches: 2 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 2 - title: Using OpenTelemetry Metrics url: /guides/opentelemetry-metrics type: guide @@ -10748,6 +10772,81 @@ url: /guides/telemetry-opentracing-to-otel-tutorial type: tutorial matches: 1 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 1 + - title: Using OpenTelemetry Metrics + url: /guides/opentelemetry-metrics + type: guide + matches: 1 + - title: Using OpenTelemetry Tracing + url: /guides/opentelemetry-tracing + type: guide + matches: 1 +/guides/opentelemetry-logging: + sameTopics: + - title: "Centralized log management (Graylog, Logstash, Fluentd)" + url: /guides/centralized-log-management + type: guide + matches: 2 + - title: Logging configuration + url: /guides/logging + type: reference + matches: 2 + - title: Migrate from OpenTracing to OpenTelemetry tracing + url: /guides/telemetry-opentracing-to-otel-tutorial + type: tutorial + matches: 2 + - title: Using OpenTelemetry + url: /guides/opentelemetry + type: reference + matches: 2 + - title: Using OpenTelemetry Metrics + url: /guides/opentelemetry-metrics + type: guide + matches: 2 + - title: Using OpenTelemetry Tracing + url: /guides/opentelemetry-tracing + type: guide + matches: 2 + - title: Collect metrics using Micrometer + url: /guides/telemetry-micrometer-tutorial + type: tutorial + matches: 1 + - title: Management interface reference + url: /guides/management-interface-reference + type: reference + matches: 1 + - title: Micrometer Metrics + url: /guides/telemetry-micrometer + type: reference + matches: 1 + - title: Observability Dev Services + url: /guides/observability-devservices + type: guide + matches: 1 + - title: SmallRye Health + url: /guides/smallrye-health + type: guide + matches: 1 + - title: SmallRye Metrics + url: /guides/smallrye-metrics + type: guide + matches: 1 + - title: Using Java Flight Recorder + url: /guides/jfr + type: guide + matches: 1 + sameExtensions: + - title: Migrate from OpenTracing to OpenTelemetry tracing + url: /guides/telemetry-opentracing-to-otel-tutorial + type: tutorial + matches: 1 + - title: Using OpenTelemetry + url: /guides/opentelemetry + type: reference + matches: 1 - title: Using OpenTelemetry Metrics url: /guides/opentelemetry-metrics type: guide @@ -10770,6 +10869,10 @@ url: /guides/opentelemetry type: reference matches: 2 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 2 - title: Using OpenTelemetry Tracing url: /guides/opentelemetry-tracing type: guide @@ -10815,6 +10918,10 @@ url: /guides/opentelemetry type: reference matches: 1 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 1 - title: Using OpenTelemetry Tracing url: /guides/opentelemetry-tracing type: guide @@ -10829,6 +10936,10 @@ url: /guides/opentelemetry type: reference matches: 2 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 2 - title: Using OpenTelemetry Metrics url: /guides/opentelemetry-metrics type: guide @@ -10878,6 +10989,10 @@ url: /guides/opentelemetry type: reference matches: 1 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 1 - title: Using OpenTelemetry Metrics url: /guides/opentelemetry-metrics type: guide @@ -13450,6 +13565,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -13526,10 +13645,6 @@ url: /guides/security-openid-connect-multitenancy type: howto matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -13608,6 +13723,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) configuration properties url: /guides/security-oidc-configuration-properties-reference type: reference @@ -13664,10 +13783,6 @@ url: /guides/security-openid-connect-multitenancy type: howto matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -13754,6 +13869,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -13838,10 +13957,6 @@ url: /guides/reactive-routes type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -13997,6 +14112,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) configuration properties url: /guides/security-oidc-configuration-properties-reference type: reference @@ -14057,10 +14176,6 @@ url: /guides/reactive-routes type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -14196,6 +14311,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) configuration properties url: /guides/security-oidc-configuration-properties-reference type: reference @@ -14256,10 +14375,6 @@ url: /guides/reactive-routes type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -14401,6 +14516,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -14485,10 +14604,6 @@ url: /guides/reactive-routes type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -14551,6 +14666,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -14627,10 +14746,6 @@ url: /guides/security-openid-connect-multitenancy type: howto matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -14717,6 +14832,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) configuration properties url: /guides/security-oidc-configuration-properties-reference type: reference @@ -14777,10 +14896,6 @@ url: /guides/reactive-routes type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -14852,10 +14967,6 @@ url: /guides/security-oauth2 type: guide matches: 2 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 2 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -14904,6 +15015,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -15043,10 +15158,6 @@ url: /guides/security-oauth2 type: guide matches: 2 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 2 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -15095,6 +15206,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -15238,10 +15353,6 @@ url: /guides/security-oauth2 type: guide matches: 2 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 2 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -15290,6 +15401,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -15445,6 +15560,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -15521,10 +15640,6 @@ url: /guides/security-openid-connect-multitenancy type: howto matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -15583,6 +15698,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -15659,10 +15778,6 @@ url: /guides/security-openid-connect-multitenancy type: howto matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -15749,6 +15864,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) configuration properties url: /guides/security-oidc-configuration-properties-reference type: reference @@ -15801,10 +15920,6 @@ url: /guides/security-openid-connect-multitenancy type: howto matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -15867,6 +15982,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 2 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 2 - title: OpenID Connect (OIDC) configuration properties url: /guides/security-oidc-configuration-properties-reference type: reference @@ -15939,10 +16058,6 @@ url: /guides/security-oauth2 type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -15998,10 +16113,6 @@ url: /guides/security-oauth2 type: guide matches: 2 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 2 - title: Using Security with JDBC url: /guides/security-jdbc type: guide @@ -16046,6 +16157,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -16149,10 +16264,6 @@ url: /guides/security-jpa type: howto matches: 2 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 2 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -16201,6 +16312,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -16327,6 +16442,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 2 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 2 - title: OpenID Connect (OIDC) configuration properties url: /guides/security-oidc-configuration-properties-reference type: reference @@ -16399,10 +16518,6 @@ url: /guides/security-oauth2 type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -16498,6 +16613,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 2 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 2 - title: OpenID Connect (OIDC) configuration properties url: /guides/security-oidc-configuration-properties-reference type: reference @@ -16570,10 +16689,6 @@ url: /guides/security-oauth2 type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -16669,6 +16784,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 2 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 2 - title: OpenID Connect (OIDC) configuration properties url: /guides/security-oidc-configuration-properties-reference type: reference @@ -16741,10 +16860,6 @@ url: /guides/security-oauth2 type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -16828,6 +16943,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 2 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 2 - title: OpenID Connect (OIDC) configuration properties url: /guides/security-oidc-configuration-properties-reference type: reference @@ -16916,10 +17035,6 @@ url: /guides/security-oauth2 type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -16975,6 +17090,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 2 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 2 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -17083,10 +17202,6 @@ url: /guides/security-oauth2 type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -17138,6 +17253,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 3 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 3 - title: Configuring Well-Known OpenID Connect Providers url: /guides/security-openid-connect-providers type: concepts @@ -17254,10 +17373,6 @@ url: /guides/security-oauth2 type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -17277,6 +17392,10 @@ matches: 1 /guides/security-openid-connect-client-reference: sameTopics: + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 3 - title: OpenID Connect client and token propagation quickstart url: /guides/security-openid-connect-client type: tutorial @@ -17397,10 +17516,6 @@ url: /guides/security-oauth2 type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -17418,60 +17533,198 @@ url: /guides/security-openid-connect-client type: tutorial matches: 1 -/guides/security-openid-connect-dev-services: +/guides/security-openid-connect-client-registration: sameTopics: - - title: Dev Services for AMQP - url: /guides/amqp-dev-services - type: guide - matches: 3 - - title: Dev Services for Apicurio Registry - url: /guides/apicurio-registry-dev-services - type: guide - matches: 3 - - title: Dev Services for Databases - url: /guides/databases-dev-services - type: guide - matches: 3 - - title: Dev Services for Elasticsearch - url: /guides/elasticsearch-dev-services - type: guide - matches: 3 - - title: Dev Services for Infinispan - url: /guides/infinispan-dev-services - type: guide - matches: 3 - - title: Dev Services for Kafka - url: /guides/kafka-dev-services - type: guide - matches: 3 - - title: Dev Services for Kubernetes - url: /guides/kubernetes-dev-services - type: guide - matches: 3 - - title: Dev Services for Pulsar - url: /guides/pulsar-dev-services - type: guide - matches: 3 - - title: Dev Services for RabbitMQ - url: /guides/rabbitmq-dev-services - type: guide - matches: 3 - - title: Dev Services for Redis - url: /guides/redis-dev-services - type: guide + - title: OpenID Connect (OIDC) and OAuth2 client and filters + url: /guides/security-openid-connect-client-reference + type: reference matches: 3 - - title: Dev Services Overview - url: /guides/dev-services - type: guide + - title: OpenID Connect client and token propagation quickstart + url: /guides/security-openid-connect-client + type: tutorial matches: 3 + - title: Configuring Well-Known OpenID Connect Providers + url: /guides/security-openid-connect-providers + type: concepts + matches: 2 + - title: Dev Services and Dev UI for OpenID Connect (OIDC) + url: /guides/security-openid-connect-dev-services + type: howto + matches: 2 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts - matches: 3 + matches: 2 + - title: OpenID Connect (OIDC) configuration properties + url: /guides/security-oidc-configuration-properties-reference + type: reference + matches: 2 - title: OpenID Connect authorization code flow mechanism for protecting web applications url: /guides/security-oidc-code-flow-authentication type: concepts - matches: 3 + matches: 2 + - title: Protect a service application by using OpenID Connect (OIDC) Bearer token authentication + url: /guides/security-oidc-bearer-token-authentication-tutorial + type: tutorial + matches: 2 + - title: Protect a web application by using OpenID Connect (OIDC) authorization code flow + url: /guides/security-oidc-code-flow-authentication-tutorial + type: tutorial + matches: 2 + - title: Using OpenID Connect (OIDC) and Keycloak to centralize authorization + url: /guides/security-keycloak-authorization + type: howto + matches: 2 + - title: Using OpenID Connect (OIDC) multitenancy + url: /guides/security-openid-connect-multitenancy + type: howto + matches: 2 + - title: Authentication mechanisms in Quarkus + url: /guides/security-authentication-mechanisms + type: concepts + matches: 1 + - title: Authorization of web endpoints + url: /guides/security-authorize-web-endpoints-reference + type: reference + matches: 1 + - title: Basic authentication + url: /guides/security-basic-authentication + type: concepts + matches: 1 + - title: "Build, Sign and Encrypt JSON Web Tokens" + url: /guides/security-jwt-build + type: guide + matches: 1 + - title: Cross-Site Request Forgery Prevention + url: /guides/security-csrf-prevention + type: guide + matches: 1 + - title: Enable Basic authentication + url: /guides/security-basic-authentication-howto + type: howto + matches: 1 + - title: Getting started with Security by using Basic authentication and Jakarta Persistence + url: /guides/security-getting-started-tutorial + type: tutorial + matches: 1 + - title: Identity providers + url: /guides/security-identity-providers + type: concepts + matches: 1 + - title: Proactive authentication + url: /guides/security-proactive-authentication + type: concepts + matches: 1 + - title: Quarkus Security architecture + url: /guides/security-architecture + type: concepts + matches: 1 + - title: Quarkus Security overview + url: /guides/security-overview + type: concepts + matches: 1 + - title: Quarkus Security with Jakarta Persistence + url: /guides/security-jpa + type: howto + matches: 1 + - title: Security Testing + url: /guides/security-testing + type: guide + matches: 1 + - title: Security Tips and Tricks + url: /guides/security-customization + type: guide + matches: 1 + - title: Security vulnerability detection and reporting in Quarkus + url: /guides/security-vulnerability-detection + type: concepts + matches: 1 + - title: TLS registry reference + url: /guides/tls-registry-reference + type: reference + matches: 1 + - title: Using a Credentials Provider + url: /guides/credentials-provider + type: guide + matches: 1 + - title: Using JWT RBAC + url: /guides/security-jwt + type: guide + matches: 1 + - title: Using Keycloak Admin Client + url: /guides/security-keycloak-admin-client + type: guide + matches: 1 + - title: Using OAuth2 RBAC + url: /guides/security-oauth2 + type: guide + matches: 1 + - title: Using Security with an LDAP Realm + url: /guides/security-ldap + type: guide + matches: 1 + - title: Using Security with JDBC + url: /guides/security-jdbc + type: guide + matches: 1 + - title: Using Security with WebAuthn + url: /guides/security-webauthn + type: guide + matches: 1 +/guides/security-openid-connect-dev-services: + sameTopics: + - title: Dev Services for AMQP + url: /guides/amqp-dev-services + type: guide + matches: 3 + - title: Dev Services for Apicurio Registry + url: /guides/apicurio-registry-dev-services + type: guide + matches: 3 + - title: Dev Services for Databases + url: /guides/databases-dev-services + type: guide + matches: 3 + - title: Dev Services for Elasticsearch + url: /guides/elasticsearch-dev-services + type: guide + matches: 3 + - title: Dev Services for Infinispan + url: /guides/infinispan-dev-services + type: guide + matches: 3 + - title: Dev Services for Kafka + url: /guides/kafka-dev-services + type: guide + matches: 3 + - title: Dev Services for Kubernetes + url: /guides/kubernetes-dev-services + type: guide + matches: 3 + - title: Dev Services for Pulsar + url: /guides/pulsar-dev-services + type: guide + matches: 3 + - title: Dev Services for RabbitMQ + url: /guides/rabbitmq-dev-services + type: guide + matches: 3 + - title: Dev Services for Redis + url: /guides/redis-dev-services + type: guide + matches: 3 + - title: Dev Services Overview + url: /guides/dev-services + type: guide + matches: 3 + - title: OpenID Connect (OIDC) Bearer token authentication + url: /guides/security-oidc-bearer-token-authentication + type: concepts + matches: 3 + - title: OpenID Connect authorization code flow mechanism for protecting web applications + url: /guides/security-oidc-code-flow-authentication + type: concepts + matches: 3 - title: Protect a service application by using OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication-tutorial type: tutorial @@ -17500,6 +17753,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 2 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 2 - title: OpenID Connect (OIDC) configuration properties url: /guides/security-oidc-configuration-properties-reference type: reference @@ -17616,10 +17873,6 @@ url: /guides/security-oauth2 type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -17683,6 +17936,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 2 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 2 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -17791,10 +18048,6 @@ url: /guides/security-oauth2 type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -17850,6 +18103,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 2 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 2 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -17982,10 +18239,6 @@ url: /guides/security-oauth2 type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -18077,6 +18330,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -18153,10 +18410,6 @@ url: /guides/security-openid-connect-multitenancy type: howto matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -18235,6 +18488,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) configuration properties url: /guides/security-oidc-configuration-properties-reference type: reference @@ -18291,10 +18548,6 @@ url: /guides/security-openid-connect-multitenancy type: howto matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -18336,144 +18589,6 @@ url: /guides/management-interface-reference type: reference matches: 1 -/guides/security-properties: - sameTopics: - - title: Identity providers - url: /guides/security-identity-providers - type: concepts - matches: 2 - - title: Quarkus Security with Jakarta Persistence - url: /guides/security-jpa - type: howto - matches: 2 - - title: Using OAuth2 RBAC - url: /guides/security-oauth2 - type: guide - matches: 2 - - title: Using Security with an LDAP Realm - url: /guides/security-ldap - type: guide - matches: 2 - - title: Using Security with JDBC - url: /guides/security-jdbc - type: guide - matches: 2 - - title: Authentication mechanisms in Quarkus - url: /guides/security-authentication-mechanisms - type: concepts - matches: 1 - - title: Authorization of web endpoints - url: /guides/security-authorize-web-endpoints-reference - type: reference - matches: 1 - - title: Basic authentication - url: /guides/security-basic-authentication - type: concepts - matches: 1 - - title: "Build, Sign and Encrypt JSON Web Tokens" - url: /guides/security-jwt-build - type: guide - matches: 1 - - title: Configuring Well-Known OpenID Connect Providers - url: /guides/security-openid-connect-providers - type: concepts - matches: 1 - - title: Cross-Site Request Forgery Prevention - url: /guides/security-csrf-prevention - type: guide - matches: 1 - - title: Dev Services and Dev UI for OpenID Connect (OIDC) - url: /guides/security-openid-connect-dev-services - type: howto - matches: 1 - - title: Enable Basic authentication - url: /guides/security-basic-authentication-howto - type: howto - matches: 1 - - title: Getting started with Security by using Basic authentication and Jakarta Persistence - url: /guides/security-getting-started-tutorial - type: tutorial - matches: 1 - - title: OpenID Connect (OIDC) and OAuth2 client and filters - url: /guides/security-openid-connect-client-reference - type: reference - matches: 1 - - title: OpenID Connect (OIDC) Bearer token authentication - url: /guides/security-oidc-bearer-token-authentication - type: concepts - matches: 1 - - title: OpenID Connect (OIDC) configuration properties - url: /guides/security-oidc-configuration-properties-reference - type: reference - matches: 1 - - title: OpenID Connect authorization code flow mechanism for protecting web applications - url: /guides/security-oidc-code-flow-authentication - type: concepts - matches: 1 - - title: OpenID Connect client and token propagation quickstart - url: /guides/security-openid-connect-client - type: tutorial - matches: 1 - - title: Proactive authentication - url: /guides/security-proactive-authentication - type: concepts - matches: 1 - - title: Protect a service application by using OpenID Connect (OIDC) Bearer token authentication - url: /guides/security-oidc-bearer-token-authentication-tutorial - type: tutorial - matches: 1 - - title: Protect a web application by using OpenID Connect (OIDC) authorization code flow - url: /guides/security-oidc-code-flow-authentication-tutorial - type: tutorial - matches: 1 - - title: Quarkus Security architecture - url: /guides/security-architecture - type: concepts - matches: 1 - - title: Quarkus Security overview - url: /guides/security-overview - type: concepts - matches: 1 - - title: Security Testing - url: /guides/security-testing - type: guide - matches: 1 - - title: Security Tips and Tricks - url: /guides/security-customization - type: guide - matches: 1 - - title: Security vulnerability detection and reporting in Quarkus - url: /guides/security-vulnerability-detection - type: concepts - matches: 1 - - title: TLS registry reference - url: /guides/tls-registry-reference - type: reference - matches: 1 - - title: Using a Credentials Provider - url: /guides/credentials-provider - type: guide - matches: 1 - - title: Using JWT RBAC - url: /guides/security-jwt - type: guide - matches: 1 - - title: Using Keycloak Admin Client - url: /guides/security-keycloak-admin-client - type: guide - matches: 1 - - title: Using OpenID Connect (OIDC) and Keycloak to centralize authorization - url: /guides/security-keycloak-authorization - type: howto - matches: 1 - - title: Using OpenID Connect (OIDC) multitenancy - url: /guides/security-openid-connect-multitenancy - type: howto - matches: 1 - - title: Using Security with WebAuthn - url: /guides/security-webauthn - type: guide - matches: 1 /guides/security-testing: sameTopics: - title: Dev Services and Dev UI for OpenID Connect (OIDC) @@ -18576,6 +18691,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -18664,10 +18783,6 @@ url: /guides/security-openid-connect-multitenancy type: howto matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -18726,6 +18841,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -18802,10 +18921,6 @@ url: /guides/security-openid-connect-multitenancy type: howto matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -18876,6 +18991,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -18944,10 +19063,6 @@ url: /guides/security-openid-connect-multitenancy type: howto matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -19010,6 +19125,10 @@ url: /guides/opentelemetry type: reference matches: 1 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 1 - title: Using OpenTelemetry Metrics url: /guides/opentelemetry-metrics type: guide @@ -19064,6 +19183,10 @@ url: /guides/opentelemetry type: reference matches: 1 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 1 - title: Using OpenTelemetry Tracing url: /guides/opentelemetry-tracing type: guide @@ -19858,6 +19981,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -19938,10 +20065,6 @@ url: /guides/security-openid-connect-multitenancy type: howto matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide @@ -20171,6 +20294,10 @@ url: /guides/opentelemetry type: reference matches: 1 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 1 - title: Using OpenTelemetry Metrics url: /guides/opentelemetry-metrics type: guide @@ -20226,6 +20353,10 @@ url: /guides/opentelemetry type: reference matches: 1 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 1 - title: Using OpenTelemetry Metrics url: /guides/opentelemetry-metrics type: guide @@ -20249,6 +20380,10 @@ url: /guides/opentelemetry type: reference matches: 2 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 2 - title: Using OpenTelemetry Metrics url: /guides/opentelemetry-metrics type: guide @@ -20294,6 +20429,10 @@ url: /guides/opentelemetry type: reference matches: 1 + - title: Using OpenTelemetry Logging + url: /guides/opentelemetry-logging + type: guide + matches: 1 - title: Using OpenTelemetry Metrics url: /guides/opentelemetry-metrics type: guide @@ -20588,6 +20727,10 @@ url: /guides/security-openid-connect-client-reference type: reference matches: 1 + - title: OpenID Connect (OIDC) and OAuth2 dynamic client registration + url: /guides/security-openid-connect-client-registration + type: reference + matches: 1 - title: OpenID Connect (OIDC) Bearer token authentication url: /guides/security-oidc-bearer-token-authentication type: concepts @@ -20672,10 +20815,6 @@ url: /guides/reactive-routes type: guide matches: 1 - - title: Using Security with .properties File - url: /guides/security-properties - type: guide - matches: 1 - title: Using Security with an LDAP Realm url: /guides/security-ldap type: guide diff --git a/_generated-doc/latest/config/quarkus-agroal.adoc b/_generated-doc/latest/config/quarkus-agroal.adoc index 599d0412c11..35abf5c60aa 100644 --- a/_generated-doc/latest/config/quarkus-agroal.adoc +++ b/_generated-doc/latest/config/quarkus-agroal.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-agroal_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -218,7 +217,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_BACKGROUND_VALIDATION_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`2M` a| [[quarkus-agroal_quarkus-datasource-jdbc-foreground-validation-interval]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-foreground-validation-interval[`quarkus.datasource.jdbc.foreground-validation-interval`]## @@ -237,7 +236,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_FOREGROUND_VALIDATION_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-agroal_quarkus-datasource-jdbc-acquisition-timeout]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-acquisition-timeout[`quarkus.datasource.jdbc.acquisition-timeout`]## @@ -256,7 +255,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-agroal_quarkus-datasource-jdbc-leak-detection-interval]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-leak-detection-interval[`quarkus.datasource.jdbc.leak-detection-interval`]## @@ -275,7 +274,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_LEAK_DETECTION_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`This feature is disabled by default.` a| [[quarkus-agroal_quarkus-datasource-jdbc-idle-removal-interval]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-idle-removal-interval[`quarkus.datasource.jdbc.idle-removal-interval`]## @@ -294,7 +293,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_IDLE_REMOVAL_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-agroal_quarkus-datasource-jdbc-max-lifetime]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-max-lifetime[`quarkus.datasource.jdbc.max-lifetime`]## @@ -313,7 +312,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_MAX_LIFETIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-agroal_quarkus-datasource-jdbc-transaction-isolation-level]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-transaction-isolation-level[`quarkus.datasource.jdbc.transaction-isolation-level`]## @@ -508,63 +507,6 @@ endif::add-copy-button-to-env-var[] |Map | -a| [[quarkus-agroal_quarkus-datasource-jdbc-tracing-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-tracing-enabled[`quarkus.datasource.jdbc.tracing.enabled`]## - -`quarkus.datasource."datasource-name".jdbc.tracing.enabled` - -[.description] --- -Enable JDBC tracing. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_JDBC_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true` - -a| [[quarkus-agroal_quarkus-datasource-jdbc-tracing-trace-with-active-span-only]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-tracing-trace-with-active-span-only[`quarkus.datasource.jdbc.tracing.trace-with-active-span-only`]## - -`quarkus.datasource."datasource-name".jdbc.tracing.trace-with-active-span-only` - -[.description] --- -Trace calls with active Spans only - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_TRACING_TRACE_WITH_ACTIVE_SPAN_ONLY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_JDBC_TRACING_TRACE_WITH_ACTIVE_SPAN_ONLY+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-agroal_quarkus-datasource-jdbc-tracing-ignore-for-tracing]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-tracing-ignore-for-tracing[`quarkus.datasource.jdbc.tracing.ignore-for-tracing`]## - -`quarkus.datasource."datasource-name".jdbc.tracing.ignore-for-tracing` - -[.description] --- -Ignore specific queries from being traced - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_TRACING_IGNORE_FOR_TRACING+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_JDBC_TRACING_IGNORE_FOR_TRACING+++` -endif::add-copy-button-to-env-var[] --- -|string -|`Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \` - a| [[quarkus-agroal_quarkus-datasource-jdbc-telemetry-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-telemetry-enabled[`quarkus.datasource.jdbc.telemetry.enabled`]## `quarkus.datasource."datasource-name".jdbc.telemetry.enabled` @@ -605,5 +547,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-agroal_quarkus.datasource.adoc b/_generated-doc/latest/config/quarkus-agroal_quarkus.datasource.adoc index 599d0412c11..35abf5c60aa 100644 --- a/_generated-doc/latest/config/quarkus-agroal_quarkus.datasource.adoc +++ b/_generated-doc/latest/config/quarkus-agroal_quarkus.datasource.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-agroal_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -218,7 +217,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_BACKGROUND_VALIDATION_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`2M` a| [[quarkus-agroal_quarkus-datasource-jdbc-foreground-validation-interval]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-foreground-validation-interval[`quarkus.datasource.jdbc.foreground-validation-interval`]## @@ -237,7 +236,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_FOREGROUND_VALIDATION_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-agroal_quarkus-datasource-jdbc-acquisition-timeout]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-acquisition-timeout[`quarkus.datasource.jdbc.acquisition-timeout`]## @@ -256,7 +255,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-agroal_quarkus-datasource-jdbc-leak-detection-interval]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-leak-detection-interval[`quarkus.datasource.jdbc.leak-detection-interval`]## @@ -275,7 +274,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_LEAK_DETECTION_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`This feature is disabled by default.` a| [[quarkus-agroal_quarkus-datasource-jdbc-idle-removal-interval]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-idle-removal-interval[`quarkus.datasource.jdbc.idle-removal-interval`]## @@ -294,7 +293,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_IDLE_REMOVAL_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-agroal_quarkus-datasource-jdbc-max-lifetime]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-max-lifetime[`quarkus.datasource.jdbc.max-lifetime`]## @@ -313,7 +312,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_MAX_LIFETIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-agroal_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-agroal_quarkus-datasource-jdbc-transaction-isolation-level]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-transaction-isolation-level[`quarkus.datasource.jdbc.transaction-isolation-level`]## @@ -508,63 +507,6 @@ endif::add-copy-button-to-env-var[] |Map | -a| [[quarkus-agroal_quarkus-datasource-jdbc-tracing-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-tracing-enabled[`quarkus.datasource.jdbc.tracing.enabled`]## - -`quarkus.datasource."datasource-name".jdbc.tracing.enabled` - -[.description] --- -Enable JDBC tracing. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_JDBC_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true` - -a| [[quarkus-agroal_quarkus-datasource-jdbc-tracing-trace-with-active-span-only]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-tracing-trace-with-active-span-only[`quarkus.datasource.jdbc.tracing.trace-with-active-span-only`]## - -`quarkus.datasource."datasource-name".jdbc.tracing.trace-with-active-span-only` - -[.description] --- -Trace calls with active Spans only - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_TRACING_TRACE_WITH_ACTIVE_SPAN_ONLY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_JDBC_TRACING_TRACE_WITH_ACTIVE_SPAN_ONLY+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-agroal_quarkus-datasource-jdbc-tracing-ignore-for-tracing]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-tracing-ignore-for-tracing[`quarkus.datasource.jdbc.tracing.ignore-for-tracing`]## - -`quarkus.datasource."datasource-name".jdbc.tracing.ignore-for-tracing` - -[.description] --- -Ignore specific queries from being traced - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_TRACING_IGNORE_FOR_TRACING+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_JDBC_TRACING_IGNORE_FOR_TRACING+++` -endif::add-copy-button-to-env-var[] --- -|string -|`Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \` - a| [[quarkus-agroal_quarkus-datasource-jdbc-telemetry-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-telemetry-enabled[`quarkus.datasource.jdbc.telemetry.enabled`]## `quarkus.datasource."datasource-name".jdbc.telemetry.enabled` @@ -605,5 +547,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-all-config.adoc b/_generated-doc/latest/config/quarkus-all-config.adoc index 53b2ca57fac..b3545933108 100644 --- a/_generated-doc/latest/config/quarkus-all-config.adoc +++ b/_generated-doc/latest/config/quarkus-all-config.adoc @@ -1,4 +1,3 @@ -:summaryTableId: all-config [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -218,7 +217,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_BACKGROUND_VALIDATION_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`2M` a| [[quarkus-agroal_quarkus-datasource-jdbc-foreground-validation-interval]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-foreground-validation-interval[`quarkus.datasource.jdbc.foreground-validation-interval`]## @@ -237,7 +236,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_FOREGROUND_VALIDATION_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-agroal_quarkus-datasource-jdbc-acquisition-timeout]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-acquisition-timeout[`quarkus.datasource.jdbc.acquisition-timeout`]## @@ -256,7 +255,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-agroal_quarkus-datasource-jdbc-leak-detection-interval]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-leak-detection-interval[`quarkus.datasource.jdbc.leak-detection-interval`]## @@ -275,7 +274,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_LEAK_DETECTION_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`This feature is disabled by default.` a| [[quarkus-agroal_quarkus-datasource-jdbc-idle-removal-interval]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-idle-removal-interval[`quarkus.datasource.jdbc.idle-removal-interval`]## @@ -294,7 +293,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_IDLE_REMOVAL_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-agroal_quarkus-datasource-jdbc-max-lifetime]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-max-lifetime[`quarkus.datasource.jdbc.max-lifetime`]## @@ -313,7 +312,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_JDBC_MAX_LIFETIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-agroal_quarkus-datasource-jdbc-transaction-isolation-level]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-transaction-isolation-level[`quarkus.datasource.jdbc.transaction-isolation-level`]## @@ -508,63 +507,6 @@ endif::add-copy-button-to-env-var[] |Map | -a| [[quarkus-agroal_quarkus-datasource-jdbc-tracing-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-tracing-enabled[`quarkus.datasource.jdbc.tracing.enabled`]## - -`quarkus.datasource."datasource-name".jdbc.tracing.enabled` - -[.description] --- -Enable JDBC tracing. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_JDBC_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true` - -a| [[quarkus-agroal_quarkus-datasource-jdbc-tracing-trace-with-active-span-only]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-tracing-trace-with-active-span-only[`quarkus.datasource.jdbc.tracing.trace-with-active-span-only`]## - -`quarkus.datasource."datasource-name".jdbc.tracing.trace-with-active-span-only` - -[.description] --- -Trace calls with active Spans only - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_TRACING_TRACE_WITH_ACTIVE_SPAN_ONLY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_JDBC_TRACING_TRACE_WITH_ACTIVE_SPAN_ONLY+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-agroal_quarkus-datasource-jdbc-tracing-ignore-for-tracing]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-tracing-ignore-for-tracing[`quarkus.datasource.jdbc.tracing.ignore-for-tracing`]## - -`quarkus.datasource."datasource-name".jdbc.tracing.ignore-for-tracing` - -[.description] --- -Ignore specific queries from being traced - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_TRACING_IGNORE_FOR_TRACING+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_JDBC_TRACING_IGNORE_FOR_TRACING+++` -endif::add-copy-button-to-env-var[] --- -|string -|`Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \` - a| [[quarkus-agroal_quarkus-datasource-jdbc-telemetry-enabled]] [.property-path]##link:#quarkus-agroal_quarkus-datasource-jdbc-telemetry-enabled[`quarkus.datasource.jdbc.telemetry.enabled`]## `quarkus.datasource."datasource-name".jdbc.telemetry.enabled` @@ -1670,7 +1612,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_CAFFEINE_EXPIRE_AFTER_WRITE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-cache_quarkus-cache-caffeine-expire-after-access]] [.property-path]##link:#quarkus-cache_quarkus-cache-caffeine-expire-after-access[`quarkus.cache.caffeine.expire-after-access`]## @@ -1687,7 +1629,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_CAFFEINE_EXPIRE_AFTER_ACCESS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-cache_quarkus-cache-caffeine-metrics-enabled]] [.property-path]##link:#quarkus-cache_quarkus-cache-caffeine-metrics-enabled[`quarkus.cache.caffeine.metrics-enabled`]## @@ -1755,7 +1697,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_CAFFEINE__CACHE_NAME__EXPIRE_AFTER_WRITE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-cache_quarkus-cache-caffeine-cache-name-expire-after-access]] [.property-path]##link:#quarkus-cache_quarkus-cache-caffeine-cache-name-expire-after-access[`quarkus.cache.caffeine."cache-name".expire-after-access`]## @@ -1772,7 +1714,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_CAFFEINE__CACHE_NAME__EXPIRE_AFTER_ACCESS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-cache_quarkus-cache-caffeine-cache-name-metrics-enabled]] [.property-path]##link:#quarkus-cache_quarkus-cache-caffeine-cache-name-metrics-enabled[`quarkus.cache.caffeine."cache-name".metrics-enabled`]## @@ -2039,13 +1981,13 @@ Environment variable: `+++QUARKUS_BUILDPACK_JVM_BUILDER_IMAGE+++` endif::add-copy-button-to-env-var[] -- |string -| +|`paketocommunity/builder-ubi-base:latest` a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-native-builder-image]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-native-builder-image[`quarkus.buildpack.native-builder-image`]## [.description] -- -The buildpacks builder image to use when building the project in jvm mode. +The buildpacks builder image to use when building the project in native mode. ifdef::add-copy-button-to-env-var[] @@ -2058,6 +2000,23 @@ endif::add-copy-button-to-env-var[] |string | +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-trust-builder-image]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-trust-builder-image[`quarkus.buildpack.trust-builder-image`]## + +[.description] +-- +Should the builder image be 'trusted' (use creator lifecycle) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_TRUST_BUILDER_IMAGE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_BUILDPACK_TRUST_BUILDER_IMAGE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-builder-env-environment-variable-name]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-builder-env-environment-variable-name[`quarkus.buildpack.builder-env."environment-variable-name"`]## [.description] @@ -2096,7 +2055,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quark [.description] -- -Max pull timeout for builder/run images, in seconds +Initial pull timeout for builder/run images, in seconds ifdef::add-copy-button-to-env-var[] @@ -2109,11 +2068,45 @@ endif::add-copy-button-to-env-var[] |int |`300` +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-pull-timeout-increase-seconds]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-pull-timeout-increase-seconds[`quarkus.buildpack.pull-timeout-increase-seconds`]## + +[.description] +-- +Increase pull timeout for builder/run images after failure, in seconds + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_PULL_TIMEOUT_INCREASE_SECONDS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_BUILDPACK_PULL_TIMEOUT_INCREASE_SECONDS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`15` + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-pull-retry-count]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-pull-retry-count[`quarkus.buildpack.pull-retry-count`]## + +[.description] +-- +How many times to retry an image pull after a failure + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_PULL_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_BUILDPACK_PULL_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-docker-host]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-docker-host[`quarkus.buildpack.docker-host`]## [.description] -- -DOCKER_HOST value to use. If not set, the env var DOCKER_HOST is used, if that is not set the value `unix:///var/run/docker.sock' (or 'npipe:///./pipe/docker_engine' for windows) is used. +DOCKER_HOST value to use. If not set, the env var DOCKER_HOST is used, if that is not set the platform will look for 'npipe:///./pipe/docker_engine' for windows, and `unix:///var/run/docker.sock' then `unix:///var/run/podman.sock` then `unix:///var/run/user//podman/podman.sock` for linux ifdef::add-copy-button-to-env-var[] @@ -2983,7 +2976,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_BUILD_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`PT5M` a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-build-log-level]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-build-log-level[`quarkus.openshift.build-log-level`]## @@ -3187,7 +3180,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S2I_BUILD_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`PT5M` @@ -3317,969 +3310,931 @@ endif::add-copy-button-to-env-var[] |list of string | - -h|[.extension-name]##Core## -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enabled]] [.property-path]##link:#quarkus-core_quarkus-native-enabled[`quarkus.native.enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-tls-verify]] [.property-path]##link:#quarkus-container-image-podman_quarkus-podman-tls-verify[`quarkus.podman.tls-verify`]## [.description] -- -Set to enable native-image building using GraalVM. +Require HTTPS and verify certificates when contacting registries ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_TLS_VERIFY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_ENABLED+++` +Environment variable: `+++QUARKUS_PODMAN_TLS_VERIFY+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-sources-only]] [.property-path]##link:#quarkus-core_quarkus-native-sources-only[`quarkus.native.sources-only`]## + +h|[.extension-name]##Core## +h|Type +h|Default + +h|[.configroot-name]##Build time analytics## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-analytics-disabled]] [.property-path]##link:#quarkus-core_quarkus-analytics-disabled[`quarkus.analytics.disabled`]## [.description] -- -Set to prevent the native-image process from actually building the native image. +If Build time analytics are disabled. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_SOURCES_ONLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_DISABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_SOURCES_ONLY+++` +Environment variable: `+++QUARKUS_ANALYTICS_DISABLED+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-additional-build-args]] [.property-path]##link:#quarkus-core_quarkus-native-additional-build-args[`quarkus.native.additional-build-args`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-analytics-uri-base]] [.property-path]##link:#quarkus-core_quarkus-analytics-uri-base[`quarkus.analytics.uri.base`]## [.description] -- -Comma-separated, additional arguments to pass to the build process. If an argument includes the `,` symbol, it needs to be escaped, e.g. `++\\++,` +The Segment base URI. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ADDITIONAL_BUILD_ARGS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_URI_BASE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_ADDITIONAL_BUILD_ARGS+++` +Environment variable: `+++QUARKUS_ANALYTICS_URI_BASE+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enable-http-url-handler]] [.property-path]##link:#quarkus-core_quarkus-native-enable-http-url-handler[`quarkus.native.enable-http-url-handler`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-analytics-timeout]] [.property-path]##link:#quarkus-core_quarkus-analytics-timeout[`quarkus.analytics.timeout`]## [.description] -- -If the HTTP url handler should be enabled, allowing you to do URL.openConnection() for HTTP URLs +The Timeout to send the build time analytics to segment. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLE_HTTP_URL_HANDLER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_ENABLE_HTTP_URL_HANDLER+++` +Environment variable: `+++QUARKUS_ANALYTICS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|int +|`3000` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enable-https-url-handler]] [.property-path]##link:#quarkus-core_quarkus-native-enable-https-url-handler[`quarkus.native.enable-https-url-handler`]## +h|[.configroot-name]##Application## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-application-name]] [.property-path]##link:#quarkus-core_quarkus-application-name[`quarkus.application.name`]## [.description] -- -If the HTTPS url handler should be enabled, allowing you to do URL.openConnection() for HTTPS URLs +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). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLE_HTTPS_URL_HANDLER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_APPLICATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_ENABLE_HTTPS_URL_HANDLER+++` +Environment variable: `+++QUARKUS_APPLICATION_NAME+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-headless]] [.property-path]##link:#quarkus-core_quarkus-native-headless[`quarkus.native.headless`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-application-version]] [.property-path]##link:#quarkus-core_quarkus-application-version[`quarkus.application.version`]## [.description] -- -The default value for java.awt.headless JVM option. Switching this option affects linking of awt libraries. +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). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_HEADLESS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_APPLICATION_VERSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_HEADLESS+++` +Environment variable: `+++QUARKUS_APPLICATION_VERSION+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-file-encoding]] [.property-path]##link:#quarkus-core_quarkus-native-file-encoding[`quarkus.native.file-encoding`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-application-ui-header]] [.property-path]##link:#quarkus-core_quarkus-application-ui-header[`quarkus.application.ui-header`]## [.description] -- -Defines the file encoding as in `-Dfile.encoding=...`. Native image runtime uses the host's (i.e. build time) value of `file.encoding` system property. We intentionally default this to UTF-8 to avoid platform specific defaults to be picked up which can then result in inconsistent behavior in the generated native executable. +The header to use for UI Screen (Swagger UI, GraphQL UI etc). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_FILE_ENCODING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_APPLICATION_UI_HEADER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_FILE_ENCODING+++` +Environment variable: `+++QUARKUS_APPLICATION_UI_HEADER+++` endif::add-copy-button-to-env-var[] -- |string -|`UTF-8` +|`{applicationName} (powered by Quarkus)` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-add-all-charsets]] [.property-path]##link:#quarkus-core_quarkus-native-add-all-charsets[`quarkus.native.add-all-charsets`]## +h|[.configroot-name]##Banner## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-banner-path]] [.property-path]##link:#quarkus-core_quarkus-banner-path[`quarkus.banner.path`]## [.description] -- -If all character sets should be added to the native executable. - -Note that some extensions (e.g. the Oracle JDBC driver) also take this setting into account to enable support for all charsets at the extension level. - -This increases image size. +The path of the banner (path relative to root of classpath) which could be provided by user ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ADD_ALL_CHARSETS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BANNER_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_ADD_ALL_CHARSETS+++` +Environment variable: `+++QUARKUS_BANNER_PATH+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +|`default_banner.txt` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-graalvm-home]] [.property-path]##link:#quarkus-core_quarkus-native-graalvm-home[`quarkus.native.graalvm-home`]## +a| [[quarkus-core_quarkus-banner-enabled]] [.property-path]##link:#quarkus-core_quarkus-banner-enabled[`quarkus.banner.enabled`]## [.description] -- -The location of the Graal distribution +Whether the banner will be displayed ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_GRAALVM_HOME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BANNER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_GRAALVM_HOME+++` +Environment variable: `+++QUARKUS_BANNER_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -|`${GRAALVM_HOME:}` +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-java-home]] [.property-path]##link:#quarkus-core_quarkus-native-java-home[`quarkus.native.java-home`]## +h|[.configroot-name]##Bootstrap## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-bootstrap-effective-model-builder]] [.property-path]##link:#quarkus-core_quarkus-bootstrap-effective-model-builder[`quarkus.bootstrap.effective-model-builder`]## [.description] -- -The location of the JDK +If set to true, the workspace initialization will be based on the effective POMs (i.e. properly interpolated, including support for profiles) instead of the raw ones. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_JAVA_HOME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BOOTSTRAP_EFFECTIVE_MODEL_BUILDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_JAVA_HOME+++` +Environment variable: `+++QUARKUS_BOOTSTRAP_EFFECTIVE_MODEL_BUILDER+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html[File] -|`${java.home}` +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-native-image-xmx]] [.property-path]##link:#quarkus-core_quarkus-native-native-image-xmx[`quarkus.native.native-image-xmx`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-bootstrap-workspace-discovery]] [.property-path]##link:#quarkus-core_quarkus-bootstrap-workspace-discovery[`quarkus.bootstrap.workspace-discovery`]## [.description] -- -The maximum Java heap to be used during the native image generation +If set to true, workspace discovery will be enabled for all launch modes. Usually, workspace discovery is enabled by default only for dev and test modes. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_NATIVE_IMAGE_XMX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BOOTSTRAP_WORKSPACE_DISCOVERY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_NATIVE_IMAGE_XMX+++` +Environment variable: `+++QUARKUS_BOOTSTRAP_WORKSPACE_DISCOVERY+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-debug-build-process]] [.property-path]##link:#quarkus-core_quarkus-native-debug-build-process[`quarkus.native.debug-build-process`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-bootstrap-warn-on-failing-workspace-modules]] [.property-path]##link:#quarkus-core_quarkus-bootstrap-warn-on-failing-workspace-modules[`quarkus.bootstrap.warn-on-failing-workspace-modules`]## [.description] -- -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 +If set to true, workspace loader will log warnings for modules that could not be loaded for some reason instead of throwing errors. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_DEBUG_BUILD_PROCESS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BOOTSTRAP_WARN_ON_FAILING_WORKSPACE_MODULES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_DEBUG_BUILD_PROCESS+++` +Environment variable: `+++QUARKUS_BOOTSTRAP_WARN_ON_FAILING_WORKSPACE_MODULES+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-publish-debug-build-process-port]] [.property-path]##link:#quarkus-core_quarkus-native-publish-debug-build-process-port[`quarkus.native.publish-debug-build-process-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-bootstrap-disable-jar-cache]] [.property-path]##link:#quarkus-core_quarkus-bootstrap-disable-jar-cache[`quarkus.bootstrap.disable-jar-cache`]## [.description] -- -If the debug port should be published when building with docker and debug-build-process is true +By default, the bootstrap mechanism will create a shared cache of open JARs for Quarkus classloaders to reduce the total number of opened ZIP FileSystems in dev and test modes. Setting system property `quarkus.bootstrap.disable-jar-cache` to `true` will make Quarkus classloaders create a new ZIP FileSystem for each JAR classpath element every time it is added to a Quarkus classloader. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_PUBLISH_DEBUG_BUILD_PROCESS_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BOOTSTRAP_DISABLE_JAR_CACHE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_PUBLISH_DEBUG_BUILD_PROCESS_PORT+++` +Environment variable: `+++QUARKUS_BOOTSTRAP_DISABLE_JAR_CACHE+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enable-isolates]] [.property-path]##link:#quarkus-core_quarkus-native-enable-isolates[`quarkus.native.enable-isolates`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-bootstrap-incubating-model-resolver]] [.property-path]##link:#quarkus-core_quarkus-bootstrap-incubating-model-resolver[`quarkus.bootstrap.incubating-model-resolver`]## [.description] -- -If isolates should be enabled +A temporary option introduced to avoid a logging warning when `-Dquarkus.bootstrap.incubating-model-resolver` is added to the build command line. This option enables an incubating implementation of the Quarkus Application Model resolver. This option will be removed as soon as the incubating implementation becomes the default one. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLE_ISOLATES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BOOTSTRAP_INCUBATING_MODEL_RESOLVER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_ENABLE_ISOLATES+++` +Environment variable: `+++QUARKUS_BOOTSTRAP_INCUBATING_MODEL_RESOLVER+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enable-fallback-images]] [.property-path]##link:#quarkus-core_quarkus-native-enable-fallback-images[`quarkus.native.enable-fallback-images`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-bootstrap-misaligned-platform-imports]] [.property-path]##link:#quarkus-core_quarkus-bootstrap-misaligned-platform-imports[`quarkus.bootstrap.misaligned-platform-imports`]## [.description] -- -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 +Whether to throw an error, warn or silently ignore misaligned platform BOM imports ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLE_FALLBACK_IMAGES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BOOTSTRAP_MISALIGNED_PLATFORM_IMPORTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_ENABLE_FALLBACK_IMAGES+++` +Environment variable: `+++QUARKUS_BOOTSTRAP_MISALIGNED_PLATFORM_IMPORTS+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +a|`error`, `warn`, `ignore` +|`error` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-auto-service-loader-registration]] [.property-path]##link:#quarkus-core_quarkus-native-auto-service-loader-registration[`quarkus.native.auto-service-loader-registration`]## +h|[.configroot-name]##Builder## +h|Type +h|Default + +a| [[quarkus-core_quarkus-builder-graph-output]] [.property-path]##link:#quarkus-core_quarkus-builder-graph-output[`quarkus.builder.graph-output`]## [.description] -- -If all META-INF/services entries should be automatically registered +Dump the graph output to a file. This is useful for debugging. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_AUTO_SERVICE_LOADER_REGISTRATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDER_GRAPH_OUTPUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_AUTO_SERVICE_LOADER_REGISTRATION+++` +Environment variable: `+++QUARKUS_BUILDER_GRAPH_OUTPUT+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-dump-proxies]] [.property-path]##link:#quarkus-core_quarkus-native-dump-proxies[`quarkus.native.dump-proxies`]## +a| [[quarkus-core_quarkus-builder-log-conflict-cause]] [.property-path]##link:#quarkus-core_quarkus-builder-log-conflict-cause[`quarkus.builder.log-conflict-cause`]## [.description] -- -If the bytecode of all proxies should be dumped for inspection +Whether to log the cause of a conflict. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_DUMP_PROXIES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDER_LOG_CONFLICT_CAUSE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_DUMP_PROXIES+++` +Environment variable: `+++QUARKUS_BUILDER_LOG_CONFLICT_CAUSE+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-container-build]] [.property-path]##link:#quarkus-core_quarkus-native-container-build[`quarkus.native.container-build`]## +h|[.configroot-name]##Class loading## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-class-loading-parent-first-artifacts]] [.property-path]##link:#quarkus-core_quarkus-class-loading-parent-first-artifacts[`quarkus.class-loading.parent-first-artifacts`]## [.description] -- -If this build should be done using a container runtime. Unless container-runtime is also set, docker will be used by default. If docker is not available or is an alias to podman, podman will be used instead as the default. +Artifacts that are loaded in a parent first manner. This can be used to work around issues where a given class needs to be loaded by the system ClassLoader. Note that if you make a library parent first all its dependencies should generally also be parent first. + +Artifacts should be configured as a comma separated list of artifact ids, with the group, artifact-id and optional classifier separated by a colon. + +WARNING: This config property can only be set in application.properties ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_CONTAINER_BUILD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLASS_LOADING_PARENT_FIRST_ARTIFACTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_CONTAINER_BUILD+++` +Environment variable: `+++QUARKUS_CLASS_LOADING_PARENT_FIRST_ARTIFACTS+++` endif::add-copy-button-to-env-var[] -- -|boolean +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-pie]] [.property-path]##link:#quarkus-core_quarkus-native-pie[`quarkus.native.pie`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-class-loading-reloadable-artifacts]] [.property-path]##link:#quarkus-core_quarkus-class-loading-reloadable-artifacts[`quarkus.class-loading.reloadable-artifacts`]## [.description] -- -Explicit configuration option to generate a native Position Independent Executable (PIE) for Linux. If the system supports PIE generation, the default behaviour is to disable it for link:https://www.redhat.com/en/blog/position-independent-executable-pie-performance[performance reasons]. However, some systems can only run position-independent executables, so this option enables the generation of such native executables. +Artifacts that are loaded in the runtime ClassLoader in dev mode, so they will be dropped and recreated on change. + +This is an advanced option, it should only be used if you have a problem with libraries holding stale state between reloads. Note that if you use this any library that depends on the listed libraries will also need to be reloadable. + +This setting has no impact on production builds. + +Artifacts should be configured as a comma separated list of artifact ids, with the group, artifact-id and optional classifier separated by a colon. + +WARNING: This config property can only be set in application.properties ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_PIE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLASS_LOADING_RELOADABLE_ARTIFACTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_PIE+++` +Environment variable: `+++QUARKUS_CLASS_LOADING_RELOADABLE_ARTIFACTS+++` endif::add-copy-button-to-env-var[] -- -|boolean +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-march]] [.property-path]##link:#quarkus-core_quarkus-native-march[`quarkus.native.march`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-class-loading-removed-artifacts]] [.property-path]##link:#quarkus-core_quarkus-class-loading-removed-artifacts[`quarkus.class-loading.removed-artifacts`]## [.description] -- -Generate instructions for a specific machine type. Defaults to `x86-64-v3` on AMD64 and `armv8-a` on AArch64. Use `compatibility` for best compatibility, or `native` for best performance if a native executable is deployed on the same machine or on a machine with the same CPU features. A list of all available machine types is available by executing `native-image -march=list` +Artifacts that will never be loaded by the class loader, and will not be packed into the final application. This allows you to explicitly remove artifacts from your application even though they may be present on the class path. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_MARCH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLASS_LOADING_REMOVED_ARTIFACTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_MARCH+++` +Environment variable: `+++QUARKUS_CLASS_LOADING_REMOVED_ARTIFACTS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-remote-container-build]] [.property-path]##link:#quarkus-core_quarkus-native-remote-container-build[`quarkus.native.remote-container-build`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-class-loading-removed-resources-group-id-artifact-id]] [.property-path]##link:#quarkus-core_quarkus-class-loading-removed-resources-group-id-artifact-id[`quarkus.class-loading.removed-resources."group-id:artifact-id"`]## [.description] -- -If this build is done using a remote docker daemon. +Resources that should be removed/hidden from dependencies. + +This allows for classes and other resources to be removed from dependencies, so they are not accessible to the application. This is a map of artifact id (in the form group:artifact) to a list of resources to be removed. + +When running in dev and test mode these resources are hidden from the ClassLoader, when running in production mode these files are removed from the jars that contain them. + +Note that if you want to remove a class you need to specify the class file name. e.g. to remove `com.acme.Foo` you would specify `com/acme/Foo.class`. + +Note that for technical reasons this is not supported when running with JBang. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_REMOTE_CONTAINER_BUILD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLASS_LOADING_REMOVED_RESOURCES__GROUP_ID_ARTIFACT_ID_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_REMOTE_CONTAINER_BUILD+++` +Environment variable: `+++QUARKUS_CLASS_LOADING_REMOVED_RESOURCES__GROUP_ID_ARTIFACT_ID_+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|Map> +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-builder-image]] [.property-path]##link:#quarkus-core_quarkus-native-builder-image[`quarkus.native.builder-image`]## +h|[.configroot-name]##Command line## +h|Type +h|Default + +a| [[quarkus-core_quarkus-args]] [.property-path]##link:#quarkus-core_quarkus-args[`quarkus.args`]## [.description] -- -The docker image to use to do the image build. It can be one of `graalvm`, `mandrel`, or the full image path, e.g. `quay.io/quarkus/ubi-quarkus-mandrel-builder-image:jdk-21`. +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. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_BUILDER_IMAGE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_BUILDER_IMAGE+++` +Environment variable: `+++QUARKUS_ARGS+++` endif::add-copy-button-to-env-var[] -- |string -|`mandrel` +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-builder-image-pull]] [.property-path]##link:#quarkus-core_quarkus-native-builder-image-pull[`quarkus.native.builder-image.pull`]## +h|[.configroot-name]##Configuration## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-sources-system-only]] [.property-path]##link:#quarkus-core_quarkus-config-sources-system-only[`quarkus.config.sources.system-only`]## [.description] -- -The strategy for pulling the builder image during the build. - -Defaults to 'always', which will always pull the most up-to-date image; useful to keep up with fixes when a (floating) tag is updated. - -Use 'missing' to only pull if there is no image locally; useful on development environments where building with out-of-date images is acceptable and bandwidth may be limited. - -Use 'never' to fail the build if there is no image locally. +Set this to `true` to read configuration from system properties and environment variables only. This only applies to runtime. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_BUILDER_IMAGE_PULL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_SOURCES_SYSTEM_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_BUILDER_IMAGE_PULL+++` +Environment variable: `+++QUARKUS_CONFIG_SOURCES_SYSTEM_ONLY+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:always[Always pull the most recent image.], tooltip:missing[Only pull the image if it's missing locally.], tooltip:never[Never pull any image; fail if the image is missing locally.] -|tooltip:always[Always pull the most recent image.] +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-container-runtime]] [.property-path]##link:#quarkus-core_quarkus-native-container-runtime[`quarkus.native.container-runtime`]## +a| [[quarkus-core_quarkus-profile]] [.property-path]##link:#quarkus-core_quarkus-profile[`quarkus.profile`]## [.description] -- -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. +A comma separated list of profiles that will be active when Quarkus launches. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_CONTAINER_RUNTIME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PROFILE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_CONTAINER_RUNTIME+++` +Environment variable: `+++QUARKUS_PROFILE+++` endif::add-copy-button-to-env-var[] -- -a|`docker`, `docker-rootless`, `wsl`, `wsl-rootless`, `podman`, `podman-rootless`, `unavailable` +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-container-runtime-options]] [.property-path]##link:#quarkus-core_quarkus-native-container-runtime-options[`quarkus.native.container-runtime-options`]## +a| [[quarkus-core_quarkus-config-profile-parent]] [.property-path]##link:#quarkus-core_quarkus-config-profile-parent[`quarkus.config.profile.parent`]## [.description] -- -Options to pass to the container runtime +Accepts a single configuration profile name. If a configuration property cannot be found in the current active profile, the config performs the same lookup in the profile set by this configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_CONTAINER_RUNTIME_OPTIONS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_PROFILE_PARENT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_CONTAINER_RUNTIME_OPTIONS+++` +Environment variable: `+++QUARKUS_CONFIG_PROFILE_PARENT+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-monitoring]] [.property-path]##link:#quarkus-core_quarkus-native-monitoring[`quarkus.native.monitoring`]## +a| [[quarkus-core_quarkus-config-locations]] [.property-path]##link:#quarkus-core_quarkus-config-locations[`quarkus.config.locations`]## [.description] -- -Enable monitoring various monitoring options. The value should be comma separated. - - - `jfr` for JDK flight recorder support - - `jvmstat` for JVMStat support - - `heapdump` for heampdump support - - `jmxclient` for JMX client support (experimental) - - `jmxserver` for JMX server support (experimental) - - `all` for all monitoring features +Additional config locations to be loaded with the Config. The configuration support multiple locations separated by a comma and each must represent a valid `java.net.URI`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_MONITORING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_LOCATIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_MONITORING+++` +Environment variable: `+++QUARKUS_CONFIG_LOCATIONS+++` endif::add-copy-button-to-env-var[] -- -a|list of `heapdump`, `jvmstat`, `jfr`, `jmxserver`, `jmxclient`, `all` +|list of link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enable-reports]] [.property-path]##link:#quarkus-core_quarkus-native-enable-reports[`quarkus.native.enable-reports`]## +a| [[quarkus-core_quarkus-config-mapping-validate-unknown]] [.property-path]##link:#quarkus-core_quarkus-config-mapping-validate-unknown[`quarkus.config.mapping.validate-unknown`]## [.description] -- -If the reports on call paths and included packages/classes/methods should be generated +Validates that a `@ConfigMapping` maps every available configuration name contained in the mapping prefix. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLE_REPORTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_MAPPING_VALIDATE_UNKNOWN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_ENABLE_REPORTS+++` +Environment variable: `+++QUARKUS_CONFIG_MAPPING_VALIDATE_UNKNOWN+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-report-exception-stack-traces]] [.property-path]##link:#quarkus-core_quarkus-native-report-exception-stack-traces[`quarkus.native.report-exception-stack-traces`]## +a| [[quarkus-core_quarkus-config-log-values]] [.property-path]##link:#quarkus-core_quarkus-config-log-values[`quarkus.config.log.values`]## [.description] -- -If exceptions should be reported with a full stack trace +Enable logging of configuration values lookup in DEBUG log level. + +The log of configuration values require the category set to `DEBUG` in the `io.smallrye.config` category: `quarkus.log.category."io.smallrye.config".level=DEBUG`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_REPORT_EXCEPTION_STACK_TRACES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_LOG_VALUES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_REPORT_EXCEPTION_STACK_TRACES+++` +Environment variable: `+++QUARKUS_CONFIG_LOG_VALUES+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-report-errors-at-runtime]] [.property-path]##link:#quarkus-core_quarkus-native-report-errors-at-runtime[`quarkus.native.report-errors-at-runtime`]## +a| [[quarkus-core_quarkus-uuid]] [.property-path]##link:#quarkus-core_quarkus-uuid[`quarkus.uuid`]## [.description] -- -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. Note that the use of this flag may result in build time failures due to `ClassNotFoundException`s. Reason most likely being that the Quarkus extension already optimized it away or do not actually need it. In such cases you should explicitly add the corresponding dependency providing the missing classes as a dependency to your project. +A property that allows accessing a generated UUID. It generates that UUID at startup time. So it changes between two starts including in dev mode. + +Access this generated UUID using expressions: `$++{++quarkus.uuid++}++`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_REPORT_ERRORS_AT_RUNTIME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_UUID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_REPORT_ERRORS_AT_RUNTIME+++` +Environment variable: `+++QUARKUS_UUID+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-reuse-existing]] [.property-path]##link:#quarkus-core_quarkus-native-reuse-existing[`quarkus.native.reuse-existing`]## +h|[.configroot-name]##Configuration tracking and dumping## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-enabled]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-enabled[`quarkus.config-tracking.enabled`]## [.description] -- -Don't build a native image if it already exists. This is useful if you have already built an image and you want to use Quarkus to deploy it somewhere. Note that this is not able to detect if the existing image is outdated, if you have modified source or config and want a new image you must not use this flag. +Whether configuration dumping is enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_REUSE_EXISTING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_REUSE_EXISTING+++` +Environment variable: `+++QUARKUS_CONFIG_TRACKING_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-resources-includes]] [.property-path]##link:#quarkus-core_quarkus-native-resources-includes[`quarkus.native.resources.includes`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-directory]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-directory[`quarkus.config-tracking.directory`]## [.description] -- -A comma separated list of globs to match resource paths that should be added to the native image. - -Use slash (`/`) as a path separator on all platforms. Globs must not start with slash. - -By default, no resources are included. - -Example: Given that you have `src/main/resources/ignored.png` and `src/main/resources/foo/selected.png` in your source tree and one of your dependency JARs contains `bar/some.txt` file, with the following configuration - -``` -quarkus.native.resources.includes = foo/**,bar/**/*.txt -``` - -the files `src/main/resources/foo/selected.png` and `bar/some.txt` will be included in the native image, while `src/main/resources/ignored.png` will not be included. - -Supported glob features Feature Description `++*++` Matches a (possibly empty) sequence of characters that does not contain slash (`/`) `++**++` Matches a (possibly empty) sequence of characters that may contain slash (`/`) `?` Matches one character, but not slash `++[++abc++]++` Matches one character given in the bracket, but not slash `++[++a-z++]++` Matches one character from the range given in the bracket, but not slash `++[++!abc++]++` Matches one character not named in the bracket; does not match slash `++[++a-z++]++` Matches one character outside the range given in the bracket; does not match slash `++{++one,two,three++}++` Matches any of the alternating tokens separated by comma; the tokens may contain wildcards, nested alternations and ranges `++\++` The escape character - -Note that there are three levels of escaping when passing this option via `application.properties`: - - . `application.properties` parser - - MicroProfile Config list converter that splits the comma separated list - - Glob parser All three levels use backslash (`++\++`) as the escaping character. So you need to use an appropriate number of backslashes depending on which level you want to escape. - -Note that Quarkus extensions typically include the resources they require by themselves. This option is useful in situations when the built-in functionality is not sufficient. +Directory in which the configuration dump should be stored. If not configured the `.quarkus` directory under the project directory will be used. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_RESOURCES_INCLUDES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_DIRECTORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_RESOURCES_INCLUDES+++` +Environment variable: `+++QUARKUS_CONFIG_TRACKING_DIRECTORY+++` endif::add-copy-button-to-env-var[] -- -|list of string +|path | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-resources-excludes]] [.property-path]##link:#quarkus-core_quarkus-native-resources-excludes[`quarkus.native.resources.excludes`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-file]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-file[`quarkus.config-tracking.file`]## [.description] -- -A comma separated list of globs to match resource paths that should *not* be added to the native image. - -Use slash (`/`) as a path separator on all platforms. Globs must not start with slash. - -Please refer to `includes` for details about the glob syntax. - -By default, no resources are excluded. - -Example: Given that you have `src/main/resources/red.png` and `src/main/resources/foo/green.png` in your source tree and one of your dependency JARs contains `bar/blue.png` file, with the following configuration - -``` -quarkus.native.resources.includes = **/*.png -quarkus.native.resources.excludes = foo/**,**/green.png -``` - -the resource `red.png` will be available in the native image while the resources `foo/green.png` and `bar/blue.png` will not be available in the native image. +File in which the configuration dump should be stored. If not configured, the `file-prefix` and `file-suffix` will be used to generate the final file name. If the configured file path is absolute, the `directory` option will be ignored. Otherwise, the path will be considered relative to the `directory`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_RESOURCES_EXCLUDES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_FILE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_RESOURCES_EXCLUDES+++` +Environment variable: `+++QUARKUS_CONFIG_TRACKING_FILE+++` endif::add-copy-button-to-env-var[] -- -|list of string +|path | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-debug-enabled]] [.property-path]##link:#quarkus-core_quarkus-native-debug-enabled[`quarkus.native.debug.enabled`]## - -[.description] --- -If debug is enabled and debug symbols are generated. The symbols will be generated in a separate .debug file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_DEBUG_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_DEBUG_ENABLED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enable-dashboard-dump]] [.property-path]##link:#quarkus-core_quarkus-native-enable-dashboard-dump[`quarkus.native.enable-dashboard-dump`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-file-prefix]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-file-prefix[`quarkus.config-tracking.file-prefix`]## [.description] -- -Generate the report files for GraalVM Dashboard. +File name prefix. This option will be ignored in case `file` is configured. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLE_DASHBOARD_DUMP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_FILE_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_ENABLE_DASHBOARD_DUMP+++` +Environment variable: `+++QUARKUS_CONFIG_TRACKING_FILE_PREFIX+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +|`quarkus` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-include-reasons-in-config-files]] [.property-path]##link:#quarkus-core_quarkus-native-include-reasons-in-config-files[`quarkus.native.include-reasons-in-config-files`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-file-suffix]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-file-suffix[`quarkus.config-tracking.file-suffix`]## [.description] -- -Include a reasons entries in the generated json configuration files. +File name suffix. This option will be ignored in case `file` is configured. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_INCLUDE_REASONS_IN_CONFIG_FILES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_FILE_SUFFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_INCLUDE_REASONS_IN_CONFIG_FILES+++` +Environment variable: `+++QUARKUS_CONFIG_TRACKING_FILE_SUFFIX+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +|`-config-dump` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-compression-level]] [.property-path]##link:#quarkus-core_quarkus-native-compression-level[`quarkus.native.compression.level`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-exclude]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-exclude[`quarkus.config-tracking.exclude`]## [.description] -- -The compression level in ++[++1, 10++]++. 10 means _best_. - -Higher compression level requires more time to compress the executable. +A list of config properties that should be excluded from the report. GLOB patterns could be used instead of property names. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_COMPRESSION_LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_EXCLUDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_COMPRESSION_LEVEL+++` +Environment variable: `+++QUARKUS_CONFIG_TRACKING_EXCLUDE+++` endif::add-copy-button-to-env-var[] -- -|int +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-compression-additional-args]] [.property-path]##link:#quarkus-core_quarkus-native-compression-additional-args[`quarkus.native.compression.additional-args`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-hash-options]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-hash-options[`quarkus.config-tracking.hash-options`]## [.description] -- -Allows passing extra arguments to the UPX command line (like --brute). The arguments are comma-separated. The exhaustive list of parameters can be found in link:https://github.com/upx/upx/blob/devel/doc/upx.pod[https://github.com/upx/upx/blob/devel/doc/upx.pod]. +A list of config properties whose values should be hashed in the report. The values will be hashed using SHA-512 algorithm. GLOB patterns could be used instead of property names. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_COMPRESSION_ADDITIONAL_ARGS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_HASH_OPTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_COMPRESSION_ADDITIONAL_ARGS+++` +Environment variable: `+++QUARKUS_CONFIG_TRACKING_HASH_OPTIONS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-agent-configuration-apply]] [.property-path]##link:#quarkus-core_quarkus-native-agent-configuration-apply[`quarkus.native.agent-configuration-apply`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-use-user-home-alias-in-paths]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-use-user-home-alias-in-paths[`quarkus.config-tracking.use-user-home-alias-in-paths`]## [.description] -- -Configuration files generated by the Quarkus build, using native image agent, are informative by default. In other words, the generated configuration files are presented in the build log but are not applied. When this option is set to true, generated configuration files are applied to the native executable building process. - -Enabling this option should be done with care, because it can make native image configuration and/or behaviour dependant on other non-obvious factors. For example, if the native image agent generated configuration was generated from running JVM unit tests, disabling test(s) can result in a different native image configuration being generated, which in turn can misconfigure the native executable or affect its behaviour in unintended ways. +Whether to use a `~` as an alias for user home directory in path values ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_AGENT_CONFIGURATION_APPLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_USE_USER_HOME_ALIAS_IN_PATHS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NATIVE_AGENT_CONFIGURATION_APPLY+++` +Environment variable: `+++QUARKUS_CONFIG_TRACKING_USE_USER_HOME_ALIAS_IN_PATHS+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-bootstrap-effective-model-builder]] [.property-path]##link:#quarkus-core_quarkus-bootstrap-effective-model-builder[`quarkus.bootstrap.effective-model-builder`]## +a| [[quarkus-core_quarkus-configuration-build-time-mismatch-at-runtime]] [.property-path]##link:#quarkus-core_quarkus-configuration-build-time-mismatch-at-runtime[`quarkus.configuration.build-time-mismatch-at-runtime`]## [.description] -- -If set to true, the workspace initialization will be based on the effective POMs (i.e. properly interpolated, including support for profiles) instead of the raw ones. - +What should happen if the application is started with a different build time configuration than it was compiled against. This may be useful to prevent misconfiguration. -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_BOOTSTRAP_EFFECTIVE_MODEL_BUILDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_BOOTSTRAP_EFFECTIVE_MODEL_BUILDER+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` +If this is set to `warn` the application will warn at start up. -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-bootstrap-workspace-discovery]] [.property-path]##link:#quarkus-core_quarkus-bootstrap-workspace-discovery[`quarkus.bootstrap.workspace-discovery`]## +If this is set to `fail` the application will fail at start up. -[.description] --- -If set to true, workspace discovery will be enabled for all launch modes. Usually, workspace discovery is enabled by default only for dev and test modes. +Native tests leveraging`@io.quarkus.test.junit.TestProfile` are always run with `quarkus.configuration.build-time-mismatch-at-runtime = fail`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_BOOTSTRAP_WORKSPACE_DISCOVERY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIGURATION_BUILD_TIME_MISMATCH_AT_RUNTIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_BOOTSTRAP_WORKSPACE_DISCOVERY+++` +Environment variable: `+++QUARKUS_CONFIGURATION_BUILD_TIME_MISMATCH_AT_RUNTIME+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +a|`warn`, `fail` +|`warn` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-bootstrap-warn-on-failing-workspace-modules]] [.property-path]##link:#quarkus-core_quarkus-bootstrap-warn-on-failing-workspace-modules[`quarkus.bootstrap.warn-on-failing-workspace-modules`]## +h|[.configroot-name]##Console## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-console-enabled]] [.property-path]##link:#quarkus-core_quarkus-console-enabled[`quarkus.console.enabled`]## [.description] -- -If set to true, workspace loader will log warnings for modules that could not be loaded for some reason instead of throwing errors. +If test results and status should be displayed in the console. + +If this is false results can still be viewed in the dev console. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_BOOTSTRAP_WARN_ON_FAILING_WORKSPACE_MODULES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONSOLE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_BOOTSTRAP_WARN_ON_FAILING_WORKSPACE_MODULES+++` +Environment variable: `+++QUARKUS_CONSOLE_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-bootstrap-disable-jar-cache]] [.property-path]##link:#quarkus-core_quarkus-bootstrap-disable-jar-cache[`quarkus.bootstrap.disable-jar-cache`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-console-disable-input]] [.property-path]##link:#quarkus-core_quarkus-console-disable-input[`quarkus.console.disable-input`]## [.description] -- -By default, the bootstrap mechanism will create a shared cache of open JARs for Quarkus classloaders to reduce the total number of opened ZIP FileSystems in dev and test modes. Setting system property `quarkus.bootstrap.disable-jar-cache` to `true` will make Quarkus classloaders create a new ZIP FileSystem for each JAR classpath element every time it is added to a Quarkus classloader. +Disables the ability to enter input on the console. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_BOOTSTRAP_DISABLE_JAR_CACHE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONSOLE_DISABLE_INPUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_BOOTSTRAP_DISABLE_JAR_CACHE+++` +Environment variable: `+++QUARKUS_CONSOLE_DISABLE_INPUT+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-bootstrap-incubating-model-resolver]] [.property-path]##link:#quarkus-core_quarkus-bootstrap-incubating-model-resolver[`quarkus.bootstrap.incubating-model-resolver`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-console-basic]] [.property-path]##link:#quarkus-core_quarkus-console-basic[`quarkus.console.basic`]## [.description] -- -A temporary option introduced to avoid a logging warning when `-Dquarkus.bootstrap.incubating-model-resolver` is added to the build command line. This option enables an incubating implementation of the Quarkus Application Model resolver. This option will be removed as soon as the incubating implementation becomes the default one. +Disable the testing status/prompt message at the bottom of the console and log these messages to STDOUT instead. + +Use this option if your terminal does not support ANSI escape sequences. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_BOOTSTRAP_INCUBATING_MODEL_RESOLVER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONSOLE_BASIC+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_BOOTSTRAP_INCUBATING_MODEL_RESOLVER+++` +Environment variable: `+++QUARKUS_CONSOLE_BASIC+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-bootstrap-misaligned-platform-imports]] [.property-path]##link:#quarkus-core_quarkus-bootstrap-misaligned-platform-imports[`quarkus.bootstrap.misaligned-platform-imports`]## +a| [[quarkus-core_quarkus-console-color]] [.property-path]##link:#quarkus-core_quarkus-console-color[`quarkus.console.color`]## [.description] -- -Whether to throw an error, warn or silently ignore misaligned platform BOM imports +If color should be enabled or disabled. If this is not present then an attempt will be made to guess if the terminal supports color ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_BOOTSTRAP_MISALIGNED_PLATFORM_IMPORTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONSOLE_COLOR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_BOOTSTRAP_MISALIGNED_PLATFORM_IMPORTS+++` +Environment variable: `+++QUARKUS_CONSOLE_COLOR+++` endif::add-copy-button-to-env-var[] -- -a|`error`, `warn`, `ignore` -|`error` - -a| [[quarkus-core_quarkus-thread-pool-core-threads]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-core-threads[`quarkus.thread-pool.core-threads`]## - -[.description] --- -The core thread pool size. This number of threads will always be kept alive. - +|boolean +| -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_CORE_THREADS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_THREAD_POOL_CORE_THREADS+++` -endif::add-copy-button-to-env-var[] --- -|int -|`1` +h|[.configroot-name]##Debugging## +h|Type +h|Default -a| [[quarkus-core_quarkus-thread-pool-prefill]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-prefill[`quarkus.thread-pool.prefill`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-debug-reflection]] [.property-path]##link:#quarkus-core_quarkus-debug-reflection[`quarkus.debug.reflection`]## [.description] -- -Prefill core thread pool. The core thread pool will be initialised with the core number of threads at startup +If set to true, writes a list of all reflective classes to META-INF ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_PREFILL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEBUG_REFLECTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_THREAD_POOL_PREFILL+++` +Environment variable: `+++QUARKUS_DEBUG_REFLECTION+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` +|`false` -a| [[quarkus-core_quarkus-thread-pool-max-threads]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-max-threads[`quarkus.thread-pool.max-threads`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-debug-generated-classes-dir]] [.property-path]##link:#quarkus-core_quarkus-debug-generated-classes-dir[`quarkus.debug.generated-classes-dir`]## [.description] -- -The maximum number of threads. If this is not specified then it will be automatically sized to the greatest of 8 ++*++ the number of available processors and 200. For example if there are 4 processors the max threads will be 200. If there are 48 processors it will be 384. +If set to a directory, all generated classes will be written into that directory ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_MAX_THREADS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEBUG_GENERATED_CLASSES_DIR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_THREAD_POOL_MAX_THREADS+++` +Environment variable: `+++QUARKUS_DEBUG_GENERATED_CLASSES_DIR+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a| [[quarkus-core_quarkus-thread-pool-queue-size]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-queue-size[`quarkus.thread-pool.queue-size`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-debug-transformed-classes-dir]] [.property-path]##link:#quarkus-core_quarkus-debug-transformed-classes-dir[`quarkus.debug.transformed-classes-dir`]## [.description] -- -The queue size. For most applications this should be unbounded +If set to a directory, all transformed classes (e.g. Panache entities) will be written into that directory ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_QUEUE_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEBUG_TRANSFORMED_CLASSES_DIR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_THREAD_POOL_QUEUE_SIZE+++` +Environment variable: `+++QUARKUS_DEBUG_TRANSFORMED_CLASSES_DIR+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a| [[quarkus-core_quarkus-thread-pool-growth-resistance]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-growth-resistance[`quarkus.thread-pool.growth-resistance`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-debug-generated-sources-dir]] [.property-path]##link:#quarkus-core_quarkus-debug-generated-sources-dir[`quarkus.debug.generated-sources-dir`]## [.description] -- -The executor growth resistance. A resistance factor applied after the core pool is full; values applied here will cause that fraction of submissions to create new threads when no idle thread is available. A value of `0.0f` implies that threads beyond the core size should be created as aggressively as threads within it; a value of `1.0f` implies that threads beyond the core size should never be created. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_GROWTH_RESISTANCE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_THREAD_POOL_GROWTH_RESISTANCE+++` -endif::add-copy-button-to-env-var[] --- -|float -|`0f` - -a| [[quarkus-core_quarkus-thread-pool-shutdown-timeout]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-shutdown-timeout[`quarkus.thread-pool.shutdown-timeout`]## +If set to a directory, ZIG files for generated code will be written into that directory. -[.description] --- -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 +A ZIG file is a textual representation of the generated code that is referenced in the stacktraces. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_SHUTDOWN_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEBUG_GENERATED_SOURCES_DIR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_THREAD_POOL_SHUTDOWN_TIMEOUT+++` +Environment variable: `+++QUARKUS_DEBUG_GENERATED_SOURCES_DIR+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`1M` +|string +| -a| [[quarkus-core_quarkus-thread-pool-shutdown-interrupt]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-shutdown-interrupt[`quarkus.thread-pool.shutdown-interrupt`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-debug-dump-build-metrics]] [.property-path]##link:#quarkus-core_quarkus-debug-dump-build-metrics[`quarkus.debug.dump-build-metrics`]## [.description] -- -The amount of time to wait for thread pool shutdown before tasks should be interrupted. If this value is greater than or equal to the value for `shutdown-timeout`, then tasks will not be interrupted before the shutdown timeout occurs. +If set to true then dump the build metrics to a JSON file in the build directory. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_SHUTDOWN_INTERRUPT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEBUG_DUMP_BUILD_METRICS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_THREAD_POOL_SHUTDOWN_INTERRUPT+++` +Environment variable: `+++QUARKUS_DEBUG_DUMP_BUILD_METRICS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` +|boolean +|`false` -a| [[quarkus-core_quarkus-thread-pool-shutdown-check-interval]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-shutdown-check-interval[`quarkus.thread-pool.shutdown-check-interval`]## +a| [[quarkus-core_quarkus-debug-print-startup-times]] [.property-path]##link:#quarkus-core_quarkus-debug-print-startup-times[`quarkus.debug.print-startup-times`]## [.description] -- -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. +If set to `true`, Quarkus prints the wall-clock time each build step took to complete. This is useful as a first step in debugging slow startup times. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_SHUTDOWN_CHECK_INTERVAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEBUG_PRINT_STARTUP_TIMES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_THREAD_POOL_SHUTDOWN_CHECK_INTERVAL+++` +Environment variable: `+++QUARKUS_DEBUG_PRINT_STARTUP_TIMES+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`5S` +|boolean +|`false` -a| [[quarkus-core_quarkus-thread-pool-keep-alive-time]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-keep-alive-time[`quarkus.thread-pool.keep-alive-time`]## +h|[.configroot-name]##Deployment## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-deploy-target]] [.property-path]##link:#quarkus-core_quarkus-deploy-target[`quarkus.deploy.target`]## [.description] -- -The amount of time a thread will stay alive with no work. +Deployment target ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_KEEP_ALIVE_TIME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEPLOY_TARGET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_THREAD_POOL_KEEP_ALIVE_TIME+++` +Environment variable: `+++QUARKUS_DEPLOY_TARGET+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`30S` +|string +| + +h|[.configroot-name]##Dev Services## +h|Type +h|Default a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-devservices-enabled]] [.property-path]##link:#quarkus-core_quarkus-devservices-enabled[`quarkus.devservices.enabled`]## @@ -4329,233 +4284,175 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DEVSERVICES_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-sources-system-only]] [.property-path]##link:#quarkus-core_quarkus-config-sources-system-only[`quarkus.config.sources.system-only`]## - -[.description] --- -Set this to `true` to read configuration from system properties and environment variables only. This only applies to runtime. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_SOURCES_SYSTEM_ONLY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_SOURCES_SYSTEM_ONLY+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-locales]] [.property-path]##link:#quarkus-core_quarkus-locales[`quarkus.locales`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-execution-model-annotations-detection-mode]] [.property-path]##link:#quarkus-core_quarkus-execution-model-annotations-detection-mode[`quarkus.execution-model-annotations.detection-mode`]## [.description] -- -The set of supported locales that can be consumed by the extensions. - -The locales must be specified in the IETF BCP 47 format e.g. en-US or fr-FR. - -For instance, the Hibernate Validator extension makes use of it. - -Native-image build uses it to define additional locales that are supposed to be available at runtime. +Detection mode of invalid usage of execution model annotations. -A special string "all" is translated as ROOT Locale and then used in native-image to include all locales. Image size penalty applies. +An execution model annotation is `@Blocking`, `@NonBlocking` and `@RunOnVirtualThread`. These annotations may only be used on "entrypoint" methods (methods invoked by various frameworks in Quarkus); using them on methods that can only be invoked by application code is invalid. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOCALES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EXECUTION_MODEL_ANNOTATIONS_DETECTION_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOCALES+++` +Environment variable: `+++QUARKUS_EXECUTION_MODEL_ANNOTATIONS_DETECTION_MODE+++` endif::add-copy-button-to-env-var[] -- -|list of link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html[Locale] -|`Set containing the build system locale` +a|tooltip:fail[Invalid usage of execution model annotations causes build failure.], tooltip:warn[Invalid usage of execution model annotations causes warning during build.], tooltip:disabled[No detection of invalid usage of execution model annotations.] +|tooltip:fail[Invalid usage of execution model annotations causes build failure.] -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-default-locale]] [.property-path]##link:#quarkus-core_quarkus-default-locale[`quarkus.default-locale`]## +h|[.configroot-name]##IDE## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-ide-target]] [.property-path]##link:#quarkus-core_quarkus-ide-target[`quarkus.ide.target`]## [.description] -- -Default locale that can be consumed by the extensions. - -The locale must be specified in the IETF BCP 47 format e.g. en-US or fr-FR. - -For instance, the Hibernate Validator extension makes use of it. - -Native-image build uses this property to derive `user.language` and `user.country` for the application's runtime. +The Ide to use to open files from the DevUI. `auto` means that Quarkus will attempt to determine the Ide being used. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DEFAULT_LOCALE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IDE_TARGET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DEFAULT_LOCALE+++` +Environment variable: `+++QUARKUS_IDE_TARGET+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html[Locale] -|`Build system locale` - -a| [[quarkus-core_quarkus-args]] [.property-path]##link:#quarkus-core_quarkus-args[`quarkus.args`]## - -[.description] --- -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. +a|`auto`, `idea`, `vscode`, `eclipse`, `netbeans` +|`auto` +h|[.configroot-name]##Indexing## +h|Type +h|Default -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_ARGS+++` -endif::add-copy-button-to-env-var[] --- -|string -| +h|[[quarkus-core_section_quarkus-index-dependency]] [.section-name.section-level1]##link:#quarkus-core_section_quarkus-index-dependency[Artifacts on the classpath that should also be indexed]## +h|Type +h|Default -a| [[quarkus-core_quarkus-init-and-exit]] [.property-path]##link:#quarkus-core_quarkus-init-and-exit[`quarkus.init-and-exit`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-index-dependency-dependency-name-group-id]] [.property-path]##link:#quarkus-core_quarkus-index-dependency-dependency-name-group-id[`quarkus.index-dependency."dependency-name".group-id`]## [.description] -- -true to quit exit right after the initialization. The option is not meant be used directly by users. +The maven groupId of the artifact. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__GROUP_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INIT_AND_EXIT+++` +Environment variable: `+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__GROUP_ID+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +|required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-application-name]] [.property-path]##link:#quarkus-core_quarkus-application-name[`quarkus.application.name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-index-dependency-dependency-name-artifact-id]] [.property-path]##link:#quarkus-core_quarkus-index-dependency-dependency-name-artifact-id[`quarkus.index-dependency."dependency-name".artifact-id`]## [.description] -- -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). +The maven artifactId of the artifact (optional). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_APPLICATION_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__ARTIFACT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_APPLICATION_NAME+++` +Environment variable: `+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__ARTIFACT_ID+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-application-version]] [.property-path]##link:#quarkus-core_quarkus-application-version[`quarkus.application.version`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-index-dependency-dependency-name-classifier]] [.property-path]##link:#quarkus-core_quarkus-index-dependency-dependency-name-classifier[`quarkus.index-dependency."dependency-name".classifier`]## [.description] -- -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). +The maven classifier of the artifact (optional). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_APPLICATION_VERSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__CLASSIFIER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_APPLICATION_VERSION+++` +Environment variable: `+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__CLASSIFIER+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-application-ui-header]] [.property-path]##link:#quarkus-core_quarkus-application-ui-header[`quarkus.application.ui-header`]## - -[.description] --- -The header to use for UI Screen (Swagger UI, GraphQL UI etc). - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_APPLICATION_UI_HEADER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_APPLICATION_UI_HEADER+++` -endif::add-copy-button-to-env-var[] --- -|string -|`{applicationName} (powered by Quarkus)` +h|[.configroot-name]##Initialization## +h|Type +h|Default -a| [[quarkus-core_quarkus-launch-rebuild]] [.property-path]##link:#quarkus-core_quarkus-launch-rebuild[`quarkus.launch.rebuild`]## +a| [[quarkus-core_quarkus-init-and-exit]] [.property-path]##link:#quarkus-core_quarkus-init-and-exit[`quarkus.init-and-exit`]## [.description] -- -If set to true, Quarkus will perform re-augmentation (assuming the `mutable-jar` package type is used) +true to quit exit right after the initialization. The option is not meant be used directly by users. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LAUNCH_REBUILD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LAUNCH_REBUILD+++` +Environment variable: `+++QUARKUS_INIT_AND_EXIT+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -h|[[quarkus-core_section_quarkus-index-dependency]] [.section-name.section-level0]##link:#quarkus-core_section_quarkus-index-dependency[Artifacts on the classpath that should also be indexed]## +h|[.configroot-name]##JNI## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-index-dependency-dependency-name-group-id]] [.property-path]##link:#quarkus-core_quarkus-index-dependency-dependency-name-group-id[`quarkus.index-dependency."dependency-name".group-id`]## - -[.description] --- -The maven groupId of the artifact. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__GROUP_ID+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__GROUP_ID+++` -endif::add-copy-button-to-env-var[] --- -|string -|required icon:exclamation-circle[title=Configuration property is required] - -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-index-dependency-dependency-name-artifact-id]] [.property-path]##link:#quarkus-core_quarkus-index-dependency-dependency-name-artifact-id[`quarkus.index-dependency."dependency-name".artifact-id`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-jni-library-paths]] [.property-path]##link:#quarkus-core_quarkus-jni-library-paths[`quarkus.jni.library-paths`]## [.description] -- -The maven artifactId of the artifact (optional). +Paths of library to load. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__ARTIFACT_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_JNI_LIBRARY_PATHS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__ARTIFACT_ID+++` +Environment variable: `+++QUARKUS_JNI_LIBRARY_PATHS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-index-dependency-dependency-name-classifier]] [.property-path]##link:#quarkus-core_quarkus-index-dependency-dependency-name-classifier[`quarkus.index-dependency."dependency-name".classifier`]## +h|[.configroot-name]##Launch## +h|Type +h|Default + +a| [[quarkus-core_quarkus-launch-rebuild]] [.property-path]##link:#quarkus-core_quarkus-launch-rebuild[`quarkus.launch.rebuild`]## [.description] -- -The maven classifier of the artifact (optional). +If set to true, Quarkus will perform re-augmentation (assuming the `mutable-jar` package type is used) ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__CLASSIFIER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAUNCH_REBUILD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__CLASSIFIER+++` +Environment variable: `+++QUARKUS_LAUNCH_REBUILD+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` +h|[.configroot-name]##Live reload## +h|Type +h|Default a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-live-reload-enabled]] [.property-path]##link:#quarkus-core_quarkus-live-reload-enabled[`quarkus.live-reload.enabled`]## @@ -4656,7 +4553,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LIVE_RELOAD_CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30S` a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-live-reload-retry-interval]] [.property-path]##link:#quarkus-core_quarkus-live-reload-retry-interval[`quarkus.live-reload.retry-interval`]## @@ -4673,7 +4570,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LIVE_RELOAD_RETRY_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`2S` a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-live-reload-retry-max-attempts]] [.property-path]##link:#quarkus-core_quarkus-live-reload-retry-max-attempts[`quarkus.live-reload.retry-max-attempts`]## @@ -4693,3613 +4590,3865 @@ endif::add-copy-button-to-env-var[] |int |`10` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-jni-library-paths]] [.property-path]##link:#quarkus-core_quarkus-jni-library-paths[`quarkus.jni.library-paths`]## +h|[.configroot-name]##Localization## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-locales]] [.property-path]##link:#quarkus-core_quarkus-locales[`quarkus.locales`]## [.description] -- -Paths of library to load. +The set of supported locales that can be consumed by the extensions. + +The locales must be specified in the IETF BCP 47 format e.g. en-US or fr-FR. + +For instance, the Hibernate Validator extension makes use of it. + +Native-image build uses it to define additional locales that are supposed to be available at runtime. + +A special string "all" is translated as ROOT Locale and then used in native-image to include all locales. Image size penalty applies. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JNI_LIBRARY_PATHS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOCALES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JNI_LIBRARY_PATHS+++` +Environment variable: `+++QUARKUS_LOCALES+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|list of link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html[Locale] +|`Set containing the build system locale` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-naming-enable-jndi]] [.property-path]##link:#quarkus-core_quarkus-naming-enable-jndi[`quarkus.naming.enable-jndi`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-default-locale]] [.property-path]##link:#quarkus-core_quarkus-default-locale[`quarkus.default-locale`]## [.description] -- -By default, Quarkus will install a non-functional JNDI initial context, to help mitigate against Log4Shell style attacks. If your application does need to use JNDI you can change this flag. +Default locale that can be consumed by the extensions. + +The locale must be specified in the IETF BCP 47 format e.g. en-US or fr-FR. + +For instance, the Hibernate Validator extension makes use of it. + +Native-image build uses this property to derive `user.language` and `user.country` for the application's runtime. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_NAMING_ENABLE_JNDI+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEFAULT_LOCALE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_NAMING_ENABLE_JNDI+++` +Environment variable: `+++QUARKUS_DEFAULT_LOCALE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html[Locale] +|`Build system locale` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-platform-group-id]] [.property-path]##link:#quarkus-core_quarkus-platform-group-id[`quarkus.platform.group-id`]## +h|[.configroot-name]##Logging## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-log-metrics-enabled]] [.property-path]##link:#quarkus-core_quarkus-log-metrics-enabled[`quarkus.log.metrics.enabled`]## [.description] -- -groupId of the platform to use +If enabled and a metrics extension is present, logging metrics are published. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PLATFORM_GROUP_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_METRICS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PLATFORM_GROUP_ID+++` +Environment variable: `+++QUARKUS_LOG_METRICS_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -|`io.quarkus.platform` - -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-platform-artifact-id]] [.property-path]##link:#quarkus-core_quarkus-platform-artifact-id[`quarkus.platform.artifact-id`]## +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-log-min-level]] [.property-path]##link:#quarkus-core_quarkus-log-min-level[`quarkus.log.min-level`]## [.description] -- -artifactId of the platform to use +The default minimum log level. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PLATFORM_ARTIFACT_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_MIN_LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PLATFORM_ARTIFACT_ID+++` +Environment variable: `+++QUARKUS_LOG_MIN_LEVEL+++` endif::add-copy-button-to-env-var[] -- -|string -|`quarkus-bom` +|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] +|`DEBUG` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-platform-version]] [.property-path]##link:#quarkus-core_quarkus-platform-version[`quarkus.platform.version`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-log-decorate-stacktraces]] [.property-path]##link:#quarkus-core_quarkus-log-decorate-stacktraces[`quarkus.log.decorate-stacktraces`]## [.description] -- -version of the platform to use +This will decorate the stacktrace in dev mode to show the line in the code that cause the exception ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PLATFORM_VERSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_DECORATE_STACKTRACES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PLATFORM_VERSION+++` +Environment variable: `+++QUARKUS_LOG_DECORATE_STACKTRACES+++` endif::add-copy-button-to-env-var[] -- -|string -|`999-SNAPSHOT` +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-enabled]] [.property-path]##link:#quarkus-core_quarkus-package-jar-enabled[`quarkus.package.jar.enabled`]## +a| [[quarkus-core_quarkus-log-level]] [.property-path]##link:#quarkus-core_quarkus-log-level[`quarkus.log.level`]## [.description] -- -If set to false, no JAR will be produced. +The log level of the root category, which is used as the default log level for all categories. + +JBoss Logging supports Apache-style log levels: + +* {@link org.jboss.logmanager.Level#FATAL} +* {@link org.jboss.logmanager.Level#ERROR} +* {@link org.jboss.logmanager.Level#WARN} +* {@link org.jboss.logmanager.Level#INFO} +* {@link org.jboss.logmanager.Level#DEBUG} +* {@link org.jboss.logmanager.Level#TRACE} + +In addition, it also supports the standard JDK log levels. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_ENABLED+++` +Environment variable: `+++QUARKUS_LOG_LEVEL+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] +|`INFO` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-type]] [.property-path]##link:#quarkus-core_quarkus-package-jar-type[`quarkus.package.jar.type`]## +a| [[quarkus-core_quarkus-log-handlers]] [.property-path]##link:#quarkus-core_quarkus-log-handlers[`quarkus.log.handlers`]## [.description] -- -The JAR output type to use. +The names of additional handlers to link to the root category. These handlers are defined in consoleHandlers, fileHandlers, or syslogHandlers. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLERS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_TYPE+++` +Environment variable: `+++QUARKUS_LOG_HANDLERS+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:fast-jar[The "fast JAR" packaging type.], tooltip:uber-jar[The "Uber-JAR" packaging type.], tooltip:mutable-jar[The "mutable JAR" packaging type (for remote development mode).], tooltip:legacy-jar[The "legacy JAR" packaging type. This corresponds to the packaging type used in Quarkus before version 1.12.] -|tooltip:fast-jar[The "fast JAR" packaging type.] +|list of string +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-compress]] [.property-path]##link:#quarkus-core_quarkus-package-jar-compress[`quarkus.package.jar.compress`]## +h|[[quarkus-core_section_quarkus-log-category]] [.section-name.section-level1]##link:#quarkus-core_section_quarkus-log-category[Minimum logging categories]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-log-category-categories-min-level]] [.property-path]##link:#quarkus-core_quarkus-log-category-categories-min-level[`quarkus.log.category."categories".min-level`]## [.description] -- -Whether the created jar will be compressed. This setting is not used when building a native image +The minimum log level for this category. By default, all categories are configured with `DEBUG` minimum level. + +To get runtime logging below `DEBUG`, e.g., `TRACE`, adjust the minimum level at build time. The right log level needs to be provided at runtime. + +As an example, to get `TRACE` logging, minimum level needs to be at `TRACE`, and the runtime log level needs to match that. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_COMPRESS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CATEGORY__CATEGORIES__MIN_LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_COMPRESS+++` +Environment variable: `+++QUARKUS_LOG_CATEGORY__CATEGORIES__MIN_LEVEL+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|InheritableLevel +|`inherit` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-manifest-add-implementation-entries]] [.property-path]##link:#quarkus-core_quarkus-package-jar-manifest-add-implementation-entries[`quarkus.package.jar.manifest.add-implementation-entries`]## +a| [[quarkus-core_quarkus-log-category-categories-level]] [.property-path]##link:#quarkus-core_quarkus-log-category-categories-level[`quarkus.log.category."categories".level`]## [.description] -- -Specify whether the `Implementation` information should be included in the runner jar's MANIFEST.MF. +The log level for this category. + +Note that to get log levels below `INFO`, the minimum level build-time configuration option also needs to be adjusted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_MANIFEST_ADD_IMPLEMENTATION_ENTRIES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CATEGORY__CATEGORIES__LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_MANIFEST_ADD_IMPLEMENTATION_ENTRIES+++` +Environment variable: `+++QUARKUS_LOG_CATEGORY__CATEGORIES__LEVEL+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|InheritableLevel +|`inherit` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-manifest-attributes-attribute-name]] [.property-path]##link:#quarkus-core_quarkus-package-jar-manifest-attributes-attribute-name[`quarkus.package.jar.manifest.attributes."attribute-name"`]## +a| [[quarkus-core_quarkus-log-category-categories-handlers]] [.property-path]##link:#quarkus-core_quarkus-log-category-categories-handlers[`quarkus.log.category."categories".handlers`]## [.description] -- -Custom manifest attributes to be added to the main section of the MANIFEST.MF file. An example of the user defined property: quarkus.package.jar.manifest.attributes."Entry-key1"=Value1 quarkus.package.jar.manifest.attributes."Entry-key2"=Value2 +The names of the handlers to link to this category. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_MANIFEST_ATTRIBUTES__ATTRIBUTE_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CATEGORY__CATEGORIES__HANDLERS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_MANIFEST_ATTRIBUTES__ATTRIBUTE_NAME_+++` +Environment variable: `+++QUARKUS_LOG_CATEGORY__CATEGORIES__HANDLERS+++` endif::add-copy-button-to-env-var[] -- -|Map +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-manifest-sections-section-name]] [.property-path]##link:#quarkus-core_quarkus-package-jar-manifest-sections-section-name[`quarkus.package.jar.manifest.sections."section-name"`]## +a| [[quarkus-core_quarkus-log-category-categories-use-parent-handlers]] [.property-path]##link:#quarkus-core_quarkus-log-category-categories-use-parent-handlers[`quarkus.log.category."categories".use-parent-handlers`]## [.description] -- -Custom manifest sections to be added to the MANIFEST.MF file. An example of the user defined property: quarkus.package.jar.manifest.sections."Section-Name"."Entry-Key1"=Value1 quarkus.package.jar.manifest.sections."Section-Name"."Entry-Key2"=Value2 +Specify whether this logger should send its output to its parent Logger ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_MANIFEST_SECTIONS__SECTION_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CATEGORY__CATEGORIES__USE_PARENT_HANDLERS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_MANIFEST_SECTIONS__SECTION_NAME_+++` +Environment variable: `+++QUARKUS_LOG_CATEGORY__CATEGORIES__USE_PARENT_HANDLERS+++` endif::add-copy-button-to-env-var[] -- -|Map> -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-user-configured-ignored-entries]] [.property-path]##link:#quarkus-core_quarkus-package-jar-user-configured-ignored-entries[`quarkus.package.jar.user-configured-ignored-entries`]## + +h|[[quarkus-core_section_quarkus-log-console]] [.section-name.section-level1]##link:#quarkus-core_section_quarkus-log-console[Console logging]## +h|Type +h|Default + +a| [[quarkus-core_quarkus-log-console-enable]] [.property-path]##link:#quarkus-core_quarkus-log-console-enable[`quarkus.log.console.enable`]## [.description] -- -Files that should not be copied to the output artifact. +If console logging should be enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_USER_CONFIGURED_IGNORED_ENTRIES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_ENABLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_USER_CONFIGURED_IGNORED_ENTRIES+++` +Environment variable: `+++QUARKUS_LOG_CONSOLE_ENABLE+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-included-optional-dependencies]] [.property-path]##link:#quarkus-core_quarkus-package-jar-included-optional-dependencies[`quarkus.package.jar.included-optional-dependencies`]## +a| [[quarkus-core_quarkus-log-console-stderr]] [.property-path]##link:#quarkus-core_quarkus-log-console-stderr[`quarkus.log.console.stderr`]## [.description] -- -List of all the dependencies that have been defined as optional to include into the final package of the application. Each optional dependency needs to be expressed in the following format: - -`groupId:artifactId++[++:++[++classifier++][++:++[++type++]]]++` - -With the classifier and type being optional (note that the brackets (`++[]++`) denote optionality and are not a part of the syntax specification). The group ID and artifact ID must be present and non-empty. - -If the type is missing, the artifact is assumed to be of type `jar`. - -This parameter is optional; if absent, no optional dependencies will be included into the final package of the application. - -For backward compatibility reasons, this parameter is ignored by default and can be enabled by setting the parameter `quarkus.package.jar.filter-optional-dependencies` to `true`. - -This parameter is meant to be used in modules where multi-builds have been configured to avoid getting a final package with unused dependencies. +If console logging should go to `System++#++err` instead of `System++#++out`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_INCLUDED_OPTIONAL_DEPENDENCIES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_STDERR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_INCLUDED_OPTIONAL_DEPENDENCIES+++` +Environment variable: `+++QUARKUS_LOG_CONSOLE_STDERR+++` endif::add-copy-button-to-env-var[] -- -|list of GACT -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-filter-optional-dependencies]] [.property-path]##link:#quarkus-core_quarkus-package-jar-filter-optional-dependencies[`quarkus.package.jar.filter-optional-dependencies`]## +a| [[quarkus-core_quarkus-log-console-format]] [.property-path]##link:#quarkus-core_quarkus-log-console-format[`quarkus.log.console.format`]## [.description] -- -Flag indicating whether the optional dependencies should be filtered out or not. - -This parameter is meant to be used in modules where multi-builds have been configured to avoid getting a final package with unused dependencies. +The log format. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_FILTER_OPTIONAL_DEPENDENCIES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_FILTER_OPTIONAL_DEPENDENCIES+++` +Environment variable: `+++QUARKUS_LOG_CONSOLE_FORMAT+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +|`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-add-runner-suffix]] [.property-path]##link:#quarkus-core_quarkus-package-jar-add-runner-suffix[`quarkus.package.jar.add-runner-suffix`]## +a| [[quarkus-core_quarkus-log-console-level]] [.property-path]##link:#quarkus-core_quarkus-log-console-level[`quarkus.log.console.level`]## [.description] -- -Indicates whether the generated JAR file should have the runner suffix appended. Only applicable to the `JarType++#++UBER_JAR uber-JAR output type`. If disabled, the JAR built by the original build system (Maven, Gradle, etc.) will be replaced with the Quarkus-built uber-JAR. +The console log level. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_ADD_RUNNER_SUFFIX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_ADD_RUNNER_SUFFIX+++` +Environment variable: `+++QUARKUS_LOG_CONSOLE_LEVEL+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] +|`ALL` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-appcds-enabled]] [.property-path]##link:#quarkus-core_quarkus-package-jar-appcds-enabled[`quarkus.package.jar.appcds.enabled`]## +a| [[quarkus-core_quarkus-log-console-darken]] [.property-path]##link:#quarkus-core_quarkus-log-console-darken[`quarkus.log.console.darken`]## [.description] -- -Whether to automate the creation of AppCDS. Furthermore, this option only works for Java 11{plus} 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. +Specify how much the colors should be darkened. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_APPCDS_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_DARKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_APPCDS_ENABLED+++` +Environment variable: `+++QUARKUS_LOG_CONSOLE_DARKEN+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|int +|`0` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-appcds-builder-image]] [.property-path]##link:#quarkus-core_quarkus-package-jar-appcds-builder-image[`quarkus.package.jar.appcds.builder-image`]## +a| [[quarkus-core_quarkus-log-console-filter]] [.property-path]##link:#quarkus-core_quarkus-log-console-filter[`quarkus.log.console.filter`]## [.description] -- -When AppCDS generation is enabled, if this property is set, then the JVM used to generate the AppCDS file will be the JVM present in the container image. The builder image is expected to have the 'java' binary on its PATH. This flag is useful when the JVM to be used at runtime is not the same exact JVM version as the one used to build the jar. Note that this property is consulted only when `quarkus.package.jar.appcds.enabled=true` and it requires having docker available during the build. +The name of the filter to link to the console handler. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_APPCDS_BUILDER_IMAGE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_FILTER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_APPCDS_BUILDER_IMAGE+++` +Environment variable: `+++QUARKUS_LOG_CONSOLE_FILTER+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-appcds-use-container]] [.property-path]##link:#quarkus-core_quarkus-package-jar-appcds-use-container[`quarkus.package.jar.appcds.use-container`]## +a| [[quarkus-core_quarkus-log-console-async]] [.property-path]##link:#quarkus-core_quarkus-log-console-async[`quarkus.log.console.async`]## [.description] -- -Whether creation of the AppCDS archive should run in a container if available. - -Normally, if either a suitable container image to use to create the AppCDS archive can be determined automatically or if one is explicitly set using the `quarkus..appcds.builder-image` setting, the AppCDS archive is generated by running the JDK contained in the image as a container. - -If this option is set to `false`, a container will not be used to generate the AppCDS archive. Instead, the JDK used to build the application is also used to create the archive. Note that the exact same JDK version must be used to run the application in this case. - -Ignored if `quarkus.package.jar.appcds.enabled` is set to `false`. +Indicates whether to log asynchronously ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_APPCDS_USE_CONTAINER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_ASYNC+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_APPCDS_USE_CONTAINER+++` +Environment variable: `+++QUARKUS_LOG_CONSOLE_ASYNC+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-user-providers-directory]] [.property-path]##link:#quarkus-core_quarkus-package-jar-user-providers-directory[`quarkus.package.jar.user-providers-directory`]## +a| [[quarkus-core_quarkus-log-console-async-queue-length]] [.property-path]##link:#quarkus-core_quarkus-log-console-async-queue-length[`quarkus.log.console.async.queue-length`]## [.description] -- -This is an advanced option that only takes effect for development mode. - -If this is specified a directory of this name will be created in the jar distribution. Users can place jar files in this directory, and when re-augmentation is performed these will be processed and added to the class-path. - -Note that before reaugmentation has been performed these jars will be ignored, and if they are updated the app should be reaugmented again. +The queue length to use before flushing writing ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_USER_PROVIDERS_DIRECTORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_ASYNC_QUEUE_LENGTH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_USER_PROVIDERS_DIRECTORY+++` +Environment variable: `+++QUARKUS_LOG_CONSOLE_ASYNC_QUEUE_LENGTH+++` endif::add-copy-button-to-env-var[] -- -|string -| +|int +|`512` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-include-dependency-list]] [.property-path]##link:#quarkus-core_quarkus-package-jar-include-dependency-list[`quarkus.package.jar.include-dependency-list`]## +a| [[quarkus-core_quarkus-log-console-async-overflow]] [.property-path]##link:#quarkus-core_quarkus-log-console-async-overflow[`quarkus.log.console.async.overflow`]## [.description] -- -If this option is true then a list of all the coordinates of the artifacts that made up this image will be included in the quarkus-app directory. This list can be used by vulnerability scanners to determine if your application has any vulnerable dependencies. Only supported for the `JarType++#++FAST_JAR fast JAR` and `JarType++#++MUTABLE_JAR mutable JAR` output types. +Determine whether to block the publisher (rather than drop the message) when the queue is full ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_INCLUDE_DEPENDENCY_LIST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_ASYNC_OVERFLOW+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_INCLUDE_DEPENDENCY_LIST+++` +Environment variable: `+++QUARKUS_LOG_CONSOLE_ASYNC_OVERFLOW+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +a|`block`, `discard` +|`block` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-decompiler-enabled]] [.property-path]##link:#quarkus-core_quarkus-package-jar-decompiler-enabled[`quarkus.package.jar.decompiler.enabled`]## + +h|[[quarkus-core_section_quarkus-log-file]] [.section-name.section-level1]##link:#quarkus-core_section_quarkus-log-file[File logging]## +h|Type +h|Default + +a| [[quarkus-core_quarkus-log-file-enable]] [.property-path]##link:#quarkus-core_quarkus-log-file-enable[`quarkus.log.file.enable`]## [.description] -- -Enable decompilation of generated and transformed bytecode into the `decompiled` directory. +If file logging should be enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_DECOMPILER_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ENABLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_DECOMPILER_ENABLED+++` +Environment variable: `+++QUARKUS_LOG_FILE_ENABLE+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-decompiler-jar-directory]] [.property-path]##link:#quarkus-core_quarkus-package-jar-decompiler-jar-directory[`quarkus.package.jar.decompiler.jar-directory`]## +a| [[quarkus-core_quarkus-log-file-format]] [.property-path]##link:#quarkus-core_quarkus-log-file-format[`quarkus.log.file.format`]## [.description] -- -The directory into which to save the decompilation tool if it doesn't exist locally. +The log format ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_DECOMPILER_JAR_DIRECTORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_JAR_DECOMPILER_JAR_DIRECTORY+++` +Environment variable: `+++QUARKUS_LOG_FILE_FORMAT+++` endif::add-copy-button-to-env-var[] -- |string -|`${user.home}/.quarkus` +|`%d{yyyy-MM-dd HH:mm:ss,SSS} %h %N[%i] %-5p [%c{3.}] (%t) %s%e%n` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-main-class]] [.property-path]##link:#quarkus-core_quarkus-package-main-class[`quarkus.package.main-class`]## +a| [[quarkus-core_quarkus-log-file-level]] [.property-path]##link:#quarkus-core_quarkus-log-file-level[`quarkus.log.file.level`]## [.description] -- -The entry point of the application. This can either be a fully qualified name of a standard Java class with a main method, or `io.quarkus.runtime.QuarkusApplication`. - -If your application has main classes annotated with `io.quarkus.runtime.annotations.QuarkusMain` then this can also reference the name given in the annotation, to avoid the need to specify fully qualified names in the config. +The level of logs to be written into the file. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_MAIN_CLASS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_MAIN_CLASS+++` +Environment variable: `+++QUARKUS_LOG_FILE_LEVEL+++` endif::add-copy-button-to-env-var[] -- -|string -| +|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] +|`ALL` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-output-directory]] [.property-path]##link:#quarkus-core_quarkus-package-output-directory[`quarkus.package.output-directory`]## +a| [[quarkus-core_quarkus-log-file-path]] [.property-path]##link:#quarkus-core_quarkus-log-file-path[`quarkus.log.file.path`]## [.description] -- -The directory into which the output package(s) should be written. Relative paths are resolved from the build systems target directory. +The name of the file in which logs will be written. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_OUTPUT_DIRECTORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_OUTPUT_DIRECTORY+++` +Environment variable: `+++QUARKUS_LOG_FILE_PATH+++` endif::add-copy-button-to-env-var[] -- -|path -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html[File] +|`quarkus.log` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-output-name]] [.property-path]##link:#quarkus-core_quarkus-package-output-name[`quarkus.package.output-name`]## +a| [[quarkus-core_quarkus-log-file-filter]] [.property-path]##link:#quarkus-core_quarkus-log-file-filter[`quarkus.log.file.filter`]## [.description] -- -The name of the final artifact, excluding the suffix and file extension. +The name of the filter to link to the file handler. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_OUTPUT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_FILTER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_OUTPUT_NAME+++` +Environment variable: `+++QUARKUS_LOG_FILE_FILTER+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-write-transformed-bytecode-to-build-output]] [.property-path]##link:#quarkus-core_quarkus-package-write-transformed-bytecode-to-build-output[`quarkus.package.write-transformed-bytecode-to-build-output`]## +a| [[quarkus-core_quarkus-log-file-encoding]] [.property-path]##link:#quarkus-core_quarkus-log-file-encoding[`quarkus.log.file.encoding`]## [.description] -- -Setting this switch to `true` will cause Quarkus to write the transformed application bytecode to the build tool's output directory. This is useful for post-build tools that need to scan the application bytecode (for example, offline code-coverage tools). - -For example, if using Maven, enabling this feature will result in the classes in `target/classes` being replaced with classes that have been transformed by Quarkus. - -Setting this to `true`, however, should be done with a lot of caution and only if subsequent builds are done in a clean environment (i.e. the build tool's output directory has been completely cleaned). +The character encoding used ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_WRITE_TRANSFORMED_BYTECODE_TO_BUILD_OUTPUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ENCODING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_WRITE_TRANSFORMED_BYTECODE_TO_BUILD_OUTPUT+++` +Environment variable: `+++QUARKUS_LOG_FILE_ENCODING+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html[Charset] +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-runner-suffix]] [.property-path]##link:#quarkus-core_quarkus-package-runner-suffix[`quarkus.package.runner-suffix`]## +a| [[quarkus-core_quarkus-log-file-async]] [.property-path]##link:#quarkus-core_quarkus-log-file-async[`quarkus.log.file.async`]## [.description] -- -The suffix that is applied to the runner artifact's base file name. +Indicates whether to log asynchronously ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_RUNNER_SUFFIX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ASYNC+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PACKAGE_RUNNER_SUFFIX+++` +Environment variable: `+++QUARKUS_LOG_FILE_ASYNC+++` endif::add-copy-button-to-env-var[] -- -|string -|`-runner` +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-ide-target]] [.property-path]##link:#quarkus-core_quarkus-ide-target[`quarkus.ide.target`]## +a| [[quarkus-core_quarkus-log-file-async-queue-length]] [.property-path]##link:#quarkus-core_quarkus-log-file-async-queue-length[`quarkus.log.file.async.queue-length`]## [.description] -- -The Ide to use to open files from the DevUI. `auto` means that Quarkus will attempt to determine the Ide being used. +The queue length to use before flushing writing ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_IDE_TARGET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ASYNC_QUEUE_LENGTH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_IDE_TARGET+++` +Environment variable: `+++QUARKUS_LOG_FILE_ASYNC_QUEUE_LENGTH+++` endif::add-copy-button-to-env-var[] -- -a|`auto`, `idea`, `vscode`, `eclipse`, `netbeans` -|`auto` +|int +|`512` -a| [[quarkus-core_quarkus-configuration-build-time-mismatch-at-runtime]] [.property-path]##link:#quarkus-core_quarkus-configuration-build-time-mismatch-at-runtime[`quarkus.configuration.build-time-mismatch-at-runtime`]## +a| [[quarkus-core_quarkus-log-file-async-overflow]] [.property-path]##link:#quarkus-core_quarkus-log-file-async-overflow[`quarkus.log.file.async.overflow`]## [.description] -- -What should happen if the application is started with a different build time configuration than it was compiled against. This may be useful to prevent misconfiguration. - -If this is set to `warn` the application will warn at start up. - -If this is set to `fail` the application will fail at start up. - -Native tests leveraging`@io.quarkus.test.junit.TestProfile` are always run with `quarkus.configuration.build-time-mismatch-at-runtime = fail`. +Determine whether to block the publisher (rather than drop the message) when the queue is full ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIGURATION_BUILD_TIME_MISMATCH_AT_RUNTIME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ASYNC_OVERFLOW+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIGURATION_BUILD_TIME_MISMATCH_AT_RUNTIME+++` +Environment variable: `+++QUARKUS_LOG_FILE_ASYNC_OVERFLOW+++` endif::add-copy-button-to-env-var[] -- -a|`warn`, `fail` -|`warn` +a|`block`, `discard` +|`block` -a| [[quarkus-core_quarkus-builder-graph-output]] [.property-path]##link:#quarkus-core_quarkus-builder-graph-output[`quarkus.builder.graph-output`]## +a| [[quarkus-core_quarkus-log-file-rotation-max-file-size]] [.property-path]##link:#quarkus-core_quarkus-log-file-rotation-max-file-size[`quarkus.log.file.rotation.max-file-size`]## [.description] -- -Dump the graph output to a file. This is useful for debugging. +The maximum log file size, after which a rotation is executed. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDER_GRAPH_OUTPUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ROTATION_MAX_FILE_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_BUILDER_GRAPH_OUTPUT+++` +Environment variable: `+++QUARKUS_LOG_FILE_ROTATION_MAX_FILE_SIZE+++` endif::add-copy-button-to-env-var[] -- -|string -| +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] +|`10M` -a| [[quarkus-core_quarkus-builder-log-conflict-cause]] [.property-path]##link:#quarkus-core_quarkus-builder-log-conflict-cause[`quarkus.builder.log-conflict-cause`]## +a| [[quarkus-core_quarkus-log-file-rotation-max-backup-index]] [.property-path]##link:#quarkus-core_quarkus-log-file-rotation-max-backup-index[`quarkus.log.file.rotation.max-backup-index`]## [.description] -- -Whether to log the cause of a conflict. +The maximum number of backups to keep. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDER_LOG_CONFLICT_CAUSE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ROTATION_MAX_BACKUP_INDEX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_BUILDER_LOG_CONFLICT_CAUSE+++` +Environment variable: `+++QUARKUS_LOG_FILE_ROTATION_MAX_BACKUP_INDEX+++` endif::add-copy-button-to-env-var[] -- -|boolean -| +|int +|`5` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-deploy-target]] [.property-path]##link:#quarkus-core_quarkus-deploy-target[`quarkus.deploy.target`]## +a| [[quarkus-core_quarkus-log-file-rotation-file-suffix]] [.property-path]##link:#quarkus-core_quarkus-log-file-rotation-file-suffix[`quarkus.log.file.rotation.file-suffix`]## [.description] -- -Deployment target +The file handler rotation file suffix. When used, the file will be rotated based on its suffix. + +The suffix must be in a date-time format that is understood by `DateTimeFormatter`. + +Example fileSuffix: .yyyy-MM-dd + +Note: If the suffix ends with .zip or .gz, the rotation file will also be compressed. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DEPLOY_TARGET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ROTATION_FILE_SUFFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DEPLOY_TARGET+++` +Environment variable: `+++QUARKUS_LOG_FILE_ROTATION_FILE_SUFFIX+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-continuous-testing]] [.property-path]##link:#quarkus-core_quarkus-test-continuous-testing[`quarkus.test.continuous-testing`]## +a| [[quarkus-core_quarkus-log-file-rotation-rotate-on-boot]] [.property-path]##link:#quarkus-core_quarkus-log-file-rotation-rotate-on-boot[`quarkus.log.file.rotation.rotate-on-boot`]## [.description] -- -If continuous testing is enabled. The default value is 'paused', which will allow you to start testing from the console or the Dev UI, but will not run tests on startup. If this is set to 'enabled' then testing will start as soon as the application has started. If this is 'disabled' then continuous testing is not enabled, and can't be enabled without restarting the application. +Indicates whether to rotate log files on server initialization. + +You need to either set a `max-file-size` or configure a `file-suffix` for it to work. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_CONTINUOUS_TESTING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ROTATION_ROTATE_ON_BOOT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_CONTINUOUS_TESTING+++` +Environment variable: `+++QUARKUS_LOG_FILE_ROTATION_ROTATE_ON_BOOT+++` endif::add-copy-button-to-env-var[] -- -a|`paused`, `enabled`, `disabled` -|`paused` +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-display-test-output]] [.property-path]##link:#quarkus-core_quarkus-test-display-test-output[`quarkus.test.display-test-output`]## + +h|[[quarkus-core_section_quarkus-log-syslog]] [.section-name.section-level1]##link:#quarkus-core_section_quarkus-log-syslog[Syslog logging]## +h|Type +h|Default + +a| [[quarkus-core_quarkus-log-syslog-enable]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-enable[`quarkus.log.syslog.enable`]## [.description] -- -If output from the running tests should be displayed in the console. +If syslog logging should be enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_DISPLAY_TEST_OUTPUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_ENABLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_DISPLAY_TEST_OUTPUT+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_ENABLE+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-include-tags]] [.property-path]##link:#quarkus-core_quarkus-test-include-tags[`quarkus.test.include-tags`]## +a| [[quarkus-core_quarkus-log-syslog-endpoint]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-endpoint[`quarkus.log.syslog.endpoint`]## [.description] -- -Tags that should be included for continuous testing. This supports JUnit Tag Expressions. +The IP address and port of the Syslog server ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_INCLUDE_TAGS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_INCLUDE_TAGS+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_ENDPOINT+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|host:port +|`localhost:514` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-exclude-tags]] [.property-path]##link:#quarkus-core_quarkus-test-exclude-tags[`quarkus.test.exclude-tags`]## +a| [[quarkus-core_quarkus-log-syslog-app-name]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-app-name[`quarkus.log.syslog.app-name`]## [.description] -- -Tags that should be excluded by default with continuous testing. This is ignored if include-tags has been set. Defaults to 'slow'. This supports JUnit Tag Expressions. +The app name used when formatting the message in RFC5424 format ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_EXCLUDE_TAGS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_APP_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_EXCLUDE_TAGS+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_APP_NAME+++` endif::add-copy-button-to-env-var[] -- -|list of string -|`slow` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-include-pattern]] [.property-path]##link:#quarkus-core_quarkus-test-include-pattern[`quarkus.test.include-pattern`]## +a| [[quarkus-core_quarkus-log-syslog-hostname]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-hostname[`quarkus.log.syslog.hostname`]## [.description] -- -Tests that should be included for continuous testing. This is a regular expression and is matched against the test class name (not the file name). +The name of the host the messages are being sent from ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_INCLUDE_PATTERN+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_HOSTNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_INCLUDE_PATTERN+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_HOSTNAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-exclude-pattern]] [.property-path]##link:#quarkus-core_quarkus-test-exclude-pattern[`quarkus.test.exclude-pattern`]## +a| [[quarkus-core_quarkus-log-syslog-facility]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-facility[`quarkus.log.syslog.facility`]## [.description] -- -Tests that should be excluded with continuous testing. This is a regular expression and is matched against the test class name (not the file name). This is ignored if include-pattern has been set. +Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164 ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_EXCLUDE_PATTERN+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_FACILITY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_EXCLUDE_PATTERN+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_FACILITY+++` endif::add-copy-button-to-env-var[] -- -|string -|`.*\.IT[^.]+\|.*IT\|.*ITCase` +a|`kernel`, `user-level`, `mail-system`, `system-daemons`, `security`, `syslogd`, `line-printer`, `network-news`, `uucp`, `clock-daemon`, `security2`, `ftp-daemon`, `ntp`, `log-audit`, `log-alert`, `clock-daemon2`, `local-use-0`, `local-use-1`, `local-use-2`, `local-use-3`, `local-use-4`, `local-use-5`, `local-use-6`, `local-use-7` +|`user-level` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-include-engines]] [.property-path]##link:#quarkus-core_quarkus-test-include-engines[`quarkus.test.include-engines`]## +a| [[quarkus-core_quarkus-log-syslog-syslog-type]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-syslog-type[`quarkus.log.syslog.syslog-type`]## [.description] -- -Test engine ids that should be included for continuous testing. +Set the `SyslogType syslog type` this handler should use to format the message sent ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_INCLUDE_ENGINES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_SYSLOG_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_INCLUDE_ENGINES+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_SYSLOG_TYPE+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +a|`rfc5424`, `rfc3164` +|`rfc5424` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-exclude-engines]] [.property-path]##link:#quarkus-core_quarkus-test-exclude-engines[`quarkus.test.exclude-engines`]## +a| [[quarkus-core_quarkus-log-syslog-protocol]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-protocol[`quarkus.log.syslog.protocol`]## [.description] -- -Test engine ids that should be excluded by default with continuous testing. This is ignored if include-engines has been set. +Sets the protocol used to connect to the Syslog server ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_EXCLUDE_ENGINES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_EXCLUDE_ENGINES+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_PROTOCOL+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +a|`tcp`, `udp`, `ssl-tcp` +|`tcp` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-flat-class-path]] [.property-path]##link:#quarkus-core_quarkus-test-flat-class-path[`quarkus.test.flat-class-path`]## +a| [[quarkus-core_quarkus-log-syslog-use-counting-framing]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-use-counting-framing[`quarkus.log.syslog.use-counting-framing`]## [.description] -- -Changes tests to use the 'flat' ClassPath used in Quarkus 1.x versions. This means all Quarkus and test classes are loaded in the same ClassLoader, however it means you cannot use continuous testing. Note that if you find this necessary for your application then you may also have problems running in development mode, which cannot use a flat class path. +If enabled, the message being sent is prefixed with the size of the message ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_FLAT_CLASS_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_USE_COUNTING_FRAMING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_FLAT_CLASS_PATH+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_USE_COUNTING_FRAMING+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-native-image-profile]] [.property-path]##link:#quarkus-core_quarkus-test-native-image-profile[`quarkus.test.native-image-profile`]## +a| [[quarkus-core_quarkus-log-syslog-truncate]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-truncate[`quarkus.log.syslog.truncate`]## [.description] -- -The profile to use when testing the native image +Set to `true` to truncate the message if it exceeds maximum length ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_NATIVE_IMAGE_PROFILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_TRUNCATE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_NATIVE_IMAGE_PROFILE+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_TRUNCATE+++` endif::add-copy-button-to-env-var[] -- -|string -|`prod` +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-integration-test-profile]] [.property-path]##link:#quarkus-core_quarkus-test-integration-test-profile[`quarkus.test.integration-test-profile`]## +a| [[quarkus-core_quarkus-log-syslog-block-on-reconnect]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-block-on-reconnect[`quarkus.log.syslog.block-on-reconnect`]## [.description] -- -The profile to use when testing using `@QuarkusIntegrationTest` +Enables or disables blocking when attempting to reconnect a `org.jboss.logmanager.handlers.SyslogHandler.Protocol++#++TCP +TCP` or `org.jboss.logmanager.handlers.SyslogHandler.Protocol++#++SSL_TCP SSL TCP` protocol ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_INTEGRATION_TEST_PROFILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_BLOCK_ON_RECONNECT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_INTEGRATION_TEST_PROFILE+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_BLOCK_ON_RECONNECT+++` endif::add-copy-button-to-env-var[] -- -|string -|`prod` +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-profile]] [.property-path]##link:#quarkus-core_quarkus-test-profile[`quarkus.test.profile`]## +a| [[quarkus-core_quarkus-log-syslog-format]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-format[`quarkus.log.syslog.format`]## [.description] -- -A comma separated list of profiles (dev, test, prod or custom profiles) to use when testing using @QuarkusTest +The log message format ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_PROFILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_PROFILE+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_FORMAT+++` endif::add-copy-button-to-env-var[] -- -|list of string -|`test` +|string +|`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-profile-tags]] [.property-path]##link:#quarkus-core_quarkus-test-profile-tags[`quarkus.test.profile.tags`]## +a| [[quarkus-core_quarkus-log-syslog-level]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-level[`quarkus.log.syslog.level`]## [.description] -- -The tags this profile is associated with. When the `quarkus.test.profile.tags` System property is set (its value is a comma separated list of strings) then Quarkus will only execute tests that are annotated with a `@TestProfile` that has at least one of the supplied (via the aforementioned system property) tags. +The log level specifying what message levels will be logged by the Syslog logger ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_PROFILE_TAGS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_PROFILE_TAGS+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_LEVEL+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] +|`ALL` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-container-network]] [.property-path]##link:#quarkus-core_quarkus-test-container-network[`quarkus.test.container.network`]## +a| [[quarkus-core_quarkus-log-syslog-filter]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-filter[`quarkus.log.syslog.filter`]## [.description] -- -Controls the container network to be used when @QuarkusIntegration needs to launch the application in a container. This setting only applies if Quarkus does not need to use a shared network - which is the case if DevServices are used when running the test. +The name of the filter to link to the file handler. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_CONTAINER_NETWORK+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_FILTER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_CONTAINER_NETWORK+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_FILTER+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-container-additional-exposed-ports-host-port]] [.property-path]##link:#quarkus-core_quarkus-test-container-additional-exposed-ports-host-port[`quarkus.test.container.additional-exposed-ports."host-port"`]## +a| [[quarkus-core_quarkus-log-syslog-max-length]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-max-length[`quarkus.log.syslog.max-length`]## [.description] -- -Set additional ports to be exposed when @QuarkusIntegration needs to launch the application in a container. +The maximum length, in bytes, of the message allowed to be sent. The length includes the header and the message. + +If not set, the default value is `2048` when `sys-log-type` is `rfc5424` (which is the default) and `1024` when `sys-log-type` is `rfc3164` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_CONTAINER_ADDITIONAL_EXPOSED_PORTS__HOST_PORT_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_MAX_LENGTH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_CONTAINER_ADDITIONAL_EXPOSED_PORTS__HOST_PORT_+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_MAX_LENGTH+++` endif::add-copy-button-to-env-var[] -- -|Map +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-container-labels-label-name]] [.property-path]##link:#quarkus-core_quarkus-test-container-labels-label-name[`quarkus.test.container.labels."label-name"`]## +a| [[quarkus-core_quarkus-log-syslog-async]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-async[`quarkus.log.syslog.async`]## [.description] -- -A set of labels to add to the launched container +Indicates whether to log asynchronously ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_CONTAINER_LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_ASYNC+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_CONTAINER_LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_ASYNC+++` endif::add-copy-button-to-env-var[] -- -|Map -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-container-volume-mounts-host-path]] [.property-path]##link:#quarkus-core_quarkus-test-container-volume-mounts-host-path[`quarkus.test.container.volume-mounts."host-path"`]## +a| [[quarkus-core_quarkus-log-syslog-async-queue-length]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-async-queue-length[`quarkus.log.syslog.async.queue-length`]## [.description] -- -A set of volume mounts to add to the launched container +The queue length to use before flushing writing ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_CONTAINER_VOLUME_MOUNTS__HOST_PATH_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_ASYNC_QUEUE_LENGTH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_CONTAINER_VOLUME_MOUNTS__HOST_PATH_+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_ASYNC_QUEUE_LENGTH+++` endif::add-copy-button-to-env-var[] -- -|Map -| +|int +|`512` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-arg-line]] [.property-path]##link:#quarkus-core_quarkus-test-arg-line[`quarkus.test.arg-line`]## +a| [[quarkus-core_quarkus-log-syslog-async-overflow]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-async-overflow[`quarkus.log.syslog.async.overflow`]## [.description] -- -Additional launch parameters to be used when Quarkus launches the produced artifact for `@QuarkusIntegrationTest` When the artifact is a `jar`, this string is passed right after the `java` command. When the artifact is a `container`, this string is passed right after the `docker run` command. When the artifact is a `native binary`, this string is passed right after the native binary name. +Determine whether to block the publisher (rather than drop the message) when the queue is full ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_ARG_LINE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_ASYNC_OVERFLOW+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_ARG_LINE+++` +Environment variable: `+++QUARKUS_LOG_SYSLOG_ASYNC_OVERFLOW+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +a|`block`, `discard` +|`block` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-env-environment-variable-name]] [.property-path]##link:#quarkus-core_quarkus-test-env-environment-variable-name[`quarkus.test.env."environment-variable-name"`]## + +h|[[quarkus-core_section_quarkus-log-handler-console]] [.section-name.section-level1]##link:#quarkus-core_section_quarkus-log-handler-console[Console handlers]## +h|Type +h|Default + +a| [[quarkus-core_quarkus-log-handler-console-console-handlers-enable]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-enable[`quarkus.log.handler.console."console-handlers".enable`]## [.description] -- -Additional environment variables to be set in the process that `@QuarkusIntegrationTest` launches. +If console logging should be enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_ENV__ENVIRONMENT_VARIABLE_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ENABLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_ENV__ENVIRONMENT_VARIABLE_NAME_+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ENABLE+++` endif::add-copy-button-to-env-var[] -- -|Map -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-wait-time]] [.property-path]##link:#quarkus-core_quarkus-test-wait-time[`quarkus.test.wait-time`]## +a| [[quarkus-core_quarkus-log-handler-console-console-handlers-stderr]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-stderr[`quarkus.log.handler.console."console-handlers".stderr`]## [.description] -- -Used in `@QuarkusIntegrationTest` to determine how long the test will wait for the application to launch +If console logging should go to `System++#++err` instead of `System++#++out`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_WAIT_TIME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__STDERR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_WAIT_TIME+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__STDERR+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT1M` +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-hang-detection-timeout]] [.property-path]##link:#quarkus-core_quarkus-test-hang-detection-timeout[`quarkus.test.hang-detection-timeout`]## +a| [[quarkus-core_quarkus-log-handler-console-console-handlers-format]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-format[`quarkus.log.handler.console."console-handlers".format`]## [.description] -- -Configures the hang detection in @QuarkusTest. If no activity happens (i.e. no test callbacks are called) over this period then QuarkusTest will dump all threads stack traces, to help diagnose a potential hang. Note that the initial timeout (before Quarkus has started) will only apply if provided by a system property, as it is not possible to read all config sources until Quarkus has booted. +The log format. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_HANG_DETECTION_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_HANG_DETECTION_TIMEOUT+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FORMAT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10M` +|string +|`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-type]] [.property-path]##link:#quarkus-core_quarkus-test-type[`quarkus.test.type`]## +a| [[quarkus-core_quarkus-log-handler-console-console-handlers-level]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-level[`quarkus.log.handler.console."console-handlers".level`]## [.description] -- -The type of test to run, this can be either: quarkus-test: Only runs `@QuarkusTest` annotated test classes unit: Only runs classes that are not annotated with `@QuarkusTest` all: Runs both, running the unit tests first +The console log level. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_TYPE+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__LEVEL+++` endif::add-copy-button-to-env-var[] -- -a|`unit`, `quarkus-test`, `all` -|`all` +|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] +|`ALL` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-only-test-application-module]] [.property-path]##link:#quarkus-core_quarkus-test-only-test-application-module[`quarkus.test.only-test-application-module`]## +a| [[quarkus-core_quarkus-log-handler-console-console-handlers-darken]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-darken[`quarkus.log.handler.console."console-handlers".darken`]## [.description] -- -If this is true then only the tests from the main application module will be run (i.e. the module that is currently running mvn quarkus:dev). If this is false then tests from all dependency modules will be run as well. +Specify how much the colors should be darkened. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_ONLY_TEST_APPLICATION_MODULE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__DARKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_ONLY_TEST_APPLICATION_MODULE+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__DARKEN+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|int +|`0` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-include-module-pattern]] [.property-path]##link:#quarkus-core_quarkus-test-include-module-pattern[`quarkus.test.include-module-pattern`]## +a| [[quarkus-core_quarkus-log-handler-console-console-handlers-filter]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-filter[`quarkus.log.handler.console."console-handlers".filter`]## [.description] -- -Modules that should be included for continuous testing. This is a regular expression and is matched against the module groupId:artifactId. +The name of the filter to link to the console handler. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_INCLUDE_MODULE_PATTERN+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FILTER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_INCLUDE_MODULE_PATTERN+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FILTER+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-exclude-module-pattern]] [.property-path]##link:#quarkus-core_quarkus-test-exclude-module-pattern[`quarkus.test.exclude-module-pattern`]## +a| [[quarkus-core_quarkus-log-handler-console-console-handlers-async]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-async[`quarkus.log.handler.console."console-handlers".async`]## [.description] -- -Modules that should be excluded for continuous testing. This is a regular expression and is matched against the module groupId:artifactId. This is ignored if include-module-pattern has been set. +Indicates whether to log asynchronously ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_EXCLUDE_MODULE_PATTERN+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_EXCLUDE_MODULE_PATTERN+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-enable-callbacks-for-integration-tests]] [.property-path]##link:#quarkus-core_quarkus-test-enable-callbacks-for-integration-tests[`quarkus.test.enable-callbacks-for-integration-tests`]## +a| [[quarkus-core_quarkus-log-handler-console-console-handlers-async-queue-length]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-async-queue-length[`quarkus.log.handler.console."console-handlers".async.queue-length`]## [.description] -- -If the test callbacks should be invoked for the integration tests (tests annotated with `@QuarkusIntegrationTest`). +The queue length to use before flushing writing ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_ENABLE_CALLBACKS_FOR_INTEGRATION_TESTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_QUEUE_LENGTH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_TEST_ENABLE_CALLBACKS_FOR_INTEGRATION_TESTS+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_QUEUE_LENGTH+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|int +|`512` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-execution-model-annotations-detection-mode]] [.property-path]##link:#quarkus-core_quarkus-execution-model-annotations-detection-mode[`quarkus.execution-model-annotations.detection-mode`]## +a| [[quarkus-core_quarkus-log-handler-console-console-handlers-async-overflow]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-async-overflow[`quarkus.log.handler.console."console-handlers".async.overflow`]## [.description] -- -Detection mode of invalid usage of execution model annotations. - -An execution model annotation is `@Blocking`, `@NonBlocking` and `@RunOnVirtualThread`. These annotations may only be used on "entrypoint" methods (methods invoked by various frameworks in Quarkus); using them on methods that can only be invoked by application code is invalid. +Determine whether to block the publisher (rather than drop the message) when the queue is full ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_EXECUTION_MODEL_ANNOTATIONS_DETECTION_MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_OVERFLOW+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_EXECUTION_MODEL_ANNOTATIONS_DETECTION_MODE+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_OVERFLOW+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:fail[Invalid usage of execution model annotations causes build failure.], tooltip:warn[Invalid usage of execution model annotations causes warning during build.], tooltip:disabled[No detection of invalid usage of execution model annotations.] -|tooltip:fail[Invalid usage of execution model annotations causes build failure.] +a|`block`, `discard` +|`block` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-analytics-disabled]] [.property-path]##link:#quarkus-core_quarkus-analytics-disabled[`quarkus.analytics.disabled`]## + +h|[[quarkus-core_section_quarkus-log-handler-file]] [.section-name.section-level1]##link:#quarkus-core_section_quarkus-log-handler-file[File handlers]## +h|Type +h|Default + +a| [[quarkus-core_quarkus-log-handler-file-file-handlers-enable]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-enable[`quarkus.log.handler.file."file-handlers".enable`]## [.description] -- -If Build time analytics are disabled. +If file logging should be enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_DISABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENABLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_ANALYTICS_DISABLED+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENABLE+++` endif::add-copy-button-to-env-var[] -- |boolean -| +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-analytics-uri-base]] [.property-path]##link:#quarkus-core_quarkus-analytics-uri-base[`quarkus.analytics.uri.base`]## +a| [[quarkus-core_quarkus-log-handler-file-file-handlers-format]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-format[`quarkus.log.handler.file."file-handlers".format`]## [.description] -- -The Segment base URI. +The log format ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_URI_BASE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_ANALYTICS_URI_BASE+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FORMAT+++` endif::add-copy-button-to-env-var[] -- |string -| +|`%d{yyyy-MM-dd HH:mm:ss,SSS} %h %N[%i] %-5p [%c{3.}] (%t) %s%e%n` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-analytics-timeout]] [.property-path]##link:#quarkus-core_quarkus-analytics-timeout[`quarkus.analytics.timeout`]## +a| [[quarkus-core_quarkus-log-handler-file-file-handlers-level]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-level[`quarkus.log.handler.file."file-handlers".level`]## [.description] -- -The Timeout to send the build time analytics to segment. +The level of logs to be written into the file. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_ANALYTICS_TIMEOUT+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__LEVEL+++` endif::add-copy-button-to-env-var[] -- -|int -|`3000` +|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] +|`ALL` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-snapstart-enable]] [.property-path]##link:#quarkus-core_quarkus-snapstart-enable[`quarkus.snapstart.enable`]## +a| [[quarkus-core_quarkus-log-handler-file-file-handlers-path]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-path[`quarkus.log.handler.file."file-handlers".path`]## [.description] -- -Enable/Disable SnapStart integration - -Default value is dependent on extensions deployed (i.e. when using AWS Lambda extensions, this will be set to true by default) +The name of the file in which logs will be written. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SNAPSTART_ENABLE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SNAPSTART_ENABLE+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__PATH+++` endif::add-copy-button-to-env-var[] -- -|boolean -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html[File] +|`quarkus.log` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-snapstart-preload-classes]] [.property-path]##link:#quarkus-core_quarkus-snapstart-preload-classes[`quarkus.snapstart.preload-classes`]## +a| [[quarkus-core_quarkus-log-handler-file-file-handlers-filter]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-filter[`quarkus.log.handler.file."file-handlers".filter`]## [.description] -- -Will do a classpath search for all `META-INF/quarkus-preload-classes.txt` files These files contain fully qualified classnames that should be loaded in the SnapStart/CRaC `beforeCheckpoint()` phase. +The name of the filter to link to the file handler. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SNAPSTART_PRELOAD_CLASSES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FILTER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SNAPSTART_PRELOAD_CLASSES+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FILTER+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-snapstart-initialize-classes]] [.property-path]##link:#quarkus-core_quarkus-snapstart-initialize-classes[`quarkus.snapstart.initialize-classes`]## +a| [[quarkus-core_quarkus-log-handler-file-file-handlers-encoding]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-encoding[`quarkus.log.handler.file."file-handlers".encoding`]## [.description] -- -if preloading classes, specify whether to do static initialization when preloading these classes. +The character encoding used ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SNAPSTART_INITIALIZE_CLASSES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENCODING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SNAPSTART_INITIALIZE_CLASSES+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENCODING+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html[Charset] +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-snapstart-full-warmup]] [.property-path]##link:#quarkus-core_quarkus-snapstart-full-warmup[`quarkus.snapstart.full-warmup`]## +a| [[quarkus-core_quarkus-log-handler-file-file-handlers-async]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-async[`quarkus.log.handler.file."file-handlers".async`]## [.description] -- -Start the full application during the snapshotting process. In other words, when enabled, it performs `Application.start()` within SnapStart/CRaC `beforeCheckpoint()` phase. +Indicates whether to log asynchronously ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SNAPSTART_FULL_WARMUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SNAPSTART_FULL_WARMUP+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-snapstart-generate-application-class-list]] [.property-path]##link:#quarkus-core_quarkus-snapstart-generate-application-class-list[`quarkus.snapstart.generate-application-class-list`]## +a| [[quarkus-core_quarkus-log-handler-file-file-handlers-async-queue-length]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-async-queue-length[`quarkus.log.handler.file."file-handlers".async.queue-length`]## [.description] -- -When SnapStart is enabled, it generates the application class list, so it can be preloaded. Only used if `preload-classes` is set to `true`. +The queue length to use before flushing writing ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SNAPSTART_GENERATE_APPLICATION_CLASS_LIST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_QUEUE_LENGTH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SNAPSTART_GENERATE_APPLICATION_CLASS_LIST+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_QUEUE_LENGTH+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|int +|`512` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-enabled]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-enabled[`quarkus.config-tracking.enabled`]## +a| [[quarkus-core_quarkus-log-handler-file-file-handlers-async-overflow]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-async-overflow[`quarkus.log.handler.file."file-handlers".async.overflow`]## [.description] -- -Whether configuration dumping is enabled +Determine whether to block the publisher (rather than drop the message) when the queue is full ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_OVERFLOW+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_TRACKING_ENABLED+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_OVERFLOW+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +a|`block`, `discard` +|`block` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-directory]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-directory[`quarkus.config-tracking.directory`]## +a| [[quarkus-core_quarkus-log-handler-file-file-handlers-rotation-max-file-size]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-rotation-max-file-size[`quarkus.log.handler.file."file-handlers".rotation.max-file-size`]## [.description] -- -Directory in which the configuration dump should be stored. If not configured the `.quarkus` directory under the project directory will be used. +The maximum log file size, after which a rotation is executed. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_DIRECTORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_FILE_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_TRACKING_DIRECTORY+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_FILE_SIZE+++` endif::add-copy-button-to-env-var[] -- -|path -| +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] +|`10M` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-file]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-file[`quarkus.config-tracking.file`]## +a| [[quarkus-core_quarkus-log-handler-file-file-handlers-rotation-max-backup-index]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-rotation-max-backup-index[`quarkus.log.handler.file."file-handlers".rotation.max-backup-index`]## [.description] -- -File in which the configuration dump should be stored. If not configured, the `file-prefix` and `file-suffix` will be used to generate the final file name. If the configured file path is absolute, the `directory` option will be ignored. Otherwise, the path will be considered relative to the `directory`. +The maximum number of backups to keep. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_FILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_BACKUP_INDEX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_TRACKING_FILE+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_BACKUP_INDEX+++` endif::add-copy-button-to-env-var[] -- -|path -| +|int +|`5` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-file-prefix]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-file-prefix[`quarkus.config-tracking.file-prefix`]## +a| [[quarkus-core_quarkus-log-handler-file-file-handlers-rotation-file-suffix]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-rotation-file-suffix[`quarkus.log.handler.file."file-handlers".rotation.file-suffix`]## [.description] -- -File name prefix. This option will be ignored in case `file` is configured. +The file handler rotation file suffix. When used, the file will be rotated based on its suffix. + +The suffix must be in a date-time format that is understood by `DateTimeFormatter`. + +Example fileSuffix: .yyyy-MM-dd + +Note: If the suffix ends with .zip or .gz, the rotation file will also be compressed. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_FILE_PREFIX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_FILE_SUFFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_TRACKING_FILE_PREFIX+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_FILE_SUFFIX+++` endif::add-copy-button-to-env-var[] -- |string -|`quarkus` +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-file-suffix]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-file-suffix[`quarkus.config-tracking.file-suffix`]## +a| [[quarkus-core_quarkus-log-handler-file-file-handlers-rotation-rotate-on-boot]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-rotation-rotate-on-boot[`quarkus.log.handler.file."file-handlers".rotation.rotate-on-boot`]## [.description] -- -File name suffix. This option will be ignored in case `file` is configured. +Indicates whether to rotate log files on server initialization. + +You need to either set a `max-file-size` or configure a `file-suffix` for it to work. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_FILE_SUFFIX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_ROTATE_ON_BOOT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_TRACKING_FILE_SUFFIX+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_ROTATE_ON_BOOT+++` endif::add-copy-button-to-env-var[] -- -|string -|`-config-dump` +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-exclude]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-exclude[`quarkus.config-tracking.exclude`]## + +h|[[quarkus-core_section_quarkus-log-handler-syslog]] [.section-name.section-level1]##link:#quarkus-core_section_quarkus-log-handler-syslog[Syslog handlers]## +h|Type +h|Default + +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-enable]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-enable[`quarkus.log.handler.syslog."syslog-handlers".enable`]## [.description] -- -A list of config properties that should be excluded from the report. GLOB patterns could be used instead of property names. +If syslog logging should be enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_EXCLUDE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENABLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_TRACKING_EXCLUDE+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENABLE+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-hash-options]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-hash-options[`quarkus.config-tracking.hash-options`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-endpoint]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-endpoint[`quarkus.log.handler.syslog."syslog-handlers".endpoint`]## [.description] -- -A list of config properties whose values should be hashed in the report. The values will be hashed using SHA-512 algorithm. GLOB patterns could be used instead of property names. +The IP address and port of the Syslog server ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_HASH_OPTIONS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_TRACKING_HASH_OPTIONS+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENDPOINT+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|host:port +|`localhost:514` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-tracking-use-user-home-alias-in-paths]] [.property-path]##link:#quarkus-core_quarkus-config-tracking-use-user-home-alias-in-paths[`quarkus.config-tracking.use-user-home-alias-in-paths`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-app-name]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-app-name[`quarkus.log.handler.syslog."syslog-handlers".app-name`]## [.description] -- -Whether to use a `~` as an alias for user home directory in path values +The app name used when formatting the message in RFC5424 format ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_TRACKING_USE_USER_HOME_ALIAS_IN_PATHS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__APP_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_TRACKING_USE_USER_HOME_ALIAS_IN_PATHS+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__APP_NAME+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-log-metrics-enabled]] [.property-path]##link:#quarkus-core_quarkus-log-metrics-enabled[`quarkus.log.metrics.enabled`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-hostname]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-hostname[`quarkus.log.handler.syslog."syslog-handlers".hostname`]## [.description] -- -If enabled and a metrics extension is present, logging metrics are published. +The name of the host the messages are being sent from ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_METRICS_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__HOSTNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_METRICS_ENABLED+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__HOSTNAME+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-log-min-level]] [.property-path]##link:#quarkus-core_quarkus-log-min-level[`quarkus.log.min-level`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-facility]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-facility[`quarkus.log.handler.syslog."syslog-handlers".facility`]## [.description] -- -The default minimum log level. +Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164 ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_MIN_LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FACILITY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_MIN_LEVEL+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FACILITY+++` endif::add-copy-button-to-env-var[] -- -|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] -|`DEBUG` +a|`kernel`, `user-level`, `mail-system`, `system-daemons`, `security`, `syslogd`, `line-printer`, `network-news`, `uucp`, `clock-daemon`, `security2`, `ftp-daemon`, `ntp`, `log-audit`, `log-alert`, `clock-daemon2`, `local-use-0`, `local-use-1`, `local-use-2`, `local-use-3`, `local-use-4`, `local-use-5`, `local-use-6`, `local-use-7` +|`user-level` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-log-decorate-stacktraces]] [.property-path]##link:#quarkus-core_quarkus-log-decorate-stacktraces[`quarkus.log.decorate-stacktraces`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-syslog-type]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-syslog-type[`quarkus.log.handler.syslog."syslog-handlers".syslog-type`]## [.description] -- -This will decorate the stacktrace in dev mode to show the line in the code that cause the exception +Set the `SyslogType syslog type` this handler should use to format the message sent ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_DECORATE_STACKTRACES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__SYSLOG_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_DECORATE_STACKTRACES+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__SYSLOG_TYPE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +a|`rfc5424`, `rfc3164` +|`rfc5424` -a| [[quarkus-core_quarkus-log-level]] [.property-path]##link:#quarkus-core_quarkus-log-level[`quarkus.log.level`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-protocol]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-protocol[`quarkus.log.handler.syslog."syslog-handlers".protocol`]## [.description] -- -The log level of the root category, which is used as the default log level for all categories. - -JBoss Logging supports Apache-style log levels: - -* {@link org.jboss.logmanager.Level#FATAL} -* {@link org.jboss.logmanager.Level#ERROR} -* {@link org.jboss.logmanager.Level#WARN} -* {@link org.jboss.logmanager.Level#INFO} -* {@link org.jboss.logmanager.Level#DEBUG} -* {@link org.jboss.logmanager.Level#TRACE} - -In addition, it also supports the standard JDK log levels. +Sets the protocol used to connect to the Syslog server ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_LEVEL+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__PROTOCOL+++` endif::add-copy-button-to-env-var[] -- -|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] -|`INFO` +a|`tcp`, `udp`, `ssl-tcp` +|`tcp` -a| [[quarkus-core_quarkus-log-handlers]] [.property-path]##link:#quarkus-core_quarkus-log-handlers[`quarkus.log.handlers`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-use-counting-framing]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-use-counting-framing[`quarkus.log.handler.syslog."syslog-handlers".use-counting-framing`]## [.description] -- -The names of additional handlers to link to the root category. These handlers are defined in consoleHandlers, fileHandlers, or syslogHandlers. +If enabled, the message being sent is prefixed with the size of the message ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLERS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__USE_COUNTING_FRAMING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLERS+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__USE_COUNTING_FRAMING+++` endif::add-copy-button-to-env-var[] -- -|list of string -| - -h|[[quarkus-core_section_quarkus-log-category]] [.section-name.section-level0]##link:#quarkus-core_section_quarkus-log-category[Minimum logging categories]## -h|Type -h|Default +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-log-category-categories-min-level]] [.property-path]##link:#quarkus-core_quarkus-log-category-categories-min-level[`quarkus.log.category."categories".min-level`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-truncate]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-truncate[`quarkus.log.handler.syslog."syslog-handlers".truncate`]## [.description] -- -The minimum log level for this category. By default, all categories are configured with `DEBUG` minimum level. - -To get runtime logging below `DEBUG`, e.g., `TRACE`, adjust the minimum level at build time. The right log level needs to be provided at runtime. - -As an example, to get `TRACE` logging, minimum level needs to be at `TRACE`, and the runtime log level needs to match that. +Set to `true` to truncate the message if it exceeds maximum length ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CATEGORY__CATEGORIES__MIN_LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__TRUNCATE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_CATEGORY__CATEGORIES__MIN_LEVEL+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__TRUNCATE+++` endif::add-copy-button-to-env-var[] -- -|InheritableLevel -|`inherit` +|boolean +|`true` -a| [[quarkus-core_quarkus-log-category-categories-level]] [.property-path]##link:#quarkus-core_quarkus-log-category-categories-level[`quarkus.log.category."categories".level`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-block-on-reconnect]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-block-on-reconnect[`quarkus.log.handler.syslog."syslog-handlers".block-on-reconnect`]## [.description] -- -The log level for this category. - -Note that to get log levels below `INFO`, the minimum level build-time configuration option also needs to be adjusted. +Enables or disables blocking when attempting to reconnect a `org.jboss.logmanager.handlers.SyslogHandler.Protocol++#++TCP +TCP` or `org.jboss.logmanager.handlers.SyslogHandler.Protocol++#++SSL_TCP SSL TCP` protocol ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CATEGORY__CATEGORIES__LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__BLOCK_ON_RECONNECT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_CATEGORY__CATEGORIES__LEVEL+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__BLOCK_ON_RECONNECT+++` endif::add-copy-button-to-env-var[] -- -|InheritableLevel -|`inherit` +|boolean +|`false` -a| [[quarkus-core_quarkus-log-category-categories-handlers]] [.property-path]##link:#quarkus-core_quarkus-log-category-categories-handlers[`quarkus.log.category."categories".handlers`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-format]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-format[`quarkus.log.handler.syslog."syslog-handlers".format`]## [.description] -- -The names of the handlers to link to this category. +The log message format ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CATEGORY__CATEGORIES__HANDLERS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FORMAT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_CATEGORY__CATEGORIES__HANDLERS+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FORMAT+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|string +|`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n` -a| [[quarkus-core_quarkus-log-category-categories-use-parent-handlers]] [.property-path]##link:#quarkus-core_quarkus-log-category-categories-use-parent-handlers[`quarkus.log.category."categories".use-parent-handlers`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-level]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-level[`quarkus.log.handler.syslog."syslog-handlers".level`]## [.description] -- -Specify whether this logger should send its output to its parent Logger +The log level specifying what message levels will be logged by the Syslog logger ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CATEGORY__CATEGORIES__USE_PARENT_HANDLERS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_CATEGORY__CATEGORIES__USE_PARENT_HANDLERS+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__LEVEL+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` - - -h|[[quarkus-core_section_quarkus-log-console]] [.section-name.section-level0]##link:#quarkus-core_section_quarkus-log-console[Console logging]## -h|Type -h|Default +|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] +|`ALL` -a| [[quarkus-core_quarkus-log-console-enable]] [.property-path]##link:#quarkus-core_quarkus-log-console-enable[`quarkus.log.console.enable`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-filter]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-filter[`quarkus.log.handler.syslog."syslog-handlers".filter`]## [.description] -- -If console logging should be enabled +The name of the filter to link to the file handler. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_ENABLE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FILTER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_CONSOLE_ENABLE+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FILTER+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +| -a| [[quarkus-core_quarkus-log-console-stderr]] [.property-path]##link:#quarkus-core_quarkus-log-console-stderr[`quarkus.log.console.stderr`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-max-length]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-max-length[`quarkus.log.handler.syslog."syslog-handlers".max-length`]## [.description] -- -If console logging should go to `System++#++err` instead of `System++#++out`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_STDERR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_CONSOLE_STDERR+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-core_quarkus-log-console-format]] [.property-path]##link:#quarkus-core_quarkus-log-console-format[`quarkus.log.console.format`]## +The maximum length, in bytes, of the message allowed to be sent. The length includes the header and the message. -[.description] --- -The log format. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). +If not set, the default value is `2048` when `sys-log-type` is `rfc5424` (which is the default) and `1024` when `sys-log-type` is `rfc3164` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_FORMAT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__MAX_LENGTH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_CONSOLE_FORMAT+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__MAX_LENGTH+++` endif::add-copy-button-to-env-var[] -- -|string -|`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n` +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] +| -a| [[quarkus-core_quarkus-log-console-level]] [.property-path]##link:#quarkus-core_quarkus-log-console-level[`quarkus.log.console.level`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async[`quarkus.log.handler.syslog."syslog-handlers".async`]## [.description] -- -The console log level. +Indicates whether to log asynchronously ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_CONSOLE_LEVEL+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC+++` endif::add-copy-button-to-env-var[] -- -|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] -|`ALL` +|boolean +|`false` -a| [[quarkus-core_quarkus-log-console-darken]] [.property-path]##link:#quarkus-core_quarkus-log-console-darken[`quarkus.log.console.darken`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async-queue-length]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async-queue-length[`quarkus.log.handler.syslog."syslog-handlers".async.queue-length`]## [.description] -- -Specify how much the colors should be darkened. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). +The queue length to use before flushing writing ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_DARKEN+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_QUEUE_LENGTH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_CONSOLE_DARKEN+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_QUEUE_LENGTH+++` endif::add-copy-button-to-env-var[] -- |int -|`0` +|`512` -a| [[quarkus-core_quarkus-log-console-filter]] [.property-path]##link:#quarkus-core_quarkus-log-console-filter[`quarkus.log.console.filter`]## +a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async-overflow]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async-overflow[`quarkus.log.handler.syslog."syslog-handlers".async.overflow`]## [.description] -- -The name of the filter to link to the console handler. +Determine whether to block the publisher (rather than drop the message) when the queue is full ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_FILTER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_OVERFLOW+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_CONSOLE_FILTER+++` +Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_OVERFLOW+++` endif::add-copy-button-to-env-var[] -- -|string -| - -a| [[quarkus-core_quarkus-log-console-async]] [.property-path]##link:#quarkus-core_quarkus-log-console-async[`quarkus.log.console.async`]## - -[.description] --- -Indicates whether to log asynchronously +a|`block`, `discard` +|`block` -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_ASYNC+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_CONSOLE_ASYNC+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` +h|[[quarkus-core_section_quarkus-log-filter]] [.section-name.section-level1]##link:#quarkus-core_section_quarkus-log-filter[Log cleanup filters - internal use]## +h|Type +h|Default -a| [[quarkus-core_quarkus-log-console-async-queue-length]] [.property-path]##link:#quarkus-core_quarkus-log-console-async-queue-length[`quarkus.log.console.async.queue-length`]## +a| [[quarkus-core_quarkus-log-filter-filters-if-starts-with]] [.property-path]##link:#quarkus-core_quarkus-log-filter-filters-if-starts-with[`quarkus.log.filter."filters".if-starts-with`]## [.description] -- -The queue length to use before flushing writing +The message prefix to match ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_ASYNC_QUEUE_LENGTH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILTER__FILTERS__IF_STARTS_WITH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_CONSOLE_ASYNC_QUEUE_LENGTH+++` +Environment variable: `+++QUARKUS_LOG_FILTER__FILTERS__IF_STARTS_WITH+++` endif::add-copy-button-to-env-var[] -- -|int -|`512` +|list of string +|`inherit` -a| [[quarkus-core_quarkus-log-console-async-overflow]] [.property-path]##link:#quarkus-core_quarkus-log-console-async-overflow[`quarkus.log.console.async.overflow`]## +a| [[quarkus-core_quarkus-log-filter-filters-target-level]] [.property-path]##link:#quarkus-core_quarkus-log-filter-filters-target-level[`quarkus.log.filter."filters".target-level`]## [.description] -- -Determine whether to block the publisher (rather than drop the message) when the queue is full +The new log level for the filtered message. Defaults to DEBUG. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_CONSOLE_ASYNC_OVERFLOW+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILTER__FILTERS__TARGET_LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_CONSOLE_ASYNC_OVERFLOW+++` +Environment variable: `+++QUARKUS_LOG_FILTER__FILTERS__TARGET_LEVEL+++` endif::add-copy-button-to-env-var[] -- -a|`block`, `discard` -|`block` +|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] +|`DEBUG` -h|[[quarkus-core_section_quarkus-log-file]] [.section-name.section-level0]##link:#quarkus-core_section_quarkus-log-file[File logging]## +h|[.configroot-name]##Naming## h|Type h|Default -a| [[quarkus-core_quarkus-log-file-enable]] [.property-path]##link:#quarkus-core_quarkus-log-file-enable[`quarkus.log.file.enable`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-naming-enable-jndi]] [.property-path]##link:#quarkus-core_quarkus-naming-enable-jndi[`quarkus.naming.enable-jndi`]## [.description] -- -If file logging should be enabled +By default, Quarkus will install a non-functional JNDI initial context, to help mitigate against Log4Shell style attacks. If your application does need to use JNDI you can change this flag. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ENABLE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NAMING_ENABLE_JNDI+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILE_ENABLE+++` +Environment variable: `+++QUARKUS_NAMING_ENABLE_JNDI+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-core_quarkus-log-file-format]] [.property-path]##link:#quarkus-core_quarkus-log-file-format[`quarkus.log.file.format`]## +h|[.configroot-name]##Native executables## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enabled]] [.property-path]##link:#quarkus-core_quarkus-native-enabled[`quarkus.native.enabled`]## [.description] -- -The log format +Set to enable native-image building using GraalVM. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_FORMAT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILE_FORMAT+++` +Environment variable: `+++QUARKUS_NATIVE_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -|`%d{yyyy-MM-dd HH:mm:ss,SSS} %h %N[%i] %-5p [%c{3.}] (%t) %s%e%n` +|boolean +|`false` -a| [[quarkus-core_quarkus-log-file-level]] [.property-path]##link:#quarkus-core_quarkus-log-file-level[`quarkus.log.file.level`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-sources-only]] [.property-path]##link:#quarkus-core_quarkus-native-sources-only[`quarkus.native.sources-only`]## [.description] -- -The level of logs to be written into the file. +Set to prevent the native-image process from actually building the native image. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_SOURCES_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILE_LEVEL+++` +Environment variable: `+++QUARKUS_NATIVE_SOURCES_ONLY+++` endif::add-copy-button-to-env-var[] -- -|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] -|`ALL` +|boolean +|`false` -a| [[quarkus-core_quarkus-log-file-path]] [.property-path]##link:#quarkus-core_quarkus-log-file-path[`quarkus.log.file.path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-additional-build-args]] [.property-path]##link:#quarkus-core_quarkus-native-additional-build-args[`quarkus.native.additional-build-args`]## [.description] -- -The name of the file in which logs will be written. +Comma-separated, additional arguments to pass to the build process. If an argument includes the `,` symbol, it needs to be escaped, e.g. `++\\++,` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ADDITIONAL_BUILD_ARGS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILE_PATH+++` +Environment variable: `+++QUARKUS_NATIVE_ADDITIONAL_BUILD_ARGS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html[File] -|`quarkus.log` +|list of string +| -a| [[quarkus-core_quarkus-log-file-filter]] [.property-path]##link:#quarkus-core_quarkus-log-file-filter[`quarkus.log.file.filter`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enable-http-url-handler]] [.property-path]##link:#quarkus-core_quarkus-native-enable-http-url-handler[`quarkus.native.enable-http-url-handler`]## [.description] -- -The name of the filter to link to the file handler. +If the HTTP url handler should be enabled, allowing you to do URL.openConnection() for HTTP URLs ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_FILTER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLE_HTTP_URL_HANDLER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILE_FILTER+++` +Environment variable: `+++QUARKUS_NATIVE_ENABLE_HTTP_URL_HANDLER+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`true` -a| [[quarkus-core_quarkus-log-file-encoding]] [.property-path]##link:#quarkus-core_quarkus-log-file-encoding[`quarkus.log.file.encoding`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enable-https-url-handler]] [.property-path]##link:#quarkus-core_quarkus-native-enable-https-url-handler[`quarkus.native.enable-https-url-handler`]## [.description] -- -The character encoding used +If the HTTPS url handler should be enabled, allowing you to do URL.openConnection() for HTTPS URLs ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ENCODING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLE_HTTPS_URL_HANDLER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILE_ENCODING+++` +Environment variable: `+++QUARKUS_NATIVE_ENABLE_HTTPS_URL_HANDLER+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html[Charset] -| +|boolean +|`false` -a| [[quarkus-core_quarkus-log-file-async]] [.property-path]##link:#quarkus-core_quarkus-log-file-async[`quarkus.log.file.async`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-headless]] [.property-path]##link:#quarkus-core_quarkus-native-headless[`quarkus.native.headless`]## [.description] -- -Indicates whether to log asynchronously +The default value for java.awt.headless JVM option. Switching this option affects linking of awt libraries. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ASYNC+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_HEADLESS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILE_ASYNC+++` +Environment variable: `+++QUARKUS_NATIVE_HEADLESS+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +|`true` -a| [[quarkus-core_quarkus-log-file-async-queue-length]] [.property-path]##link:#quarkus-core_quarkus-log-file-async-queue-length[`quarkus.log.file.async.queue-length`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-file-encoding]] [.property-path]##link:#quarkus-core_quarkus-native-file-encoding[`quarkus.native.file-encoding`]## [.description] -- -The queue length to use before flushing writing +Defines the file encoding as in `-Dfile.encoding=...`. Native image runtime uses the host's (i.e. build time) value of `file.encoding` system property. We intentionally default this to UTF-8 to avoid platform specific defaults to be picked up which can then result in inconsistent behavior in the generated native executable. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ASYNC_QUEUE_LENGTH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_FILE_ENCODING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILE_ASYNC_QUEUE_LENGTH+++` +Environment variable: `+++QUARKUS_NATIVE_FILE_ENCODING+++` endif::add-copy-button-to-env-var[] -- -|int -|`512` +|string +|`UTF-8` -a| [[quarkus-core_quarkus-log-file-async-overflow]] [.property-path]##link:#quarkus-core_quarkus-log-file-async-overflow[`quarkus.log.file.async.overflow`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-add-all-charsets]] [.property-path]##link:#quarkus-core_quarkus-native-add-all-charsets[`quarkus.native.add-all-charsets`]## [.description] -- -Determine whether to block the publisher (rather than drop the message) when the queue is full +If all character sets should be added to the native executable. + +Note that some extensions (e.g. the Oracle JDBC driver) also take this setting into account to enable support for all charsets at the extension level. + +This increases image size. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ASYNC_OVERFLOW+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ADD_ALL_CHARSETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILE_ASYNC_OVERFLOW+++` +Environment variable: `+++QUARKUS_NATIVE_ADD_ALL_CHARSETS+++` endif::add-copy-button-to-env-var[] -- -a|`block`, `discard` -|`block` +|boolean +|`false` -a| [[quarkus-core_quarkus-log-file-rotation-max-file-size]] [.property-path]##link:#quarkus-core_quarkus-log-file-rotation-max-file-size[`quarkus.log.file.rotation.max-file-size`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-graalvm-home]] [.property-path]##link:#quarkus-core_quarkus-native-graalvm-home[`quarkus.native.graalvm-home`]## [.description] -- -The maximum log file size, after which a rotation is executed. +The location of the Graal distribution ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ROTATION_MAX_FILE_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_GRAALVM_HOME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILE_ROTATION_MAX_FILE_SIZE+++` +Environment variable: `+++QUARKUS_NATIVE_GRAALVM_HOME+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] -|`10M` +|string +|`${GRAALVM_HOME:}` -a| [[quarkus-core_quarkus-log-file-rotation-max-backup-index]] [.property-path]##link:#quarkus-core_quarkus-log-file-rotation-max-backup-index[`quarkus.log.file.rotation.max-backup-index`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-java-home]] [.property-path]##link:#quarkus-core_quarkus-native-java-home[`quarkus.native.java-home`]## [.description] -- -The maximum number of backups to keep. +The location of the JDK ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ROTATION_MAX_BACKUP_INDEX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_JAVA_HOME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILE_ROTATION_MAX_BACKUP_INDEX+++` +Environment variable: `+++QUARKUS_NATIVE_JAVA_HOME+++` endif::add-copy-button-to-env-var[] -- -|int -|`5` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html[File] +|`${java.home}` -a| [[quarkus-core_quarkus-log-file-rotation-file-suffix]] [.property-path]##link:#quarkus-core_quarkus-log-file-rotation-file-suffix[`quarkus.log.file.rotation.file-suffix`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-native-image-xmx]] [.property-path]##link:#quarkus-core_quarkus-native-native-image-xmx[`quarkus.native.native-image-xmx`]## [.description] -- -The file handler rotation file suffix. When used, the file will be rotated based on its suffix. - -The suffix must be in a date-time format that is understood by `DateTimeFormatter`. - -Example fileSuffix: .yyyy-MM-dd - -Note: If the suffix ends with .zip or .gz, the rotation file will also be compressed. +The maximum Java heap to be used during the native image generation ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ROTATION_FILE_SUFFIX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_NATIVE_IMAGE_XMX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILE_ROTATION_FILE_SUFFIX+++` +Environment variable: `+++QUARKUS_NATIVE_NATIVE_IMAGE_XMX+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-core_quarkus-log-file-rotation-rotate-on-boot]] [.property-path]##link:#quarkus-core_quarkus-log-file-rotation-rotate-on-boot[`quarkus.log.file.rotation.rotate-on-boot`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-debug-build-process]] [.property-path]##link:#quarkus-core_quarkus-native-debug-build-process[`quarkus.native.debug-build-process`]## [.description] -- -Indicates whether to rotate log files on server initialization. - -You need to either set a `max-file-size` or configure a `file-suffix` for it to work. +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 ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILE_ROTATION_ROTATE_ON_BOOT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_DEBUG_BUILD_PROCESS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILE_ROTATION_ROTATE_ON_BOOT+++` +Environment variable: `+++QUARKUS_NATIVE_DEBUG_BUILD_PROCESS+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` - - -h|[[quarkus-core_section_quarkus-log-syslog]] [.section-name.section-level0]##link:#quarkus-core_section_quarkus-log-syslog[Syslog logging]## -h|Type -h|Default +|`false` -a| [[quarkus-core_quarkus-log-syslog-enable]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-enable[`quarkus.log.syslog.enable`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-publish-debug-build-process-port]] [.property-path]##link:#quarkus-core_quarkus-native-publish-debug-build-process-port[`quarkus.native.publish-debug-build-process-port`]## [.description] -- -If syslog logging should be enabled +If the debug port should be published when building with docker and debug-build-process is true ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_ENABLE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_PUBLISH_DEBUG_BUILD_PROCESS_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_ENABLE+++` +Environment variable: `+++QUARKUS_NATIVE_PUBLISH_DEBUG_BUILD_PROCESS_PORT+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +|`true` -a| [[quarkus-core_quarkus-log-syslog-endpoint]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-endpoint[`quarkus.log.syslog.endpoint`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enable-isolates]] [.property-path]##link:#quarkus-core_quarkus-native-enable-isolates[`quarkus.native.enable-isolates`]## [.description] -- -The IP address and port of the Syslog server +If isolates should be enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_ENDPOINT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLE_ISOLATES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_ENDPOINT+++` +Environment variable: `+++QUARKUS_NATIVE_ENABLE_ISOLATES+++` endif::add-copy-button-to-env-var[] -- -|host:port -|`localhost:514` +|boolean +|`true` -a| [[quarkus-core_quarkus-log-syslog-app-name]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-app-name[`quarkus.log.syslog.app-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enable-fallback-images]] [.property-path]##link:#quarkus-core_quarkus-native-enable-fallback-images[`quarkus.native.enable-fallback-images`]## [.description] -- -The app name used when formatting the message in RFC5424 format +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 ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_APP_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLE_FALLBACK_IMAGES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_APP_NAME+++` +Environment variable: `+++QUARKUS_NATIVE_ENABLE_FALLBACK_IMAGES+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a| [[quarkus-core_quarkus-log-syslog-hostname]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-hostname[`quarkus.log.syslog.hostname`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-auto-service-loader-registration]] [.property-path]##link:#quarkus-core_quarkus-native-auto-service-loader-registration[`quarkus.native.auto-service-loader-registration`]## [.description] -- -The name of the host the messages are being sent from +If all META-INF/services entries should be automatically registered ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_HOSTNAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_AUTO_SERVICE_LOADER_REGISTRATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_HOSTNAME+++` +Environment variable: `+++QUARKUS_NATIVE_AUTO_SERVICE_LOADER_REGISTRATION+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a| [[quarkus-core_quarkus-log-syslog-facility]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-facility[`quarkus.log.syslog.facility`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-dump-proxies]] [.property-path]##link:#quarkus-core_quarkus-native-dump-proxies[`quarkus.native.dump-proxies`]## [.description] -- -Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164 +If the bytecode of all proxies should be dumped for inspection ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_FACILITY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_DUMP_PROXIES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_FACILITY+++` +Environment variable: `+++QUARKUS_NATIVE_DUMP_PROXIES+++` endif::add-copy-button-to-env-var[] -- -a|`kernel`, `user-level`, `mail-system`, `system-daemons`, `security`, `syslogd`, `line-printer`, `network-news`, `uucp`, `clock-daemon`, `security2`, `ftp-daemon`, `ntp`, `log-audit`, `log-alert`, `clock-daemon2`, `local-use-0`, `local-use-1`, `local-use-2`, `local-use-3`, `local-use-4`, `local-use-5`, `local-use-6`, `local-use-7` -|`user-level` +|boolean +|`false` -a| [[quarkus-core_quarkus-log-syslog-syslog-type]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-syslog-type[`quarkus.log.syslog.syslog-type`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-container-build]] [.property-path]##link:#quarkus-core_quarkus-native-container-build[`quarkus.native.container-build`]## [.description] -- -Set the `SyslogType syslog type` this handler should use to format the message sent +If this build should be done using a container runtime. Unless container-runtime is also set, docker will be used by default. If docker is not available or is an alias to podman, podman will be used instead as the default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_SYSLOG_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_CONTAINER_BUILD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_SYSLOG_TYPE+++` +Environment variable: `+++QUARKUS_NATIVE_CONTAINER_BUILD+++` endif::add-copy-button-to-env-var[] -- -a|`rfc5424`, `rfc3164` -|`rfc5424` +|boolean +| -a| [[quarkus-core_quarkus-log-syslog-protocol]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-protocol[`quarkus.log.syslog.protocol`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-pie]] [.property-path]##link:#quarkus-core_quarkus-native-pie[`quarkus.native.pie`]## [.description] -- -Sets the protocol used to connect to the Syslog server +Explicit configuration option to generate a native Position Independent Executable (PIE) for Linux. If the system supports PIE generation, the default behaviour is to disable it for link:https://www.redhat.com/en/blog/position-independent-executable-pie-performance[performance reasons]. However, some systems can only run position-independent executables, so this option enables the generation of such native executables. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_PROTOCOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_PIE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_PROTOCOL+++` +Environment variable: `+++QUARKUS_NATIVE_PIE+++` endif::add-copy-button-to-env-var[] -- -a|`tcp`, `udp`, `ssl-tcp` -|`tcp` +|boolean +| -a| [[quarkus-core_quarkus-log-syslog-use-counting-framing]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-use-counting-framing[`quarkus.log.syslog.use-counting-framing`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-march]] [.property-path]##link:#quarkus-core_quarkus-native-march[`quarkus.native.march`]## [.description] -- -If enabled, the message being sent is prefixed with the size of the message +Generate instructions for a specific machine type. Defaults to `x86-64-v3` on AMD64 and `armv8-a` on AArch64. Use `compatibility` for best compatibility, or `native` for best performance if a native executable is deployed on the same machine or on a machine with the same CPU features. A list of all available machine types is available by executing `native-image -march=list` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_USE_COUNTING_FRAMING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_MARCH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_USE_COUNTING_FRAMING+++` +Environment variable: `+++QUARKUS_NATIVE_MARCH+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-core_quarkus-log-syslog-truncate]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-truncate[`quarkus.log.syslog.truncate`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-remote-container-build]] [.property-path]##link:#quarkus-core_quarkus-native-remote-container-build[`quarkus.native.remote-container-build`]## [.description] -- -Set to `true` to truncate the message if it exceeds maximum length +If this build is done using a remote docker daemon. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_TRUNCATE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_REMOTE_CONTAINER_BUILD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_TRUNCATE+++` +Environment variable: `+++QUARKUS_NATIVE_REMOTE_CONTAINER_BUILD+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` +|`false` -a| [[quarkus-core_quarkus-log-syslog-block-on-reconnect]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-block-on-reconnect[`quarkus.log.syslog.block-on-reconnect`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-builder-image]] [.property-path]##link:#quarkus-core_quarkus-native-builder-image[`quarkus.native.builder-image`]## [.description] -- -Enables or disables blocking when attempting to reconnect a `org.jboss.logmanager.handlers.SyslogHandler.Protocol++#++TCP -TCP` or `org.jboss.logmanager.handlers.SyslogHandler.Protocol++#++SSL_TCP SSL TCP` protocol +The docker image to use to do the image build. It can be one of `graalvm`, `mandrel`, or the full image path, e.g. `quay.io/quarkus/ubi-quarkus-mandrel-builder-image:jdk-21`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_BLOCK_ON_RECONNECT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_BUILDER_IMAGE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_BLOCK_ON_RECONNECT+++` +Environment variable: `+++QUARKUS_NATIVE_BUILDER_IMAGE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +|`mandrel` -a| [[quarkus-core_quarkus-log-syslog-format]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-format[`quarkus.log.syslog.format`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-builder-image-pull]] [.property-path]##link:#quarkus-core_quarkus-native-builder-image-pull[`quarkus.native.builder-image.pull`]## [.description] -- -The log message format +The strategy for pulling the builder image during the build. + +Defaults to 'always', which will always pull the most up-to-date image; useful to keep up with fixes when a (floating) tag is updated. + +Use 'missing' to only pull if there is no image locally; useful on development environments where building with out-of-date images is acceptable and bandwidth may be limited. + +Use 'never' to fail the build if there is no image locally. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_FORMAT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_BUILDER_IMAGE_PULL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_FORMAT+++` +Environment variable: `+++QUARKUS_NATIVE_BUILDER_IMAGE_PULL+++` endif::add-copy-button-to-env-var[] -- -|string -|`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n` +a|tooltip:always[Always pull the most recent image.], tooltip:missing[Only pull the image if it's missing locally.], tooltip:never[Never pull any image; fail if the image is missing locally.] +|tooltip:always[Always pull the most recent image.] -a| [[quarkus-core_quarkus-log-syslog-level]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-level[`quarkus.log.syslog.level`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-container-runtime]] [.property-path]##link:#quarkus-core_quarkus-native-container-runtime[`quarkus.native.container-runtime`]## [.description] -- -The log level specifying what message levels will be logged by the Syslog logger +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. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_CONTAINER_RUNTIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_LEVEL+++` +Environment variable: `+++QUARKUS_NATIVE_CONTAINER_RUNTIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] -|`ALL` +a|`docker`, `docker-rootless`, `wsl`, `wsl-rootless`, `podman`, `podman-rootless`, `unavailable` +| -a| [[quarkus-core_quarkus-log-syslog-filter]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-filter[`quarkus.log.syslog.filter`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-container-runtime-options]] [.property-path]##link:#quarkus-core_quarkus-native-container-runtime-options[`quarkus.native.container-runtime-options`]## [.description] -- -The name of the filter to link to the file handler. +Options to pass to the container runtime ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_FILTER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_CONTAINER_RUNTIME_OPTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_FILTER+++` +Environment variable: `+++QUARKUS_NATIVE_CONTAINER_RUNTIME_OPTIONS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a| [[quarkus-core_quarkus-log-syslog-max-length]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-max-length[`quarkus.log.syslog.max-length`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-monitoring]] [.property-path]##link:#quarkus-core_quarkus-native-monitoring[`quarkus.native.monitoring`]## [.description] -- -The maximum length, in bytes, of the message allowed to be sent. The length includes the header and the message. +Enable monitoring various monitoring options. The value should be comma separated. -If not set, the default value is `2048` when `sys-log-type` is `rfc5424` (which is the default) and `1024` when `sys-log-type` is `rfc3164` + - `jfr` for JDK flight recorder support + - `jvmstat` for JVMStat support + - `heapdump` for heampdump support + - `jmxclient` for JMX client support (experimental) + - `jmxserver` for JMX server support (experimental) + - `all` for all monitoring features ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_MAX_LENGTH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_MONITORING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_MAX_LENGTH+++` +Environment variable: `+++QUARKUS_NATIVE_MONITORING+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +a|list of `heapdump`, `jvmstat`, `jfr`, `jmxserver`, `jmxclient`, `all` | -a| [[quarkus-core_quarkus-log-syslog-async]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-async[`quarkus.log.syslog.async`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enable-reports]] [.property-path]##link:#quarkus-core_quarkus-native-enable-reports[`quarkus.native.enable-reports`]## [.description] -- -Indicates whether to log asynchronously +If the reports on call paths and included packages/classes/methods should be generated ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_ASYNC+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLE_REPORTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_ASYNC+++` +Environment variable: `+++QUARKUS_NATIVE_ENABLE_REPORTS+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-core_quarkus-log-syslog-async-queue-length]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-async-queue-length[`quarkus.log.syslog.async.queue-length`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-report-exception-stack-traces]] [.property-path]##link:#quarkus-core_quarkus-native-report-exception-stack-traces[`quarkus.native.report-exception-stack-traces`]## [.description] -- -The queue length to use before flushing writing +If exceptions should be reported with a full stack trace ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_ASYNC_QUEUE_LENGTH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_REPORT_EXCEPTION_STACK_TRACES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_ASYNC_QUEUE_LENGTH+++` +Environment variable: `+++QUARKUS_NATIVE_REPORT_EXCEPTION_STACK_TRACES+++` endif::add-copy-button-to-env-var[] -- -|int -|`512` +|boolean +|`true` -a| [[quarkus-core_quarkus-log-syslog-async-overflow]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-async-overflow[`quarkus.log.syslog.async.overflow`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-report-errors-at-runtime]] [.property-path]##link:#quarkus-core_quarkus-native-report-errors-at-runtime[`quarkus.native.report-errors-at-runtime`]## [.description] -- -Determine whether to block the publisher (rather than drop the message) when the queue is full +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. Note that the use of this flag may result in build time failures due to `ClassNotFoundException`s. Reason most likely being that the Quarkus extension already optimized it away or do not actually need it. In such cases you should explicitly add the corresponding dependency providing the missing classes as a dependency to your project. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SYSLOG_ASYNC_OVERFLOW+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_REPORT_ERRORS_AT_RUNTIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SYSLOG_ASYNC_OVERFLOW+++` +Environment variable: `+++QUARKUS_NATIVE_REPORT_ERRORS_AT_RUNTIME+++` endif::add-copy-button-to-env-var[] -- -a|`block`, `discard` -|`block` - - -h|[[quarkus-core_section_quarkus-log-handler-console]] [.section-name.section-level0]##link:#quarkus-core_section_quarkus-log-handler-console[Console handlers]## -h|Type -h|Default +|boolean +|`false` -a| [[quarkus-core_quarkus-log-handler-console-console-handlers-enable]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-enable[`quarkus.log.handler.console."console-handlers".enable`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-reuse-existing]] [.property-path]##link:#quarkus-core_quarkus-native-reuse-existing[`quarkus.native.reuse-existing`]## [.description] -- -If console logging should be enabled +Don't build a native image if it already exists. This is useful if you have already built an image and you want to use Quarkus to deploy it somewhere. Note that this is not able to detect if the existing image is outdated, if you have modified source or config and want a new image you must not use this flag. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ENABLE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_REUSE_EXISTING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ENABLE+++` +Environment variable: `+++QUARKUS_NATIVE_REUSE_EXISTING+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` +|`false` -a| [[quarkus-core_quarkus-log-handler-console-console-handlers-stderr]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-stderr[`quarkus.log.handler.console."console-handlers".stderr`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-resources-includes]] [.property-path]##link:#quarkus-core_quarkus-native-resources-includes[`quarkus.native.resources.includes`]## [.description] -- -If console logging should go to `System++#++err` instead of `System++#++out`. +A comma separated list of globs to match resource paths that should be added to the native image. + +Use slash (`/`) as a path separator on all platforms. Globs must not start with slash. + +By default, no resources are included. + +Example: Given that you have `src/main/resources/ignored.png` and `src/main/resources/foo/selected.png` in your source tree and one of your dependency JARs contains `bar/some.txt` file, with the following configuration + +``` +quarkus.native.resources.includes = foo/**,bar/**/*.txt +``` + +the files `src/main/resources/foo/selected.png` and `bar/some.txt` will be included in the native image, while `src/main/resources/ignored.png` will not be included. + +Supported glob features Feature Description `++*++` Matches a (possibly empty) sequence of characters that does not contain slash (`/`) `++**++` Matches a (possibly empty) sequence of characters that may contain slash (`/`) `?` Matches one character, but not slash `++[++abc++]++` Matches one character given in the bracket, but not slash `++[++a-z++]++` Matches one character from the range given in the bracket, but not slash `++[++!abc++]++` Matches one character not named in the bracket; does not match slash `++[++a-z++]++` Matches one character outside the range given in the bracket; does not match slash `++{++one,two,three++}++` Matches any of the alternating tokens separated by comma; the tokens may contain wildcards, nested alternations and ranges `++\++` The escape character + +Note that there are three levels of escaping when passing this option via `application.properties`: + + . `application.properties` parser + - MicroProfile Config list converter that splits the comma separated list + - Glob parser All three levels use backslash (`++\++`) as the escaping character. So you need to use an appropriate number of backslashes depending on which level you want to escape. + +Note that Quarkus extensions typically include the resources they require by themselves. This option is useful in situations when the built-in functionality is not sufficient. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__STDERR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_RESOURCES_INCLUDES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__STDERR+++` +Environment variable: `+++QUARKUS_NATIVE_RESOURCES_INCLUDES+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|list of string +| -a| [[quarkus-core_quarkus-log-handler-console-console-handlers-format]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-format[`quarkus.log.handler.console."console-handlers".format`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-resources-excludes]] [.property-path]##link:#quarkus-core_quarkus-native-resources-excludes[`quarkus.native.resources.excludes`]## [.description] -- -The log format. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). +A comma separated list of globs to match resource paths that should *not* be added to the native image. + +Use slash (`/`) as a path separator on all platforms. Globs must not start with slash. + +Please refer to `includes` for details about the glob syntax. + +By default, no resources are excluded. + +Example: Given that you have `src/main/resources/red.png` and `src/main/resources/foo/green.png` in your source tree and one of your dependency JARs contains `bar/blue.png` file, with the following configuration + +``` +quarkus.native.resources.includes = **/*.png +quarkus.native.resources.excludes = foo/**,**/green.png +``` + +the resource `red.png` will be available in the native image while the resources `foo/green.png` and `bar/blue.png` will not be available in the native image. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FORMAT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_RESOURCES_EXCLUDES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FORMAT+++` +Environment variable: `+++QUARKUS_NATIVE_RESOURCES_EXCLUDES+++` endif::add-copy-button-to-env-var[] -- -|string -|`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n` +|list of string +| -a| [[quarkus-core_quarkus-log-handler-console-console-handlers-level]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-level[`quarkus.log.handler.console."console-handlers".level`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-debug-enabled]] [.property-path]##link:#quarkus-core_quarkus-native-debug-enabled[`quarkus.native.debug.enabled`]## [.description] -- -The console log level. +If debug is enabled and debug symbols are generated. The symbols will be generated in a separate .debug file. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_DEBUG_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__LEVEL+++` +Environment variable: `+++QUARKUS_NATIVE_DEBUG_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] -|`ALL` +|boolean +|`false` -a| [[quarkus-core_quarkus-log-handler-console-console-handlers-darken]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-darken[`quarkus.log.handler.console."console-handlers".darken`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enable-dashboard-dump]] [.property-path]##link:#quarkus-core_quarkus-native-enable-dashboard-dump[`quarkus.native.enable-dashboard-dump`]## [.description] -- -Specify how much the colors should be darkened. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). +Generate the report files for GraalVM Dashboard. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__DARKEN+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLE_DASHBOARD_DUMP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__DARKEN+++` +Environment variable: `+++QUARKUS_NATIVE_ENABLE_DASHBOARD_DUMP+++` endif::add-copy-button-to-env-var[] -- -|int -|`0` +|boolean +|`false` -a| [[quarkus-core_quarkus-log-handler-console-console-handlers-filter]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-filter[`quarkus.log.handler.console."console-handlers".filter`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-include-reasons-in-config-files]] [.property-path]##link:#quarkus-core_quarkus-native-include-reasons-in-config-files[`quarkus.native.include-reasons-in-config-files`]## [.description] -- -The name of the filter to link to the console handler. +Include a reasons entries in the generated json configuration files. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FILTER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_INCLUDE_REASONS_IN_CONFIG_FILES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FILTER+++` +Environment variable: `+++QUARKUS_NATIVE_INCLUDE_REASONS_IN_CONFIG_FILES+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a| [[quarkus-core_quarkus-log-handler-console-console-handlers-async]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-async[`quarkus.log.handler.console."console-handlers".async`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-compression-level]] [.property-path]##link:#quarkus-core_quarkus-native-compression-level[`quarkus.native.compression.level`]## [.description] -- -Indicates whether to log asynchronously +The compression level in ++[++1, 10++]++. 10 means _best_. + +Higher compression level requires more time to compress the executable. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_COMPRESSION_LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC+++` +Environment variable: `+++QUARKUS_NATIVE_COMPRESSION_LEVEL+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|int +| -a| [[quarkus-core_quarkus-log-handler-console-console-handlers-async-queue-length]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-async-queue-length[`quarkus.log.handler.console."console-handlers".async.queue-length`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-compression-additional-args]] [.property-path]##link:#quarkus-core_quarkus-native-compression-additional-args[`quarkus.native.compression.additional-args`]## [.description] -- -The queue length to use before flushing writing +Allows passing extra arguments to the UPX command line (like --brute). The arguments are comma-separated. The exhaustive list of parameters can be found in link:https://github.com/upx/upx/blob/devel/doc/upx.pod[https://github.com/upx/upx/blob/devel/doc/upx.pod]. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_QUEUE_LENGTH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_COMPRESSION_ADDITIONAL_ARGS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_QUEUE_LENGTH+++` +Environment variable: `+++QUARKUS_NATIVE_COMPRESSION_ADDITIONAL_ARGS+++` endif::add-copy-button-to-env-var[] -- -|int -|`512` +|list of string +| -a| [[quarkus-core_quarkus-log-handler-console-console-handlers-async-overflow]] [.property-path]##link:#quarkus-core_quarkus-log-handler-console-console-handlers-async-overflow[`quarkus.log.handler.console."console-handlers".async.overflow`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-agent-configuration-apply]] [.property-path]##link:#quarkus-core_quarkus-native-agent-configuration-apply[`quarkus.native.agent-configuration-apply`]## [.description] -- -Determine whether to block the publisher (rather than drop the message) when the queue is full +Configuration files generated by the Quarkus build, using native image agent, are informative by default. In other words, the generated configuration files are presented in the build log but are not applied. When this option is set to true, generated configuration files are applied to the native executable building process. + +Enabling this option should be done with care, because it can make native image configuration and/or behaviour dependant on other non-obvious factors. For example, if the native image agent generated configuration was generated from running JVM unit tests, disabling test(s) can result in a different native image configuration being generated, which in turn can misconfigure the native executable or affect its behaviour in unintended ways. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_OVERFLOW+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_AGENT_CONFIGURATION_APPLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_OVERFLOW+++` +Environment variable: `+++QUARKUS_NATIVE_AGENT_CONFIGURATION_APPLY+++` endif::add-copy-button-to-env-var[] -- -a|`block`, `discard` -|`block` - +|boolean +|`false` -h|[[quarkus-core_section_quarkus-log-handler-file]] [.section-name.section-level0]##link:#quarkus-core_section_quarkus-log-handler-file[File handlers]## +h|[.configroot-name]##Packaging the application## h|Type h|Default -a| [[quarkus-core_quarkus-log-handler-file-file-handlers-enable]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-enable[`quarkus.log.handler.file."file-handlers".enable`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-enabled]] [.property-path]##link:#quarkus-core_quarkus-package-jar-enabled[`quarkus.package.jar.enabled`]## [.description] -- -If file logging should be enabled +If set to false, no JAR will be produced. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENABLE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENABLE+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +|`true` -a| [[quarkus-core_quarkus-log-handler-file-file-handlers-format]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-format[`quarkus.log.handler.file."file-handlers".format`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-type]] [.property-path]##link:#quarkus-core_quarkus-package-jar-type[`quarkus.package.jar.type`]## [.description] -- -The log format +The JAR output type to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FORMAT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FORMAT+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_TYPE+++` endif::add-copy-button-to-env-var[] -- -|string -|`%d{yyyy-MM-dd HH:mm:ss,SSS} %h %N[%i] %-5p [%c{3.}] (%t) %s%e%n` +a|tooltip:fast-jar[The "fast JAR" packaging type.], tooltip:uber-jar[The "Uber-JAR" packaging type.], tooltip:mutable-jar[The "mutable JAR" packaging type (for remote development mode).], tooltip:legacy-jar[The "legacy JAR" packaging type. This corresponds to the packaging type used in Quarkus before version 1.12.] +|tooltip:fast-jar[The "fast JAR" packaging type.] -a| [[quarkus-core_quarkus-log-handler-file-file-handlers-level]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-level[`quarkus.log.handler.file."file-handlers".level`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-compress]] [.property-path]##link:#quarkus-core_quarkus-package-jar-compress[`quarkus.package.jar.compress`]## [.description] -- -The level of logs to be written into the file. +Whether the created jar will be compressed. This setting is not used when building a native image ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_COMPRESS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__LEVEL+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_COMPRESS+++` endif::add-copy-button-to-env-var[] -- -|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] -|`ALL` +|boolean +|`true` -a| [[quarkus-core_quarkus-log-handler-file-file-handlers-path]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-path[`quarkus.log.handler.file."file-handlers".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-manifest-add-implementation-entries]] [.property-path]##link:#quarkus-core_quarkus-package-jar-manifest-add-implementation-entries[`quarkus.package.jar.manifest.add-implementation-entries`]## [.description] -- -The name of the file in which logs will be written. +Specify whether the `Implementation` information should be included in the runner jar's MANIFEST.MF. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_MANIFEST_ADD_IMPLEMENTATION_ENTRIES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__PATH+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_MANIFEST_ADD_IMPLEMENTATION_ENTRIES+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html[File] -|`quarkus.log` +|boolean +|`true` -a| [[quarkus-core_quarkus-log-handler-file-file-handlers-filter]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-filter[`quarkus.log.handler.file."file-handlers".filter`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-manifest-attributes-attribute-name]] [.property-path]##link:#quarkus-core_quarkus-package-jar-manifest-attributes-attribute-name[`quarkus.package.jar.manifest.attributes."attribute-name"`]## [.description] -- -The name of the filter to link to the file handler. +Custom manifest attributes to be added to the main section of the MANIFEST.MF file. An example of the user defined property: quarkus.package.jar.manifest.attributes."Entry-key1"=Value1 quarkus.package.jar.manifest.attributes."Entry-key2"=Value2 ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FILTER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_MANIFEST_ATTRIBUTES__ATTRIBUTE_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FILTER+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_MANIFEST_ATTRIBUTES__ATTRIBUTE_NAME_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a| [[quarkus-core_quarkus-log-handler-file-file-handlers-encoding]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-encoding[`quarkus.log.handler.file."file-handlers".encoding`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-manifest-sections-section-name]] [.property-path]##link:#quarkus-core_quarkus-package-jar-manifest-sections-section-name[`quarkus.package.jar.manifest.sections."section-name"`]## [.description] -- -The character encoding used +Custom manifest sections to be added to the MANIFEST.MF file. An example of the user defined property: quarkus.package.jar.manifest.sections."Section-Name"."Entry-Key1"=Value1 quarkus.package.jar.manifest.sections."Section-Name"."Entry-Key2"=Value2 ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENCODING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_MANIFEST_SECTIONS__SECTION_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENCODING+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_MANIFEST_SECTIONS__SECTION_NAME_+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html[Charset] +|Map> | -a| [[quarkus-core_quarkus-log-handler-file-file-handlers-async]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-async[`quarkus.log.handler.file."file-handlers".async`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-user-configured-ignored-entries]] [.property-path]##link:#quarkus-core_quarkus-package-jar-user-configured-ignored-entries[`quarkus.package.jar.user-configured-ignored-entries`]## [.description] -- -Indicates whether to log asynchronously +Files that should not be copied to the output artifact. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_USER_CONFIGURED_IGNORED_ENTRIES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_USER_CONFIGURED_IGNORED_ENTRIES+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|list of string +| -a| [[quarkus-core_quarkus-log-handler-file-file-handlers-async-queue-length]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-async-queue-length[`quarkus.log.handler.file."file-handlers".async.queue-length`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-included-optional-dependencies]] [.property-path]##link:#quarkus-core_quarkus-package-jar-included-optional-dependencies[`quarkus.package.jar.included-optional-dependencies`]## [.description] -- -The queue length to use before flushing writing +List of all the dependencies that have been defined as optional to include into the final package of the application. Each optional dependency needs to be expressed in the following format: + +`groupId:artifactId++[++:++[++classifier++][++:++[++type++]]]++` + +With the classifier and type being optional (note that the brackets (`++[]++`) denote optionality and are not a part of the syntax specification). The group ID and artifact ID must be present and non-empty. + +If the type is missing, the artifact is assumed to be of type `jar`. + +This parameter is optional; if absent, no optional dependencies will be included into the final package of the application. + +For backward compatibility reasons, this parameter is ignored by default and can be enabled by setting the parameter `quarkus.package.jar.filter-optional-dependencies` to `true`. + +This parameter is meant to be used in modules where multi-builds have been configured to avoid getting a final package with unused dependencies. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_QUEUE_LENGTH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_INCLUDED_OPTIONAL_DEPENDENCIES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_QUEUE_LENGTH+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_INCLUDED_OPTIONAL_DEPENDENCIES+++` endif::add-copy-button-to-env-var[] -- -|int -|`512` +|list of GACT +| -a| [[quarkus-core_quarkus-log-handler-file-file-handlers-async-overflow]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-async-overflow[`quarkus.log.handler.file."file-handlers".async.overflow`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-filter-optional-dependencies]] [.property-path]##link:#quarkus-core_quarkus-package-jar-filter-optional-dependencies[`quarkus.package.jar.filter-optional-dependencies`]## [.description] -- -Determine whether to block the publisher (rather than drop the message) when the queue is full +Flag indicating whether the optional dependencies should be filtered out or not. + +This parameter is meant to be used in modules where multi-builds have been configured to avoid getting a final package with unused dependencies. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_OVERFLOW+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_FILTER_OPTIONAL_DEPENDENCIES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_OVERFLOW+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_FILTER_OPTIONAL_DEPENDENCIES+++` endif::add-copy-button-to-env-var[] -- -a|`block`, `discard` -|`block` +|boolean +|`false` -a| [[quarkus-core_quarkus-log-handler-file-file-handlers-rotation-max-file-size]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-rotation-max-file-size[`quarkus.log.handler.file."file-handlers".rotation.max-file-size`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-add-runner-suffix]] [.property-path]##link:#quarkus-core_quarkus-package-jar-add-runner-suffix[`quarkus.package.jar.add-runner-suffix`]## [.description] -- -The maximum log file size, after which a rotation is executed. +Indicates whether the generated JAR file should have the runner suffix appended. Only applicable to the `JarType++#++UBER_JAR uber-JAR output type`. If disabled, the JAR built by the original build system (Maven, Gradle, etc.) will be replaced with the Quarkus-built uber-JAR. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_FILE_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_ADD_RUNNER_SUFFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_FILE_SIZE+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_ADD_RUNNER_SUFFIX+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] -|`10M` +|boolean +|`true` -a| [[quarkus-core_quarkus-log-handler-file-file-handlers-rotation-max-backup-index]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-rotation-max-backup-index[`quarkus.log.handler.file."file-handlers".rotation.max-backup-index`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-appcds-enabled]] [.property-path]##link:#quarkus-core_quarkus-package-jar-appcds-enabled[`quarkus.package.jar.appcds.enabled`]## [.description] -- -The maximum number of backups to keep. +Whether to automate the creation of AppCDS. Furthermore, this option only works for Java 11{plus} 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. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_BACKUP_INDEX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_APPCDS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_BACKUP_INDEX+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_APPCDS_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|int -|`5` +|boolean +|`false` -a| [[quarkus-core_quarkus-log-handler-file-file-handlers-rotation-file-suffix]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-rotation-file-suffix[`quarkus.log.handler.file."file-handlers".rotation.file-suffix`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-appcds-builder-image]] [.property-path]##link:#quarkus-core_quarkus-package-jar-appcds-builder-image[`quarkus.package.jar.appcds.builder-image`]## [.description] -- -The file handler rotation file suffix. When used, the file will be rotated based on its suffix. - -The suffix must be in a date-time format that is understood by `DateTimeFormatter`. - -Example fileSuffix: .yyyy-MM-dd - -Note: If the suffix ends with .zip or .gz, the rotation file will also be compressed. +When AppCDS generation is enabled, if this property is set, then the JVM used to generate the AppCDS file will be the JVM present in the container image. The builder image is expected to have the 'java' binary on its PATH. This flag is useful when the JVM to be used at runtime is not the same exact JVM version as the one used to build the jar. Note that this property is consulted only when `quarkus.package.jar.appcds.enabled=true` and it requires having docker available during the build. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_FILE_SUFFIX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_APPCDS_BUILDER_IMAGE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_FILE_SUFFIX+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_APPCDS_BUILDER_IMAGE+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-core_quarkus-log-handler-file-file-handlers-rotation-rotate-on-boot]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-rotation-rotate-on-boot[`quarkus.log.handler.file."file-handlers".rotation.rotate-on-boot`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-appcds-use-container]] [.property-path]##link:#quarkus-core_quarkus-package-jar-appcds-use-container[`quarkus.package.jar.appcds.use-container`]## [.description] -- -Indicates whether to rotate log files on server initialization. +Whether creation of the AppCDS archive should run in a container if available. -You need to either set a `max-file-size` or configure a `file-suffix` for it to work. +Normally, if either a suitable container image to use to create the AppCDS archive can be determined automatically or if one is explicitly set using the `quarkus..appcds.builder-image` setting, the AppCDS archive is generated by running the JDK contained in the image as a container. + +If this option is set to `false`, a container will not be used to generate the AppCDS archive. Instead, the JDK used to build the application is also used to create the archive. Note that the exact same JDK version must be used to run the application in this case. + +Ignored if `quarkus.package.jar.appcds.enabled` is set to `false`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_ROTATE_ON_BOOT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_APPCDS_USE_CONTAINER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_ROTATE_ON_BOOT+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_APPCDS_USE_CONTAINER+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` - -h|[[quarkus-core_section_quarkus-log-handler-syslog]] [.section-name.section-level0]##link:#quarkus-core_section_quarkus-log-handler-syslog[Syslog handlers]## -h|Type -h|Default - -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-enable]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-enable[`quarkus.log.handler.syslog."syslog-handlers".enable`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-user-providers-directory]] [.property-path]##link:#quarkus-core_quarkus-package-jar-user-providers-directory[`quarkus.package.jar.user-providers-directory`]## [.description] -- -If syslog logging should be enabled +This is an advanced option that only takes effect for development mode. + +If this is specified a directory of this name will be created in the jar distribution. Users can place jar files in this directory, and when re-augmentation is performed these will be processed and added to the class-path. + +Note that before reaugmentation has been performed these jars will be ignored, and if they are updated the app should be reaugmented again. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENABLE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_USER_PROVIDERS_DIRECTORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENABLE+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_USER_PROVIDERS_DIRECTORY+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-endpoint]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-endpoint[`quarkus.log.handler.syslog."syslog-handlers".endpoint`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-include-dependency-list]] [.property-path]##link:#quarkus-core_quarkus-package-jar-include-dependency-list[`quarkus.package.jar.include-dependency-list`]## [.description] -- -The IP address and port of the Syslog server +If this option is true then a list of all the coordinates of the artifacts that made up this image will be included in the quarkus-app directory. This list can be used by vulnerability scanners to determine if your application has any vulnerable dependencies. Only supported for the `JarType++#++FAST_JAR fast JAR` and `JarType++#++MUTABLE_JAR mutable JAR` output types. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENDPOINT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_INCLUDE_DEPENDENCY_LIST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENDPOINT+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_INCLUDE_DEPENDENCY_LIST+++` endif::add-copy-button-to-env-var[] -- -|host:port -|`localhost:514` +|boolean +|`true` -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-app-name]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-app-name[`quarkus.log.handler.syslog."syslog-handlers".app-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-decompiler-enabled]] [.property-path]##link:#quarkus-core_quarkus-package-jar-decompiler-enabled[`quarkus.package.jar.decompiler.enabled`]## [.description] -- -The app name used when formatting the message in RFC5424 format +Enable decompilation of generated and transformed bytecode into a filesystem. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__APP_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_DECOMPILER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__APP_NAME+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_DECOMPILER_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-hostname]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-hostname[`quarkus.log.handler.syslog."syslog-handlers".hostname`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-decompiler-output-directory]] [.property-path]##link:#quarkus-core_quarkus-package-jar-decompiler-output-directory[`quarkus.package.jar.decompiler.output-directory`]## [.description] -- -The name of the host the messages are being sent from +The directory into which to save the decompilation output. + +A relative path is understood as relative to the build directory. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__HOSTNAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_DECOMPILER_OUTPUT_DIRECTORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__HOSTNAME+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_DECOMPILER_OUTPUT_DIRECTORY+++` endif::add-copy-button-to-env-var[] -- |string -| +|`decompiler` -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-facility]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-facility[`quarkus.log.handler.syslog."syslog-handlers".facility`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-decompiler-jar-directory]] [.property-path]##link:#quarkus-core_quarkus-package-jar-decompiler-jar-directory[`quarkus.package.jar.decompiler.jar-directory`]## [.description] -- -Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164 +The directory into which to save the decompilation tool if it doesn't exist locally. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FACILITY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_DECOMPILER_JAR_DIRECTORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FACILITY+++` +Environment variable: `+++QUARKUS_PACKAGE_JAR_DECOMPILER_JAR_DIRECTORY+++` endif::add-copy-button-to-env-var[] -- -a|`kernel`, `user-level`, `mail-system`, `system-daemons`, `security`, `syslogd`, `line-printer`, `network-news`, `uucp`, `clock-daemon`, `security2`, `ftp-daemon`, `ntp`, `log-audit`, `log-alert`, `clock-daemon2`, `local-use-0`, `local-use-1`, `local-use-2`, `local-use-3`, `local-use-4`, `local-use-5`, `local-use-6`, `local-use-7` -|`user-level` +|string +|`${user.home}/.quarkus` -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-syslog-type]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-syslog-type[`quarkus.log.handler.syslog."syslog-handlers".syslog-type`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-main-class]] [.property-path]##link:#quarkus-core_quarkus-package-main-class[`quarkus.package.main-class`]## [.description] -- -Set the `SyslogType syslog type` this handler should use to format the message sent +The entry point of the application. This can either be a fully qualified name of a standard Java class with a main method, or `io.quarkus.runtime.QuarkusApplication`. + +If your application has main classes annotated with `io.quarkus.runtime.annotations.QuarkusMain` then this can also reference the name given in the annotation, to avoid the need to specify fully qualified names in the config. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__SYSLOG_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_MAIN_CLASS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__SYSLOG_TYPE+++` +Environment variable: `+++QUARKUS_PACKAGE_MAIN_CLASS+++` endif::add-copy-button-to-env-var[] -- -a|`rfc5424`, `rfc3164` -|`rfc5424` +|string +| -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-protocol]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-protocol[`quarkus.log.handler.syslog."syslog-handlers".protocol`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-output-directory]] [.property-path]##link:#quarkus-core_quarkus-package-output-directory[`quarkus.package.output-directory`]## [.description] -- -Sets the protocol used to connect to the Syslog server +The directory into which the output package(s) should be written. Relative paths are resolved from the build systems target directory. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__PROTOCOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_OUTPUT_DIRECTORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__PROTOCOL+++` +Environment variable: `+++QUARKUS_PACKAGE_OUTPUT_DIRECTORY+++` endif::add-copy-button-to-env-var[] -- -a|`tcp`, `udp`, `ssl-tcp` -|`tcp` +|path +| -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-use-counting-framing]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-use-counting-framing[`quarkus.log.handler.syslog."syslog-handlers".use-counting-framing`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-output-name]] [.property-path]##link:#quarkus-core_quarkus-package-output-name[`quarkus.package.output-name`]## [.description] -- -If enabled, the message being sent is prefixed with the size of the message +The name of the final artifact, excluding the suffix and file extension. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__USE_COUNTING_FRAMING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_OUTPUT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__USE_COUNTING_FRAMING+++` +Environment variable: `+++QUARKUS_PACKAGE_OUTPUT_NAME+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-truncate]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-truncate[`quarkus.log.handler.syslog."syslog-handlers".truncate`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-write-transformed-bytecode-to-build-output]] [.property-path]##link:#quarkus-core_quarkus-package-write-transformed-bytecode-to-build-output[`quarkus.package.write-transformed-bytecode-to-build-output`]## [.description] -- -Set to `true` to truncate the message if it exceeds maximum length - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__TRUNCATE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__TRUNCATE+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` +Setting this switch to `true` will cause Quarkus to write the transformed application bytecode to the build tool's output directory. This is useful for post-build tools that need to scan the application bytecode (for example, offline code-coverage tools). -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-block-on-reconnect]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-block-on-reconnect[`quarkus.log.handler.syslog."syslog-handlers".block-on-reconnect`]## +For example, if using Maven, enabling this feature will result in the classes in `target/classes` being replaced with classes that have been transformed by Quarkus. -[.description] --- -Enables or disables blocking when attempting to reconnect a `org.jboss.logmanager.handlers.SyslogHandler.Protocol++#++TCP -TCP` or `org.jboss.logmanager.handlers.SyslogHandler.Protocol++#++SSL_TCP SSL TCP` protocol +Setting this to `true`, however, should be done with a lot of caution and only if subsequent builds are done in a clean environment (i.e. the build tool's output directory has been completely cleaned). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__BLOCK_ON_RECONNECT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_WRITE_TRANSFORMED_BYTECODE_TO_BUILD_OUTPUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__BLOCK_ON_RECONNECT+++` +Environment variable: `+++QUARKUS_PACKAGE_WRITE_TRANSFORMED_BYTECODE_TO_BUILD_OUTPUT+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-format]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-format[`quarkus.log.handler.syslog."syslog-handlers".format`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-runner-suffix]] [.property-path]##link:#quarkus-core_quarkus-package-runner-suffix[`quarkus.package.runner-suffix`]## [.description] -- -The log message format +The suffix that is applied to the runner artifact's base file name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FORMAT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_RUNNER_SUFFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FORMAT+++` +Environment variable: `+++QUARKUS_PACKAGE_RUNNER_SUFFIX+++` endif::add-copy-button-to-env-var[] -- |string -|`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n` +|`-runner` -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-level]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-level[`quarkus.log.handler.syslog."syslog-handlers".level`]## +h|[.configroot-name]##Platform## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-platform-group-id]] [.property-path]##link:#quarkus-core_quarkus-platform-group-id[`quarkus.platform.group-id`]## [.description] -- -The log level specifying what message levels will be logged by the Syslog logger +groupId of the platform to use ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PLATFORM_GROUP_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__LEVEL+++` +Environment variable: `+++QUARKUS_PLATFORM_GROUP_ID+++` endif::add-copy-button-to-env-var[] -- -|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] -|`ALL` +|string +|`io.quarkus.platform` -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-filter]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-filter[`quarkus.log.handler.syslog."syslog-handlers".filter`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-platform-artifact-id]] [.property-path]##link:#quarkus-core_quarkus-platform-artifact-id[`quarkus.platform.artifact-id`]## [.description] -- -The name of the filter to link to the file handler. +artifactId of the platform to use ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FILTER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PLATFORM_ARTIFACT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FILTER+++` +Environment variable: `+++QUARKUS_PLATFORM_ARTIFACT_ID+++` endif::add-copy-button-to-env-var[] -- |string -| +|`quarkus-bom` -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-max-length]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-max-length[`quarkus.log.handler.syslog."syslog-handlers".max-length`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-platform-version]] [.property-path]##link:#quarkus-core_quarkus-platform-version[`quarkus.platform.version`]## [.description] -- -The maximum length, in bytes, of the message allowed to be sent. The length includes the header and the message. - -If not set, the default value is `2048` when `sys-log-type` is `rfc5424` (which is the default) and `1024` when `sys-log-type` is `rfc3164` +version of the platform to use ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__MAX_LENGTH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PLATFORM_VERSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__MAX_LENGTH+++` +Environment variable: `+++QUARKUS_PLATFORM_VERSION+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] -| +|string +|`999-SNAPSHOT` -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async[`quarkus.log.handler.syslog."syslog-handlers".async`]## +h|[.configroot-name]##Shutdown## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-shutdown-delay-enabled]] [.property-path]##link:#quarkus-core_quarkus-shutdown-delay-enabled[`quarkus.shutdown.delay-enabled`]## [.description] -- -Indicates whether to log asynchronously +Whether Quarkus should wait between shutdown being requested and actually initiated. This delay gives the infrastructure time to detect that the application instance is shutting down and stop routing traffic to it. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SHUTDOWN_DELAY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC+++` +Environment variable: `+++QUARKUS_SHUTDOWN_DELAY_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async-queue-length]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async-queue-length[`quarkus.log.handler.syslog."syslog-handlers".async.queue-length`]## +a| [[quarkus-core_quarkus-shutdown-timeout]] [.property-path]##link:#quarkus-core_quarkus-shutdown-timeout[`quarkus.shutdown.timeout`]## [.description] -- -The queue length to use before flushing writing +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. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_QUEUE_LENGTH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SHUTDOWN_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_QUEUE_LENGTH+++` +Environment variable: `+++QUARKUS_SHUTDOWN_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|int -|`512` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| -a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async-overflow]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async-overflow[`quarkus.log.handler.syslog."syslog-handlers".async.overflow`]## +a| [[quarkus-core_quarkus-shutdown-delay]] [.property-path]##link:#quarkus-core_quarkus-shutdown-delay[`quarkus.shutdown.delay`]## [.description] -- -Determine whether to block the publisher (rather than drop the message) when the queue is full +Delay between shutdown being requested and actually initiated. Also called the pre-shutdown phase. In pre-shutdown, the server continues working as usual, except a readiness probe starts reporting "down" (if the `smallrye-health` extension is present). This gives the infrastructure time to detect that the application instance is shutting down and stop routing traffic to it. Notice that this property will only take effect if `quarkus.shutdown.delay-enabled` is explicitly set to `true`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_OVERFLOW+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SHUTDOWN_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_OVERFLOW+++` +Environment variable: `+++QUARKUS_SHUTDOWN_DELAY+++` endif::add-copy-button-to-env-var[] -- -a|`block`, `discard` -|`block` - +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| -h|[[quarkus-core_section_quarkus-log-filter]] [.section-name.section-level0]##link:#quarkus-core_section_quarkus-log-filter[Log cleanup filters - internal use]## +h|[.configroot-name]##SnapStart## h|Type h|Default -a| [[quarkus-core_quarkus-log-filter-filters-if-starts-with]] [.property-path]##link:#quarkus-core_quarkus-log-filter-filters-if-starts-with[`quarkus.log.filter."filters".if-starts-with`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-snapstart-enable]] [.property-path]##link:#quarkus-core_quarkus-snapstart-enable[`quarkus.snapstart.enable`]## [.description] -- -The message prefix to match +Enable/Disable SnapStart integration + +Default value is dependent on extensions deployed (i.e. when using AWS Lambda extensions, this will be set to true by default) ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILTER__FILTERS__IF_STARTS_WITH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNAPSTART_ENABLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILTER__FILTERS__IF_STARTS_WITH+++` +Environment variable: `+++QUARKUS_SNAPSTART_ENABLE+++` endif::add-copy-button-to-env-var[] -- -|list of string -|`inherit` +|boolean +| -a| [[quarkus-core_quarkus-log-filter-filters-target-level]] [.property-path]##link:#quarkus-core_quarkus-log-filter-filters-target-level[`quarkus.log.filter."filters".target-level`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-snapstart-preload-classes]] [.property-path]##link:#quarkus-core_quarkus-snapstart-preload-classes[`quarkus.snapstart.preload-classes`]## [.description] -- -The new log level for the filtered message. Defaults to DEBUG. +Will do a classpath search for all `META-INF/quarkus-preload-classes.txt` files These files contain fully qualified classnames that should be loaded in the SnapStart/CRaC `beforeCheckpoint()` phase. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_FILTER__FILTERS__TARGET_LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNAPSTART_PRELOAD_CLASSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_FILTER__FILTERS__TARGET_LEVEL+++` +Environment variable: `+++QUARKUS_SNAPSTART_PRELOAD_CLASSES+++` endif::add-copy-button-to-env-var[] -- -|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level] -|`DEBUG` - +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-class-loading-parent-first-artifacts]] [.property-path]##link:#quarkus-core_quarkus-class-loading-parent-first-artifacts[`quarkus.class-loading.parent-first-artifacts`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-snapstart-initialize-classes]] [.property-path]##link:#quarkus-core_quarkus-snapstart-initialize-classes[`quarkus.snapstart.initialize-classes`]## [.description] -- -Artifacts that are loaded in a parent first manner. This can be used to work around issues where a given class needs to be loaded by the system ClassLoader. Note that if you make a library parent first all its dependencies should generally also be parent first. - -Artifacts should be configured as a comma separated list of artifact ids, with the group, artifact-id and optional classifier separated by a colon. - -WARNING: This config property can only be set in application.properties +if preloading classes, specify whether to do static initialization when preloading these classes. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLASS_LOADING_PARENT_FIRST_ARTIFACTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNAPSTART_INITIALIZE_CLASSES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLASS_LOADING_PARENT_FIRST_ARTIFACTS+++` +Environment variable: `+++QUARKUS_SNAPSTART_INITIALIZE_CLASSES+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-class-loading-reloadable-artifacts]] [.property-path]##link:#quarkus-core_quarkus-class-loading-reloadable-artifacts[`quarkus.class-loading.reloadable-artifacts`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-snapstart-full-warmup]] [.property-path]##link:#quarkus-core_quarkus-snapstart-full-warmup[`quarkus.snapstart.full-warmup`]## [.description] -- -Artifacts that are loaded in the runtime ClassLoader in dev mode, so they will be dropped and recreated on change. - -This is an advanced option, it should only be used if you have a problem with libraries holding stale state between reloads. Note that if you use this any library that depends on the listed libraries will also need to be reloadable. - -This setting has no impact on production builds. - -Artifacts should be configured as a comma separated list of artifact ids, with the group, artifact-id and optional classifier separated by a colon. - -WARNING: This config property can only be set in application.properties +Start the full application during the snapshotting process. In other words, when enabled, it performs `Application.start()` within SnapStart/CRaC `beforeCheckpoint()` phase. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLASS_LOADING_RELOADABLE_ARTIFACTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNAPSTART_FULL_WARMUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLASS_LOADING_RELOADABLE_ARTIFACTS+++` +Environment variable: `+++QUARKUS_SNAPSTART_FULL_WARMUP+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-class-loading-removed-artifacts]] [.property-path]##link:#quarkus-core_quarkus-class-loading-removed-artifacts[`quarkus.class-loading.removed-artifacts`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-snapstart-generate-application-class-list]] [.property-path]##link:#quarkus-core_quarkus-snapstart-generate-application-class-list[`quarkus.snapstart.generate-application-class-list`]## [.description] -- -Artifacts that will never be loaded by the class loader, and will not be packed into the final application. This allows you to explicitly remove artifacts from your application even though they may be present on the class path. +When SnapStart is enabled, it generates the application class list, so it can be preloaded. Only used if `preload-classes` is set to `true`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLASS_LOADING_REMOVED_ARTIFACTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNAPSTART_GENERATE_APPLICATION_CLASS_LIST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLASS_LOADING_REMOVED_ARTIFACTS+++` +Environment variable: `+++QUARKUS_SNAPSTART_GENERATE_APPLICATION_CLASS_LIST+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-class-loading-removed-resources-group-id-artifact-id]] [.property-path]##link:#quarkus-core_quarkus-class-loading-removed-resources-group-id-artifact-id[`quarkus.class-loading.removed-resources."group-id:artifact-id"`]## +h|[.configroot-name]##SSL## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-ssl-native]] [.property-path]##link:#quarkus-core_quarkus-ssl-native[`quarkus.ssl.native`]## [.description] -- -Resources that should be removed/hidden from dependencies. - -This allows for classes and other resources to be removed from dependencies, so they are not accessible to the application. This is a map of artifact id (in the form group:artifact) to a list of resources to be removed. - -When running in dev and test mode these resources are hidden from the ClassLoader, when running in production mode these files are removed from the jars that contain them. - -Note that if you want to remove a class you need to specify the class file name. e.g. to remove `com.acme.Foo` you would specify `com/acme/Foo.class`. - -Note that for technical reasons this is not supported when running with JBang. +Enable native SSL support. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLASS_LOADING_REMOVED_RESOURCES__GROUP_ID_ARTIFACT_ID_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSL_NATIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLASS_LOADING_REMOVED_RESOURCES__GROUP_ID_ARTIFACT_ID_+++` +Environment variable: `+++QUARKUS_SSL_NATIVE+++` endif::add-copy-button-to-env-var[] -- -|Map> +|boolean | -a| [[quarkus-core_quarkus-profile]] [.property-path]##link:#quarkus-core_quarkus-profile[`quarkus.profile`]## +h|[.configroot-name]##Testing## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-continuous-testing]] [.property-path]##link:#quarkus-core_quarkus-test-continuous-testing[`quarkus.test.continuous-testing`]## [.description] -- -A comma separated list of profiles that will be active when Quarkus launches. +If continuous testing is enabled. The default value is 'paused', which will allow you to start testing from the console or the Dev UI, but will not run tests on startup. If this is set to 'enabled' then testing will start as soon as the application has started. If this is 'disabled' then continuous testing is not enabled, and can't be enabled without restarting the application. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PROFILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_CONTINUOUS_TESTING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PROFILE+++` +Environment variable: `+++QUARKUS_TEST_CONTINUOUS_TESTING+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +a|`paused`, `enabled`, `disabled` +|`paused` -a| [[quarkus-core_quarkus-config-profile-parent]] [.property-path]##link:#quarkus-core_quarkus-config-profile-parent[`quarkus.config.profile.parent`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-display-test-output]] [.property-path]##link:#quarkus-core_quarkus-test-display-test-output[`quarkus.test.display-test-output`]## [.description] -- -Accepts a single configuration profile name. If a configuration property cannot be found in the current active profile, the config performs the same lookup in the profile set by this configuration. +If output from the running tests should be displayed in the console. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_PROFILE_PARENT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_DISPLAY_TEST_OUTPUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_PROFILE_PARENT+++` +Environment variable: `+++QUARKUS_TEST_DISPLAY_TEST_OUTPUT+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a| [[quarkus-core_quarkus-config-locations]] [.property-path]##link:#quarkus-core_quarkus-config-locations[`quarkus.config.locations`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-include-tags]] [.property-path]##link:#quarkus-core_quarkus-test-include-tags[`quarkus.test.include-tags`]## [.description] -- -Additional config locations to be loaded with the Config. The configuration support multiple locations separated by a comma and each must represent a valid `java.net.URI`. +Tags that should be included for continuous testing. This supports JUnit Tag Expressions. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_LOCATIONS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_INCLUDE_TAGS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_LOCATIONS+++` +Environment variable: `+++QUARKUS_TEST_INCLUDE_TAGS+++` endif::add-copy-button-to-env-var[] -- -|list of link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +|list of string | -a| [[quarkus-core_quarkus-config-mapping-validate-unknown]] [.property-path]##link:#quarkus-core_quarkus-config-mapping-validate-unknown[`quarkus.config.mapping.validate-unknown`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-exclude-tags]] [.property-path]##link:#quarkus-core_quarkus-test-exclude-tags[`quarkus.test.exclude-tags`]## [.description] -- -Validates that a `@ConfigMapping` maps every available configuration name contained in the mapping prefix. +Tags that should be excluded by default with continuous testing. This is ignored if include-tags has been set. Defaults to 'slow'. This supports JUnit Tag Expressions. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_MAPPING_VALIDATE_UNKNOWN+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_EXCLUDE_TAGS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_MAPPING_VALIDATE_UNKNOWN+++` +Environment variable: `+++QUARKUS_TEST_EXCLUDE_TAGS+++` endif::add-copy-button-to-env-var[] -- -|boolean -| +|list of string +|`slow` -a| [[quarkus-core_quarkus-config-log-values]] [.property-path]##link:#quarkus-core_quarkus-config-log-values[`quarkus.config.log.values`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-include-pattern]] [.property-path]##link:#quarkus-core_quarkus-test-include-pattern[`quarkus.test.include-pattern`]## [.description] -- -Enable logging of configuration values lookup in DEBUG log level. + -The log of configuration values require the category set to `DEBUG` in the `io.smallrye.config` category: `quarkus.log.category."io.smallrye.config".level=DEBUG`. +Tests that should be included for continuous testing. This is a regular expression and is matched against the test class name (not the file name). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_LOG_VALUES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_INCLUDE_PATTERN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_LOG_VALUES+++` +Environment variable: `+++QUARKUS_TEST_INCLUDE_PATTERN+++` endif::add-copy-button-to-env-var[] -- -|boolean +|string | -a| [[quarkus-core_quarkus-uuid]] [.property-path]##link:#quarkus-core_quarkus-uuid[`quarkus.uuid`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-exclude-pattern]] [.property-path]##link:#quarkus-core_quarkus-test-exclude-pattern[`quarkus.test.exclude-pattern`]## [.description] -- -A property that allows accessing a generated UUID. It generates that UUID at startup time. So it changes between two starts including in dev mode. + -Access this generated UUID using expressions: `$++{++quarkus.uuid++}++`. +Tests that should be excluded with continuous testing. This is a regular expression and is matched against the test class name (not the file name). This is ignored if include-pattern has been set. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_UUID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_EXCLUDE_PATTERN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_UUID+++` +Environment variable: `+++QUARKUS_TEST_EXCLUDE_PATTERN+++` endif::add-copy-button-to-env-var[] -- |string -| +|`.*\.IT[^.]+\|.*IT\|.*ITCase` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-shutdown-delay-enabled]] [.property-path]##link:#quarkus-core_quarkus-shutdown-delay-enabled[`quarkus.shutdown.delay-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-include-engines]] [.property-path]##link:#quarkus-core_quarkus-test-include-engines[`quarkus.test.include-engines`]## [.description] -- -Whether Quarkus should wait between shutdown being requested and actually initiated. This delay gives the infrastructure time to detect that the application instance is shutting down and stop routing traffic to it. +Test engine ids that should be included for continuous testing. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SHUTDOWN_DELAY_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_INCLUDE_ENGINES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SHUTDOWN_DELAY_ENABLED+++` +Environment variable: `+++QUARKUS_TEST_INCLUDE_ENGINES+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|list of string +| -a| [[quarkus-core_quarkus-shutdown-timeout]] [.property-path]##link:#quarkus-core_quarkus-shutdown-timeout[`quarkus.shutdown.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-exclude-engines]] [.property-path]##link:#quarkus-core_quarkus-test-exclude-engines[`quarkus.test.exclude-engines`]## [.description] -- -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. +Test engine ids that should be excluded by default with continuous testing. This is ignored if include-engines has been set. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SHUTDOWN_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_EXCLUDE_ENGINES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SHUTDOWN_TIMEOUT+++` +Environment variable: `+++QUARKUS_TEST_EXCLUDE_ENGINES+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|list of string | -a| [[quarkus-core_quarkus-shutdown-delay]] [.property-path]##link:#quarkus-core_quarkus-shutdown-delay[`quarkus.shutdown.delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-flat-class-path]] [.property-path]##link:#quarkus-core_quarkus-test-flat-class-path[`quarkus.test.flat-class-path`]## [.description] -- -Delay between shutdown being requested and actually initiated. Also called the pre-shutdown phase. In pre-shutdown, the server continues working as usual, except a readiness probe starts reporting "down" (if the `smallrye-health` extension is present). This gives the infrastructure time to detect that the application instance is shutting down and stop routing traffic to it. Notice that this property will only take effect if `quarkus.shutdown.delay-enabled` is explicitly set to `true`. +Changes tests to use the 'flat' ClassPath used in Quarkus 1.x versions. This means all Quarkus and test classes are loaded in the same ClassLoader, however it means you cannot use continuous testing. Note that if you find this necessary for your application then you may also have problems running in development mode, which cannot use a flat class path. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SHUTDOWN_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_FLAT_CLASS_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SHUTDOWN_DELAY+++` +Environment variable: `+++QUARKUS_TEST_FLAT_CLASS_PATH+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-banner-path]] [.property-path]##link:#quarkus-core_quarkus-banner-path[`quarkus.banner.path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-native-image-profile]] [.property-path]##link:#quarkus-core_quarkus-test-native-image-profile[`quarkus.test.native-image-profile`]## [.description] -- -The path of the banner (path relative to root of classpath) which could be provided by user +The profile to use when testing the native image ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_BANNER_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_NATIVE_IMAGE_PROFILE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_BANNER_PATH+++` +Environment variable: `+++QUARKUS_TEST_NATIVE_IMAGE_PROFILE+++` endif::add-copy-button-to-env-var[] -- |string -|`default_banner.txt` +|`prod` -a| [[quarkus-core_quarkus-banner-enabled]] [.property-path]##link:#quarkus-core_quarkus-banner-enabled[`quarkus.banner.enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-integration-test-profile]] [.property-path]##link:#quarkus-core_quarkus-test-integration-test-profile[`quarkus.test.integration-test-profile`]## [.description] -- -Whether the banner will be displayed +The profile to use when testing using `@QuarkusIntegrationTest` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_BANNER_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_INTEGRATION_TEST_PROFILE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_BANNER_ENABLED+++` +Environment variable: `+++QUARKUS_TEST_INTEGRATION_TEST_PROFILE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +|`prod` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-ssl-native]] [.property-path]##link:#quarkus-core_quarkus-ssl-native[`quarkus.ssl.native`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-profile]] [.property-path]##link:#quarkus-core_quarkus-test-profile[`quarkus.test.profile`]## [.description] -- -Enable native SSL support. +A comma separated list of profiles (dev, test, prod or custom profiles) to use when testing using @QuarkusTest ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SSL_NATIVE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_PROFILE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SSL_NATIVE+++` +Environment variable: `+++QUARKUS_TEST_PROFILE+++` endif::add-copy-button-to-env-var[] -- -|boolean -| +|list of string +|`test` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-console-enabled]] [.property-path]##link:#quarkus-core_quarkus-console-enabled[`quarkus.console.enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-profile-tags]] [.property-path]##link:#quarkus-core_quarkus-test-profile-tags[`quarkus.test.profile.tags`]## [.description] -- -If test results and status should be displayed in the console. - -If this is false results can still be viewed in the dev console. +The tags this profile is associated with. When the `quarkus.test.profile.tags` System property is set (its value is a comma separated list of strings) then Quarkus will only execute tests that are annotated with a `@TestProfile` that has at least one of the supplied (via the aforementioned system property) tags. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONSOLE_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_PROFILE_TAGS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONSOLE_ENABLED+++` +Environment variable: `+++QUARKUS_TEST_PROFILE_TAGS+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|list of string +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-console-disable-input]] [.property-path]##link:#quarkus-core_quarkus-console-disable-input[`quarkus.console.disable-input`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-container-network]] [.property-path]##link:#quarkus-core_quarkus-test-container-network[`quarkus.test.container.network`]## [.description] -- -Disables the ability to enter input on the console. +Controls the container network to be used when @QuarkusIntegration needs to launch the application in a container. This setting only applies if Quarkus does not need to use a shared network - which is the case if DevServices are used when running the test. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONSOLE_DISABLE_INPUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_CONTAINER_NETWORK+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONSOLE_DISABLE_INPUT+++` +Environment variable: `+++QUARKUS_TEST_CONTAINER_NETWORK+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-console-basic]] [.property-path]##link:#quarkus-core_quarkus-console-basic[`quarkus.console.basic`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-container-additional-exposed-ports-host-port]] [.property-path]##link:#quarkus-core_quarkus-test-container-additional-exposed-ports-host-port[`quarkus.test.container.additional-exposed-ports."host-port"`]## [.description] -- -Disable the testing status/prompt message at the bottom of the console and log these messages to STDOUT instead. - -Use this option if your terminal does not support ANSI escape sequences. +Set additional ports to be exposed when @QuarkusIntegration needs to launch the application in a container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONSOLE_BASIC+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_CONTAINER_ADDITIONAL_EXPOSED_PORTS__HOST_PORT_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONSOLE_BASIC+++` +Environment variable: `+++QUARKUS_TEST_CONTAINER_ADDITIONAL_EXPOSED_PORTS__HOST_PORT_+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|Map +| -a| [[quarkus-core_quarkus-console-color]] [.property-path]##link:#quarkus-core_quarkus-console-color[`quarkus.console.color`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-container-labels-label-name]] [.property-path]##link:#quarkus-core_quarkus-test-container-labels-label-name[`quarkus.test.container.labels."label-name"`]## [.description] -- -If color should be enabled or disabled. If this is not present then an attempt will be made to guess if the terminal supports color +A set of labels to add to the launched container ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONSOLE_COLOR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_CONTAINER_LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONSOLE_COLOR+++` +Environment variable: `+++QUARKUS_TEST_CONTAINER_LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|boolean +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-debug-reflection]] [.property-path]##link:#quarkus-core_quarkus-debug-reflection[`quarkus.debug.reflection`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-container-volume-mounts-host-path]] [.property-path]##link:#quarkus-core_quarkus-test-container-volume-mounts-host-path[`quarkus.test.container.volume-mounts."host-path"`]## [.description] -- -If set to true, writes a list of all reflective classes to META-INF +A set of volume mounts to add to the launched container ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DEBUG_REFLECTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_CONTAINER_VOLUME_MOUNTS__HOST_PATH_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DEBUG_REFLECTION+++` +Environment variable: `+++QUARKUS_TEST_CONTAINER_VOLUME_MOUNTS__HOST_PATH_+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|Map +| -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-debug-generated-classes-dir]] [.property-path]##link:#quarkus-core_quarkus-debug-generated-classes-dir[`quarkus.debug.generated-classes-dir`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-arg-line]] [.property-path]##link:#quarkus-core_quarkus-test-arg-line[`quarkus.test.arg-line`]## [.description] -- -If set to a directory, all generated classes will be written into that directory +Additional launch parameters to be used when Quarkus launches the produced artifact for `@QuarkusIntegrationTest` When the artifact is a `jar`, this string is passed right after the `java` command. When the artifact is a `container`, this string is passed right after the `docker run` command. When the artifact is a `native binary`, this string is passed right after the native binary name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DEBUG_GENERATED_CLASSES_DIR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_ARG_LINE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DEBUG_GENERATED_CLASSES_DIR+++` +Environment variable: `+++QUARKUS_TEST_ARG_LINE+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-debug-transformed-classes-dir]] [.property-path]##link:#quarkus-core_quarkus-debug-transformed-classes-dir[`quarkus.debug.transformed-classes-dir`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-env-environment-variable-name]] [.property-path]##link:#quarkus-core_quarkus-test-env-environment-variable-name[`quarkus.test.env."environment-variable-name"`]## [.description] -- -If set to a directory, all transformed classes (e.g. Panache entities) will be written into that directory +Additional environment variables to be set in the process that `@QuarkusIntegrationTest` launches. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DEBUG_TRANSFORMED_CLASSES_DIR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_ENV__ENVIRONMENT_VARIABLE_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DEBUG_TRANSFORMED_CLASSES_DIR+++` +Environment variable: `+++QUARKUS_TEST_ENV__ENVIRONMENT_VARIABLE_NAME_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-debug-generated-sources-dir]] [.property-path]##link:#quarkus-core_quarkus-debug-generated-sources-dir[`quarkus.debug.generated-sources-dir`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-wait-time]] [.property-path]##link:#quarkus-core_quarkus-test-wait-time[`quarkus.test.wait-time`]## [.description] -- -If set to a directory, ZIG files for generated code will be written into that directory. - -A ZIG file is a textual representation of the generated code that is referenced in the stacktraces. +Used in `@QuarkusIntegrationTest` to determine how long the test will wait for the application to launch ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DEBUG_GENERATED_SOURCES_DIR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_WAIT_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DEBUG_GENERATED_SOURCES_DIR+++` +Environment variable: `+++QUARKUS_TEST_WAIT_TIME+++` endif::add-copy-button-to-env-var[] -- -|string -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`PT1M` -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-debug-dump-build-metrics]] [.property-path]##link:#quarkus-core_quarkus-debug-dump-build-metrics[`quarkus.debug.dump-build-metrics`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-hang-detection-timeout]] [.property-path]##link:#quarkus-core_quarkus-test-hang-detection-timeout[`quarkus.test.hang-detection-timeout`]## [.description] -- -If set to true then dump the build metrics to a JSON file in the build directory. +Configures the hang detection in @QuarkusTest. If no activity happens (i.e. no test callbacks are called) over this period then QuarkusTest will dump all threads stack traces, to help diagnose a potential hang. Note that the initial timeout (before Quarkus has started) will only apply if provided by a system property, as it is not possible to read all config sources until Quarkus has booted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DEBUG_DUMP_BUILD_METRICS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_HANG_DETECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DEBUG_DUMP_BUILD_METRICS+++` +Environment variable: `+++QUARKUS_TEST_HANG_DETECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10M` -a| [[quarkus-core_quarkus-debug-print-startup-times]] [.property-path]##link:#quarkus-core_quarkus-debug-print-startup-times[`quarkus.debug.print-startup-times`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-type]] [.property-path]##link:#quarkus-core_quarkus-test-type[`quarkus.test.type`]## [.description] -- -If set to `true`, Quarkus prints the wall-clock time each build step took to complete. This is useful as a first step in debugging slow startup times. +The type of test to run, this can be either: quarkus-test: Only runs `@QuarkusTest` annotated test classes unit: Only runs classes that are not annotated with `@QuarkusTest` all: Runs both, running the unit tests first ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DEBUG_PRINT_STARTUP_TIMES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DEBUG_PRINT_STARTUP_TIMES+++` +Environment variable: `+++QUARKUS_TEST_TYPE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` - - -h|[.extension-name]##CycloneDX## -h|Type -h|Default +a|`unit`, `quarkus-test`, `all` +|`all` -a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-skip]] [.property-path]##link:#quarkus-cyclonedx_quarkus-cyclonedx-skip[`quarkus.cyclonedx.skip`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-only-test-application-module]] [.property-path]##link:#quarkus-core_quarkus-test-only-test-application-module[`quarkus.test.only-test-application-module`]## [.description] -- -Whether to skip SBOM generation +If this is true then only the tests from the main application module will be run (i.e. the module that is currently running mvn quarkus:dev). If this is false then tests from all dependency modules will be run as well. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_SKIP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_ONLY_TEST_APPLICATION_MODULE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CYCLONEDX_SKIP+++` +Environment variable: `+++QUARKUS_TEST_ONLY_TEST_APPLICATION_MODULE+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-format]] [.property-path]##link:#quarkus-cyclonedx_quarkus-cyclonedx-format[`quarkus.cyclonedx.format`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-include-module-pattern]] [.property-path]##link:#quarkus-core_quarkus-test-include-module-pattern[`quarkus.test.include-module-pattern`]## [.description] -- -SBOM file format. Supported formats are ++{++code json++}++ and ++{++code xml++}++. The default format is JSON. If both are desired then `all` could be used as the value of this option. +Modules that should be included for continuous testing. This is a regular expression and is matched against the module groupId:artifactId. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_FORMAT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_INCLUDE_MODULE_PATTERN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CYCLONEDX_FORMAT+++` +Environment variable: `+++QUARKUS_TEST_INCLUDE_MODULE_PATTERN+++` endif::add-copy-button-to-env-var[] -- |string -|`json` +| -a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-schema-version]] [.property-path]##link:#quarkus-cyclonedx_quarkus-cyclonedx-schema-version[`quarkus.cyclonedx.schema-version`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-exclude-module-pattern]] [.property-path]##link:#quarkus-core_quarkus-test-exclude-module-pattern[`quarkus.test.exclude-module-pattern`]## [.description] -- -CycloneDX specification version. The default value be the latest supported by the integrated CycloneDX library. +Modules that should be excluded for continuous testing. This is a regular expression and is matched against the module groupId:artifactId. This is ignored if include-module-pattern has been set. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_EXCLUDE_MODULE_PATTERN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++` +Environment variable: `+++QUARKUS_TEST_EXCLUDE_MODULE_PATTERN+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-include-license-text]] [.property-path]##link:#quarkus-cyclonedx_quarkus-cyclonedx-include-license-text[`quarkus.cyclonedx.include-license-text`]## +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-enable-callbacks-for-integration-tests]] [.property-path]##link:#quarkus-core_quarkus-test-enable-callbacks-for-integration-tests[`quarkus.test.enable-callbacks-for-integration-tests`]## [.description] -- -Whether to include the license text into generated SBOMs. +If the test callbacks should be invoked for the integration tests (tests annotated with `@QuarkusIntegrationTest`). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_INCLUDE_LICENSE_TEXT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_TEST_ENABLE_CALLBACKS_FOR_INTEGRATION_TESTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CYCLONEDX_INCLUDE_LICENSE_TEXT+++` +Environment variable: `+++QUARKUS_TEST_ENABLE_CALLBACKS_FOR_INTEGRATION_TESTS+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` - -h|[.extension-name]##Datasources## +h|[.configroot-name]##Core thread pool## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-datasource_quarkus-datasource-health-enabled]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-health-enabled[`quarkus.datasource.health.enabled`]## +a| [[quarkus-core_quarkus-thread-pool-core-threads]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-core-threads[`quarkus.thread-pool.core-threads`]## [.description] -- -Whether or not a health check is published in case the smallrye-health extension is present. - -This is a global setting and is not specific to a datasource. +The core thread pool size. This number of threads will always be kept alive. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_HEALTH_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_CORE_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_HEALTH_ENABLED+++` +Environment variable: `+++QUARKUS_THREAD_POOL_CORE_THREADS+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|int +|`1` -a|icon:lock[title=Fixed at build time] [[quarkus-datasource_quarkus-datasource-metrics-enabled]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-metrics-enabled[`quarkus.datasource.metrics.enabled`]## +a| [[quarkus-core_quarkus-thread-pool-prefill]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-prefill[`quarkus.thread-pool.prefill`]## [.description] -- -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. +Prefill core thread pool. The core thread pool will be initialised with the core number of threads at startup ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_METRICS_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_PREFILL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_METRICS_ENABLED+++` +Environment variable: `+++QUARKUS_THREAD_POOL_PREFILL+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-datasource_quarkus-datasource-db-kind]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-db-kind[`quarkus.datasource.db-kind`]## +|`true` -`quarkus.datasource."datasource-name".db-kind` +a| [[quarkus-core_quarkus-thread-pool-max-threads]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-max-threads[`quarkus.thread-pool.max-threads`]## [.description] -- -The kind of database we will connect to (e.g. h2, postgresql...). +The maximum number of threads. If this is not specified then it will be automatically sized to the greatest of 8 ++*++ the number of available processors and 200. For example if there are 4 processors the max threads will be 200. If there are 48 processors it will be 384. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DB_KIND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_MAX_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_DB_KIND+++` +Environment variable: `+++QUARKUS_THREAD_POOL_MAX_THREADS+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-datasource_quarkus-datasource-db-version]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-db-version[`quarkus.datasource.db-version`]## - -`quarkus.datasource."datasource-name".db-version` +a| [[quarkus-core_quarkus-thread-pool-queue-size]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-queue-size[`quarkus.thread-pool.queue-size`]## [.description] -- -The version of the database we will connect to (e.g. '10.0'). - -CAUTION: The version number set here should follow the same numbering scheme -as the string returned by `java.sql.DatabaseMetaData#getDatabaseProductVersion()` -for your database's JDBC driver. -This numbering scheme may be different from the most popular one for your database; -for example Microsoft SQL Server 2016 would be version `13`. - -As a rule, the version set here should be as high as possible, -but must be lower than or equal to the version of any database your application will connect to. - -A high version will allow better performance and using more features -(e.g. Hibernate ORM may generate more efficient SQL, -avoid workarounds and take advantage of more database features), -but if it is higher than the version of the database you want to connect to, -it may lead to runtime exceptions -(e.g. Hibernate ORM may generate invalid SQL that your database will reject). - -Some extensions (like the Hibernate ORM extension) -will try to check this version against the actual database version on startup, -leading to a startup failure when the actual version is lower -or simply a warning in case the database cannot be reached. - -The default for this property is specific to each extension; -the Hibernate ORM extension will default to the oldest version it supports. +The queue size. For most applications this should be unbounded ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DB_VERSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_QUEUE_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_DB_VERSION+++` +Environment variable: `+++QUARKUS_THREAD_POOL_QUEUE_SIZE+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-datasource_quarkus-datasource-health-exclude]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-health-exclude[`quarkus.datasource.health-exclude`]## - -`quarkus.datasource."datasource-name".health-exclude` +a| [[quarkus-core_quarkus-thread-pool-growth-resistance]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-growth-resistance[`quarkus.thread-pool.growth-resistance`]## [.description] -- -Whether this particular data source should be excluded from the health check if the general health check for data sources is enabled. - -By default, the health check includes all configured data sources (if it is enabled). +The executor growth resistance. A resistance factor applied after the core pool is full; values applied here will cause that fraction of submissions to create new threads when no idle thread is available. A value of `0.0f` implies that threads beyond the core size should be created as aggressively as threads within it; a value of `1.0f` implies that threads beyond the core size should never be created. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_HEALTH_EXCLUDE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_GROWTH_RESISTANCE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_HEALTH_EXCLUDE+++` +Environment variable: `+++QUARKUS_THREAD_POOL_GROWTH_RESISTANCE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` - -a| [[quarkus-datasource_quarkus-datasource-active]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-active[`quarkus.datasource.active`]## +|float +|`0f` -`quarkus.datasource."datasource-name".active` +a| [[quarkus-core_quarkus-thread-pool-shutdown-timeout]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-shutdown-timeout[`quarkus.thread-pool.shutdown-timeout`]## [.description] -- -Whether this datasource should be active at runtime. - -See xref:datasource.adoc#datasource-active[this section of the documentation]. - -If the datasource is not active, it won't start with the application, -and accessing the corresponding Datasource CDI bean will fail, -meaning in particular that consumers of this datasource -(e.g. Hibernate ORM persistence units) will fail to start unless they are inactive too. +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 ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_ACTIVE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_SHUTDOWN_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_ACTIVE+++` +Environment variable: `+++QUARKUS_THREAD_POOL_SHUTDOWN_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`1M` -a| [[quarkus-datasource_quarkus-datasource-username]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-username[`quarkus.datasource.username`]## +a| [[quarkus-core_quarkus-thread-pool-shutdown-interrupt]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-shutdown-interrupt[`quarkus.thread-pool.shutdown-interrupt`]## -`quarkus.datasource."datasource-name".username` +[.description] +-- +The amount of time to wait for thread pool shutdown before tasks should be interrupted. If this value is greater than or equal to the value for `shutdown-timeout`, then tasks will not be interrupted before the shutdown timeout occurs. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_SHUTDOWN_INTERRUPT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_THREAD_POOL_SHUTDOWN_INTERRUPT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-core_quarkus-thread-pool-shutdown-check-interval]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-shutdown-check-interval[`quarkus.thread-pool.shutdown-check-interval`]## + +[.description] +-- +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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_SHUTDOWN_CHECK_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_THREAD_POOL_SHUTDOWN_CHECK_INTERVAL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-core_quarkus-thread-pool-keep-alive-time]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-keep-alive-time[`quarkus.thread-pool.keep-alive-time`]## + +[.description] +-- +The amount of time a thread will stay alive with no work. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_THREAD_POOL_KEEP_ALIVE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_THREAD_POOL_KEEP_ALIVE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`30S` + + +h|[.extension-name]##CycloneDX## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-skip]] [.property-path]##link:#quarkus-cyclonedx_quarkus-cyclonedx-skip[`quarkus.cyclonedx.skip`]## + +[.description] +-- +Whether to skip SBOM generation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_SKIP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CYCLONEDX_SKIP+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-format]] [.property-path]##link:#quarkus-cyclonedx_quarkus-cyclonedx-format[`quarkus.cyclonedx.format`]## + +[.description] +-- +SBOM file format. Supported formats are ++{++code json++}++ and ++{++code xml++}++. The default format is JSON. If both are desired then `all` could be used as the value of this option. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_FORMAT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CYCLONEDX_FORMAT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`json` + +a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-schema-version]] [.property-path]##link:#quarkus-cyclonedx_quarkus-cyclonedx-schema-version[`quarkus.cyclonedx.schema-version`]## + +[.description] +-- +CycloneDX specification version. The default value be the latest supported by the integrated CycloneDX library. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CYCLONEDX_SCHEMA_VERSION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-cyclonedx_quarkus-cyclonedx-include-license-text]] [.property-path]##link:#quarkus-cyclonedx_quarkus-cyclonedx-include-license-text[`quarkus.cyclonedx.include-license-text`]## + +[.description] +-- +Whether to include the license text into generated SBOMs. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CYCLONEDX_INCLUDE_LICENSE_TEXT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CYCLONEDX_INCLUDE_LICENSE_TEXT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + + +h|[.extension-name]##Datasources## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-datasource_quarkus-datasource-health-enabled]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-health-enabled[`quarkus.datasource.health.enabled`]## + +[.description] +-- +Whether or not a health check is published in case the smallrye-health extension is present. + +This is a global setting and is not specific to a datasource. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_HEALTH_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DATASOURCE_HEALTH_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-datasource_quarkus-datasource-metrics-enabled]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-metrics-enabled[`quarkus.datasource.metrics.enabled`]## + +[.description] +-- +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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_METRICS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DATASOURCE_METRICS_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-datasource_quarkus-datasource-db-kind]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-db-kind[`quarkus.datasource.db-kind`]## + +`quarkus.datasource."datasource-name".db-kind` + +[.description] +-- +The kind of database we will connect to (e.g. h2, postgresql...). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DB_KIND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DATASOURCE_DB_KIND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-datasource_quarkus-datasource-db-version]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-db-version[`quarkus.datasource.db-version`]## + +`quarkus.datasource."datasource-name".db-version` + +[.description] +-- +The version of the database we will connect to (e.g. '10.0'). + +CAUTION: The version number set here should follow the same numbering scheme +as the string returned by `java.sql.DatabaseMetaData#getDatabaseProductVersion()` +for your database's JDBC driver. +This numbering scheme may be different from the most popular one for your database; +for example Microsoft SQL Server 2016 would be version `13`. + +As a rule, the version set here should be as high as possible, +but must be lower than or equal to the version of any database your application will connect to. + +A high version will allow better performance and using more features +(e.g. Hibernate ORM may generate more efficient SQL, +avoid workarounds and take advantage of more database features), +but if it is higher than the version of the database you want to connect to, +it may lead to runtime exceptions +(e.g. Hibernate ORM may generate invalid SQL that your database will reject). + +Some extensions (like the Hibernate ORM extension) +will try to check this version against the actual database version on startup, +leading to a startup failure when the actual version is lower +or simply a warning in case the database cannot be reached. + +The default for this property is specific to each extension; +the Hibernate ORM extension will default to the oldest version it supports. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DB_VERSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DATASOURCE_DB_VERSION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-datasource_quarkus-datasource-health-exclude]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-health-exclude[`quarkus.datasource.health-exclude`]## + +`quarkus.datasource."datasource-name".health-exclude` + +[.description] +-- +Whether this particular data source should be excluded from the health check if the general health check for data sources is enabled. + +By default, the health check includes all configured data sources (if it is enabled). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_HEALTH_EXCLUDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DATASOURCE_HEALTH_EXCLUDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-datasource_quarkus-datasource-active]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-active[`quarkus.datasource.active`]## + +`quarkus.datasource."datasource-name".active` + +[.description] +-- +Whether this datasource should be active at runtime. + +See xref:datasource.adoc#datasource-active[this section of the documentation]. + +If the datasource is not active, it won't start with the application, +and accessing the corresponding Datasource CDI bean will fail, +meaning in particular that consumers of this datasource +(e.g. Hibernate ORM persistence units) will fail to start unless they are inactive too. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_ACTIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DATASOURCE_ACTIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-datasource_quarkus-datasource-username]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-username[`quarkus.datasource.username`]## + +`quarkus.datasource."datasource-name".username` [.description] -- @@ -8666,394 +8815,858 @@ endif::add-copy-button-to-env-var[] -h|[.extension-name]##Eclipse Vert.x - HTTP## +h|[.extension-name]##DevServices - Keycloak## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-root-path]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-root-path[`quarkus.http.root-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-enabled]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-enabled[`quarkus.keycloak.devservices.enabled`]## [.description] -- -The HTTP root path. All web content will be served relative to this root path. +Flag to enable (default) or disable Dev Services. When enabled, Dev Services for Keycloak automatically configures and starts Keycloak in Dev or Test mode, and when Docker is running. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_ROOT_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_ROOT_PATH+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -|`/` +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-auth-basic]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-basic[`quarkus.http.auth.basic`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-image-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-image-name[`quarkus.keycloak.devservices.image-name`]## [.description] -- -If basic auth should be enabled. If both basic and form auth is enabled then basic auth will be enabled in silent mode. The basic auth is enabled by default if no authentication mechanisms are configured or Quarkus can safely determine that basic authentication is required. +The container image name for Dev Services providers. Defaults to a Quarkus-based Keycloak image. For a WildFly-based distribution, use an image like `quay.io/keycloak/keycloak:19.0.3-legacy`. Keycloak Quarkus and WildFly images are initialized differently. Dev Services for Keycloak will assume it is a Keycloak Quarkus image unless the image version ends with `-legacy`. Override with `quarkus.keycloak.devservices.keycloak-x-image`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_BASIC+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_AUTH_BASIC+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] -- -|boolean -| +|string +|`quay.io/keycloak/keycloak:25.0.6` -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-auth-form-enabled]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-form-enabled[`quarkus.http.auth.form.enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]## [.description] -- -If form authentication is enabled. +Indicates if a Keycloak-X image is used. By default, the image is identified by `keycloak-x` in the image name. For custom images, override with `quarkus.keycloak.devservices.keycloak-x-image`. You do not need to set this property if the default check works. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_FORM_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_KEYCLOAK_X_IMAGE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_ENABLED+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_KEYCLOAK_X_IMAGE+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +| -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-auth-form-post-location]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-form-post-location[`quarkus.http.auth.form.post-location`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-shared]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-shared[`quarkus.keycloak.devservices.shared`]## [.description] -- -The post location. +Determines if the Keycloak container is shared. When shared, Quarkus uses label-based service discovery to find and reuse a running Keycloak container, so a second one is not started. Otherwise, if a matching container is not is found, a new container is started. The service discovery uses the `quarkus-dev-service-label` label, whose value is set by the `service-name` property. Container sharing is available only in dev mode. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_FORM_POST_LOCATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_POST_LOCATION+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] -- -|string -|`/j_security_check` +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-auth-proactive]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-proactive[`quarkus.http.auth.proactive`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-service-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-service-name[`quarkus.keycloak.devservices.service-name`]## [.description] -- -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. +The value of the `quarkus-dev-service-keycloak` label for identifying the Keycloak container. Used in shared mode to locate an existing container with this label. If not found, a new container is initialized with this label. Applicable only in dev mode. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_PROACTIVE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_AUTH_PROACTIVE+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +|`quarkus` -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-ssl-client-auth]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-ssl-client-auth[`quarkus.http.ssl.client-auth`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-realm-path]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-realm-path[`quarkus.keycloak.devservices.realm-path`]## [.description] -- -Configures the engine to require/request client authentication. `NONE, REQUEST, REQUIRED`. +A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties. -When set to `REQUIRED`, it's recommended to also set `quarkus.http.insecure-requests=disabled` to disable the plain HTTP port. If `quarkus.http.insecure-requests` is not set, but this parameter is set to `REQUIRED`, then, `quarkus.http.insecure-requests` is automatically set to `disabled`. +To learn more about Keycloak realm files, consult the link:https://www.keycloak.org/server/importExport[Importing and Exporting Keycloak Realms documentation]. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_SSL_CLIENT_AUTH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_SSL_CLIENT_AUTH+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH+++` endif::add-copy-button-to-env-var[] -- -a|`none`, `request`, `required` -|`none` +|list of string +| -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-virtual]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-virtual[`quarkus.http.virtual`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-resource-aliases-alias-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-resource-aliases-alias-name[`quarkus.keycloak.devservices.resource-aliases."alias-name"`]## [.description] -- -If this is true then only a virtual channel will be set up for vertx web. We have this switch for testing purposes. +Aliases to additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between an alias and a class or file system resource path. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_VIRTUAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_ALIASES__ALIAS_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_VIRTUAL+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_ALIASES__ALIAS_NAME_+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|Map +| -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-non-application-root-path]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-non-application-root-path[`quarkus.http.non-application-root-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-resource-mappings-resource-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-resource-mappings-resource-name[`quarkus.keycloak.devservices.resource-mappings."resource-name"`]## [.description] -- -A common root path for non-application endpoints. Various extension-provided endpoints such as metrics, health, -and openapi are deployed under this path by default. -

-* Relative path (Default, `q`) -> -Non-application endpoints will be served from -`${quarkus.http.root-path}/${quarkus.http.non-application-root-path}`. -* Absolute path (`/q`) -> -Non-application endpoints will be served from the specified path. -* `${quarkus.http.root-path}` -> Setting this path to the same value as HTTP root path disables -this root path. All extension-provided endpoints will be served from `${quarkus.http.root-path}`. -

-If the management interface is enabled, the root path for the endpoints exposed on the management interface -is configured using the `quarkus.management.root-path` property instead of this property. +Additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between a class or file system resource path alias and the Keycloak container location. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_NON_APPLICATION_ROOT_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_MAPPINGS__RESOURCE_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_NON_APPLICATION_ROOT_PATH+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_MAPPINGS__RESOURCE_NAME_+++` endif::add-copy-button-to-env-var[] -- -|string -|`q` +|Map +| -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-test-timeout]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-test-timeout[`quarkus.http.test-timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-java-opts]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-java-opts[`quarkus.keycloak.devservices.java-opts`]## [.description] -- -The REST Assured client timeout for testing. +The `JAVA_OPTS` passed to the keycloak JVM ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_TEST_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_JAVA_OPTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_TEST_TIMEOUT+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_JAVA_OPTS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`30S` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-enable-compression]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-enable-compression[`quarkus.http.enable-compression`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-show-logs]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-show-logs[`quarkus.keycloak.devservices.show-logs`]## [.description] -- -If enabled then the response body is compressed if the `Content-Type` header is set and the value is a compressed media type as configured via `compress-media-types`. - -Note that the RESTEasy Reactive and Reactive Routes extensions also make it possible to enable/disable compression declaratively using the annotations `io.quarkus.vertx.http.Compressed` and `io.quarkus.vertx.http.Uncompressed`. +Show Keycloak log messages with a "Keycloak:" prefix. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_ENABLE_COMPRESSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_SHOW_LOGS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_ENABLE_COMPRESSION+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_SHOW_LOGS+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-enable-decompression]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-enable-decompression[`quarkus.http.enable-decompression`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-start-command]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-start-command[`quarkus.keycloak.devservices.start-command`]## [.description] -- -When enabled, vert.x will decompress the request's body if it's compressed. - -Note that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request. +Keycloak start command. Use this property to experiment with Keycloak start options, see `https://www.keycloak.org/server/all-config`. Note, it is ignored when loading legacy Keycloak WildFly images. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_ENABLE_DECOMPRESSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_START_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_ENABLE_DECOMPRESSION+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_START_COMMAND+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-compressors]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-compressors[`quarkus.http.compressors`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-realm-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-realm-name[`quarkus.keycloak.devservices.realm-name`]## [.description] -- -If user adds br, then brotli will be added to the list of supported compression algorithms. It implies loading libbrotli native library via JNI and in case of native image, packing the native library into the native image as a resource thus inflating its size. Note that a native shared object library must be available for your platform in Brotli4J project. - -Client expresses its capability by sending Accept-Encoding header, e.g. Accept-Encoding: deflate, gzip, br Server chooses the compression algorithm based on the client's capabilities and marks it in a response header, e.g.: content-encoding: gzip +The name of the Keycloak realm. This property is used to create the realm if the realm file pointed to by the `realm-path` property does not exist. The default value is `quarkus` in this case. It is recommended to always set this property so that Dev Services for Keycloak can identify the realm name without parsing the realm file. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_COMPRESSORS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_REALM_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_COMPRESSORS+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_REALM_NAME+++` endif::add-copy-button-to-env-var[] -- -|list of string -|`gzip,deflate` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-compress-media-types]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-compress-media-types[`quarkus.http.compress-media-types`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-create-realm]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-create-realm[`quarkus.keycloak.devservices.create-realm`]## [.description] -- -List of media types for which the compression should be enabled automatically, unless declared explicitly via `Compressed` or `Uncompressed`. +Specifies whether to create the Keycloak realm when no realm file is found at the `realm-path`. Set to `false` if the realm is to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by `io.quarkus.test.common.QuarkusTestResourceLifecycleManager`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_COMPRESS_MEDIA_TYPES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_REALM+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_COMPRESS_MEDIA_TYPES+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_REALM+++` endif::add-copy-button-to-env-var[] -- -|list of string -|`text/html,text/plain,text/xml,text/css,text/javascript,application/javascript,application/graphql+json` +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-compression-level]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-compression-level[`quarkus.http.compression-level`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-create-client]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-create-client[`quarkus.keycloak.devservices.create-client`]## [.description] -- -The compression level used when compression support is enabled. +Specifies whether to create the default client id `quarkus-app` with a secret `secret`and register them if the `create-realm` property is set to true. For OIDC extension configuration properties `quarkus.oidc.client.id` and `quarkus.oidc.credentials.secret` will be configured. For OIDC Client extension configuration properties `quarkus.oidc-client.client.id` and `quarkus.oidc-client.credentials.secret` will be configured. Set to `false` if clients have to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by `io.quarkus.test.common.QuarkusTestResourceLifecycleManager` or registered dynamically. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_COMPRESSION_LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_CLIENT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_COMPRESSION_LEVEL+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_CLIENT+++` endif::add-copy-button-to-env-var[] -- -|int -| +|boolean +|`true` -a| [[quarkus-vertx-http_quarkus-http-cors]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-cors[`quarkus.http.cors`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-start-with-disabled-tenant]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-start-with-disabled-tenant[`quarkus.keycloak.devservices.start-with-disabled-tenant`]## [.description] -- -Enable the CORS filter. +Specifies whether to start the container even if the default OIDC tenant is disabled. Setting this property to true may be necessary in a multi-tenant OIDC setup, especially when OIDC tenants are created dynamically. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_CORS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_START_WITH_DISABLED_TENANT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_CORS+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_START_WITH_DISABLED_TENANT+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-vertx-http_quarkus-http-port]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-port[`quarkus.http.port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-users-users]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-users-users[`quarkus.keycloak.devservices.users."users"`]## [.description] -- -The HTTP port +A map of Keycloak usernames to passwords. If empty, default users `alice` and `bob` are created with their names as passwords. This map is used for user creation when no realm file is found at the `realm-path`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_USERS__USERS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_PORT+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_USERS__USERS_+++` endif::add-copy-button-to-env-var[] -- -|int -|`8080` +|Map +| -a| [[quarkus-vertx-http_quarkus-http-test-port]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-test-port[`quarkus.http.test-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-roles-role-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-roles-role-name[`quarkus.keycloak.devservices.roles."role-name"`]## [.description] -- -The HTTP port used to run tests +A map of roles for Keycloak users. If empty, default roles are assigned: `alice` receives `admin` and `user` roles, while other users receive `user` role. This map is used for role creation when no realm file is found at the `realm-path`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_TEST_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_ROLES__ROLE_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_TEST_PORT+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_ROLES__ROLE_NAME_+++` endif::add-copy-button-to-env-var[] -- -|int -|`8081` +|Map> +| -a| [[quarkus-vertx-http_quarkus-http-host]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-host[`quarkus.http.host`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-port]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-port[`quarkus.keycloak.devservices.port`]## [.description] -- -The HTTP host - -In dev/test mode this defaults to localhost, in prod mode this defaults to 0.0.0.0 - -Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine. +The specific port for the dev service to listen on. -As an exception, when running in Windows Subsystem for Linux (WSL), the HTTP host defaults to 0.0.0.0 even in dev/test mode since using localhost makes the application inaccessible. +If not specified, a random port is selected. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_HOST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_HOST+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_PORT+++` endif::add-copy-button-to-env-var[] -- -|string -|required icon:exclamation-circle[title=Configuration property is required] +|int +| -a| [[quarkus-vertx-http_quarkus-http-test-host]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-test-host[`quarkus.http.test-host`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-container-env-environment-variable-name[`quarkus.keycloak.devservices.container-env."environment-variable-name"`]## [.description] -- -Used when `QuarkusIntegrationTest` is meant to execute against an application that is already running and listening on the host specified by this property. +Environment variables to be passed to the container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_TEST_HOST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_TEST_HOST+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a| [[quarkus-vertx-http_quarkus-http-host-enabled]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-host-enabled[`quarkus.http.host-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-container-memory-limit]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-container-memory-limit[`quarkus.keycloak.devservices.container-memory-limit`]## [.description] -- -Enable listening to host:port +Memory limit for Keycloak container + +If not specified, 750MiB is the default memory limit. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_HOST_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_MEMORY_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_HOST_ENABLED+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_MEMORY_LIMIT+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] +|`750M` -a| [[quarkus-vertx-http_quarkus-http-ssl-port]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-ssl-port[`quarkus.http.ssl-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-web-client-timeout]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-web-client-timeout[`quarkus.keycloak.devservices.web-client-timeout`]## [.description] -- -The HTTPS port +The WebClient timeout. Use this property to configure how long an HTTP client used by OIDC dev service admin client will wait for a response from OpenId Connect Provider when acquiring admin token and creating realm. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_SSL_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_WEB_CLIENT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HTTP_SSL_PORT+++` +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_WEB_CLIENT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|int -|`8443` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`4S` -a| [[quarkus-vertx-http_quarkus-http-test-ssl-port]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-test-ssl-port[`quarkus.http.test-ssl-port`]## + +h|[.extension-name]##Eclipse Vert.x - HTTP## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-dev-ui-history-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-dev-ui-history-size[`quarkus.dev-ui.history-size`]## + +[.description] +-- +The number of history log entries to remember. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEV_UI_HISTORY_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEV_UI_HISTORY_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-dev-ui-show-json-rpc-log]] [.property-path]##link:#quarkus-vertx-http_quarkus-dev-ui-show-json-rpc-log[`quarkus.dev-ui.show-json-rpc-log`]## + +[.description] +-- +Show the JsonRPC Log. Useful for extension developers + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEV_UI_SHOW_JSON_RPC_LOG+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEV_UI_SHOW_JSON_RPC_LOG+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-dev-ui-hosts]] [.property-path]##link:#quarkus-vertx-http_quarkus-dev-ui-hosts[`quarkus.dev-ui.hosts`]## + +[.description] +-- +More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com (This can also be a regex) By default localhost and 127.0.0.1 will always be allowed + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEV_UI_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEV_UI_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-dev-ui-cors-enabled]] [.property-path]##link:#quarkus-vertx-http_quarkus-dev-ui-cors-enabled[`quarkus.dev-ui.cors.enabled`]## + +[.description] +-- +Enable CORS filter. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DEV_UI_CORS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEV_UI_CORS_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-root-path]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-root-path[`quarkus.http.root-path`]## + +[.description] +-- +The HTTP root path. All web content will be served relative to this root path. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_ROOT_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_ROOT_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-auth-basic]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-basic[`quarkus.http.auth.basic`]## + +[.description] +-- +If basic auth should be enabled. If both basic and form auth is enabled then basic auth will be enabled in silent mode. The basic auth is enabled by default if no authentication mechanisms are configured or Quarkus can safely determine that basic authentication is required. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_BASIC+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_BASIC+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-auth-form-enabled]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-form-enabled[`quarkus.http.auth.form.enabled`]## + +[.description] +-- +If form authentication is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_FORM_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-auth-form-post-location]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-form-post-location[`quarkus.http.auth.form.post-location`]## + +[.description] +-- +The post location. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_FORM_POST_LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_POST_LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/j_security_check` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-auth-proactive]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-proactive[`quarkus.http.auth.proactive`]## + +[.description] +-- +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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_PROACTIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_PROACTIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-auth-inclusive]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-inclusive[`quarkus.http.auth.inclusive`]## + +[.description] +-- +Require that all registered HTTP authentication mechanisms must complete the authentication. + +Typically, this property has to be true when the credentials are carried over mTLS, when both mTLS and another authentication, for example, OIDC bearer token authentication, must succeed. In such cases, `SecurityIdentity` created by the first mechanism, mTLS, can be injected, identities created by other mechanisms will be available on `SecurityIdentity`. The identities can be retrieved using utility method as in the example below: + +``` +``` + +`io.quarkus.vertx.http.runtime.security.HttpSecurityUtils.getSecurityIdentities(securityIdentity)` + +This property is false by default which means that the authentication process is complete as soon as the first `SecurityIdentity` is created. + +This property will be ignored if the path specific authentication is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_INCLUSIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_INCLUSIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-ssl-client-auth]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-ssl-client-auth[`quarkus.http.ssl.client-auth`]## + +[.description] +-- +Configures the engine to require/request client authentication. `NONE, REQUEST, REQUIRED`. + +When set to `REQUIRED`, it's recommended to also set `quarkus.http.insecure-requests=disabled` to disable the plain HTTP port. If `quarkus.http.insecure-requests` is not set, but this parameter is set to `REQUIRED`, then, `quarkus.http.insecure-requests` is automatically set to `disabled`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_SSL_CLIENT_AUTH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_SSL_CLIENT_AUTH+++` +endif::add-copy-button-to-env-var[] +-- +a|`none`, `request`, `required` +|`none` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-virtual]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-virtual[`quarkus.http.virtual`]## + +[.description] +-- +If this is true then only a virtual channel will be set up for vertx web. We have this switch for testing purposes. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_VIRTUAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_VIRTUAL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-non-application-root-path]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-non-application-root-path[`quarkus.http.non-application-root-path`]## + +[.description] +-- +A common root path for non-application endpoints. Various extension-provided endpoints such as metrics, health, +and openapi are deployed under this path by default. +

+* Relative path (Default, `q`) -> +Non-application endpoints will be served from +`${quarkus.http.root-path}/${quarkus.http.non-application-root-path}`. +* Absolute path (`/q`) -> +Non-application endpoints will be served from the specified path. +* `${quarkus.http.root-path}` -> Setting this path to the same value as HTTP root path disables +this root path. All extension-provided endpoints will be served from `${quarkus.http.root-path}`. +

+If the management interface is enabled, the root path for the endpoints exposed on the management interface +is configured using the `quarkus.management.root-path` property instead of this property. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_NON_APPLICATION_ROOT_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_NON_APPLICATION_ROOT_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`q` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-test-timeout]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-test-timeout[`quarkus.http.test-timeout`]## + +[.description] +-- +The REST Assured client timeout for testing. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_TEST_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_TEST_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-enable-compression]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-enable-compression[`quarkus.http.enable-compression`]## + +[.description] +-- +If enabled then the response body is compressed if the `Content-Type` header is set and the value is a compressed media type as configured via `compress-media-types`. + +Note that the RESTEasy Reactive and Reactive Routes extensions also make it possible to enable/disable compression declaratively using the annotations `io.quarkus.vertx.http.Compressed` and `io.quarkus.vertx.http.Uncompressed`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_ENABLE_COMPRESSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_ENABLE_COMPRESSION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-enable-decompression]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-enable-decompression[`quarkus.http.enable-decompression`]## + +[.description] +-- +When enabled, vert.x will decompress the request's body if it's compressed. + +Note that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_ENABLE_DECOMPRESSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_ENABLE_DECOMPRESSION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-compressors]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-compressors[`quarkus.http.compressors`]## + +[.description] +-- +If user adds br, then brotli will be added to the list of supported compression algorithms. It implies loading libbrotli native library via JNI and in case of native image, packing the native library into the native image as a resource thus inflating its size. Note that a native shared object library must be available for your platform in Brotli4J project. + +Client expresses its capability by sending Accept-Encoding header, e.g. Accept-Encoding: deflate, gzip, br Server chooses the compression algorithm based on the client's capabilities and marks it in a response header, e.g.: content-encoding: gzip + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_COMPRESSORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_COMPRESSORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +|`gzip,deflate` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-compress-media-types]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-compress-media-types[`quarkus.http.compress-media-types`]## + +[.description] +-- +List of media types for which the compression should be enabled automatically, unless declared explicitly via `Compressed` or `Uncompressed`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_COMPRESS_MEDIA_TYPES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_COMPRESS_MEDIA_TYPES+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +|`text/html,text/plain,text/xml,text/css,text/javascript,application/javascript,application/json,application/graphql+json,application/xhtml+xml` + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-compression-level]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-compression-level[`quarkus.http.compression-level`]## + +[.description] +-- +The compression level used when compression support is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_COMPRESSION_LEVEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_COMPRESSION_LEVEL+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-vertx-http_quarkus-http-cors]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-cors[`quarkus.http.cors`]## + +[.description] +-- +Enable the CORS filter. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_CORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_CORS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-vertx-http_quarkus-http-port]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-port[`quarkus.http.port`]## + +[.description] +-- +The HTTP port + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`8080` + +a| [[quarkus-vertx-http_quarkus-http-test-port]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-test-port[`quarkus.http.test-port`]## + +[.description] +-- +The HTTP port used to run tests + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_TEST_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_TEST_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`8081` + +a| [[quarkus-vertx-http_quarkus-http-host]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-host[`quarkus.http.host`]## + +[.description] +-- +The HTTP host + +In dev/test mode this defaults to localhost, in prod mode this defaults to 0.0.0.0 + +Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine. + +As an exception, when running in Windows Subsystem for Linux (WSL), the HTTP host defaults to 0.0.0.0 even in dev/test mode since using localhost makes the application inaccessible. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|required icon:exclamation-circle[title=Configuration property is required] + +a| [[quarkus-vertx-http_quarkus-http-test-host]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-test-host[`quarkus.http.test-host`]## + +[.description] +-- +Used when `QuarkusIntegrationTest` is meant to execute against an application that is already running and listening on the host specified by this property. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_TEST_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_TEST_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-vertx-http_quarkus-http-host-enabled]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-host-enabled[`quarkus.http.host-enabled`]## + +[.description] +-- +Enable listening to host:port + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_HOST_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_HOST_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-vertx-http_quarkus-http-ssl-port]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-ssl-port[`quarkus.http.ssl-port`]## + +[.description] +-- +The HTTPS port + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_SSL_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_SSL_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`8443` + +a| [[quarkus-vertx-http_quarkus-http-test-ssl-port]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-test-ssl-port[`quarkus.http.test-ssl-port`]## [.description] -- @@ -9493,7 +10106,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_SSL_CERTIFICATE_RELOAD_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx-http_quarkus-http-ssl-cipher-suites]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-ssl-cipher-suites[`quarkus.http.ssl.cipher-suites`]## @@ -9622,7 +10235,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30M` a| [[quarkus-vertx-http_quarkus-http-read-timeout]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-read-timeout[`quarkus.http.read-timeout`]## @@ -9639,7 +10252,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-vertx-http_quarkus-http-body-handle-file-uploads]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-body-handle-file-uploads[`quarkus.http.body.handle-file-uploads`]## @@ -10401,7 +11014,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`PT30M` a| [[quarkus-vertx-http_quarkus-http-auth-form-new-cookie-interval]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-form-new-cookie-interval[`quarkus.http.auth.form.new-cookie-interval`]## @@ -10418,7 +11031,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_NEW_COOKIE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`PT1M` a| [[quarkus-vertx-http_quarkus-http-auth-form-cookie-name]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-form-cookie-name[`quarkus.http.auth.form.cookie-name`]## @@ -10489,6 +11102,23 @@ endif::add-copy-button-to-env-var[] a|`strict`, `lax`, `none` |`strict` +a| [[quarkus-vertx-http_quarkus-http-auth-form-cookie-max-age]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-form-cookie-max-age[`quarkus.http.auth.form.cookie-max-age`]## + +[.description] +-- +Max-Age attribute for the session cookie. This is the amount of time the browser will keep the cookie. The default value is empty, which means the cookie will be kept until the browser is closed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_FORM_COOKIE_MAX_AGE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_COOKIE_MAX_AGE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| + h|[[quarkus-vertx-http_section_quarkus-http-cors]] [.section-name.section-level0]##link:#quarkus-vertx-http_section_quarkus-http-cors[The CORS config]## h|Type @@ -10576,7 +11206,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_CORS_ACCESS_CONTROL_MAX_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx-http_quarkus-http-cors-access-control-allow-credentials]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-cors-access-control-allow-credentials[`quarkus.http.cors.access-control-allow-credentials`]## @@ -10683,7 +11313,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_STATIC_RESOURCES_CACHE_ENTRY_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-vertx-http_quarkus-http-static-resources-max-age]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-static-resources-max-age[`quarkus.http.static-resources.max-age`]## @@ -10700,7 +11330,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_STATIC_RESOURCES_MAX_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`24H` a| [[quarkus-vertx-http_quarkus-http-static-resources-max-cache-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-static-resources-max-cache-size[`quarkus.http.static-resources.max-cache-size`]## @@ -10756,7 +11386,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_HEADER_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`20K` a| [[quarkus-vertx-http_quarkus-http-limits-max-body-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits-max-body-size[`quarkus.http.limits.max-body-size`]## @@ -10773,7 +11403,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_BODY_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`10240K` a| [[quarkus-vertx-http_quarkus-http-limits-max-chunk-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits-max-chunk-size[`quarkus.http.limits.max-chunk-size`]## @@ -10790,7 +11420,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_CHUNK_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`8192` a| [[quarkus-vertx-http_quarkus-http-limits-max-initial-line-length]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits-max-initial-line-length[`quarkus.http.limits.max-initial-line-length`]## @@ -10824,7 +11454,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_FORM_ATTRIBUTE_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`2048` a| [[quarkus-vertx-http_quarkus-http-limits-max-form-fields]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits-max-form-fields[`quarkus.http.limits.max-form-fields`]## @@ -10858,7 +11488,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_FORM_BUFFERED_BYTES+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`1K` a| [[quarkus-vertx-http_quarkus-http-limits-max-parameters]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits-max-parameters[`quarkus.http.limits.max-parameters`]## @@ -11000,7 +11630,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_RST_FLOOD_WINDOW_DURATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | @@ -11222,7 +11852,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_TRAFFIC_SHAPING_INBOUND_GLOBAL_BANDWIDTH+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] | a| [[quarkus-vertx-http_quarkus-http-traffic-shaping-outbound-global-bandwidth]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-traffic-shaping-outbound-global-bandwidth[`quarkus.http.traffic-shaping.outbound-global-bandwidth`]## @@ -11239,7 +11869,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_TRAFFIC_SHAPING_OUTBOUND_GLOBAL_BANDWIDTH+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] | a| [[quarkus-vertx-http_quarkus-http-traffic-shaping-max-delay]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-traffic-shaping-max-delay[`quarkus.http.traffic-shaping.max-delay`]## @@ -11256,7 +11886,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_TRAFFIC_SHAPING_MAX_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx-http_quarkus-http-traffic-shaping-check-interval]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-traffic-shaping-check-interval[`quarkus.http.traffic-shaping.check-interval`]## @@ -11275,7 +11905,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_TRAFFIC_SHAPING_CHECK_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx-http_quarkus-http-traffic-shaping-peak-outbound-global-bandwidth]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-traffic-shaping-peak-outbound-global-bandwidth[`quarkus.http.traffic-shaping.peak-outbound-global-bandwidth`]## @@ -11292,7 +11922,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_TRAFFIC_SHAPING_PEAK_OUTBOUND_GLOBAL_BANDWIDTH+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] | @@ -11600,73 +12230,44 @@ endif::add-copy-button-to-env-var[] |`All proxy addresses are trusted` -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-dev-ui-history-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-dev-ui-history-size[`quarkus.dev-ui.history-size`]## - -[.description] --- -The number of history log entries to remember. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DEV_UI_HISTORY_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DEV_UI_HISTORY_SIZE+++` -endif::add-copy-button-to-env-var[] --- -|int -|`50` +h|[[quarkus-vertx-http_section_quarkus-http-websocket-server]] [.section-name.section-level0]##link:#quarkus-vertx-http_section_quarkus-http-websocket-server[WebSocket Server configuration]## +h|Type +h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-dev-ui-show-json-rpc-log]] [.property-path]##link:#quarkus-vertx-http_quarkus-dev-ui-show-json-rpc-log[`quarkus.dev-ui.show-json-rpc-log`]## +a| [[quarkus-vertx-http_quarkus-http-websocket-server-max-frame-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-websocket-server-max-frame-size[`quarkus.http.websocket-server.max-frame-size`]## [.description] -- -Show the JsonRPC Log. Useful for extension developers +The maximum amount of data that can be sent in a single frame. Messages larger than this must be broken up into continuation frames. Default 65536 (from HttpServerOptions of Vert.X HttpServerOptions) ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DEV_UI_SHOW_JSON_RPC_LOG+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_FRAME_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DEV_UI_SHOW_JSON_RPC_LOG+++` +Environment variable: `+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_FRAME_SIZE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|int +| -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-dev-ui-hosts]] [.property-path]##link:#quarkus-vertx-http_quarkus-dev-ui-hosts[`quarkus.dev-ui.hosts`]## +a| [[quarkus-vertx-http_quarkus-http-websocket-server-max-message-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-websocket-server-max-message-size[`quarkus.http.websocket-server.max-message-size`]## [.description] -- -More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com By default localhost and 127.0.0.1 will always be allowed +The maximum WebSocket message size. Default 262144 (from HttpServerOptions of Vert.X HttpServerOptions) ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DEV_UI_HOSTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_MESSAGE_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DEV_UI_HOSTS+++` +Environment variable: `+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_MESSAGE_SIZE+++` endif::add-copy-button-to-env-var[] -- -|list of string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-dev-ui-cors-enabled]] [.property-path]##link:#quarkus-vertx-http_quarkus-dev-ui-cors-enabled[`quarkus.dev-ui.cors.enabled`]## - -[.description] --- -Enable CORS filter. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DEV_UI_CORS_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DEV_UI_CORS_ENABLED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-management-enabled]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-enabled[`quarkus.management.enabled`]## @@ -12254,7 +12855,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_SSL_CERTIFICATE_RELOAD_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx-http_quarkus-management-ssl-cipher-suites]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-ssl-cipher-suites[`quarkus.management.ssl.cipher-suites`]## @@ -12364,7 +12965,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_LIMITS_MAX_HEADER_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`20K` a| [[quarkus-vertx-http_quarkus-management-limits-max-body-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-limits-max-body-size[`quarkus.management.limits.max-body-size`]## @@ -12381,7 +12982,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_LIMITS_MAX_BODY_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`10240K` a| [[quarkus-vertx-http_quarkus-management-limits-max-chunk-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-limits-max-chunk-size[`quarkus.management.limits.max-chunk-size`]## @@ -12398,7 +12999,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_LIMITS_MAX_CHUNK_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`8192` a| [[quarkus-vertx-http_quarkus-management-limits-max-initial-line-length]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-limits-max-initial-line-length[`quarkus.management.limits.max-initial-line-length`]## @@ -12432,7 +13033,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_LIMITS_MAX_FORM_ATTRIBUTE_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`2048` a| [[quarkus-vertx-http_quarkus-management-limits-max-form-fields]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-limits-max-form-fields[`quarkus.management.limits.max-form-fields`]## @@ -12466,7 +13067,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_LIMITS_MAX_FORM_BUFFERED_BYTES+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`1K` a| [[quarkus-vertx-http_quarkus-management-limits-max-parameters]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-limits-max-parameters[`quarkus.management.limits.max-parameters`]## @@ -12608,7 +13209,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_LIMITS_RST_FLOOD_WINDOW_DURATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx-http_quarkus-management-idle-timeout]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-idle-timeout[`quarkus.management.idle-timeout`]## @@ -12625,7 +13226,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30M` a| [[quarkus-vertx-http_quarkus-management-body-handle-file-uploads]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-body-handle-file-uploads[`quarkus.management.body.handle-file-uploads`]## @@ -13371,7 +13972,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ELASTICSEARCH_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-elasticsearch-rest-client_quarkus-elasticsearch-socket-timeout]] [.property-path]##link:#quarkus-elasticsearch-rest-client_quarkus-elasticsearch-socket-timeout[`quarkus.elasticsearch.socket-timeout`]## @@ -13388,7 +13989,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ELASTICSEARCH_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-elasticsearch-rest-client_quarkus-elasticsearch-max-connections]] [.property-path]##link:#quarkus-elasticsearch-rest-client_quarkus-elasticsearch-max-connections[`quarkus.elasticsearch.max-connections`]## @@ -13475,7 +14076,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5M` h|[[quarkus-elasticsearch-rest-client_section_quarkus-elasticsearch-devservices]] [.section-name.section-level0]##link:#quarkus-elasticsearch-rest-client_section_quarkus-elasticsearch-devservices[Dev Services]## @@ -14267,7 +14868,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECURITY_LDAP_DIR_CONTEXT_CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-elytron-security-ldap_quarkus-security-ldap-dir-context-read-timeout]] [.property-path]##link:#quarkus-elytron-security-ldap_quarkus-security-ldap-dir-context-read-timeout[`quarkus.security.ldap.dir-context.read-timeout`]## @@ -14284,7 +14885,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECURITY_LDAP_DIR_CONTEXT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-elytron-security-ldap_quarkus-security-ldap-cache-enabled]] [.property-path]##link:#quarkus-elytron-security-ldap_quarkus-security-ldap-cache-enabled[`quarkus.security.ldap.cache.enabled`]## @@ -14318,7 +14919,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECURITY_LDAP_CACHE_MAX_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-elytron-security-ldap_quarkus-security-ldap-cache-size]] [.property-path]##link:#quarkus-elytron-security-ldap_quarkus-security-ldap-cache-size[`quarkus.security.ldap.cache.size`]## @@ -14882,7 +15483,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_FLYWAY_CONNECT_RETRIES_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`120 seconds` a| [[quarkus-flyway_quarkus-flyway-default-schema]] [.property-path]##link:#quarkus-flyway_quarkus-flyway-default-schema[`quarkus.flyway.default-schema`]## @@ -15477,7 +16078,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_FLYWAY__DATASOURCE_NAME__CONNECT_RETRIES_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`120 seconds` a| [[quarkus-flyway_quarkus-flyway-datasource-name-default-schema]] [.property-path]##link:#quarkus-flyway_quarkus-flyway-datasource-name-default-schema[`quarkus.flyway."datasource-name".default-schema`]## @@ -16157,6 +16758,48 @@ h|[.extension-name]##gRPC## h|Type h|Default +a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-generate-code-grpc-scan-for-proto]] [.property-path]##link:#quarkus-grpc_quarkus-generate-code-grpc-scan-for-proto[`quarkus.generate-code.grpc.scan-for-proto`]## + +[.description] +-- +gRPC code generation can scan dependencies of the application for proto files to generate Java stubs from. This property sets the scope of the dependencies to scan. Applicable values: + + - _none_ - default - don't scan dependencies + - a comma separated list of _groupId:artifactId_ coordinates to scan + - _all_ - scan all dependencies + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_PROTO+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_PROTO+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`none` + +a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-generate-code-grpc-scan-for-imports]] [.property-path]##link:#quarkus-grpc_quarkus-generate-code-grpc-scan-for-imports[`quarkus.generate-code.grpc.scan-for-imports`]## + +[.description] +-- +Specify the dependencies that are allowed to have proto files that can be imported by this application's protos Applicable values: + + - _none_ - default - don't scan dependencies + - a comma separated list of _groupId:artifactId_ coordinates to scan + - _all_ - scan all dependencies By default, _com.google.protobuf:protobuf-java_. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_IMPORTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_IMPORTS+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`com.google.protobuf:protobuf-java` + a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-grpc-server-health-enabled]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-server-health-enabled[`quarkus.grpc.server.health.enabled`]## [.description] @@ -16820,7 +17463,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-clients-client-name-flow-control-window]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-clients-client-name-flow-control-window[`quarkus.grpc.clients."client-name".flow-control-window`]## @@ -16854,7 +17497,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-clients-client-name-keep-alive-timeout]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-clients-client-name-keep-alive-timeout[`quarkus.grpc.clients."client-name".keep-alive-timeout`]## @@ -16871,7 +17514,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-clients-client-name-keep-alive-without-calls]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-clients-client-name-keep-alive-without-calls[`quarkus.grpc.clients."client-name".keep-alive-without-calls`]## @@ -17126,7 +17769,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__DEADLINE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | @@ -17289,7 +17932,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_SERVER_HANDSHAKE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-server-max-inbound-message-size]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-server-max-inbound-message-size[`quarkus.grpc.server.max-inbound-message-size`]## @@ -17298,6 +17941,8 @@ a| [[quarkus-grpc_quarkus-grpc-server-max-inbound-message-size]] [.property-path -- The max inbound message size in bytes. +When using a single server (using `quarkus.grpc.server.use-separate-server=false`), the default value is 256KB. When using a separate server (using `quarkus.grpc.server.use-separate-server=true`), the default value is 4MB. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_SERVER_MAX_INBOUND_MESSAGE_SIZE+++[] @@ -17669,7 +18314,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_SERVER_NETTY_KEEP_ALIVE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-server-netty-permit-keep-alive-time]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-server-netty-permit-keep-alive-time[`quarkus.grpc.server.netty.permit-keep-alive-time`]## @@ -17686,7 +18331,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_SERVER_NETTY_PERMIT_KEEP_ALIVE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-server-netty-permit-keep-alive-without-calls]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-server-netty-permit-keep-alive-without-calls[`quarkus.grpc.server.netty.permit-keep-alive-without-calls`]## @@ -17741,48 +18386,6 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-generate-code-grpc-scan-for-proto]] [.property-path]##link:#quarkus-grpc_quarkus-generate-code-grpc-scan-for-proto[`quarkus.generate-code.grpc.scan-for-proto`]## - -[.description] --- -gRPC code generation can scan dependencies of the application for proto files to generate Java stubs from. This property sets the scope of the dependencies to scan. Applicable values: - - - _none_ - default - don't scan dependencies - - a comma separated list of _groupId:artifactId_ coordinates to scan - - _all_ - scan all dependencies - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_PROTO+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_PROTO+++` -endif::add-copy-button-to-env-var[] --- -|string -|`none` - -a|icon:lock[title=Fixed at build time] [[quarkus-grpc_quarkus-generate-code-grpc-scan-for-imports]] [.property-path]##link:#quarkus-grpc_quarkus-generate-code-grpc-scan-for-imports[`quarkus.generate-code.grpc.scan-for-imports`]## - -[.description] --- -Specify the dependencies that are allowed to have proto files that can be imported by this application's protos Applicable values: - - - _none_ - default - don't scan dependencies - - a comma separated list of _groupId:artifactId_ coordinates to scan - - _all_ - scan all dependencies By default, _com.google.protobuf:protobuf-java_. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_IMPORTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_IMPORTS+++` -endif::add-copy-button-to-env-var[] --- -|string -|`com.google.protobuf:protobuf-java` - h|[.extension-name]##Hibernate Envers## h|Type @@ -18852,6 +19455,29 @@ endif::add-copy-button-to-env-var[] |string | +a| [[quarkus-hibernate-orm_quarkus-hibernate-orm-database-version-check-enabled]] [.property-path]##link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-version-check-enabled[`quarkus.hibernate-orm.database.version-check.enabled`]## + +`quarkus.hibernate-orm."persistence-unit-name".database.version-check.enabled` + +[.description] +-- +Whether Hibernate ORM should check on startup +that the version of the database matches the version configured on the dialect +(either the default version, or the one set through `quarkus.datasource.db-version`). + +This should be set to `false` if the database is not available on startup. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_VERSION_CHECK_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_VERSION_CHECK_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|``true` if the dialect was set automatically by Quarkus, `false` if it was set explicitly` + h|[[quarkus-hibernate-orm_section_quarkus-hibernate-orm-dialect]] [.section-name.section-level0]##link:#quarkus-hibernate-orm_section_quarkus-hibernate-orm-dialect[Dialect related configuration]## h|Type @@ -19196,7 +19822,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_ORM_CACHE__CACHE__EXPIRATION_MAX_IDLE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-memory-object-count]] [.property-path]##link:#quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-memory-object-count[`quarkus.hibernate-orm.cache."cache".memory.object-count`]## @@ -19862,58 +20488,6 @@ endif::add-copy-button-to-env-var[] |ElasticsearchVersion | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[`quarkus.hibernate-search-orm.elasticsearch.layout.strategy`]## - -`quarkus.hibernate-search-orm.elasticsearch."backend-name".layout.strategy` - -`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.layout.strategy` - -`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".layout.strategy` - -[.description] --- -A xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component -used to configure the Elasticsearch layout: index names, index aliases, ... - -The referenced bean must implement `IndexLayoutStrategy`. - -Available built-in implementations: - -`simple`:: -The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, -and an alias for read operations named `myindex-read`. -`no-alias`:: -A strategy without index aliases, mostly useful on legacy clusters: -if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex`, and will not use any alias. - -See -link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] -for more information. - -[NOTE] -==== -Instead of setting this configuration property, -you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension` -and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. -See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section] -for more information. - -If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. -==== - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file[`quarkus.hibernate-search-orm.elasticsearch.schema-management.settings-file`]## `quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.settings-file` @@ -20127,7 +20701,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-read-timeout]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-read-timeout[`quarkus.hibernate-search-orm.elasticsearch.read-timeout`]## @@ -20150,7 +20724,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-request-timeout]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-request-timeout[`quarkus.hibernate-search-orm.elasticsearch.request-timeout`]## @@ -20176,7 +20750,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_REQUEST_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-max-connections]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-max-connections[`quarkus.hibernate-search-orm.elasticsearch.max-connections`]## @@ -20268,7 +20842,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size[`quarkus.hibernate-search-orm.elasticsearch.thread-pool.size`]## @@ -20399,7 +20973,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count[`quarkus.hibernate-search-orm.elasticsearch.indexing.queue-count`]## @@ -20493,6 +21067,58 @@ endif::add-copy-button-to-env-var[] |int |`100` +a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[`quarkus.hibernate-search-orm.elasticsearch.layout.strategy`]## + +`quarkus.hibernate-search-orm.elasticsearch."backend-name".layout.strategy` + +`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.layout.strategy` + +`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".layout.strategy` + +[.description] +-- +A xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component +used to configure the Elasticsearch layout: index names, index aliases, ... + +The referenced bean must implement `IndexLayoutStrategy`. + +Available built-in implementations: + +`simple`:: +The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, +this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, +and an alias for read operations named `myindex-read`. +`no-alias`:: +A strategy without index aliases, mostly useful on legacy clusters: +if the index name in Hibernate Search is `myIndex`, +this strategy will create an index named `myindex`, and will not use any alias. + +See +link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] +for more information. + +[NOTE] +==== +Instead of setting this configuration property, +you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension` +and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. +See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section] +for more information. + +If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. +==== + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + h|[[quarkus-hibernate-search-orm-elasticsearch_section_quarkus-hibernate-search-orm-elasticsearch-indexes]] [.section-name.section-level1]##link:#quarkus-hibernate-search-orm-elasticsearch_section_quarkus-hibernate-search-orm-elasticsearch-indexes[Per-index configuration overrides]## h|Type h|Default @@ -20642,7 +21268,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[`quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.queue-count`]## @@ -20897,7 +21523,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_POLLING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`0.100S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-pulse-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-pulse-interval[`quarkus.hibernate-search-orm.coordination.event-processor.pulse-interval`]## @@ -20936,7 +21562,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_PULSE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-pulse-expiration]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-pulse-expiration[`quarkus.hibernate-search-orm.coordination.event-processor.pulse-expiration`]## @@ -20972,7 +21598,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_PULSE_EXPIRATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-batch-size]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-batch-size[`quarkus.hibernate-search-orm.coordination.event-processor.batch-size`]## @@ -21027,7 +21653,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_TRANSACTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-retry-delay]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-retry-delay[`quarkus.hibernate-search-orm.coordination.event-processor.retry-delay`]## @@ -21052,7 +21678,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_RETRY_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-polling-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-polling-interval[`quarkus.hibernate-search-orm.coordination.mass-indexer.polling-interval`]## @@ -21084,7 +21710,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_POLLING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`0.100S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-pulse-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-pulse-interval[`quarkus.hibernate-search-orm.coordination.mass-indexer.pulse-interval`]## @@ -21121,7 +21747,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_PULSE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-pulse-expiration]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-pulse-expiration[`quarkus.hibernate-search-orm.coordination.mass-indexer.pulse-expiration`]## @@ -21157,7 +21783,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_PULSE_EXPIRATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30S` h|[[quarkus-hibernate-search-orm-outbox-polling_section_quarkus-hibernate-search-orm]] [.section-name.section-level0]##link:#quarkus-hibernate-search-orm-outbox-polling_section_quarkus-hibernate-search-orm[Configuration for persistence units]## @@ -21501,7 +22127,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_POLLING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`0.100S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-pulse-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-pulse-interval[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.pulse-interval`]## @@ -21540,7 +22166,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_PULSE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-pulse-expiration]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-pulse-expiration[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.pulse-expiration`]## @@ -21576,7 +22202,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_PULSE_EXPIRATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-batch-size]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-batch-size[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.batch-size`]## @@ -21631,7 +22257,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_TRANSACTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-retry-delay]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-retry-delay[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.retry-delay`]## @@ -21656,7 +22282,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_RETRY_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-polling-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-polling-interval[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".mass-indexer.polling-interval`]## @@ -21688,7 +22314,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_POLLING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`0.100S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-pulse-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-pulse-interval[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".mass-indexer.pulse-interval`]## @@ -21725,7 +22351,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_PULSE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-pulse-expiration]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-pulse-expiration[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".mass-indexer.pulse-expiration`]## @@ -21761,7 +22387,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_PULSE_EXPIRATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30S` @@ -22101,54 +22727,6 @@ endif::add-copy-button-to-env-var[] |ElasticsearchVersion | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy[`quarkus.hibernate-search-standalone.elasticsearch.layout.strategy`]## - -`quarkus.hibernate-search-standalone.elasticsearch."backend-name".layout.strategy` - -[.description] --- -A xref:hibernate-search-standalone-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component -used to configure the Elasticsearch layout: index names, index aliases, ... - -The referenced bean must implement `IndexLayoutStrategy`. - -Available built-in implementations: - -`simple`:: -The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, -and an alias for read operations named `myindex-read`. -`no-alias`:: -A strategy without index aliases, mostly useful on legacy clusters: -if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex`, and will not use any alias. - -See -link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] -for more information. - -[NOTE] -==== -Instead of setting this configuration property, -you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension` -and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. -See xref:hibernate-search-standalone-elasticsearch.adoc#plugging-in-custom-components[this section] -for more information. - -If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. -==== - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-schema-management-settings-file]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-schema-management-settings-file[`quarkus.hibernate-search-standalone.elasticsearch.schema-management.settings-file`]## `quarkus.hibernate-search-standalone.elasticsearch."backend-name".schema-management.settings-file` @@ -22330,7 +22908,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-read-timeout]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-read-timeout[`quarkus.hibernate-search-standalone.elasticsearch.read-timeout`]## @@ -22349,7 +22927,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-request-timeout]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-request-timeout[`quarkus.hibernate-search-standalone.elasticsearch.request-timeout`]## @@ -22371,7 +22949,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_REQUEST_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-max-connections]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-max-connections[`quarkus.hibernate-search-standalone.elasticsearch.max-connections`]## @@ -22447,7 +23025,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-thread-pool-size]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-thread-pool-size[`quarkus.hibernate-search-standalone.elasticsearch.thread-pool.size`]## @@ -22558,7 +23136,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-indexing-queue-count]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-indexing-queue-count[`quarkus.hibernate-search-standalone.elasticsearch.indexing.queue-count`]## @@ -22640,6 +23218,54 @@ endif::add-copy-button-to-env-var[] |int |`100` +a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy[`quarkus.hibernate-search-standalone.elasticsearch.layout.strategy`]## + +`quarkus.hibernate-search-standalone.elasticsearch."backend-name".layout.strategy` + +[.description] +-- +A xref:hibernate-search-standalone-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component +used to configure the Elasticsearch layout: index names, index aliases, ... + +The referenced bean must implement `IndexLayoutStrategy`. + +Available built-in implementations: + +`simple`:: +The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, +this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, +and an alias for read operations named `myindex-read`. +`no-alias`:: +A strategy without index aliases, mostly useful on legacy clusters: +if the index name in Hibernate Search is `myIndex`, +this strategy will create an index named `myindex`, and will not use any alias. + +See +link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] +for more information. + +[NOTE] +==== +Instead of setting this configuration property, +you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension` +and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. +See xref:hibernate-search-standalone-elasticsearch.adoc#plugging-in-custom-components[this section] +for more information. + +If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. +==== + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + h|[[quarkus-hibernate-search-standalone-elasticsearch_section_quarkus-hibernate-search-standalone-elasticsearch-indexes]] [.section-name.section-level1]##link:#quarkus-hibernate-search-standalone-elasticsearch_section_quarkus-hibernate-search-standalone-elasticsearch-indexes[Per-index configuration overrides]## h|Type h|Default @@ -22769,7 +23395,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-indexes-index-name-indexing-queue-count]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-indexes-index-name-indexing-queue-count[`quarkus.hibernate-search-standalone.elasticsearch.indexes."index-name".indexing.queue-count`]## @@ -23055,7 +23681,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_INFINISPAN_LIFESPAN+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-infinispan-cache_quarkus-cache-infinispan-max-idle]] [.property-path]##link:#quarkus-infinispan-cache_quarkus-cache-infinispan-max-idle[`quarkus.cache.infinispan.max-idle`]## @@ -23072,7 +23698,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_INFINISPAN_MAX_IDLE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | h|[[quarkus-infinispan-cache_section_quarkus-cache-infinispan]] [.section-name.section-level0]##link:#quarkus-infinispan-cache_section_quarkus-cache-infinispan[Additional configuration applied to a specific Infinispan cache (highest precedence)]## @@ -23093,7 +23719,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_INFINISPAN__CACHE_NAME__LIFESPAN+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-infinispan-cache_quarkus-cache-infinispan-cache-name-max-idle]] [.property-path]##link:#quarkus-infinispan-cache_quarkus-cache-infinispan-cache-name-max-idle[`quarkus.cache.infinispan."cache-name".max-idle`]## @@ -23110,7 +23736,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_INFINISPAN__CACHE_NAME__MAX_IDLE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | @@ -25498,7 +26124,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KAFKA_DEVSERVICES_TOPIC_PARTITIONS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`2S` a|icon:lock[title=Fixed at build time] [[quarkus-kafka-client_quarkus-kafka-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-kafka-client_quarkus-kafka-devservices-container-env-environment-variable-name[`quarkus.kafka.devservices.container-env."environment-variable-name"`]## @@ -25659,7 +26285,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KAFKA_STREAMS_TOPICS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-kafka-streams_quarkus-kafka-streams-schema-registry-key]] [.property-path]##link:#quarkus-kafka-streams_quarkus-kafka-streams-schema-registry-key[`quarkus.kafka-streams.schema-registry-key`]## @@ -25931,7 +26557,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_MIN_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-kafka-streams_quarkus-kafka-streams-sasl-login-refresh-buffer]] [.property-path]##link:#quarkus-kafka-streams_quarkus-kafka-streams-sasl-login-refresh-buffer[`quarkus.kafka-streams.sasl.login-refresh-buffer`]## @@ -25948,7 +26574,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_BUFFER+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-kafka-streams_quarkus-kafka-streams-ssl-protocol]] [.property-path]##link:#quarkus-kafka-streams_quarkus-kafka-streams-ssl-protocol[`quarkus.kafka-streams.ssl.protocol`]## @@ -26415,6 +27041,27 @@ endif::add-copy-button-to-env-var[] a|`password`, `client-credentials` |`password` +a| [[quarkus-keycloak-admin-client_quarkus-keycloak-admin-client-tls-configuration-name]] [.property-path]##link:#quarkus-keycloak-admin-client_quarkus-keycloak-admin-client-tls-configuration-name[`quarkus.keycloak.admin-client.tls-configuration-name`]## + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_ADMIN_CLIENT_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KEYCLOAK_ADMIN_CLIENT_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + h|[.extension-name]##Keycloak Authorization## h|Type @@ -26991,41 +27638,7 @@ h|[.extension-name]##Kubernetes - Vanilla## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-flavor]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-flavor[`quarkus.openshift.flavor`]## - -[.description] --- -The OpenShift flavor / version to use. Older versions of OpenShift have minor differences in the labels and fields they support. This option allows users to have their manifests automatically aligned to the OpenShift 'flavor' they use. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_FLAVOR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_FLAVOR+++` -endif::add-copy-button-to-env-var[] --- -a|`v3`, `v4` -|`v4` - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-deployment-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-deployment-kind[`quarkus.openshift.deployment-kind`]## - -[.description] --- -The kind of the deployment resource to use. Supported values are 'Deployment', 'StatefulSet', 'Job', 'CronJob' and 'DeploymentConfig'. Defaults to 'DeploymentConfig' if `flavor == v3`, or 'Deployment' otherwise. DeploymentConfig is deprecated as of OpenShift 4.14. See https://access.redhat.com/articles/7041372 for details. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_DEPLOYMENT_KIND+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_DEPLOYMENT_KIND+++` -endif::add-copy-button-to-env-var[] --- -a|`deployment`, `deployment-config`, `stateful-set`, `job`, `cron-job`, `knative-service` -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-part-of]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-part-of[`quarkus.openshift.part-of`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-part-of]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-part-of[`quarkus.knative.part-of`]## [.description] -- @@ -27033,33 +27646,33 @@ The name of the group this component belongs too ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PART_OF+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PART_OF+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PART_OF+++` +Environment variable: `+++QUARKUS_KNATIVE_PART_OF+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-name[`quarkus.openshift.name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-name[`quarkus.knative.name`]## [.description] -- -The name of the application. This value will be used for naming Kubernetes resources like: 'Deployment', 'Service' and so on... +The name of the application. This value will be used for naming Kubernetes resources like: - Deployment - Service and so on ... ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-version]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-version[`quarkus.openshift.version`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-version]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-version[`quarkus.knative.version`]## [.description] -- @@ -27067,16 +27680,16 @@ The version of the application. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_VERSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_VERSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_VERSION+++` +Environment variable: `+++QUARKUS_KNATIVE_VERSION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-namespace[`quarkus.openshift.namespace`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-namespace[`quarkus.knative.namespace`]## [.description] -- @@ -27084,16 +27697,16 @@ The namespace the generated resources should belong to. If not value is set, the ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_NAMESPACE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_NAMESPACE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_NAMESPACE+++` +Environment variable: `+++QUARKUS_KNATIVE_NAMESPACE+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-labels-label-name[`quarkus.openshift.labels."label-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-labels-label-name[`quarkus.knative.labels."label-name"`]## [.description] -- @@ -27101,16 +27714,16 @@ Custom labels to add to all resources ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_KNATIVE_LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-annotations-annotation-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-annotations-annotation-name[`quarkus.openshift.annotations."annotation-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-annotations-annotation-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-annotations-annotation-name[`quarkus.knative.annotations."annotation-name"`]## [.description] -- @@ -27118,33 +27731,33 @@ Custom annotations to add to all resources ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ANNOTATIONS__ANNOTATION_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ANNOTATIONS__ANNOTATION_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ANNOTATIONS__ANNOTATION_NAME_+++` +Environment variable: `+++QUARKUS_KNATIVE_ANNOTATIONS__ANNOTATION_NAME_+++` endif::add-copy-button-to-env-var[] -- |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-add-build-timestamp]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-add-build-timestamp[`quarkus.openshift.add-build-timestamp`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-add-build-timestamp]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-add-build-timestamp[`quarkus.knative.add-build-timestamp`]## [.description] -- -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 +Whether to add the build timestamp to the Kubernetes annotations This is a very useful way to have manifests of successive builds of the same application differ - thus ensuring that Kubernetes will apply the updated resources ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ADD_BUILD_TIMESTAMP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ADD_BUILD_TIMESTAMP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ADD_BUILD_TIMESTAMP+++` +Environment variable: `+++QUARKUS_KNATIVE_ADD_BUILD_TIMESTAMP+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-working-dir[`quarkus.openshift.working-dir`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-working-dir[`quarkus.knative.working-dir`]## [.description] -- @@ -27152,16 +27765,16 @@ Working directory ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_WORKING_DIR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_WORKING_DIR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_WORKING_DIR+++` +Environment variable: `+++QUARKUS_KNATIVE_WORKING_DIR+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-command[`quarkus.openshift.command`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-command[`quarkus.knative.command`]## [.description] -- @@ -27169,16 +27782,16 @@ The commands ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_COMMAND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_COMMAND+++` +Environment variable: `+++QUARKUS_KNATIVE_COMMAND+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-arguments[`quarkus.openshift.arguments`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-arguments[`quarkus.knative.arguments`]## [.description] -- @@ -27186,16 +27799,16 @@ The arguments ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ARGUMENTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ARGUMENTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ARGUMENTS+++` +Environment variable: `+++QUARKUS_KNATIVE_ARGUMENTS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-service-account[`quarkus.openshift.service-account`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-service-account[`quarkus.knative.service-account`]## [.description] -- @@ -27203,16 +27816,16 @@ The service account ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SERVICE_ACCOUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SERVICE_ACCOUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SERVICE_ACCOUNT+++` +Environment variable: `+++QUARKUS_KNATIVE_SERVICE_ACCOUNT+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-ports-ports-container-port[`quarkus.openshift.ports."ports".container-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-ports-ports-container-port[`quarkus.knative.ports."ports".container-port`]## [.description] -- @@ -27220,16 +27833,16 @@ The port number. Refers to the container port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PORTS__PORTS__CONTAINER_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PORTS__PORTS__CONTAINER_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PORTS__PORTS__CONTAINER_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_PORTS__PORTS__CONTAINER_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-ports-ports-host-port[`quarkus.openshift.ports."ports".host-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-ports-ports-host-port[`quarkus.knative.ports."ports".host-port`]## [.description] -- @@ -27237,16 +27850,16 @@ The host port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PORTS__PORTS__HOST_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PORTS__PORTS__HOST_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PORTS__PORTS__HOST_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_PORTS__PORTS__HOST_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-ports-ports-path[`quarkus.openshift.ports."ports".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-ports-ports-path[`quarkus.knative.ports."ports".path`]## [.description] -- @@ -27254,16 +27867,16 @@ The application path (refers to web application path). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PORTS__PORTS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PORTS__PORTS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PORTS__PORTS__PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_PORTS__PORTS__PATH+++` endif::add-copy-button-to-env-var[] -- |string |`/` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-ports-ports-protocol]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-ports-ports-protocol[`quarkus.openshift.ports."ports".protocol`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-ports-ports-protocol]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-ports-ports-protocol[`quarkus.knative.ports."ports".protocol`]## [.description] -- @@ -27271,16 +27884,16 @@ The protocol. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PORTS__PORTS__PROTOCOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PORTS__PORTS__PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PORTS__PORTS__PROTOCOL+++` +Environment variable: `+++QUARKUS_KNATIVE_PORTS__PORTS__PROTOCOL+++` endif::add-copy-button-to-env-var[] -- a|`tcp`, `udp`, `sctp`, `http`, `proxy` |`tcp` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-ports-ports-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-ports-ports-node-port[`quarkus.openshift.ports."ports".node-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-ports-ports-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-ports-ports-node-port[`quarkus.knative.ports."ports".node-port`]## [.description] -- @@ -27288,16 +27901,16 @@ The nodePort to which this port should be mapped to. This only takes affect when ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PORTS__PORTS__NODE_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PORTS__PORTS__NODE_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PORTS__PORTS__NODE_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_PORTS__PORTS__NODE_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-ports-ports-tls]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-ports-ports-tls[`quarkus.openshift.ports."ports".tls`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-ports-ports-tls]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-ports-ports-tls[`quarkus.knative.ports."ports".tls`]## [.description] -- @@ -27305,33 +27918,16 @@ If enabled, the port will be configured to use the schema HTTPS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PORTS__PORTS__TLS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PORTS__PORTS__TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PORTS__PORTS__TLS+++` +Environment variable: `+++QUARKUS_KNATIVE_PORTS__PORTS__TLS+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-replicas]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-replicas[`quarkus.openshift.replicas`]## - -[.description] --- -The number of desired pods - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_REPLICAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_REPLICAS+++` -endif::add-copy-button-to-env-var[] --- -|int -|`1` - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-service-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-service-type[`quarkus.openshift.service-type`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-service-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-service-type[`quarkus.knative.service-type`]## [.description] -- @@ -27339,33 +27935,16 @@ The type of service that will be generated for the application ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SERVICE_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SERVICE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SERVICE_TYPE+++` +Environment variable: `+++QUARKUS_KNATIVE_SERVICE_TYPE+++` endif::add-copy-button-to-env-var[] -- a|`cluster-ip`, `node-port`, `load-balancer`, `external-name` |`cluster-ip` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-node-port[`quarkus.openshift.node-port`]## - -[.description] --- -The nodePort to set when serviceType is set to nodePort - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_NODE_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_NODE_PORT+++` -endif::add-copy-button-to-env-var[] --- -|int -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-image-pull-policy[`quarkus.openshift.image-pull-policy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-image-pull-policy[`quarkus.knative.image-pull-policy`]## [.description] -- @@ -27373,16 +27952,16 @@ Image pull policy ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_IMAGE_PULL_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_IMAGE_PULL_POLICY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_IMAGE_PULL_POLICY+++` +Environment variable: `+++QUARKUS_KNATIVE_IMAGE_PULL_POLICY+++` endif::add-copy-button-to-env-var[] -- a|`always`, `if-not-present`, `never` |`always` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-image-pull-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-image-pull-secrets[`quarkus.openshift.image-pull-secrets`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-image-pull-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-image-pull-secrets[`quarkus.knative.image-pull-secrets`]## [.description] -- @@ -27390,16 +27969,16 @@ The image pull secret ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_IMAGE_PULL_SECRETS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_IMAGE_PULL_SECRETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_IMAGE_PULL_SECRETS+++` +Environment variable: `+++QUARKUS_KNATIVE_IMAGE_PULL_SECRETS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-generate-image-pull-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-generate-image-pull-secret[`quarkus.openshift.generate-image-pull-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-generate-image-pull-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-generate-image-pull-secret[`quarkus.knative.generate-image-pull-secret`]## [.description] -- @@ -27407,16 +27986,16 @@ Enable generation of image pull secret, when the container image username and pa ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_GENERATE_IMAGE_PULL_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GENERATE_IMAGE_PULL_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_GENERATE_IMAGE_PULL_SECRET+++` +Environment variable: `+++QUARKUS_KNATIVE_GENERATE_IMAGE_PULL_SECRET+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-port[`quarkus.openshift.liveness-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-port[`quarkus.knative.liveness-probe.http-action-port`]## [.description] -- @@ -27424,16 +28003,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-port-name[`quarkus.openshift.liveness-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-port-name[`quarkus.knative.liveness-probe.http-action-port-name`]## [.description] -- @@ -27441,16 +28020,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-path[`quarkus.openshift.liveness-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-path[`quarkus.knative.liveness-probe.http-action-path`]## [.description] -- @@ -27458,16 +28037,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-scheme[`quarkus.openshift.liveness-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-scheme[`quarkus.knative.liveness-probe.http-action-scheme`]## [.description] -- @@ -27475,16 +28054,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-exec-action[`quarkus.openshift.liveness-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-exec-action[`quarkus.knative.liveness-probe.exec-action`]## [.description] -- @@ -27492,16 +28071,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-tcp-socket-action[`quarkus.openshift.liveness-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-tcp-socket-action[`quarkus.knative.liveness-probe.tcp-socket-action`]## [.description] -- @@ -27509,16 +28088,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-grpc-action[`quarkus.openshift.liveness-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-grpc-action[`quarkus.knative.liveness-probe.grpc-action`]## [.description] -- @@ -27526,16 +28105,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-grpc-action-enabled[`quarkus.openshift.liveness-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-grpc-action-enabled[`quarkus.knative.liveness-probe.grpc-action-enabled`]## [.description] -- @@ -27543,16 +28122,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-initial-delay[`quarkus.openshift.liveness-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-initial-delay[`quarkus.knative.liveness-probe.initial-delay`]## [.description] -- @@ -27560,16 +28139,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-period[`quarkus.openshift.liveness-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-period[`quarkus.knative.liveness-probe.period`]## [.description] -- @@ -27577,16 +28156,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-timeout[`quarkus.openshift.liveness-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-timeout[`quarkus.knative.liveness-probe.timeout`]## [.description] -- @@ -27594,16 +28173,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-success-threshold[`quarkus.openshift.liveness-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-success-threshold[`quarkus.knative.liveness-probe.success-threshold`]## [.description] -- @@ -27611,16 +28190,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-failure-threshold[`quarkus.openshift.liveness-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-failure-threshold[`quarkus.knative.liveness-probe.failure-threshold`]## [.description] -- @@ -27628,16 +28207,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-port[`quarkus.openshift.readiness-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-port[`quarkus.knative.readiness-probe.http-action-port`]## [.description] -- @@ -27645,16 +28224,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-port-name[`quarkus.openshift.readiness-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-port-name[`quarkus.knative.readiness-probe.http-action-port-name`]## [.description] -- @@ -27662,16 +28241,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-path[`quarkus.openshift.readiness-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-path[`quarkus.knative.readiness-probe.http-action-path`]## [.description] -- @@ -27679,16 +28258,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-scheme[`quarkus.openshift.readiness-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-scheme[`quarkus.knative.readiness-probe.http-action-scheme`]## [.description] -- @@ -27696,16 +28275,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-exec-action[`quarkus.openshift.readiness-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-exec-action[`quarkus.knative.readiness-probe.exec-action`]## [.description] -- @@ -27713,16 +28292,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-tcp-socket-action[`quarkus.openshift.readiness-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-tcp-socket-action[`quarkus.knative.readiness-probe.tcp-socket-action`]## [.description] -- @@ -27730,16 +28309,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-grpc-action[`quarkus.openshift.readiness-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-grpc-action[`quarkus.knative.readiness-probe.grpc-action`]## [.description] -- @@ -27747,16 +28326,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-grpc-action-enabled[`quarkus.openshift.readiness-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-grpc-action-enabled[`quarkus.knative.readiness-probe.grpc-action-enabled`]## [.description] -- @@ -27764,16 +28343,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-initial-delay[`quarkus.openshift.readiness-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-initial-delay[`quarkus.knative.readiness-probe.initial-delay`]## [.description] -- @@ -27781,16 +28360,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-period[`quarkus.openshift.readiness-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-period[`quarkus.knative.readiness-probe.period`]## [.description] -- @@ -27798,16 +28377,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-timeout[`quarkus.openshift.readiness-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-timeout[`quarkus.knative.readiness-probe.timeout`]## [.description] -- @@ -27815,16 +28394,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-success-threshold[`quarkus.openshift.readiness-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-success-threshold[`quarkus.knative.readiness-probe.success-threshold`]## [.description] -- @@ -27832,16 +28411,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-failure-threshold[`quarkus.openshift.readiness-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-failure-threshold[`quarkus.knative.readiness-probe.failure-threshold`]## [.description] -- @@ -27849,16 +28428,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-port[`quarkus.openshift.startup-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-http-action-port[`quarkus.knative.startup-probe.http-action-port`]## [.description] -- @@ -27866,16 +28445,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-port-name[`quarkus.openshift.startup-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-http-action-port-name[`quarkus.knative.startup-probe.http-action-port-name`]## [.description] -- @@ -27883,16 +28462,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-path[`quarkus.openshift.startup-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-http-action-path[`quarkus.knative.startup-probe.http-action-path`]## [.description] -- @@ -27900,16 +28479,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-scheme[`quarkus.openshift.startup-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-http-action-scheme[`quarkus.knative.startup-probe.http-action-scheme`]## [.description] -- @@ -27917,16 +28496,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-exec-action[`quarkus.openshift.startup-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-exec-action[`quarkus.knative.startup-probe.exec-action`]## [.description] -- @@ -27934,16 +28513,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-tcp-socket-action[`quarkus.openshift.startup-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-tcp-socket-action[`quarkus.knative.startup-probe.tcp-socket-action`]## [.description] -- @@ -27951,16 +28530,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-grpc-action[`quarkus.openshift.startup-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-grpc-action[`quarkus.knative.startup-probe.grpc-action`]## [.description] -- @@ -27968,16 +28547,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-grpc-action-enabled[`quarkus.openshift.startup-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-grpc-action-enabled[`quarkus.knative.startup-probe.grpc-action-enabled`]## [.description] -- @@ -27985,16 +28564,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-initial-delay[`quarkus.openshift.startup-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-initial-delay[`quarkus.knative.startup-probe.initial-delay`]## [.description] -- @@ -28002,16 +28581,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-period[`quarkus.openshift.startup-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-period[`quarkus.knative.startup-probe.period`]## [.description] -- @@ -28019,16 +28598,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-timeout[`quarkus.openshift.startup-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-timeout[`quarkus.knative.startup-probe.timeout`]## [.description] -- @@ -28036,16 +28615,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-success-threshold[`quarkus.openshift.startup-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-success-threshold[`quarkus.knative.startup-probe.success-threshold`]## [.description] -- @@ -28053,16 +28632,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-failure-threshold[`quarkus.openshift.startup-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-failure-threshold[`quarkus.knative.startup-probe.failure-threshold`]## [.description] -- @@ -28070,16 +28649,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-annotations]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-annotations[`quarkus.openshift.prometheus.annotations`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-annotations]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-annotations[`quarkus.knative.prometheus.annotations`]## [.description] -- @@ -28087,16 +28666,16 @@ When true (the default), emit a set of annotations to identify services that sho ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_ANNOTATIONS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_ANNOTATIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_ANNOTATIONS+++` +Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_ANNOTATIONS+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-generate-service-monitor]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-generate-service-monitor[`quarkus.openshift.prometheus.generate-service-monitor`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-generate-service-monitor]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-generate-service-monitor[`quarkus.knative.prometheus.generate-service-monitor`]## [.description] -- @@ -28104,16 +28683,16 @@ When true (the default), emit a set of annotations to identify services that sho ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_GENERATE_SERVICE_MONITOR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_GENERATE_SERVICE_MONITOR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_GENERATE_SERVICE_MONITOR+++` +Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_GENERATE_SERVICE_MONITOR+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-prefix]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-prefix[`quarkus.openshift.prometheus.prefix`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-prefix]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-prefix[`quarkus.knative.prometheus.prefix`]## [.description] -- @@ -28121,16 +28700,16 @@ Define the annotation prefix used for scrape values, this value will be used as ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_PREFIX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_PREFIX+++` +Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_PREFIX+++` endif::add-copy-button-to-env-var[] -- |string |`prometheus.io` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-scrape]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-scrape[`quarkus.openshift.prometheus.scrape`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-scrape]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-scrape[`quarkus.knative.prometheus.scrape`]## [.description] -- @@ -28138,16 +28717,16 @@ Define the annotation used to indicate services that should be scraped. By defau ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_SCRAPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_SCRAPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_SCRAPE+++` +Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_SCRAPE+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-path[`quarkus.openshift.prometheus.path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-path[`quarkus.knative.prometheus.path`]## [.description] -- @@ -28155,16 +28734,16 @@ Define the annotation used to indicate the path to scrape. By default, `/path` w ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-port[`quarkus.openshift.prometheus.port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-port[`quarkus.knative.prometheus.port`]## [.description] -- @@ -28172,16 +28751,16 @@ Define the annotation used to indicate the port to scrape. By default, `/port` w ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_PORT+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-scheme[`quarkus.openshift.prometheus.scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-scheme[`quarkus.knative.prometheus.scheme`]## [.description] -- @@ -28189,16 +28768,16 @@ Define the annotation used to indicate the scheme to use for scraping By default ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_SCHEME+++` +Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-mounts-mounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-mounts-mounts-name[`quarkus.openshift.mounts."mounts".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-mounts-mounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-mounts-mounts-name[`quarkus.knative.mounts."mounts".name`]## [.description] -- @@ -28206,16 +28785,16 @@ The name of the volumeName to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-mounts-mounts-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-mounts-mounts-path[`quarkus.openshift.mounts."mounts".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-mounts-mounts-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-mounts-mounts-path[`quarkus.knative.mounts."mounts".path`]## [.description] -- @@ -28223,16 +28802,16 @@ The path to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-mounts-mounts-sub-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-mounts-mounts-sub-path[`quarkus.openshift.mounts."mounts".sub-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-mounts-mounts-sub-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-mounts-mounts-sub-path[`quarkus.knative.mounts."mounts".sub-path`]## [.description] -- @@ -28240,16 +28819,16 @@ Path within the volumeName from which the container's volumeName should be mount ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__SUB_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__SUB_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__SUB_PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__SUB_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-mounts-mounts-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-mounts-mounts-read-only[`quarkus.openshift.mounts."mounts".read-only`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-mounts-mounts-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-mounts-mounts-read-only[`quarkus.knative.mounts."mounts".read-only`]## [.description] -- @@ -28257,16 +28836,16 @@ ReadOnly ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__READ_ONLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__READ_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__READ_ONLY+++` +Environment variable: `+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__READ_ONLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-secret-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-secret-name[`quarkus.openshift.secret-volumes."secret-volumes".secret-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-secret-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-secret-name[`quarkus.knative.secret-volumes."secret-volumes".secret-name`]## [.description] -- @@ -28274,16 +28853,16 @@ The name of the secret to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__SECRET_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__SECRET_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__SECRET_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__SECRET_NAME+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-default-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-default-mode[`quarkus.openshift.secret-volumes."secret-volumes".default-mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-default-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-default-mode[`quarkus.knative.secret-volumes."secret-volumes".default-mode`]## [.description] -- @@ -28291,16 +28870,16 @@ Default mode. When specifying an octal number, leading zero must be present. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__DEFAULT_MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__DEFAULT_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__DEFAULT_MODE+++` +Environment variable: `+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__DEFAULT_MODE+++` endif::add-copy-button-to-env-var[] -- |string |`0600` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-items-items-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-items-items-path[`quarkus.openshift.secret-volumes."secret-volumes".items."items".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-items-items-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-items-items-path[`quarkus.knative.secret-volumes."secret-volumes".items."items".path`]## [.description] -- @@ -28308,16 +28887,16 @@ The path where the file will be mounted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__PATH+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-items-items-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-items-items-mode[`quarkus.openshift.secret-volumes."secret-volumes".items."items".mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-items-items-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-items-items-mode[`quarkus.knative.secret-volumes."secret-volumes".items."items".mode`]## [.description] -- @@ -28325,16 +28904,16 @@ It must be a value between 0000 and 0777. If not specified, the volume defaultMo ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__MODE+++` +Environment variable: `+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__MODE+++` endif::add-copy-button-to-env-var[] -- |int |`-1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-optional]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-optional[`quarkus.openshift.secret-volumes."secret-volumes".optional`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-optional]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-optional[`quarkus.knative.secret-volumes."secret-volumes".optional`]## [.description] -- @@ -28342,16 +28921,16 @@ Optional ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__OPTIONAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__OPTIONAL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__OPTIONAL+++` +Environment variable: `+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__OPTIONAL+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-config-map-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-config-map-name[`quarkus.openshift.config-map-volumes."config-map-volumes".config-map-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-config-map-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-config-map-name[`quarkus.knative.config-map-volumes."config-map-volumes".config-map-name`]## [.description] -- @@ -28359,16 +28938,16 @@ The name of the ConfigMap to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__CONFIG_MAP_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__CONFIG_MAP_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__CONFIG_MAP_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__CONFIG_MAP_NAME+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-default-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-default-mode[`quarkus.openshift.config-map-volumes."config-map-volumes".default-mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-default-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-default-mode[`quarkus.knative.config-map-volumes."config-map-volumes".default-mode`]## [.description] -- @@ -28376,16 +28955,16 @@ Default mode. When specifying an octal number, leading zero must be present. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__DEFAULT_MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__DEFAULT_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__DEFAULT_MODE+++` +Environment variable: `+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__DEFAULT_MODE+++` endif::add-copy-button-to-env-var[] -- |string |`0600` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-items-items-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-items-items-path[`quarkus.openshift.config-map-volumes."config-map-volumes".items."items".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-items-items-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-items-items-path[`quarkus.knative.config-map-volumes."config-map-volumes".items."items".path`]## [.description] -- @@ -28393,16 +28972,16 @@ The path where the file will be mounted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__PATH+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-items-items-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-items-items-mode[`quarkus.openshift.config-map-volumes."config-map-volumes".items."items".mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-items-items-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-items-items-mode[`quarkus.knative.config-map-volumes."config-map-volumes".items."items".mode`]## [.description] -- @@ -28410,16 +28989,16 @@ It must be a value between 0000 and 0777. If not specified, the volume defaultMo ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__MODE+++` +Environment variable: `+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__MODE+++` endif::add-copy-button-to-env-var[] -- |int |`-1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-optional]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-optional[`quarkus.openshift.config-map-volumes."config-map-volumes".optional`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-optional]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-optional[`quarkus.knative.config-map-volumes."config-map-volumes".optional`]## [.description] -- @@ -28427,16 +29006,16 @@ Optional ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__OPTIONAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__OPTIONAL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__OPTIONAL+++` +Environment variable: `+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__OPTIONAL+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-empty-dir-volumes]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-empty-dir-volumes[`quarkus.openshift.empty-dir-volumes`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-empty-dir-volumes]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-empty-dir-volumes[`quarkus.knative.empty-dir-volumes`]## [.description] -- @@ -28444,16 +29023,16 @@ EmptyDir volumes ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_EMPTY_DIR_VOLUMES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_EMPTY_DIR_VOLUMES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_EMPTY_DIR_VOLUMES+++` +Environment variable: `+++QUARKUS_KNATIVE_EMPTY_DIR_VOLUMES+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-git-repo-volumes-git-repo-volumes-repository]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-git-repo-volumes-git-repo-volumes-repository[`quarkus.openshift.git-repo-volumes."git-repo-volumes".repository`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-git-repo-volumes-git-repo-volumes-repository]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-git-repo-volumes-git-repo-volumes-repository[`quarkus.knative.git-repo-volumes."git-repo-volumes".repository`]## [.description] -- @@ -28461,16 +29040,16 @@ Git repository URL. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REPOSITORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REPOSITORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REPOSITORY+++` +Environment variable: `+++QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REPOSITORY+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-git-repo-volumes-git-repo-volumes-directory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-git-repo-volumes-git-repo-volumes-directory[`quarkus.openshift.git-repo-volumes."git-repo-volumes".directory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-git-repo-volumes-git-repo-volumes-directory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-git-repo-volumes-git-repo-volumes-directory[`quarkus.knative.git-repo-volumes."git-repo-volumes".directory`]## [.description] -- @@ -28478,16 +29057,16 @@ The directory of the repository to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__DIRECTORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__DIRECTORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__DIRECTORY+++` +Environment variable: `+++QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__DIRECTORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-git-repo-volumes-git-repo-volumes-revision]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-git-repo-volumes-git-repo-volumes-revision[`quarkus.openshift.git-repo-volumes."git-repo-volumes".revision`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-git-repo-volumes-git-repo-volumes-revision]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-git-repo-volumes-git-repo-volumes-revision[`quarkus.knative.git-repo-volumes."git-repo-volumes".revision`]## [.description] -- @@ -28495,16 +29074,16 @@ The commit hash to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REVISION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REVISION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REVISION+++` +Environment variable: `+++QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REVISION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-pvc-volumes-pvc-volumes-claim-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-pvc-volumes-pvc-volumes-claim-name[`quarkus.openshift.pvc-volumes."pvc-volumes".claim-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-pvc-volumes-pvc-volumes-claim-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-pvc-volumes-pvc-volumes-claim-name[`quarkus.knative.pvc-volumes."pvc-volumes".claim-name`]## [.description] -- @@ -28512,16 +29091,16 @@ The name of the claim to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__CLAIM_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__CLAIM_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__CLAIM_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__CLAIM_NAME+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-pvc-volumes-pvc-volumes-default-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-pvc-volumes-pvc-volumes-default-mode[`quarkus.openshift.pvc-volumes."pvc-volumes".default-mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-pvc-volumes-pvc-volumes-default-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-pvc-volumes-pvc-volumes-default-mode[`quarkus.knative.pvc-volumes."pvc-volumes".default-mode`]## [.description] -- @@ -28529,16 +29108,16 @@ Default mode. When specifying an octal number, leading zero must be present. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__DEFAULT_MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__DEFAULT_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__DEFAULT_MODE+++` +Environment variable: `+++QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__DEFAULT_MODE+++` endif::add-copy-button-to-env-var[] -- |string |`0600` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-pvc-volumes-pvc-volumes-optional]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-pvc-volumes-pvc-volumes-optional[`quarkus.openshift.pvc-volumes."pvc-volumes".optional`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-pvc-volumes-pvc-volumes-optional]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-pvc-volumes-pvc-volumes-optional[`quarkus.knative.pvc-volumes."pvc-volumes".optional`]## [.description] -- @@ -28546,16 +29125,16 @@ Optional ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__OPTIONAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__OPTIONAL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__OPTIONAL+++` +Environment variable: `+++QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__OPTIONAL+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-volume-id]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-volume-id[`quarkus.openshift.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".volume-id`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-volume-id]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-volume-id[`quarkus.knative.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".volume-id`]## [.description] -- @@ -28563,16 +29142,16 @@ The name of the disk to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__VOLUME_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__VOLUME_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__VOLUME_ID+++` +Environment variable: `+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__VOLUME_ID+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-partition]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-partition[`quarkus.openshift.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".partition`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-partition]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-partition[`quarkus.knative.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".partition`]## [.description] -- @@ -28580,16 +29159,16 @@ The partition. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__PARTITION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__PARTITION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__PARTITION+++` +Environment variable: `+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__PARTITION+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-fs-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-fs-type[`quarkus.openshift.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".fs-type`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-fs-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-fs-type[`quarkus.knative.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".fs-type`]## [.description] -- @@ -28597,16 +29176,16 @@ Filesystem type. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__FS_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__FS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__FS_TYPE+++` +Environment variable: `+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__FS_TYPE+++` endif::add-copy-button-to-env-var[] -- |string |`ext4` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-read-only[`quarkus.openshift.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".read-only`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-read-only[`quarkus.knative.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".read-only`]## [.description] -- @@ -28614,16 +29193,16 @@ Whether the volumeName is read only or not. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__READ_ONLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__READ_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__READ_ONLY+++` +Environment variable: `+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__READ_ONLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-file-volumes-azure-file-volumes-share-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-file-volumes-azure-file-volumes-share-name[`quarkus.openshift.azure-file-volumes."azure-file-volumes".share-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-file-volumes-azure-file-volumes-share-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-file-volumes-azure-file-volumes-share-name[`quarkus.knative.azure-file-volumes."azure-file-volumes".share-name`]## [.description] -- @@ -28631,16 +29210,16 @@ The share name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SHARE_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SHARE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SHARE_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SHARE_NAME+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-file-volumes-azure-file-volumes-secret-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-file-volumes-azure-file-volumes-secret-name[`quarkus.openshift.azure-file-volumes."azure-file-volumes".secret-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-file-volumes-azure-file-volumes-secret-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-file-volumes-azure-file-volumes-secret-name[`quarkus.knative.azure-file-volumes."azure-file-volumes".secret-name`]## [.description] -- @@ -28648,16 +29227,16 @@ The secret name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SECRET_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SECRET_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SECRET_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SECRET_NAME+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-file-volumes-azure-file-volumes-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-file-volumes-azure-file-volumes-read-only[`quarkus.openshift.azure-file-volumes."azure-file-volumes".read-only`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-file-volumes-azure-file-volumes-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-file-volumes-azure-file-volumes-read-only[`quarkus.knative.azure-file-volumes."azure-file-volumes".read-only`]## [.description] -- @@ -28665,16 +29244,16 @@ Whether the volumeName is read only or not. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__READ_ONLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__READ_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__READ_ONLY+++` +Environment variable: `+++QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__READ_ONLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-disk-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-disk-name[`quarkus.openshift.azure-disk-volumes."azure-disk-volumes".disk-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-disk-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-disk-name[`quarkus.knative.azure-disk-volumes."azure-disk-volumes".disk-name`]## [.description] -- @@ -28682,16 +29261,16 @@ The name of the disk to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_NAME+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-disk-uri]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-disk-uri[`quarkus.openshift.azure-disk-volumes."azure-disk-volumes".disk-uri`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-disk-uri]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-disk-uri[`quarkus.knative.azure-disk-volumes."azure-disk-volumes".disk-uri`]## [.description] -- @@ -28699,16 +29278,16 @@ The URI of the vhd blob object OR the resourceID of an Azure managed data disk i ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_URI+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_URI+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_URI+++` +Environment variable: `+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_URI+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-kind[`quarkus.openshift.azure-disk-volumes."azure-disk-volumes".kind`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-kind[`quarkus.knative.azure-disk-volumes."azure-disk-volumes".kind`]## [.description] -- @@ -28716,16 +29295,16 @@ Kind of disk. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__KIND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__KIND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__KIND+++` +Environment variable: `+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__KIND+++` endif::add-copy-button-to-env-var[] -- a|`managed`, `shared` |`managed` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-caching-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-caching-mode[`quarkus.openshift.azure-disk-volumes."azure-disk-volumes".caching-mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-caching-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-caching-mode[`quarkus.knative.azure-disk-volumes."azure-disk-volumes".caching-mode`]## [.description] -- @@ -28733,16 +29312,16 @@ Disk caching mode. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__CACHING_MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__CACHING_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__CACHING_MODE+++` +Environment variable: `+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__CACHING_MODE+++` endif::add-copy-button-to-env-var[] -- a|`read-write`, `read-only`, `none` |`read-write` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-fs-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-fs-type[`quarkus.openshift.azure-disk-volumes."azure-disk-volumes".fs-type`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-fs-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-fs-type[`quarkus.knative.azure-disk-volumes."azure-disk-volumes".fs-type`]## [.description] -- @@ -28750,16 +29329,16 @@ File system type. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__FS_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__FS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__FS_TYPE+++` +Environment variable: `+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__FS_TYPE+++` endif::add-copy-button-to-env-var[] -- |string |`ext4` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-read-only[`quarkus.openshift.azure-disk-volumes."azure-disk-volumes".read-only`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-read-only[`quarkus.knative.azure-disk-volumes."azure-disk-volumes".read-only`]## [.description] -- @@ -28767,16 +29346,33 @@ Whether the volumeName is read only or not. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__READ_ONLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__READ_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__READ_ONLY+++` +Environment variable: `+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__READ_ONLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-image[`quarkus.openshift.init-containers."init-containers".image`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-container-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-container-name[`quarkus.knative.container-name`]## + +[.description] +-- +If set, it will change the name of the container according to the configuration + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KNATIVE_CONTAINER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-image[`quarkus.knative.init-containers."init-containers".image`]## [.description] -- @@ -28784,16 +29380,16 @@ The container image. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-working-dir[`quarkus.openshift.init-containers."init-containers".working-dir`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-working-dir[`quarkus.knative.init-containers."init-containers".working-dir`]## [.description] -- @@ -28801,16 +29397,16 @@ Working directory. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__WORKING_DIR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__WORKING_DIR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__WORKING_DIR+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__WORKING_DIR+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-command[`quarkus.openshift.init-containers."init-containers".command`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-command[`quarkus.knative.init-containers."init-containers".command`]## [.description] -- @@ -28818,16 +29414,16 @@ The commands ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__COMMAND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__COMMAND+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__COMMAND+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-arguments[`quarkus.openshift.init-containers."init-containers".arguments`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-arguments[`quarkus.knative.init-containers."init-containers".arguments`]## [.description] -- @@ -28835,16 +29431,16 @@ The arguments ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ARGUMENTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ARGUMENTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ARGUMENTS+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ARGUMENTS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-service-account[`quarkus.openshift.init-containers."init-containers".service-account`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-service-account[`quarkus.knative.init-containers."init-containers".service-account`]## [.description] -- @@ -28852,16 +29448,16 @@ The service account. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__SERVICE_ACCOUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__SERVICE_ACCOUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__SERVICE_ACCOUNT+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__SERVICE_ACCOUNT+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-host]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-host[`quarkus.openshift.init-containers."init-containers".host`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-host]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-host[`quarkus.knative.init-containers."init-containers".host`]## [.description] -- @@ -28869,16 +29465,16 @@ The host under which the application is going to be exposed. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__HOST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__HOST+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__HOST+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-container-port[`quarkus.openshift.init-containers."init-containers".ports."ports".container-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-container-port[`quarkus.knative.init-containers."init-containers".ports."ports".container-port`]## [.description] -- @@ -28886,16 +29482,16 @@ The port number. Refers to the container port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__CONTAINER_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__CONTAINER_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__CONTAINER_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__CONTAINER_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-host-port[`quarkus.openshift.init-containers."init-containers".ports."ports".host-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-host-port[`quarkus.knative.init-containers."init-containers".ports."ports".host-port`]## [.description] -- @@ -28903,16 +29499,16 @@ The host port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__HOST_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__HOST_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__HOST_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__HOST_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-path[`quarkus.openshift.init-containers."init-containers".ports."ports".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-path[`quarkus.knative.init-containers."init-containers".ports."ports".path`]## [.description] -- @@ -28920,16 +29516,16 @@ The application path (refers to web application path). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PATH+++` endif::add-copy-button-to-env-var[] -- |string |`/` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-protocol]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-protocol[`quarkus.openshift.init-containers."init-containers".ports."ports".protocol`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-protocol]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-protocol[`quarkus.knative.init-containers."init-containers".ports."ports".protocol`]## [.description] -- @@ -28937,16 +29533,16 @@ The protocol. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PROTOCOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PROTOCOL+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PROTOCOL+++` endif::add-copy-button-to-env-var[] -- a|`tcp`, `udp`, `sctp`, `http`, `proxy` |`tcp` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-node-port[`quarkus.openshift.init-containers."init-containers".ports."ports".node-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-node-port[`quarkus.knative.init-containers."init-containers".ports."ports".node-port`]## [.description] -- @@ -28954,16 +29550,16 @@ The nodePort to which this port should be mapped to. This only takes affect when ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__NODE_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__NODE_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__NODE_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__NODE_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-tls]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-tls[`quarkus.openshift.init-containers."init-containers".ports."ports".tls`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-tls]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-tls[`quarkus.knative.init-containers."init-containers".ports."ports".tls`]## [.description] -- @@ -28971,16 +29567,16 @@ If enabled, the port will be configured to use the schema HTTPS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__TLS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__TLS+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__TLS+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-image-pull-policy[`quarkus.openshift.init-containers."init-containers".image-pull-policy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-image-pull-policy[`quarkus.knative.init-containers."init-containers".image-pull-policy`]## [.description] -- @@ -28988,16 +29584,16 @@ Image pull policy. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_POLICY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_POLICY+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_POLICY+++` endif::add-copy-button-to-env-var[] -- a|`always`, `if-not-present`, `never` |`always` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-image-pull-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-image-pull-secrets[`quarkus.openshift.init-containers."init-containers".image-pull-secrets`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-image-pull-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-image-pull-secrets[`quarkus.knative.init-containers."init-containers".image-pull-secrets`]## [.description] -- @@ -29005,16 +29601,16 @@ The image pull secret ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_SECRETS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_SECRETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_SECRETS+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_SECRETS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-port[`quarkus.openshift.init-containers."init-containers".liveness-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-port[`quarkus.knative.init-containers."init-containers".liveness-probe.http-action-port`]## [.description] -- @@ -29022,16 +29618,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-port-name[`quarkus.openshift.init-containers."init-containers".liveness-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-port-name[`quarkus.knative.init-containers."init-containers".liveness-probe.http-action-port-name`]## [.description] -- @@ -29039,16 +29635,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-path[`quarkus.openshift.init-containers."init-containers".liveness-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-path[`quarkus.knative.init-containers."init-containers".liveness-probe.http-action-path`]## [.description] -- @@ -29056,16 +29652,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-scheme[`quarkus.openshift.init-containers."init-containers".liveness-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-scheme[`quarkus.knative.init-containers."init-containers".liveness-probe.http-action-scheme`]## [.description] -- @@ -29073,16 +29669,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-exec-action[`quarkus.openshift.init-containers."init-containers".liveness-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-exec-action[`quarkus.knative.init-containers."init-containers".liveness-probe.exec-action`]## [.description] -- @@ -29090,16 +29686,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-tcp-socket-action[`quarkus.openshift.init-containers."init-containers".liveness-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-tcp-socket-action[`quarkus.knative.init-containers."init-containers".liveness-probe.tcp-socket-action`]## [.description] -- @@ -29107,16 +29703,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-grpc-action[`quarkus.openshift.init-containers."init-containers".liveness-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-grpc-action[`quarkus.knative.init-containers."init-containers".liveness-probe.grpc-action`]## [.description] -- @@ -29124,16 +29720,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-grpc-action-enabled[`quarkus.openshift.init-containers."init-containers".liveness-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-grpc-action-enabled[`quarkus.knative.init-containers."init-containers".liveness-probe.grpc-action-enabled`]## [.description] -- @@ -29141,16 +29737,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-initial-delay[`quarkus.openshift.init-containers."init-containers".liveness-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-initial-delay[`quarkus.knative.init-containers."init-containers".liveness-probe.initial-delay`]## [.description] -- @@ -29158,16 +29754,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-period[`quarkus.openshift.init-containers."init-containers".liveness-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-period[`quarkus.knative.init-containers."init-containers".liveness-probe.period`]## [.description] -- @@ -29175,16 +29771,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-timeout[`quarkus.openshift.init-containers."init-containers".liveness-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-timeout[`quarkus.knative.init-containers."init-containers".liveness-probe.timeout`]## [.description] -- @@ -29192,16 +29788,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-success-threshold[`quarkus.openshift.init-containers."init-containers".liveness-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-success-threshold[`quarkus.knative.init-containers."init-containers".liveness-probe.success-threshold`]## [.description] -- @@ -29209,16 +29805,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-failure-threshold[`quarkus.openshift.init-containers."init-containers".liveness-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-failure-threshold[`quarkus.knative.init-containers."init-containers".liveness-probe.failure-threshold`]## [.description] -- @@ -29226,16 +29822,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-port[`quarkus.openshift.init-containers."init-containers".readiness-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-port[`quarkus.knative.init-containers."init-containers".readiness-probe.http-action-port`]## [.description] -- @@ -29243,16 +29839,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-port-name[`quarkus.openshift.init-containers."init-containers".readiness-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-port-name[`quarkus.knative.init-containers."init-containers".readiness-probe.http-action-port-name`]## [.description] -- @@ -29260,16 +29856,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-path[`quarkus.openshift.init-containers."init-containers".readiness-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-path[`quarkus.knative.init-containers."init-containers".readiness-probe.http-action-path`]## [.description] -- @@ -29277,16 +29873,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-scheme[`quarkus.openshift.init-containers."init-containers".readiness-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-scheme[`quarkus.knative.init-containers."init-containers".readiness-probe.http-action-scheme`]## [.description] -- @@ -29294,16 +29890,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-exec-action[`quarkus.openshift.init-containers."init-containers".readiness-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-exec-action[`quarkus.knative.init-containers."init-containers".readiness-probe.exec-action`]## [.description] -- @@ -29311,16 +29907,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-tcp-socket-action[`quarkus.openshift.init-containers."init-containers".readiness-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-tcp-socket-action[`quarkus.knative.init-containers."init-containers".readiness-probe.tcp-socket-action`]## [.description] -- @@ -29328,16 +29924,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-grpc-action[`quarkus.openshift.init-containers."init-containers".readiness-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-grpc-action[`quarkus.knative.init-containers."init-containers".readiness-probe.grpc-action`]## [.description] -- @@ -29345,16 +29941,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-grpc-action-enabled[`quarkus.openshift.init-containers."init-containers".readiness-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-grpc-action-enabled[`quarkus.knative.init-containers."init-containers".readiness-probe.grpc-action-enabled`]## [.description] -- @@ -29362,16 +29958,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-initial-delay[`quarkus.openshift.init-containers."init-containers".readiness-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-initial-delay[`quarkus.knative.init-containers."init-containers".readiness-probe.initial-delay`]## [.description] -- @@ -29379,16 +29975,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-period[`quarkus.openshift.init-containers."init-containers".readiness-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-period[`quarkus.knative.init-containers."init-containers".readiness-probe.period`]## [.description] -- @@ -29396,16 +29992,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-timeout[`quarkus.openshift.init-containers."init-containers".readiness-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-timeout[`quarkus.knative.init-containers."init-containers".readiness-probe.timeout`]## [.description] -- @@ -29413,16 +30009,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-success-threshold[`quarkus.openshift.init-containers."init-containers".readiness-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-success-threshold[`quarkus.knative.init-containers."init-containers".readiness-probe.success-threshold`]## [.description] -- @@ -29430,16 +30026,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-failure-threshold[`quarkus.openshift.init-containers."init-containers".readiness-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-failure-threshold[`quarkus.knative.init-containers."init-containers".readiness-probe.failure-threshold`]## [.description] -- @@ -29447,16 +30043,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-name[`quarkus.openshift.init-containers."init-containers".mounts."mounts".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-name[`quarkus.knative.init-containers."init-containers".mounts."mounts".name`]## [.description] -- @@ -29464,16 +30060,16 @@ The name of the volumeName to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-path[`quarkus.openshift.init-containers."init-containers".mounts."mounts".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-path[`quarkus.knative.init-containers."init-containers".mounts."mounts".path`]## [.description] -- @@ -29481,16 +30077,16 @@ The path to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-sub-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-sub-path[`quarkus.openshift.init-containers."init-containers".mounts."mounts".sub-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-sub-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-sub-path[`quarkus.knative.init-containers."init-containers".mounts."mounts".sub-path`]## [.description] -- @@ -29498,16 +30094,16 @@ Path within the volumeName from which the container's volumeName should be mount ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__SUB_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__SUB_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__SUB_PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__SUB_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-read-only[`quarkus.openshift.init-containers."init-containers".mounts."mounts".read-only`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-read-only[`quarkus.knative.init-containers."init-containers".mounts."mounts".read-only`]## [.description] -- @@ -29515,16 +30111,16 @@ ReadOnly ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__READ_ONLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__READ_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__READ_ONLY+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__READ_ONLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-limits-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-limits-cpu[`quarkus.openshift.init-containers."init-containers".resources.limits.cpu`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-limits-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-limits-cpu[`quarkus.knative.init-containers."init-containers".resources.limits.cpu`]## [.description] -- @@ -29532,16 +30128,16 @@ CPU Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_CPU+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_CPU+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_CPU+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_CPU+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-limits-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-limits-memory[`quarkus.openshift.init-containers."init-containers".resources.limits.memory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-limits-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-limits-memory[`quarkus.knative.init-containers."init-containers".resources.limits.memory`]## [.description] -- @@ -29549,16 +30145,16 @@ Memory Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_MEMORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_MEMORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_MEMORY+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_MEMORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-requests-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-requests-cpu[`quarkus.openshift.init-containers."init-containers".resources.requests.cpu`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-requests-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-requests-cpu[`quarkus.knative.init-containers."init-containers".resources.requests.cpu`]## [.description] -- @@ -29566,16 +30162,16 @@ CPU Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_CPU+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_CPU+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_CPU+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_CPU+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-requests-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-requests-memory[`quarkus.openshift.init-containers."init-containers".resources.requests.memory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-requests-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-requests-memory[`quarkus.knative.init-containers."init-containers".resources.requests.memory`]## [.description] -- @@ -29583,16 +30179,16 @@ Memory Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_MEMORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_MEMORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_MEMORY+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_MEMORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-secrets[`quarkus.openshift.init-containers."init-containers".env.secrets`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-secrets[`quarkus.knative.init-containers."init-containers".env.secrets`]## [.description] -- @@ -29600,16 +30196,16 @@ The optional list of Secret names to load environment variables from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_SECRETS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_SECRETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_SECRETS+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_SECRETS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-configmaps]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-configmaps[`quarkus.openshift.init-containers."init-containers".env.configmaps`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-configmaps]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-configmaps[`quarkus.knative.init-containers."init-containers".env.configmaps`]## [.description] -- @@ -29617,16 +30213,16 @@ The optional list of ConfigMap names to load environment variables from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_CONFIGMAPS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_CONFIGMAPS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_CONFIGMAPS+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_CONFIGMAPS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-fields-environment-variable-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-fields-environment-variable-name[`quarkus.openshift.init-containers."init-containers".env.fields."environment-variable-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-fields-environment-variable-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-fields-environment-variable-name[`quarkus.knative.init-containers."init-containers".env.fields."environment-variable-name"`]## [.description] -- @@ -29634,16 +30230,16 @@ The map associating environment variable names to their associated field referen ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++` endif::add-copy-button-to-env-var[] -- |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-vars-vars]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-vars-vars[`quarkus.openshift.init-containers."init-containers".env.vars."vars"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-vars-vars]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-vars-vars[`quarkus.knative.init-containers."init-containers".env.vars."vars"`]## [.description] -- @@ -29651,16 +30247,16 @@ The map associating environment name to its associated value. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_VARS__VARS_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_VARS__VARS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_VARS__VARS_+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_VARS__VARS_+++` endif::add-copy-button-to-env-var[] -- |Map> | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-mapping-mapping-from-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-mapping-mapping-from-secret[`quarkus.openshift.init-containers."init-containers".env.mapping."mapping".from-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-mapping-mapping-from-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-mapping-mapping-from-secret[`quarkus.knative.init-containers."init-containers".env.mapping."mapping".from-secret`]## [.description] -- @@ -29668,16 +30264,16 @@ The optional name of the Secret from which a value is to be extracted. Mutually ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-mapping-mapping-from-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-mapping-mapping-from-configmap[`quarkus.openshift.init-containers."init-containers".env.mapping."mapping".from-configmap`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-mapping-mapping-from-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-mapping-mapping-from-configmap[`quarkus.knative.init-containers."init-containers".env.mapping."mapping".from-configmap`]## [.description] -- @@ -29685,16 +30281,16 @@ The optional name of the ConfigMap from which a value is to be extracted. Mutual ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-mapping-mapping-with-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-mapping-mapping-with-key[`quarkus.openshift.init-containers."init-containers".env.mapping."mapping".with-key`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-mapping-mapping-with-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-mapping-mapping-with-key[`quarkus.knative.init-containers."init-containers".env.mapping."mapping".with-key`]## [.description] -- @@ -29702,16 +30298,16 @@ The key identifying the field from which the value is extracted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-using-prefix-prefixes-for-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-using-prefix-prefixes-for-secret[`quarkus.openshift.init-containers."init-containers".env.using-prefix."prefixes".for-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-using-prefix-prefixes-for-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-using-prefix-prefixes-for-secret[`quarkus.knative.init-containers."init-containers".env.using-prefix."prefixes".for-secret`]## [.description] -- @@ -29719,16 +30315,16 @@ The optional prefix to use when adding the environment variable to the container ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-using-prefix-prefixes-for-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-using-prefix-prefixes-for-configmap[`quarkus.openshift.init-containers."init-containers".env.using-prefix."prefixes".for-configmap`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-using-prefix-prefixes-for-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-using-prefix-prefixes-for-configmap[`quarkus.knative.init-containers."init-containers".env.using-prefix."prefixes".for-configmap`]## [.description] -- @@ -29736,16 +30332,16 @@ The optional prefix to use when adding the environment variable to the container ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++` +Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-image[`quarkus.openshift.sidecars."sidecars".image`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-image[`quarkus.knative.containers."containers".image`]## [.description] -- @@ -29753,16 +30349,16 @@ The container image. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-working-dir[`quarkus.openshift.sidecars."sidecars".working-dir`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-working-dir[`quarkus.knative.containers."containers".working-dir`]## [.description] -- @@ -29770,16 +30366,16 @@ Working directory. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__WORKING_DIR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__WORKING_DIR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__WORKING_DIR+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__WORKING_DIR+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-command[`quarkus.openshift.sidecars."sidecars".command`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-command[`quarkus.knative.containers."containers".command`]## [.description] -- @@ -29787,16 +30383,16 @@ The commands ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__COMMAND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__COMMAND+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__COMMAND+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-arguments[`quarkus.openshift.sidecars."sidecars".arguments`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-arguments[`quarkus.knative.containers."containers".arguments`]## [.description] -- @@ -29804,16 +30400,16 @@ The arguments ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ARGUMENTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ARGUMENTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ARGUMENTS+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ARGUMENTS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-service-account[`quarkus.openshift.sidecars."sidecars".service-account`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-service-account[`quarkus.knative.containers."containers".service-account`]## [.description] -- @@ -29821,16 +30417,16 @@ The service account. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__SERVICE_ACCOUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__SERVICE_ACCOUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__SERVICE_ACCOUNT+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__SERVICE_ACCOUNT+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-host]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-host[`quarkus.openshift.sidecars."sidecars".host`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-host]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-host[`quarkus.knative.containers."containers".host`]## [.description] -- @@ -29838,16 +30434,16 @@ The host under which the application is going to be exposed. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__HOST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__HOST+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__HOST+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-container-port[`quarkus.openshift.sidecars."sidecars".ports."ports".container-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-container-port[`quarkus.knative.containers."containers".ports."ports".container-port`]## [.description] -- @@ -29855,16 +30451,16 @@ The port number. Refers to the container port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__CONTAINER_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__CONTAINER_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__CONTAINER_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__CONTAINER_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-host-port[`quarkus.openshift.sidecars."sidecars".ports."ports".host-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-host-port[`quarkus.knative.containers."containers".ports."ports".host-port`]## [.description] -- @@ -29872,16 +30468,16 @@ The host port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__HOST_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__HOST_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__HOST_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__HOST_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-path[`quarkus.openshift.sidecars."sidecars".ports."ports".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-path[`quarkus.knative.containers."containers".ports."ports".path`]## [.description] -- @@ -29889,16 +30485,16 @@ The application path (refers to web application path). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__PATH+++` endif::add-copy-button-to-env-var[] -- |string |`/` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-protocol]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-protocol[`quarkus.openshift.sidecars."sidecars".ports."ports".protocol`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-protocol]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-protocol[`quarkus.knative.containers."containers".ports."ports".protocol`]## [.description] -- @@ -29906,16 +30502,16 @@ The protocol. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__PROTOCOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__PROTOCOL+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__PROTOCOL+++` endif::add-copy-button-to-env-var[] -- a|`tcp`, `udp`, `sctp`, `http`, `proxy` |`tcp` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-node-port[`quarkus.openshift.sidecars."sidecars".ports."ports".node-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-node-port[`quarkus.knative.containers."containers".ports."ports".node-port`]## [.description] -- @@ -29923,16 +30519,16 @@ The nodePort to which this port should be mapped to. This only takes affect when ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__NODE_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__NODE_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__NODE_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__NODE_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-tls]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-tls[`quarkus.openshift.sidecars."sidecars".ports."ports".tls`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-tls]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-tls[`quarkus.knative.containers."containers".ports."ports".tls`]## [.description] -- @@ -29940,16 +30536,16 @@ If enabled, the port will be configured to use the schema HTTPS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__TLS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__TLS+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__TLS+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-image-pull-policy[`quarkus.openshift.sidecars."sidecars".image-pull-policy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-image-pull-policy[`quarkus.knative.containers."containers".image-pull-policy`]## [.description] -- @@ -29957,16 +30553,16 @@ Image pull policy. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE_PULL_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE_PULL_POLICY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE_PULL_POLICY+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE_PULL_POLICY+++` endif::add-copy-button-to-env-var[] -- a|`always`, `if-not-present`, `never` |`always` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-image-pull-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-image-pull-secrets[`quarkus.openshift.sidecars."sidecars".image-pull-secrets`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-image-pull-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-image-pull-secrets[`quarkus.knative.containers."containers".image-pull-secrets`]## [.description] -- @@ -29974,16 +30570,16 @@ The image pull secret ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE_PULL_SECRETS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE_PULL_SECRETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE_PULL_SECRETS+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE_PULL_SECRETS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-port[`quarkus.openshift.sidecars."sidecars".liveness-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-port[`quarkus.knative.containers."containers".liveness-probe.http-action-port`]## [.description] -- @@ -29991,16 +30587,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-port-name[`quarkus.openshift.sidecars."sidecars".liveness-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-port-name[`quarkus.knative.containers."containers".liveness-probe.http-action-port-name`]## [.description] -- @@ -30008,16 +30604,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-path[`quarkus.openshift.sidecars."sidecars".liveness-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-path[`quarkus.knative.containers."containers".liveness-probe.http-action-path`]## [.description] -- @@ -30025,16 +30621,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-scheme[`quarkus.openshift.sidecars."sidecars".liveness-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-scheme[`quarkus.knative.containers."containers".liveness-probe.http-action-scheme`]## [.description] -- @@ -30042,16 +30638,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-exec-action[`quarkus.openshift.sidecars."sidecars".liveness-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-exec-action[`quarkus.knative.containers."containers".liveness-probe.exec-action`]## [.description] -- @@ -30059,16 +30655,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-tcp-socket-action[`quarkus.openshift.sidecars."sidecars".liveness-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-tcp-socket-action[`quarkus.knative.containers."containers".liveness-probe.tcp-socket-action`]## [.description] -- @@ -30076,16 +30672,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-grpc-action[`quarkus.openshift.sidecars."sidecars".liveness-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-grpc-action[`quarkus.knative.containers."containers".liveness-probe.grpc-action`]## [.description] -- @@ -30093,16 +30689,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-grpc-action-enabled[`quarkus.openshift.sidecars."sidecars".liveness-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-grpc-action-enabled[`quarkus.knative.containers."containers".liveness-probe.grpc-action-enabled`]## [.description] -- @@ -30110,16 +30706,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-initial-delay[`quarkus.openshift.sidecars."sidecars".liveness-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-initial-delay[`quarkus.knative.containers."containers".liveness-probe.initial-delay`]## [.description] -- @@ -30127,16 +30723,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-period[`quarkus.openshift.sidecars."sidecars".liveness-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-period[`quarkus.knative.containers."containers".liveness-probe.period`]## [.description] -- @@ -30144,16 +30740,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-timeout[`quarkus.openshift.sidecars."sidecars".liveness-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-timeout[`quarkus.knative.containers."containers".liveness-probe.timeout`]## [.description] -- @@ -30161,16 +30757,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-success-threshold[`quarkus.openshift.sidecars."sidecars".liveness-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-success-threshold[`quarkus.knative.containers."containers".liveness-probe.success-threshold`]## [.description] -- @@ -30178,16 +30774,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-failure-threshold[`quarkus.openshift.sidecars."sidecars".liveness-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-failure-threshold[`quarkus.knative.containers."containers".liveness-probe.failure-threshold`]## [.description] -- @@ -30195,16 +30791,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-port[`quarkus.openshift.sidecars."sidecars".readiness-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-port[`quarkus.knative.containers."containers".readiness-probe.http-action-port`]## [.description] -- @@ -30212,16 +30808,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-port-name[`quarkus.openshift.sidecars."sidecars".readiness-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-port-name[`quarkus.knative.containers."containers".readiness-probe.http-action-port-name`]## [.description] -- @@ -30229,16 +30825,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-path[`quarkus.openshift.sidecars."sidecars".readiness-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-path[`quarkus.knative.containers."containers".readiness-probe.http-action-path`]## [.description] -- @@ -30246,16 +30842,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-scheme[`quarkus.openshift.sidecars."sidecars".readiness-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-scheme[`quarkus.knative.containers."containers".readiness-probe.http-action-scheme`]## [.description] -- @@ -30263,16 +30859,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-exec-action[`quarkus.openshift.sidecars."sidecars".readiness-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-exec-action[`quarkus.knative.containers."containers".readiness-probe.exec-action`]## [.description] -- @@ -30280,16 +30876,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-tcp-socket-action[`quarkus.openshift.sidecars."sidecars".readiness-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-tcp-socket-action[`quarkus.knative.containers."containers".readiness-probe.tcp-socket-action`]## [.description] -- @@ -30297,16 +30893,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-grpc-action[`quarkus.openshift.sidecars."sidecars".readiness-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-grpc-action[`quarkus.knative.containers."containers".readiness-probe.grpc-action`]## [.description] -- @@ -30314,16 +30910,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-grpc-action-enabled[`quarkus.openshift.sidecars."sidecars".readiness-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-grpc-action-enabled[`quarkus.knative.containers."containers".readiness-probe.grpc-action-enabled`]## [.description] -- @@ -30331,16 +30927,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-initial-delay[`quarkus.openshift.sidecars."sidecars".readiness-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-initial-delay[`quarkus.knative.containers."containers".readiness-probe.initial-delay`]## [.description] -- @@ -30348,16 +30944,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-period[`quarkus.openshift.sidecars."sidecars".readiness-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-period[`quarkus.knative.containers."containers".readiness-probe.period`]## [.description] -- @@ -30365,16 +30961,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-timeout[`quarkus.openshift.sidecars."sidecars".readiness-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-timeout[`quarkus.knative.containers."containers".readiness-probe.timeout`]## [.description] -- @@ -30382,16 +30978,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-success-threshold[`quarkus.openshift.sidecars."sidecars".readiness-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-success-threshold[`quarkus.knative.containers."containers".readiness-probe.success-threshold`]## [.description] -- @@ -30399,16 +30995,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-failure-threshold[`quarkus.openshift.sidecars."sidecars".readiness-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-failure-threshold[`quarkus.knative.containers."containers".readiness-probe.failure-threshold`]## [.description] -- @@ -30416,16 +31012,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-name[`quarkus.openshift.sidecars."sidecars".mounts."mounts".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-name[`quarkus.knative.containers."containers".mounts."mounts".name`]## [.description] -- @@ -30433,16 +31029,16 @@ The name of the volumeName to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-path[`quarkus.openshift.sidecars."sidecars".mounts."mounts".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-path[`quarkus.knative.containers."containers".mounts."mounts".path`]## [.description] -- @@ -30450,16 +31046,16 @@ The path to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-sub-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-sub-path[`quarkus.openshift.sidecars."sidecars".mounts."mounts".sub-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-sub-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-sub-path[`quarkus.knative.containers."containers".mounts."mounts".sub-path`]## [.description] -- @@ -30467,16 +31063,16 @@ Path within the volumeName from which the container's volumeName should be mount ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__SUB_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__SUB_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__SUB_PATH+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__SUB_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-read-only[`quarkus.openshift.sidecars."sidecars".mounts."mounts".read-only`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-read-only[`quarkus.knative.containers."containers".mounts."mounts".read-only`]## [.description] -- @@ -30484,16 +31080,16 @@ ReadOnly ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__READ_ONLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__READ_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__READ_ONLY+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__READ_ONLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-limits-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-limits-cpu[`quarkus.openshift.sidecars."sidecars".resources.limits.cpu`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-resources-limits-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-resources-limits-cpu[`quarkus.knative.containers."containers".resources.limits.cpu`]## [.description] -- @@ -30501,16 +31097,16 @@ CPU Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_LIMITS_CPU+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_LIMITS_CPU+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_LIMITS_CPU+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_LIMITS_CPU+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-limits-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-limits-memory[`quarkus.openshift.sidecars."sidecars".resources.limits.memory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-resources-limits-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-resources-limits-memory[`quarkus.knative.containers."containers".resources.limits.memory`]## [.description] -- @@ -30518,16 +31114,16 @@ Memory Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_LIMITS_MEMORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_LIMITS_MEMORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_LIMITS_MEMORY+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_LIMITS_MEMORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-requests-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-requests-cpu[`quarkus.openshift.sidecars."sidecars".resources.requests.cpu`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-resources-requests-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-resources-requests-cpu[`quarkus.knative.containers."containers".resources.requests.cpu`]## [.description] -- @@ -30535,16 +31131,16 @@ CPU Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_REQUESTS_CPU+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_REQUESTS_CPU+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_REQUESTS_CPU+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_REQUESTS_CPU+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-requests-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-requests-memory[`quarkus.openshift.sidecars."sidecars".resources.requests.memory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-resources-requests-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-resources-requests-memory[`quarkus.knative.containers."containers".resources.requests.memory`]## [.description] -- @@ -30552,16 +31148,16 @@ Memory Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_REQUESTS_MEMORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_REQUESTS_MEMORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_REQUESTS_MEMORY+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_REQUESTS_MEMORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-secrets[`quarkus.openshift.sidecars."sidecars".env.secrets`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-secrets[`quarkus.knative.containers."containers".env.secrets`]## [.description] -- @@ -30569,16 +31165,16 @@ The optional list of Secret names to load environment variables from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_SECRETS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_SECRETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_SECRETS+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_SECRETS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-configmaps]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-configmaps[`quarkus.openshift.sidecars."sidecars".env.configmaps`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-configmaps]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-configmaps[`quarkus.knative.containers."containers".env.configmaps`]## [.description] -- @@ -30586,16 +31182,16 @@ The optional list of ConfigMap names to load environment variables from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_CONFIGMAPS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_CONFIGMAPS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_CONFIGMAPS+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_CONFIGMAPS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-fields-environment-variable-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-fields-environment-variable-name[`quarkus.openshift.sidecars."sidecars".env.fields."environment-variable-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-fields-environment-variable-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-fields-environment-variable-name[`quarkus.knative.containers."containers".env.fields."environment-variable-name"`]## [.description] -- @@ -30603,16 +31199,16 @@ The map associating environment variable names to their associated field referen ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++` endif::add-copy-button-to-env-var[] -- |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-vars-vars]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-vars-vars[`quarkus.openshift.sidecars."sidecars".env.vars."vars"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-vars-vars]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-vars-vars[`quarkus.knative.containers."containers".env.vars."vars"`]## [.description] -- @@ -30620,16 +31216,16 @@ The map associating environment name to its associated value. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_VARS__VARS_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_VARS__VARS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_VARS__VARS_+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_VARS__VARS_+++` endif::add-copy-button-to-env-var[] -- |Map> | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-mapping-mapping-from-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-mapping-mapping-from-secret[`quarkus.openshift.sidecars."sidecars".env.mapping."mapping".from-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-mapping-mapping-from-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-mapping-mapping-from-secret[`quarkus.knative.containers."containers".env.mapping."mapping".from-secret`]## [.description] -- @@ -30637,16 +31233,16 @@ The optional name of the Secret from which a value is to be extracted. Mutually ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_SECRET+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-mapping-mapping-from-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-mapping-mapping-from-configmap[`quarkus.openshift.sidecars."sidecars".env.mapping."mapping".from-configmap`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-mapping-mapping-from-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-mapping-mapping-from-configmap[`quarkus.knative.containers."containers".env.mapping."mapping".from-configmap`]## [.description] -- @@ -30654,16 +31250,16 @@ The optional name of the ConfigMap from which a value is to be extracted. Mutual ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-mapping-mapping-with-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-mapping-mapping-with-key[`quarkus.openshift.sidecars."sidecars".env.mapping."mapping".with-key`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-mapping-mapping-with-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-mapping-mapping-with-key[`quarkus.knative.containers."containers".env.mapping."mapping".with-key`]## [.description] -- @@ -30671,16 +31267,16 @@ The key identifying the field from which the value is extracted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__WITH_KEY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__WITH_KEY+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-using-prefix-prefixes-for-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-using-prefix-prefixes-for-secret[`quarkus.openshift.sidecars."sidecars".env.using-prefix."prefixes".for-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-using-prefix-prefixes-for-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-using-prefix-prefixes-for-secret[`quarkus.knative.containers."containers".env.using-prefix."prefixes".for-secret`]## [.description] -- @@ -30688,16 +31284,16 @@ The optional prefix to use when adding the environment variable to the container ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-using-prefix-prefixes-for-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-using-prefix-prefixes-for-configmap[`quarkus.openshift.sidecars."sidecars".env.using-prefix."prefixes".for-configmap`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-using-prefix-prefixes-for-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-using-prefix-prefixes-for-configmap[`quarkus.knative.containers."containers".env.using-prefix."prefixes".for-configmap`]## [.description] -- @@ -30705,16 +31301,16 @@ The optional prefix to use when adding the environment variable to the container ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++` +Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-host-aliases-host-aliases-ip]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-host-aliases-host-aliases-ip[`quarkus.openshift.host-aliases."host-aliases".ip`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-host-aliases-host-aliases-ip]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-host-aliases-host-aliases-ip[`quarkus.knative.host-aliases."host-aliases".ip`]## [.description] -- @@ -30722,16 +31318,16 @@ The ip address ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_HOST_ALIASES__HOST_ALIASES__IP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_HOST_ALIASES__HOST_ALIASES__IP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_HOST_ALIASES__HOST_ALIASES__IP+++` +Environment variable: `+++QUARKUS_KNATIVE_HOST_ALIASES__HOST_ALIASES__IP+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-host-aliases-host-aliases-hostnames]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-host-aliases-host-aliases-hostnames[`quarkus.openshift.host-aliases."host-aliases".hostnames`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-host-aliases-host-aliases-hostnames]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-host-aliases-host-aliases-hostnames[`quarkus.knative.host-aliases."host-aliases".hostnames`]## [.description] -- @@ -30739,16 +31335,16 @@ The hostnames to resolve to the ip ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_HOST_ALIASES__HOST_ALIASES__HOSTNAMES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_HOST_ALIASES__HOST_ALIASES__HOSTNAMES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_HOST_ALIASES__HOST_ALIASES__HOSTNAMES+++` +Environment variable: `+++QUARKUS_KNATIVE_HOST_ALIASES__HOST_ALIASES__HOSTNAMES+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-resources-limits-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-resources-limits-cpu[`quarkus.openshift.resources.limits.cpu`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-resources-limits-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-resources-limits-cpu[`quarkus.knative.resources.limits.cpu`]## [.description] -- @@ -30756,16 +31352,16 @@ CPU Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RESOURCES_LIMITS_CPU+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RESOURCES_LIMITS_CPU+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RESOURCES_LIMITS_CPU+++` +Environment variable: `+++QUARKUS_KNATIVE_RESOURCES_LIMITS_CPU+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-resources-limits-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-resources-limits-memory[`quarkus.openshift.resources.limits.memory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-resources-limits-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-resources-limits-memory[`quarkus.knative.resources.limits.memory`]## [.description] -- @@ -30773,16 +31369,16 @@ Memory Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RESOURCES_LIMITS_MEMORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RESOURCES_LIMITS_MEMORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RESOURCES_LIMITS_MEMORY+++` +Environment variable: `+++QUARKUS_KNATIVE_RESOURCES_LIMITS_MEMORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-resources-requests-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-resources-requests-cpu[`quarkus.openshift.resources.requests.cpu`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-resources-requests-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-resources-requests-cpu[`quarkus.knative.resources.requests.cpu`]## [.description] -- @@ -30790,16 +31386,16 @@ CPU Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RESOURCES_REQUESTS_CPU+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RESOURCES_REQUESTS_CPU+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RESOURCES_REQUESTS_CPU+++` +Environment variable: `+++QUARKUS_KNATIVE_RESOURCES_REQUESTS_CPU+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-resources-requests-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-resources-requests-memory[`quarkus.openshift.resources.requests.memory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-resources-requests-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-resources-requests-memory[`quarkus.knative.resources.requests.memory`]## [.description] -- @@ -30807,2105 +31403,1714 @@ Memory Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RESOURCES_REQUESTS_MEMORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RESOURCES_REQUESTS_MEMORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RESOURCES_REQUESTS_MEMORY+++` +Environment variable: `+++QUARKUS_KNATIVE_RESOURCES_REQUESTS_MEMORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-container-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-container-name[`quarkus.openshift.container-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-name[`quarkus.knative.rbac.roles."roles".name`]## [.description] -- -If set, it will change the name of the container according to the configuration +The name of the role. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CONTAINER_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CONTAINER_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-expose]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-expose[`quarkus.openshift.route.expose`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-namespace[`quarkus.knative.rbac.roles."roles".namespace`]## [.description] -- -If true, the service will be exposed +The namespace of the role. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_EXPOSE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__NAMESPACE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_EXPOSE+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__NAMESPACE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-host]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-host[`quarkus.openshift.route.host`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-labels-label-name[`quarkus.knative.rbac.roles."roles".labels."label-name"`]## [.description] -- -The host under which the application is going to be exposed +Labels to add into the Role resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_HOST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_HOST+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-target-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-target-port[`quarkus.openshift.route.target-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-api-groups]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-api-groups[`quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".api-groups`]## [.description] -- -The target named port. If not provided, it will be deducted from the Service resource ports. Options are: "http" and "https". +API groups of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TARGET_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TARGET_PORT+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++` endif::add-copy-button-to-env-var[] -- -|string -|`http` +|list of string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-annotations-annotation-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-annotations-annotation-name[`quarkus.openshift.route.annotations."annotation-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-non-resource-urls]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-non-resource-urls[`quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".non-resource-urls`]## [.description] -- -Custom annotations to add to exposition (route or ingress) resources +Non resource URLs of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_ANNOTATIONS__ANNOTATION_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_ANNOTATIONS__ANNOTATION_NAME_+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++` endif::add-copy-button-to-env-var[] -- -|Map +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-labels-label-name[`quarkus.openshift.route.labels."label-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-resource-names]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-resource-names[`quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".resource-names`]## [.description] -- -Custom labels to add to exposition (route or ingress) resources +Resource names of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++` endif::add-copy-button-to-env-var[] -- -|Map +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-tls-ca-certificate]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-tls-ca-certificate[`quarkus.openshift.route.tls.ca-certificate`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-resources]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-resources[`quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".resources`]## [.description] -- -The cert authority certificate contents. +Resources of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_CA_CERTIFICATE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TLS_CA_CERTIFICATE+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-tls-certificate]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-tls-certificate[`quarkus.openshift.route.tls.certificate`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-verbs]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-verbs[`quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".verbs`]## [.description] -- -The certificate contents. +Verbs of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_CERTIFICATE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__VERBS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TLS_CERTIFICATE+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__VERBS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-tls-destination-ca-certificate]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-tls-destination-ca-certificate[`quarkus.openshift.route.tls.destination-ca-certificate`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-name[`quarkus.knative.rbac.cluster-roles."cluster-roles".name`]## [.description] -- -The contents of the ca certificate of the final destination. +The name of the cluster role. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_DESTINATION_CA_CERTIFICATE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TLS_DESTINATION_CA_CERTIFICATE+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-tls-insecure-edge-termination-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-tls-insecure-edge-termination-policy[`quarkus.openshift.route.tls.insecure-edge-termination-policy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-labels-label-name[`quarkus.knative.rbac.cluster-roles."cluster-roles".labels."label-name"`]## [.description] -- -The desired behavior for insecure connections to a route. +Labels to add into the ClusterRole resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_INSECURE_EDGE_TERMINATION_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TLS_INSECURE_EDGE_TERMINATION_POLICY+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-tls-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-tls-key[`quarkus.openshift.route.tls.key`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-api-groups]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-api-groups[`quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".api-groups`]## [.description] -- -The key file contents. +API groups of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_KEY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TLS_KEY+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-tls-termination]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-tls-termination[`quarkus.openshift.route.tls.termination`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-non-resource-urls]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-non-resource-urls[`quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".non-resource-urls`]## [.description] -- -The termination type. +Non resource URLs of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_TERMINATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TLS_TERMINATION+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-add-version-to-label-selectors]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-add-version-to-label-selectors[`quarkus.openshift.add-version-to-label-selectors`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resource-names]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resource-names[`quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resource-names`]## [.description] -- -If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and DeploymentConfig +Resource names of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ADD_VERSION_TO_LABEL_SELECTORS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ADD_VERSION_TO_LABEL_SELECTORS+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|list of string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-add-name-to-label-selectors]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-add-name-to-label-selectors[`quarkus.openshift.add-name-to-label-selectors`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resources]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resources[`quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resources`]## [.description] -- -If true, the 'app.kubernetes.io/name' label will be part of the selectors of Service and Deployment +Resources of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ADD_NAME_TO_LABEL_SELECTORS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ADD_NAME_TO_LABEL_SELECTORS+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|list of string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-parallelism]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-parallelism[`quarkus.openshift.job.parallelism`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-verbs]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-verbs[`quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".verbs`]## [.description] -- -Specifies the maximum desired number of pods the job should run at any given time. +Verbs of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_PARALLELISM+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__VERBS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_JOB_PARALLELISM+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__VERBS+++` endif::add-copy-button-to-env-var[] -- -|int +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-completions]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-completions[`quarkus.openshift.job.completions`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-name[`quarkus.knative.rbac.service-accounts."service-accounts".name`]## [.description] -- -Specifies the desired number of successfully finished pods the job should be run with. +The name of the service account. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_COMPLETIONS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_JOB_COMPLETIONS+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-completion-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-completion-mode[`quarkus.openshift.job.completion-mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-namespace[`quarkus.knative.rbac.service-accounts."service-accounts".namespace`]## [.description] -- -CompletionMode specifies how Pod completions are tracked. +The namespace of the service account. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_COMPLETION_MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAMESPACE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_JOB_COMPLETION_MODE+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAMESPACE+++` endif::add-copy-button-to-env-var[] -- -a|`non-indexed`, `indexed` -|`non-indexed` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-backoff-limit]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-backoff-limit[`quarkus.openshift.job.backoff-limit`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-labels-label-name[`quarkus.knative.rbac.service-accounts."service-accounts".labels."label-name"`]## [.description] -- -Specifies the number of retries before marking this job failed. +Labels of the service account. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_BACKOFF_LIMIT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_JOB_BACKOFF_LIMIT+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|int +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-active-deadline-seconds]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-active-deadline-seconds[`quarkus.openshift.job.active-deadline-seconds`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-use-as-default]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-use-as-default[`quarkus.knative.rbac.service-accounts."service-accounts".use-as-default`]## [.description] -- -Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. +If true, this service account will be used in the generated Deployment resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_ACTIVE_DEADLINE_SECONDS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__USE_AS_DEFAULT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_JOB_ACTIVE_DEADLINE_SECONDS+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__USE_AS_DEFAULT+++` endif::add-copy-button-to-env-var[] -- -|long +|boolean | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-ttl-seconds-after-finished]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-ttl-seconds-after-finished[`quarkus.openshift.job.ttl-seconds-after-finished`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-name[`quarkus.knative.rbac.role-bindings."role-bindings".name`]## [.description] -- -Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. +Name of the RoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_TTL_SECONDS_AFTER_FINISHED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_JOB_TTL_SECONDS_AFTER_FINISHED+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-suspend]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-suspend[`quarkus.openshift.job.suspend`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-labels-label-name[`quarkus.knative.rbac.role-bindings."role-bindings".labels."label-name"`]## [.description] -- -Suspend specifies whether the Job controller should create Pods or not. +Labels to add into the RoleBinding resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_SUSPEND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_JOB_SUSPEND+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|Map +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-restart-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-restart-policy[`quarkus.openshift.job.restart-policy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-role-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-role-name[`quarkus.knative.rbac.role-bindings."role-bindings".role-name`]## [.description] -- -Restart policy when the job container fails. +The name of the Role resource to use by the RoleRef element in the generated Role Binding resource. By default, it's "view" role name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_RESTART_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__ROLE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_JOB_RESTART_POLICY+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__ROLE_NAME+++` endif::add-copy-button-to-env-var[] -- -a|`on-failure`, `never` -|`on-failure` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-schedule]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-schedule[`quarkus.openshift.cron-job.schedule`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-cluster-wide]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-cluster-wide[`quarkus.knative.rbac.role-bindings."role-bindings".cluster-wide`]## [.description] -- -The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. +If the Role sets in the `role-name` property is cluster wide or not. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_SCHEDULE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__CLUSTER_WIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_SCHEDULE+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__CLUSTER_WIDE+++` endif::add-copy-button-to-env-var[] -- -|string +|boolean | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-concurrency-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-concurrency-policy[`quarkus.openshift.cron-job.concurrency-policy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-name[`quarkus.knative.rbac.role-bindings."role-bindings".subjects."subjects".name`]## [.description] -- -ConcurrencyPolicy describes how the job will be handled. +The "name" resource to use by the Subject element in the generated Role Binding resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_CONCURRENCY_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_CONCURRENCY_POLICY+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++` endif::add-copy-button-to-env-var[] -- -a|`allow`, `forbid`, `replace` -|`allow` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-starting-deadline-seconds]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-starting-deadline-seconds[`quarkus.openshift.cron-job.starting-deadline-seconds`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-kind[`quarkus.knative.rbac.role-bindings."role-bindings".subjects."subjects".kind`]## [.description] -- -Deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. +The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_STARTING_DEADLINE_SECONDS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_STARTING_DEADLINE_SECONDS+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++` endif::add-copy-button-to-env-var[] -- -|long -| +|string +|`ServiceAccount` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-failed-jobs-history-limit]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-failed-jobs-history-limit[`quarkus.openshift.cron-job.failed-jobs-history-limit`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-api-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-api-group[`quarkus.knative.rbac.role-bindings."role-bindings".subjects."subjects".api-group`]## [.description] -- -The number of failed finished jobs to retain. The default value is 1. +The "apiGroup" resource that matches with the "kind" property. By default, it's empty. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_FAILED_JOBS_HISTORY_LIMIT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_FAILED_JOBS_HISTORY_LIMIT+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-successful-jobs-history-limit]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-successful-jobs-history-limit[`quarkus.openshift.cron-job.successful-jobs-history-limit`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-namespace[`quarkus.knative.rbac.role-bindings."role-bindings".subjects."subjects".namespace`]## [.description] -- -The number of successful finished jobs to retain. The default value is 3. +The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_SUCCESSFUL_JOBS_HISTORY_LIMIT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_SUCCESSFUL_JOBS_HISTORY_LIMIT+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-parallelism]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-parallelism[`quarkus.openshift.cron-job.parallelism`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-name[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".name`]## [.description] -- -Specifies the maximum desired number of pods the job should run at any given time. +Name of the ClusterRoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_PARALLELISM+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_PARALLELISM+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-completions]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-completions[`quarkus.openshift.cron-job.completions`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-labels-label-name[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".labels."label-name"`]## [.description] -- -Specifies the desired number of successfully finished pods the job should be run with. +Labels to add into the RoleBinding resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_COMPLETIONS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_COMPLETIONS+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|int +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-completion-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-completion-mode[`quarkus.openshift.cron-job.completion-mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-role-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-role-name[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".role-name`]## [.description] -- -CompletionMode specifies how Pod completions are tracked. +The name of the ClusterRole resource to use by the RoleRef element in the generated ClusterRoleBinding resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_COMPLETION_MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__ROLE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_COMPLETION_MODE+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__ROLE_NAME+++` endif::add-copy-button-to-env-var[] -- -a|`non-indexed`, `indexed` -|`non-indexed` +|string +|required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-backoff-limit]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-backoff-limit[`quarkus.openshift.cron-job.backoff-limit`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-name[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".name`]## [.description] -- -Specifies the number of retries before marking this job failed. +The "name" resource to use by the Subject element in the generated Role Binding resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_BACKOFF_LIMIT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_BACKOFF_LIMIT+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-active-deadline-seconds]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-active-deadline-seconds[`quarkus.openshift.cron-job.active-deadline-seconds`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-kind[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".kind`]## [.description] -- -Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. +The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_ACTIVE_DEADLINE_SECONDS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_ACTIVE_DEADLINE_SECONDS+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++` endif::add-copy-button-to-env-var[] -- -|long -| +|string +|`ServiceAccount` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-ttl-seconds-after-finished]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-ttl-seconds-after-finished[`quarkus.openshift.cron-job.ttl-seconds-after-finished`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-api-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-api-group[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".api-group`]## [.description] -- -Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. +The "apiGroup" resource that matches with the "kind" property. By default, it's empty. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_TTL_SECONDS_AFTER_FINISHED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_TTL_SECONDS_AFTER_FINISHED+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-suspend]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-suspend[`quarkus.openshift.cron-job.suspend`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-namespace[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".namespace`]## [.description] -- -Suspend specifies whether the Job controller should create Pods or not. +The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_SUSPEND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_SUSPEND+++` +Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-restart-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-restart-policy[`quarkus.openshift.cron-job.restart-policy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-add-version-to-label-selectors]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-add-version-to-label-selectors[`quarkus.knative.add-version-to-label-selectors`]## [.description] -- -Restart policy when the job container fails. +If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and Deployment ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_RESTART_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ADD_VERSION_TO_LABEL_SELECTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_RESTART_POLICY+++` +Environment variable: `+++QUARKUS_KNATIVE_ADD_VERSION_TO_LABEL_SELECTORS+++` endif::add-copy-button-to-env-var[] -- -a|`on-failure`, `never` -|`on-failure` +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-name[`quarkus.openshift.rbac.roles."roles".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-add-name-to-label-selectors]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-add-name-to-label-selectors[`quarkus.knative.add-name-to-label-selectors`]## [.description] -- -The name of the role. +If true, the 'app.kubernetes.io/name' label will be part of the selectors of Service and Deployment ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ADD_NAME_TO_LABEL_SELECTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_ADD_NAME_TO_LABEL_SELECTORS+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-namespace[`quarkus.openshift.rbac.roles."roles".namespace`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-idempotent]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-idempotent[`quarkus.knative.idempotent`]## [.description] -- -The namespace of the role. +Switch used to control whether non-idempotent fields are included in generated kubernetes resources to improve git-ops compatibility ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__NAMESPACE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_IDEMPOTENT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__NAMESPACE+++` +Environment variable: `+++QUARKUS_KNATIVE_IDEMPOTENT+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-labels-label-name[`quarkus.openshift.rbac.roles."roles".labels."label-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-vcs-uri-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-vcs-uri-enabled[`quarkus.knative.vcs-uri.enabled`]## [.description] -- -Labels to add into the Role resource. +Whether the vcs-uri annotation should be added to the generated configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_VCS_URI_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_KNATIVE_VCS_URI_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|Map -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-api-groups]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-api-groups[`quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".api-groups`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-vcs-uri-override]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-vcs-uri-override[`quarkus.knative.vcs-uri.override`]## [.description] -- -API groups of the policy rule. +Optional override of the vcs-uri annotation. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_VCS_URI_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++` +Environment variable: `+++QUARKUS_KNATIVE_VCS_URI_OVERRIDE+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-non-resource-urls]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-non-resource-urls[`quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".non-resource-urls`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-secrets[`quarkus.knative.env.secrets`]## [.description] -- -Non resource URLs of the policy rule. +The optional list of Secret names to load environment variables from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_SECRETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++` +Environment variable: `+++QUARKUS_KNATIVE_ENV_SECRETS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-resource-names]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-resource-names[`quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".resource-names`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-configmaps]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-configmaps[`quarkus.knative.env.configmaps`]## [.description] -- -Resource names of the policy rule. +The optional list of ConfigMap names to load environment variables from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_CONFIGMAPS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++` +Environment variable: `+++QUARKUS_KNATIVE_ENV_CONFIGMAPS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-resources]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-resources[`quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".resources`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-fields-environment-variable-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-fields-environment-variable-name[`quarkus.knative.env.fields."environment-variable-name"`]## [.description] -- -Resources of the policy rule. +The map associating environment variable names to their associated field references they take their value from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++` +Environment variable: `+++QUARKUS_KNATIVE_ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++` endif::add-copy-button-to-env-var[] -- -|list of string +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-verbs]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-verbs[`quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".verbs`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-vars-vars]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-vars-vars[`quarkus.knative.env.vars."vars"`]## [.description] -- -Verbs of the policy rule. +The map associating environment name to its associated value. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__VERBS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_VARS__VARS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__VERBS+++` +Environment variable: `+++QUARKUS_KNATIVE_ENV_VARS__VARS_+++` endif::add-copy-button-to-env-var[] -- -|list of string +|Map> | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-name[`quarkus.openshift.rbac.cluster-roles."cluster-roles".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-mapping-mapping-from-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-mapping-mapping-from-secret[`quarkus.knative.env.mapping."mapping".from-secret`]## [.description] -- -The name of the cluster role. +The optional name of the Secret from which a value is to be extracted. Mutually exclusive with `from-configmap`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__FROM_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__FROM_SECRET+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-labels-label-name[`quarkus.openshift.rbac.cluster-roles."cluster-roles".labels."label-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-mapping-mapping-from-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-mapping-mapping-from-configmap[`quarkus.knative.env.mapping."mapping".from-configmap`]## [.description] -- -Labels to add into the ClusterRole resource. +The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with `from-secret`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++` endif::add-copy-button-to-env-var[] -- -|Map +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-api-groups]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-api-groups[`quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".api-groups`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-mapping-mapping-with-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-mapping-mapping-with-key[`quarkus.knative.env.mapping."mapping".with-key`]## [.description] -- -API groups of the policy rule. +The key identifying the field from which the value is extracted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__WITH_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++` +Environment variable: `+++QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__WITH_KEY+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|string +|required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-non-resource-urls]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-non-resource-urls[`quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".non-resource-urls`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-using-prefix-prefixes-for-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-using-prefix-prefixes-for-secret[`quarkus.knative.env.using-prefix."prefixes".for-secret`]## [.description] -- -Non resource URLs of the policy rule. +The optional prefix to use when adding the environment variable to the container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++` +Environment variable: `+++QUARKUS_KNATIVE_ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resource-names]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resource-names[`quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resource-names`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-using-prefix-prefixes-for-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-using-prefix-prefixes-for-configmap[`quarkus.knative.env.using-prefix."prefixes".for-configmap`]## [.description] -- -Resource names of the policy rule. +The optional prefix to use when adding the environment variable to the container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++` +Environment variable: `+++QUARKUS_KNATIVE_ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resources]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resources[`quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resources`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-cluster-local]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-cluster-local[`quarkus.knative.cluster-local`]## [.description] -- -Resources of the policy rule. +Whether this service is cluster-local. Cluster local services are not exposed to the outside world. More information in link:https://knative.dev/docs/serving/services/private-services/[this link]. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CLUSTER_LOCAL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++` +Environment variable: `+++QUARKUS_KNATIVE_CLUSTER_LOCAL+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-verbs]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-verbs[`quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".verbs`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-min-scale]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-min-scale[`quarkus.knative.min-scale`]## [.description] -- -Verbs of the policy rule. +This value controls the minimum number of replicas each revision should have. Knative will attempt to never have less than this number of replicas at any point in time. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__VERBS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_MIN_SCALE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__VERBS+++` +Environment variable: `+++QUARKUS_KNATIVE_MIN_SCALE+++` endif::add-copy-button-to-env-var[] -- -|list of string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-name[`quarkus.openshift.rbac.service-accounts."service-accounts".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-max-scale]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-max-scale[`quarkus.knative.max-scale`]## [.description] -- -The name of the service account. +This value controls the maximum number of replicas each revision should have. Knative will attempt to never have more than this number of replicas running, or in the process of being created, at any point in time. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_MAX_SCALE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_MAX_SCALE+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-namespace[`quarkus.openshift.rbac.service-accounts."service-accounts".namespace`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-scale-to-zero-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-scale-to-zero-enabled[`quarkus.knative.scale-to-zero-enabled`]## [.description] -- -The namespace of the service account. +The scale-to-zero values control whether Knative allows revisions to scale down to zero, or stops at “1”. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAMESPACE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SCALE_TO_ZERO_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAMESPACE+++` +Environment variable: `+++QUARKUS_KNATIVE_SCALE_TO_ZERO_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-labels-label-name[`quarkus.openshift.rbac.service-accounts."service-accounts".labels."label-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-revision-auto-scaling-auto-scaler-class]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-revision-auto-scaling-auto-scaler-class[`quarkus.knative.revision-auto-scaling.auto-scaler-class`]## [.description] -- -Labels of the service account. +The Autoscaler class. Knative Serving comes with its own autoscaler, the KPA (Knative Pod Autoscaler) but can also be configured to use Kubernetes’ HPA (Horizontal Pod Autoscaler) or even a custom third-party autoscaler. Possible values (kpa, hpa, default: kpa). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_AUTO_SCALER_CLASS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_AUTO_SCALER_CLASS+++` endif::add-copy-button-to-env-var[] -- -|Map +a|tooltip:kpa[Kubernetes Pod Autoscaler], tooltip:hpa[Horizontal Pod Autoscaler] | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-use-as-default]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-use-as-default[`quarkus.openshift.rbac.service-accounts."service-accounts".use-as-default`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-revision-auto-scaling-metric]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-revision-auto-scaling-metric[`quarkus.knative.revision-auto-scaling.metric`]## [.description] -- -If true, this service account will be used in the generated Deployment resource. +The autoscaling metric to use. Possible values (concurrency, rps, cpu). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__USE_AS_DEFAULT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_METRIC+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__USE_AS_DEFAULT+++` +Environment variable: `+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_METRIC+++` endif::add-copy-button-to-env-var[] -- -|boolean +a|tooltip:concurrency[Concurrency], tooltip:rps[Requests per second], tooltip:cpu[CPU] | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-name[`quarkus.openshift.rbac.role-bindings."role-bindings".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-revision-auto-scaling-target]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-revision-auto-scaling-target[`quarkus.knative.revision-auto-scaling.target`]## [.description] -- -Name of the RoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name. +The autoscaling target. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_TARGET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_TARGET+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-labels-label-name[`quarkus.openshift.rbac.role-bindings."role-bindings".labels."label-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-revision-auto-scaling-container-concurrency]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-revision-auto-scaling-container-concurrency[`quarkus.knative.revision-auto-scaling.container-concurrency`]## [.description] -- -Labels to add into the RoleBinding resource. +The exact amount of requests allowed to the replica at a time. Its default value is “0”, which means an unlimited number of requests are allowed to flow into the replica. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_CONTAINER_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_CONTAINER_CONCURRENCY+++` endif::add-copy-button-to-env-var[] -- -|Map +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-role-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-role-name[`quarkus.openshift.rbac.role-bindings."role-bindings".role-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-revision-auto-scaling-target-utilization-percentage]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-revision-auto-scaling-target-utilization-percentage[`quarkus.knative.revision-auto-scaling.target-utilization-percentage`]## [.description] -- -The name of the Role resource to use by the RoleRef element in the generated Role Binding resource. By default, it's "view" role name. +This value specifies a percentage of the target to actually be targeted by the autoscaler. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__ROLE_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_TARGET_UTILIZATION_PERCENTAGE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__ROLE_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_TARGET_UTILIZATION_PERCENTAGE+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-cluster-wide]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-cluster-wide[`quarkus.openshift.rbac.role-bindings."role-bindings".cluster-wide`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-global-auto-scaling-auto-scaler-class]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-global-auto-scaling-auto-scaler-class[`quarkus.knative.global-auto-scaling.auto-scaler-class`]## [.description] -- -If the Role sets in the `role-name` property is cluster wide or not. +The Autoscaler class. Knative Serving comes with its own autoscaler, the KPA (Knative Pod Autoscaler) but can also be configured to use Kubernetes’ HPA (Horizontal Pod Autoscaler) or even a custom third-party autoscaler. Possible values (kpa, hpa, default: kpa). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__CLUSTER_WIDE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_AUTO_SCALER_CLASS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__CLUSTER_WIDE+++` +Environment variable: `+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_AUTO_SCALER_CLASS+++` endif::add-copy-button-to-env-var[] -- -|boolean +a|tooltip:kpa[Kubernetes Pod Autoscaler], tooltip:hpa[Horizontal Pod Autoscaler] | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-name[`quarkus.openshift.rbac.role-bindings."role-bindings".subjects."subjects".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-global-auto-scaling-container-concurrency]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-global-auto-scaling-container-concurrency[`quarkus.knative.global-auto-scaling.container-concurrency`]## [.description] -- -The "name" resource to use by the Subject element in the generated Role Binding resource. +The exact amount of requests allowed to the replica at a time. Its default value is “0”, which means an unlimited number of requests are allowed to flow Integer>o the replica. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_CONTAINER_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_CONTAINER_CONCURRENCY+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-kind[`quarkus.openshift.rbac.role-bindings."role-bindings".subjects."subjects".kind`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-global-auto-scaling-target-utilization-percentage]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-global-auto-scaling-target-utilization-percentage[`quarkus.knative.global-auto-scaling.target-utilization-percentage`]## [.description] -- -The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind. +This value specifies a percentage of the target to actually be targeted by the autoscaler. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_TARGET_UTILIZATION_PERCENTAGE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++` +Environment variable: `+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_TARGET_UTILIZATION_PERCENTAGE+++` endif::add-copy-button-to-env-var[] -- -|string -|`ServiceAccount` +|int +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-api-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-api-group[`quarkus.openshift.rbac.role-bindings."role-bindings".subjects."subjects".api-group`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-global-auto-scaling-requests-per-second]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-global-auto-scaling-requests-per-second[`quarkus.knative.global-auto-scaling.requests-per-second`]## [.description] -- -The "apiGroup" resource that matches with the "kind" property. By default, it's empty. +The requests per second per replica. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_REQUESTS_PER_SECOND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++` +Environment variable: `+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_REQUESTS_PER_SECOND+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-namespace[`quarkus.openshift.rbac.role-bindings."role-bindings".subjects."subjects".namespace`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-revision-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-revision-name[`quarkus.knative.revision-name`]## [.description] -- -The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources. +The name of the revision. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_REVISION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++` +Environment variable: `+++QUARKUS_KNATIVE_REVISION_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-name[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-traffic-traffic-tag]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-traffic-traffic-tag[`quarkus.knative.traffic."traffic".tag`]## [.description] -- -Name of the ClusterRoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name. +Tag is optionally used to expose a dedicated url for referencing this target exclusively. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__TAG+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__TAG+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-labels-label-name[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".labels."label-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-traffic-traffic-revision-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-traffic-traffic-revision-name[`quarkus.knative.traffic."traffic".revision-name`]## [.description] -- -Labels to add into the RoleBinding resource. +RevisionName of a specific revision to which to send this portion of traffic. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__REVISION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__REVISION_NAME+++` endif::add-copy-button-to-env-var[] -- -|Map +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-role-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-role-name[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".role-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-traffic-traffic-latest-revision]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-traffic-traffic-latest-revision[`quarkus.knative.traffic."traffic".latest-revision`]## [.description] -- -The name of the ClusterRole resource to use by the RoleRef element in the generated ClusterRoleBinding resource. +LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__ROLE_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__LATEST_REVISION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__ROLE_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__LATEST_REVISION+++` endif::add-copy-button-to-env-var[] -- -|string -|required icon:exclamation-circle[title=Configuration property is required] +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-name[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-traffic-traffic-percent]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-traffic-traffic-percent[`quarkus.knative.traffic."traffic".percent`]## [.description] -- -The "name" resource to use by the Subject element in the generated Role Binding resource. +Percent indicates that percentage based routing should be used and the value indicates the percent of traffic that is to be routed to this Revision or Configuration. `0` (zero) mean no traffic, `100` means all traffic. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__PERCENT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__PERCENT+++` endif::add-copy-button-to-env-var[] -- -|string -| +|long +|`100` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-kind[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".kind`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-app-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-app-secret[`quarkus.knative.app-secret`]## [.description] -- -The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind. +If set, the secret will mounted to the application container and its contents will be used for application configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_APP_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++` +Environment variable: `+++QUARKUS_KNATIVE_APP_SECRET+++` endif::add-copy-button-to-env-var[] -- |string -|`ServiceAccount` +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-api-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-api-group[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".api-group`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-app-config-map]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-app-config-map[`quarkus.knative.app-config-map`]## [.description] -- -The "apiGroup" resource that matches with the "kind" property. By default, it's empty. +If set, the config map will be mounted to the application container and its contents will be used for application configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_APP_CONFIG_MAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++` +Environment variable: `+++QUARKUS_KNATIVE_APP_CONFIG_MAP+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-namespace[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".namespace`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-level]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-level[`quarkus.knative.security-context.se-linux-options.level`]## [.description] -- -The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources. +The SELinux level label that applies to the container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_LEVEL+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-secrets[`quarkus.openshift.env.secrets`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-role]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-role[`quarkus.knative.security-context.se-linux-options.role`]## [.description] -- -The optional list of Secret names to load environment variables from. +The SELinux role label that applies to the container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_SECRETS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_ROLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ENV_SECRETS+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_ROLE+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-configmaps]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-configmaps[`quarkus.openshift.env.configmaps`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-type[`quarkus.knative.security-context.se-linux-options.type`]## [.description] -- -The optional list of ConfigMap names to load environment variables from. +The SELinux type label that applies to the container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_CONFIGMAPS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ENV_CONFIGMAPS+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_TYPE+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-fields-environment-variable-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-fields-environment-variable-name[`quarkus.openshift.env.fields."environment-variable-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-user]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-user[`quarkus.knative.security-context.se-linux-options.user`]## [.description] -- -The map associating environment variable names to their associated field references they take their value from. +The SELinux user label that applies to the container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_USER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_USER+++` endif::add-copy-button-to-env-var[] -- -|Map +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-vars-vars]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-vars-vars[`quarkus.openshift.env.vars."vars"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-windows-options-gmsa-credential-spec-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-windows-options-gmsa-credential-spec-name[`quarkus.knative.security-context.windows-options.gmsa-credential-spec-name`]## [.description] -- -The map associating environment name to its associated value. +The name of the GMSA credential spec to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_VARS__VARS_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ENV_VARS__VARS_+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC_NAME+++` endif::add-copy-button-to-env-var[] -- -|Map> +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-mapping-mapping-from-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-mapping-mapping-from-secret[`quarkus.openshift.env.mapping."mapping".from-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-windows-options-gmsa-credential-spec]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-windows-options-gmsa-credential-spec[`quarkus.knative.security-context.windows-options.gmsa-credential-spec`]## [.description] -- -The optional name of the Secret from which a value is to be extracted. Mutually exclusive with `from-configmap`. +GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__FROM_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__FROM_SECRET+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-mapping-mapping-from-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-mapping-mapping-from-configmap[`quarkus.openshift.env.mapping."mapping".from-configmap`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-windows-options-run-as-user-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-windows-options-run-as-user-name[`quarkus.knative.security-context.windows-options.run-as-user-name`]## [.description] -- -The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with `from-secret`. +The UserName in Windows to run the entrypoint of the container process. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_RUN_AS_USER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_RUN_AS_USER_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-mapping-mapping-with-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-mapping-mapping-with-key[`quarkus.openshift.env.mapping."mapping".with-key`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-windows-options-host-process]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-windows-options-host-process[`quarkus.knative.security-context.windows-options.host-process`]## [.description] -- -The key identifying the field from which the value is extracted. +HostProcess determines if a container should be run as a 'Host Process' container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__WITH_KEY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_HOST_PROCESS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__WITH_KEY+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_HOST_PROCESS+++` endif::add-copy-button-to-env-var[] -- -|string -|required icon:exclamation-circle[title=Configuration property is required] +|boolean +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-using-prefix-prefixes-for-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-using-prefix-prefixes-for-secret[`quarkus.openshift.env.using-prefix."prefixes".for-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-run-as-user]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-run-as-user[`quarkus.knative.security-context.run-as-user`]## [.description] -- -The optional prefix to use when adding the environment variable to the container. +The UID to run the entrypoint of the container process. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_USER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_USER+++` endif::add-copy-button-to-env-var[] -- -|string +|long | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-using-prefix-prefixes-for-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-using-prefix-prefixes-for-configmap[`quarkus.openshift.env.using-prefix."prefixes".for-configmap`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-run-as-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-run-as-group[`quarkus.knative.security-context.run-as-group`]## [.description] -- -The optional prefix to use when adding the environment variable to the container. +The GID to run the entrypoint of the container process. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_GROUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_GROUP+++` endif::add-copy-button-to-env-var[] -- -|string +|long | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-app-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-app-secret[`quarkus.openshift.app-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-run-as-non-root]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-run-as-non-root[`quarkus.knative.security-context.run-as-non-root`]## [.description] -- -If set, the secret will mounted to the application container and its contents will be used for application configuration. +Indicates that the container must run as a non-root user. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_APP_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_NON_ROOT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_APP_SECRET+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_NON_ROOT+++` endif::add-copy-button-to-env-var[] -- -|string +|boolean | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-app-config-map]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-app-config-map[`quarkus.openshift.app-config-map`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-supplemental-groups]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-supplemental-groups[`quarkus.knative.security-context.supplemental-groups`]## [.description] -- -If set, the config amp will be mounted to the application container and its contents will be used for application configuration. +A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_APP_CONFIG_MAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SUPPLEMENTAL_GROUPS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_APP_CONFIG_MAP+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SUPPLEMENTAL_GROUPS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of long | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-level]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-level[`quarkus.openshift.security-context.se-linux-options.level`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-fs-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-fs-group[`quarkus.knative.security-context.fs-group`]## [.description] -- -The SELinux level label that applies to the container. +A special supplemental group that applies to all containers in a pod. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_FS_GROUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_LEVEL+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_FS_GROUP+++` endif::add-copy-button-to-env-var[] -- -|string +|long | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-role]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-role[`quarkus.openshift.security-context.se-linux-options.role`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-sysctls-sysctl-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-sysctls-sysctl-name[`quarkus.knative.security-context.sysctls."sysctl-name"`]## [.description] -- -The SELinux role label that applies to the container. +Sysctls hold a list of namespaced sysctls used for the pod. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_ROLE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SYSCTLS__SYSCTL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_ROLE+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SYSCTLS__SYSCTL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-type[`quarkus.openshift.security-context.se-linux-options.type`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-fs-group-change-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-fs-group-change-policy[`quarkus.knative.security-context.fs-group-change-policy`]## [.description] -- -The SELinux type label that applies to the container. +It holds policies that will be used for applying fsGroup to a volume when volume is mounted. Values: OnRootMismatch, Always ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_FS_GROUP_CHANGE_POLICY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_TYPE+++` +Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_FS_GROUP_CHANGE_POLICY+++` endif::add-copy-button-to-env-var[] -- -|string +a|tooltip:on-root-mismatch[It indicates that volume's ownership and permissions will be changed only when permission and ownership of root directory does not match with expected permissions on the volume.], tooltip:always[It indicates that volume's ownership and permissions should always be changed whenever volume is mounted inside a Pod. This the default behavior.] | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-user]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-user[`quarkus.openshift.security-context.se-linux-options.user`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-deploy]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-deploy[`quarkus.knative.deploy`]## [.description] -- -The SELinux user label that applies to the container. +If set to true, Quarkus will attempt to deploy the application to the target knative cluster ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_USER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_DEPLOY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_USER+++` +Environment variable: `+++QUARKUS_KNATIVE_DEPLOY+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-windows-options-gmsa-credential-spec-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-windows-options-gmsa-credential-spec-name[`quarkus.openshift.security-context.windows-options.gmsa-credential-spec-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-deploy-strategy]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-deploy-strategy[`quarkus.knative.deploy-strategy`]## [.description] -- -The name of the GMSA credential spec to use. +If deploy is enabled, it will follow this strategy to update the resources to the target Knative cluster. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_DEPLOY_STRATEGY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC_NAME+++` +Environment variable: `+++QUARKUS_KNATIVE_DEPLOY_STRATEGY+++` endif::add-copy-button-to-env-var[] -- -|string -| +a|`create-or-update`, `create`, `replace`, `server-side-apply` +|`create-or-update` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-windows-options-gmsa-credential-spec]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-windows-options-gmsa-credential-spec[`quarkus.openshift.security-context.windows-options.gmsa-credential-spec`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-part-of]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-part-of[`quarkus.kubernetes.part-of`]## [.description] -- -GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. +The name of the group this component belongs too ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_PART_OF+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC+++` +Environment variable: `+++QUARKUS_KUBERNETES_PART_OF+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-windows-options-run-as-user-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-windows-options-run-as-user-name[`quarkus.openshift.security-context.windows-options.run-as-user-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-name[`quarkus.kubernetes.name`]## [.description] -- -The UserName in Windows to run the entrypoint of the container process. +The name of the application. This value will be used for naming Kubernetes resources like: - Deployment - Service and so on ... ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_RUN_AS_USER_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_RUN_AS_USER_NAME+++` +Environment variable: `+++QUARKUS_KUBERNETES_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-windows-options-host-process]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-windows-options-host-process[`quarkus.openshift.security-context.windows-options.host-process`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-version]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-version[`quarkus.kubernetes.version`]## [.description] -- -HostProcess determines if a container should be run as a 'Host Process' container. +The version of the application. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_HOST_PROCESS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_VERSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_HOST_PROCESS+++` +Environment variable: `+++QUARKUS_KUBERNETES_VERSION+++` endif::add-copy-button-to-env-var[] -- -|boolean +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-run-as-user]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-run-as-user[`quarkus.openshift.security-context.run-as-user`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-deployment-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-deployment-kind[`quarkus.kubernetes.deployment-kind`]## [.description] -- -The UID to run the entrypoint of the container process. +The kind of the deployment resource to use. Supported values are 'StatefulSet', 'Job', 'CronJob' and 'Deployment' defaulting to the latter. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_USER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_DEPLOYMENT_KIND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_USER+++` +Environment variable: `+++QUARKUS_KUBERNETES_DEPLOYMENT_KIND+++` endif::add-copy-button-to-env-var[] -- -|long +a|`deployment`, `deployment-config`, `stateful-set`, `job`, `cron-job`, `knative-service` | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-run-as-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-run-as-group[`quarkus.openshift.security-context.run-as-group`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-namespace[`quarkus.kubernetes.namespace`]## [.description] -- -The GID to run the entrypoint of the container process. +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). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_GROUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_NAMESPACE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_GROUP+++` +Environment variable: `+++QUARKUS_KUBERNETES_NAMESPACE+++` endif::add-copy-button-to-env-var[] -- -|long +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-run-as-non-root]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-run-as-non-root[`quarkus.openshift.security-context.run-as-non-root`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-labels-label-name[`quarkus.kubernetes.labels."label-name"`]## [.description] -- -Indicates that the container must run as a non-root user. +Custom labels to add to all resources ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_NON_ROOT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_NON_ROOT+++` +Environment variable: `+++QUARKUS_KUBERNETES_LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|boolean +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-supplemental-groups]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-supplemental-groups[`quarkus.openshift.security-context.supplemental-groups`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-annotations-annotation-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-annotations-annotation-name[`quarkus.kubernetes.annotations."annotation-name"`]## [.description] -- -A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. +Custom annotations to add to all resources ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SUPPLEMENTAL_GROUPS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_ANNOTATIONS__ANNOTATION_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SUPPLEMENTAL_GROUPS+++` +Environment variable: `+++QUARKUS_KUBERNETES_ANNOTATIONS__ANNOTATION_NAME_+++` endif::add-copy-button-to-env-var[] -- -|list of long +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-fs-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-fs-group[`quarkus.openshift.security-context.fs-group`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-add-build-timestamp]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-add-build-timestamp[`quarkus.kubernetes.add-build-timestamp`]## [.description] -- -A special supplemental group that applies to all containers in a pod. +Whether to add the build timestamp to the Kubernetes annotations This is a very useful way to have manifests of successive builds of the same application differ - thus ensuring that Kubernetes will apply the updated resources ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_FS_GROUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_ADD_BUILD_TIMESTAMP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_FS_GROUP+++` +Environment variable: `+++QUARKUS_KUBERNETES_ADD_BUILD_TIMESTAMP+++` endif::add-copy-button-to-env-var[] -- -|long -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-sysctls-sysctl-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-sysctls-sysctl-name[`quarkus.openshift.security-context.sysctls."sysctl-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-working-dir[`quarkus.kubernetes.working-dir`]## [.description] -- -Sysctls hold a list of namespaced sysctls used for the pod. +Working directory ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SYSCTLS__SYSCTL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_WORKING_DIR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SYSCTLS__SYSCTL_NAME_+++` +Environment variable: `+++QUARKUS_KUBERNETES_WORKING_DIR+++` endif::add-copy-button-to-env-var[] -- -|Map +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-fs-group-change-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-fs-group-change-policy[`quarkus.openshift.security-context.fs-group-change-policy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-command[`quarkus.kubernetes.command`]## [.description] -- -It holds policies that will be used for applying fsGroup to a volume when volume is mounted. Values: OnRootMismatch, Always +The commands ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_FS_GROUP_CHANGE_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_FS_GROUP_CHANGE_POLICY+++` +Environment variable: `+++QUARKUS_KUBERNETES_COMMAND+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:on-root-mismatch[It indicates that volume's ownership and permissions will be changed only when permission and ownership of root directory does not match with expected permissions on the volume.], tooltip:always[It indicates that volume's ownership and permissions should always be changed whenever volume is mounted inside a Pod. This the default behavior.] +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-remote-debug-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-remote-debug-enabled[`quarkus.openshift.remote-debug.enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-arguments[`quarkus.kubernetes.arguments`]## [.description] -- -If true, the debug mode in pods will be enabled. +The arguments ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_ARGUMENTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_ENABLED+++` +Environment variable: `+++QUARKUS_KUBERNETES_ARGUMENTS+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|list of string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-remote-debug-transport]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-remote-debug-transport[`quarkus.openshift.remote-debug.transport`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-service-account[`quarkus.kubernetes.service-account`]## [.description] -- -The transport to use. +The service account ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_TRANSPORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_SERVICE_ACCOUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_TRANSPORT+++` +Environment variable: `+++QUARKUS_KUBERNETES_SERVICE_ACCOUNT+++` endif::add-copy-button-to-env-var[] -- |string -|`dt_socket` +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-remote-debug-suspend]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-remote-debug-suspend[`quarkus.openshift.remote-debug.suspend`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-ports-ports-container-port[`quarkus.kubernetes.ports."ports".container-port`]## [.description] -- -If enabled, it means the JVM will wait for the debugger to attach before executing the main class. If false, the JVM will immediately execute the main class, while listening for the debugger connection. +The port number. Refers to the container port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_SUSPEND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_PORTS__PORTS__CONTAINER_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_SUSPEND+++` +Environment variable: `+++QUARKUS_KUBERNETES_PORTS__PORTS__CONTAINER_PORT+++` endif::add-copy-button-to-env-var[] -- -|string -|`n` +|int +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-remote-debug-address-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-remote-debug-address-port[`quarkus.openshift.remote-debug.address-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-ports-ports-host-port[`quarkus.kubernetes.ports."ports".host-port`]## [.description] -- -It specifies the address at which the debug socket will listen. +The host port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_ADDRESS_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_PORTS__PORTS__HOST_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_ADDRESS_PORT+++` +Environment variable: `+++QUARKUS_KUBERNETES_PORTS__PORTS__HOST_PORT+++` endif::add-copy-button-to-env-var[] -- |int -|`5005` +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-deploy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-deploy[`quarkus.openshift.deploy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-ports-ports-path[`quarkus.kubernetes.ports."ports".path`]## [.description] -- -If set to true, Quarkus will attempt to deploy the application to the target Openshift cluster +The application path (refers to web application path). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_DEPLOY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_PORTS__PORTS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_DEPLOY+++` +Environment variable: `+++QUARKUS_KUBERNETES_PORTS__PORTS__PATH+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-deploy-strategy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-deploy-strategy[`quarkus.openshift.deploy-strategy`]## - -[.description] --- -If deploy is enabled, it will follow this strategy to update the resources to the target OpenShift cluster. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_DEPLOY_STRATEGY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_DEPLOY_STRATEGY+++` -endif::add-copy-button-to-env-var[] --- -a|`create-or-update`, `create`, `replace`, `server-side-apply` -|`create-or-update` - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-tasks-init-tasks-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-tasks-init-tasks-enabled[`quarkus.openshift.init-tasks."init-tasks".enabled`]## - -[.description] --- -If true, the init task will be generated. Otherwise, the init task resource generation will be skipped. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__ENABLED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-tasks-init-tasks-wait-for-container-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-tasks-init-tasks-wait-for-container-image[`quarkus.openshift.init-tasks."init-tasks".wait-for-container.image`]## - -[.description] --- -The init task image to use by the init-container. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++` -endif::add-copy-button-to-env-var[] --- -|string -|`groundnuty/k8s-wait-for:no-root-v1.7` - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-task-defaults-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-task-defaults-enabled[`quarkus.openshift.init-task-defaults.enabled`]## - -[.description] --- -If true, the init task will be generated. Otherwise, the init task resource generation will be skipped. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_ENABLED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-task-defaults-wait-for-container-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-task-defaults-wait-for-container-image[`quarkus.openshift.init-task-defaults.wait-for-container.image`]## - -[.description] --- -The init task image to use by the init-container. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE+++` -endif::add-copy-button-to-env-var[] --- -|string -|`groundnuty/k8s-wait-for:no-root-v1.7` - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-idempotent]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-idempotent[`quarkus.openshift.idempotent`]## - -[.description] --- -Switch used to control whether non-idempotent fields are included in generated kubernetes resources to improve git-ops compatibility - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_IDEMPOTENT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_IDEMPOTENT+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-vcs-uri-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-vcs-uri-enabled[`quarkus.openshift.vcs-uri.enabled`]## - -[.description] --- -Whether the vcs-uri annotation should be added to the generated configuration. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_VCS_URI_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_VCS_URI_ENABLED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-vcs-uri-override]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-vcs-uri-override[`quarkus.openshift.vcs-uri.override`]## - -[.description] --- -Optional override of the vcs-uri annotation. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_VCS_URI_OVERRIDE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENSHIFT_VCS_URI_OVERRIDE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-part-of]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-part-of[`quarkus.kubernetes.part-of`]## - -[.description] --- -The name of the group this component belongs too - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_PART_OF+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_PART_OF+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-name[`quarkus.kubernetes.name`]## - -[.description] --- -The name of the application. This value will be used for naming Kubernetes resources like: - Deployment - Service and so on ... - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_NAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-version]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-version[`quarkus.kubernetes.version`]## - -[.description] --- -The version of the application. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_VERSION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_VERSION+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-deployment-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-deployment-kind[`quarkus.kubernetes.deployment-kind`]## - -[.description] --- -The kind of the deployment resource to use. Supported values are 'StatefulSet', 'Job', 'CronJob' and 'Deployment' defaulting to the latter. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_DEPLOYMENT_KIND+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_DEPLOYMENT_KIND+++` -endif::add-copy-button-to-env-var[] --- -a|`deployment`, `deployment-config`, `stateful-set`, `job`, `cron-job`, `knative-service` -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-namespace[`quarkus.kubernetes.namespace`]## - -[.description] --- -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). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_NAMESPACE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_NAMESPACE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-labels-label-name[`quarkus.kubernetes.labels."label-name"`]## - -[.description] --- -Custom labels to add to all resources - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_LABELS__LABEL_NAME_+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_LABELS__LABEL_NAME_+++` -endif::add-copy-button-to-env-var[] --- -|Map -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-annotations-annotation-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-annotations-annotation-name[`quarkus.kubernetes.annotations."annotation-name"`]## - -[.description] --- -Custom annotations to add to all resources - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_ANNOTATIONS__ANNOTATION_NAME_+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_ANNOTATIONS__ANNOTATION_NAME_+++` -endif::add-copy-button-to-env-var[] --- -|Map -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-add-build-timestamp]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-add-build-timestamp[`quarkus.kubernetes.add-build-timestamp`]## - -[.description] --- -Whether to add the build timestamp to the Kubernetes annotations This is a very useful way to have manifests of successive builds of the same application differ - thus ensuring that Kubernetes will apply the updated resources - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_ADD_BUILD_TIMESTAMP+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_ADD_BUILD_TIMESTAMP+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-working-dir[`quarkus.kubernetes.working-dir`]## - -[.description] --- -Working directory - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_WORKING_DIR+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_WORKING_DIR+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-command[`quarkus.kubernetes.command`]## - -[.description] --- -The commands - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_COMMAND+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_COMMAND+++` -endif::add-copy-button-to-env-var[] --- -|list of string -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-arguments[`quarkus.kubernetes.arguments`]## - -[.description] --- -The arguments - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_ARGUMENTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_ARGUMENTS+++` -endif::add-copy-button-to-env-var[] --- -|list of string -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-service-account[`quarkus.kubernetes.service-account`]## - -[.description] --- -The service account - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_SERVICE_ACCOUNT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_SERVICE_ACCOUNT+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-ports-ports-container-port[`quarkus.kubernetes.ports."ports".container-port`]## - -[.description] --- -The port number. Refers to the container port. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_PORTS__PORTS__CONTAINER_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_PORTS__PORTS__CONTAINER_PORT+++` -endif::add-copy-button-to-env-var[] --- -|int -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-ports-ports-host-port[`quarkus.kubernetes.ports."ports".host-port`]## - -[.description] --- -The host port. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_PORTS__PORTS__HOST_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_PORTS__PORTS__HOST_PORT+++` -endif::add-copy-button-to-env-var[] --- -|int -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-ports-ports-path[`quarkus.kubernetes.ports."ports".path`]## - -[.description] --- -The application path (refers to web application path). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_PORTS__PORTS__PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_PORTS__PORTS__PATH+++` -endif::add-copy-button-to-env-var[] --- -|string -|`/` +|string +|`/` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-ports-ports-protocol]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-ports-ports-protocol[`quarkus.kubernetes.ports."ports".protocol`]## @@ -33261,7 +33466,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-liveness-probe-period[`quarkus.kubernetes.liveness-probe.period`]## @@ -33278,7 +33483,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-liveness-probe-timeout[`quarkus.kubernetes.liveness-probe.timeout`]## @@ -33295,7 +33500,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-liveness-probe-success-threshold[`quarkus.kubernetes.liveness-probe.success-threshold`]## @@ -33482,7 +33687,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-readiness-probe-period[`quarkus.kubernetes.readiness-probe.period`]## @@ -33499,7 +33704,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-readiness-probe-timeout[`quarkus.kubernetes.readiness-probe.timeout`]## @@ -33516,7 +33721,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-readiness-probe-success-threshold[`quarkus.kubernetes.readiness-probe.success-threshold`]## @@ -33703,7 +33908,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_STARTUP_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-startup-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-startup-probe-period[`quarkus.kubernetes.startup-probe.period`]## @@ -33720,7 +33925,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_STARTUP_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-startup-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-startup-probe-timeout[`quarkus.kubernetes.startup-probe.timeout`]## @@ -33737,7 +33942,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_STARTUP_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-startup-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-startup-probe-success-threshold[`quarkus.kubernetes.startup-probe.success-threshold`]## @@ -34859,7 +35064,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-liveness-probe-period[`quarkus.kubernetes.init-containers."init-containers".liveness-probe.period`]## @@ -34876,7 +35081,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-liveness-probe-timeout[`quarkus.kubernetes.init-containers."init-containers".liveness-probe.timeout`]## @@ -34893,7 +35098,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-liveness-probe-success-threshold[`quarkus.kubernetes.init-containers."init-containers".liveness-probe.success-threshold`]## @@ -35080,7 +35285,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-readiness-probe-period[`quarkus.kubernetes.init-containers."init-containers".readiness-probe.period`]## @@ -35097,7 +35302,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-readiness-probe-timeout[`quarkus.kubernetes.init-containers."init-containers".readiness-probe.timeout`]## @@ -35114,7 +35319,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-readiness-probe-success-threshold[`quarkus.kubernetes.init-containers."init-containers".readiness-probe.success-threshold`]## @@ -35828,7 +36033,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-liveness-probe-period[`quarkus.kubernetes.sidecars."sidecars".liveness-probe.period`]## @@ -35845,7 +36050,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-liveness-probe-timeout[`quarkus.kubernetes.sidecars."sidecars".liveness-probe.timeout`]## @@ -35862,7 +36067,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-liveness-probe-success-threshold[`quarkus.kubernetes.sidecars."sidecars".liveness-probe.success-threshold`]## @@ -36049,7 +36254,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-readiness-probe-period[`quarkus.kubernetes.sidecars."sidecars".readiness-probe.period`]## @@ -36066,7 +36271,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-readiness-probe-timeout[`quarkus.kubernetes.sidecars."sidecars".readiness-probe.timeout`]## @@ -36083,7 +36288,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-readiness-probe-success-threshold[`quarkus.kubernetes.sidecars."sidecars".readiness-probe.success-threshold`]## @@ -38415,7 +38620,41 @@ endif::add-copy-button-to-env-var[] |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-part-of]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-part-of[`quarkus.knative.part-of`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-flavor]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-flavor[`quarkus.openshift.flavor`]## + +[.description] +-- +The OpenShift flavor / version to use. Older versions of OpenShift have minor differences in the labels and fields they support. This option allows users to have their manifests automatically aligned to the OpenShift 'flavor' they use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_FLAVOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OPENSHIFT_FLAVOR+++` +endif::add-copy-button-to-env-var[] +-- +a|`v3`, `v4` +|`v4` + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-deployment-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-deployment-kind[`quarkus.openshift.deployment-kind`]## + +[.description] +-- +The kind of the deployment resource to use. Supported values are 'Deployment', 'StatefulSet', 'Job', 'CronJob' and 'DeploymentConfig'. Defaults to 'DeploymentConfig' if `flavor == v3`, or 'Deployment' otherwise. DeploymentConfig is deprecated as of OpenShift 4.14. See https://access.redhat.com/articles/7041372 for details. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_DEPLOYMENT_KIND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OPENSHIFT_DEPLOYMENT_KIND+++` +endif::add-copy-button-to-env-var[] +-- +a|`deployment`, `deployment-config`, `stateful-set`, `job`, `cron-job`, `knative-service` +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-part-of]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-part-of[`quarkus.openshift.part-of`]## [.description] -- @@ -38423,33 +38662,33 @@ The name of the group this component belongs too ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PART_OF+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PART_OF+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PART_OF+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PART_OF+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-name[`quarkus.knative.name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-name[`quarkus.openshift.name`]## [.description] -- -The name of the application. This value will be used for naming Kubernetes resources like: - Deployment - Service and so on ... +The name of the application. This value will be used for naming Kubernetes resources like: 'Deployment', 'Service' and so on... ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-version]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-version[`quarkus.knative.version`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-version]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-version[`quarkus.openshift.version`]## [.description] -- @@ -38457,16 +38696,16 @@ The version of the application. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_VERSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_VERSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_VERSION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_VERSION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-namespace[`quarkus.knative.namespace`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-namespace[`quarkus.openshift.namespace`]## [.description] -- @@ -38474,16 +38713,16 @@ The namespace the generated resources should belong to. If not value is set, the ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_NAMESPACE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_NAMESPACE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_NAMESPACE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_NAMESPACE+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-labels-label-name[`quarkus.knative.labels."label-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-labels-label-name[`quarkus.openshift.labels."label-name"`]## [.description] -- @@ -38491,16 +38730,16 @@ Custom labels to add to all resources ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-annotations-annotation-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-annotations-annotation-name[`quarkus.knative.annotations."annotation-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-annotations-annotation-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-annotations-annotation-name[`quarkus.openshift.annotations."annotation-name"`]## [.description] -- @@ -38508,33 +38747,33 @@ Custom annotations to add to all resources ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ANNOTATIONS__ANNOTATION_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ANNOTATIONS__ANNOTATION_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ANNOTATIONS__ANNOTATION_NAME_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ANNOTATIONS__ANNOTATION_NAME_+++` endif::add-copy-button-to-env-var[] -- |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-add-build-timestamp]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-add-build-timestamp[`quarkus.knative.add-build-timestamp`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-add-build-timestamp]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-add-build-timestamp[`quarkus.openshift.add-build-timestamp`]## [.description] -- -Whether to add the build timestamp to the Kubernetes annotations This is a very useful way to have manifests of successive builds of the same application differ - thus ensuring that Kubernetes will apply the updated resources +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 ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ADD_BUILD_TIMESTAMP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ADD_BUILD_TIMESTAMP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ADD_BUILD_TIMESTAMP+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ADD_BUILD_TIMESTAMP+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-working-dir[`quarkus.knative.working-dir`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-working-dir[`quarkus.openshift.working-dir`]## [.description] -- @@ -38542,16 +38781,16 @@ Working directory ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_WORKING_DIR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_WORKING_DIR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_WORKING_DIR+++` +Environment variable: `+++QUARKUS_OPENSHIFT_WORKING_DIR+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-command[`quarkus.knative.command`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-command[`quarkus.openshift.command`]## [.description] -- @@ -38559,16 +38798,16 @@ The commands ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_COMMAND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_COMMAND+++` +Environment variable: `+++QUARKUS_OPENSHIFT_COMMAND+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-arguments[`quarkus.knative.arguments`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-arguments[`quarkus.openshift.arguments`]## [.description] -- @@ -38576,16 +38815,16 @@ The arguments ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ARGUMENTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ARGUMENTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ARGUMENTS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ARGUMENTS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-service-account[`quarkus.knative.service-account`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-service-account[`quarkus.openshift.service-account`]## [.description] -- @@ -38593,16 +38832,16 @@ The service account ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SERVICE_ACCOUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SERVICE_ACCOUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SERVICE_ACCOUNT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SERVICE_ACCOUNT+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-ports-ports-container-port[`quarkus.knative.ports."ports".container-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-ports-ports-container-port[`quarkus.openshift.ports."ports".container-port`]## [.description] -- @@ -38610,16 +38849,16 @@ The port number. Refers to the container port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PORTS__PORTS__CONTAINER_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PORTS__PORTS__CONTAINER_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PORTS__PORTS__CONTAINER_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PORTS__PORTS__CONTAINER_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-ports-ports-host-port[`quarkus.knative.ports."ports".host-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-ports-ports-host-port[`quarkus.openshift.ports."ports".host-port`]## [.description] -- @@ -38627,16 +38866,16 @@ The host port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PORTS__PORTS__HOST_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PORTS__PORTS__HOST_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PORTS__PORTS__HOST_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PORTS__PORTS__HOST_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-ports-ports-path[`quarkus.knative.ports."ports".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-ports-ports-path[`quarkus.openshift.ports."ports".path`]## [.description] -- @@ -38644,16 +38883,16 @@ The application path (refers to web application path). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PORTS__PORTS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PORTS__PORTS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PORTS__PORTS__PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PORTS__PORTS__PATH+++` endif::add-copy-button-to-env-var[] -- |string |`/` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-ports-ports-protocol]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-ports-ports-protocol[`quarkus.knative.ports."ports".protocol`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-ports-ports-protocol]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-ports-ports-protocol[`quarkus.openshift.ports."ports".protocol`]## [.description] -- @@ -38661,16 +38900,16 @@ The protocol. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PORTS__PORTS__PROTOCOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PORTS__PORTS__PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PORTS__PORTS__PROTOCOL+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PORTS__PORTS__PROTOCOL+++` endif::add-copy-button-to-env-var[] -- a|`tcp`, `udp`, `sctp`, `http`, `proxy` |`tcp` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-ports-ports-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-ports-ports-node-port[`quarkus.knative.ports."ports".node-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-ports-ports-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-ports-ports-node-port[`quarkus.openshift.ports."ports".node-port`]## [.description] -- @@ -38678,16 +38917,16 @@ The nodePort to which this port should be mapped to. This only takes affect when ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PORTS__PORTS__NODE_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PORTS__PORTS__NODE_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PORTS__PORTS__NODE_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PORTS__PORTS__NODE_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-ports-ports-tls]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-ports-ports-tls[`quarkus.knative.ports."ports".tls`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-ports-ports-tls]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-ports-ports-tls[`quarkus.openshift.ports."ports".tls`]## [.description] -- @@ -38695,16 +38934,33 @@ If enabled, the port will be configured to use the schema HTTPS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PORTS__PORTS__TLS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PORTS__PORTS__TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PORTS__PORTS__TLS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PORTS__PORTS__TLS+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-service-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-service-type[`quarkus.knative.service-type`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-replicas]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-replicas[`quarkus.openshift.replicas`]## + +[.description] +-- +The number of desired pods + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_REPLICAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OPENSHIFT_REPLICAS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-service-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-service-type[`quarkus.openshift.service-type`]## [.description] -- @@ -38712,16 +38968,33 @@ The type of service that will be generated for the application ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SERVICE_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SERVICE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SERVICE_TYPE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SERVICE_TYPE+++` endif::add-copy-button-to-env-var[] -- a|`cluster-ip`, `node-port`, `load-balancer`, `external-name` |`cluster-ip` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-image-pull-policy[`quarkus.knative.image-pull-policy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-node-port[`quarkus.openshift.node-port`]## + +[.description] +-- +The nodePort to set when serviceType is set to nodePort + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_NODE_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OPENSHIFT_NODE_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-image-pull-policy[`quarkus.openshift.image-pull-policy`]## [.description] -- @@ -38729,16 +39002,16 @@ Image pull policy ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_IMAGE_PULL_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_IMAGE_PULL_POLICY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_IMAGE_PULL_POLICY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_IMAGE_PULL_POLICY+++` endif::add-copy-button-to-env-var[] -- a|`always`, `if-not-present`, `never` |`always` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-image-pull-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-image-pull-secrets[`quarkus.knative.image-pull-secrets`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-image-pull-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-image-pull-secrets[`quarkus.openshift.image-pull-secrets`]## [.description] -- @@ -38746,16 +39019,16 @@ The image pull secret ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_IMAGE_PULL_SECRETS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_IMAGE_PULL_SECRETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_IMAGE_PULL_SECRETS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_IMAGE_PULL_SECRETS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-generate-image-pull-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-generate-image-pull-secret[`quarkus.knative.generate-image-pull-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-generate-image-pull-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-generate-image-pull-secret[`quarkus.openshift.generate-image-pull-secret`]## [.description] -- @@ -38763,16 +39036,16 @@ Enable generation of image pull secret, when the container image username and pa ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GENERATE_IMAGE_PULL_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_GENERATE_IMAGE_PULL_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_GENERATE_IMAGE_PULL_SECRET+++` +Environment variable: `+++QUARKUS_OPENSHIFT_GENERATE_IMAGE_PULL_SECRET+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-port[`quarkus.knative.liveness-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-port[`quarkus.openshift.liveness-probe.http-action-port`]## [.description] -- @@ -38780,16 +39053,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-port-name[`quarkus.knative.liveness-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-port-name[`quarkus.openshift.liveness-probe.http-action-port-name`]## [.description] -- @@ -38797,16 +39070,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-path[`quarkus.knative.liveness-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-path[`quarkus.openshift.liveness-probe.http-action-path`]## [.description] -- @@ -38814,16 +39087,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-http-action-scheme[`quarkus.knative.liveness-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-http-action-scheme[`quarkus.openshift.liveness-probe.http-action-scheme`]## [.description] -- @@ -38831,16 +39104,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-exec-action[`quarkus.knative.liveness-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-exec-action[`quarkus.openshift.liveness-probe.exec-action`]## [.description] -- @@ -38848,16 +39121,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-tcp-socket-action[`quarkus.knative.liveness-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-tcp-socket-action[`quarkus.openshift.liveness-probe.tcp-socket-action`]## [.description] -- @@ -38865,16 +39138,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-grpc-action[`quarkus.knative.liveness-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-grpc-action[`quarkus.openshift.liveness-probe.grpc-action`]## [.description] -- @@ -38882,16 +39155,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-grpc-action-enabled[`quarkus.knative.liveness-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-grpc-action-enabled[`quarkus.openshift.liveness-probe.grpc-action-enabled`]## [.description] -- @@ -38899,16 +39172,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-initial-delay[`quarkus.knative.liveness-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-initial-delay[`quarkus.openshift.liveness-probe.initial-delay`]## [.description] -- @@ -38916,16 +39189,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-period[`quarkus.knative.liveness-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-period[`quarkus.openshift.liveness-probe.period`]## [.description] -- @@ -38933,16 +39206,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-timeout[`quarkus.knative.liveness-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-timeout[`quarkus.openshift.liveness-probe.timeout`]## [.description] -- @@ -38950,16 +39223,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-success-threshold[`quarkus.knative.liveness-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-success-threshold[`quarkus.openshift.liveness-probe.success-threshold`]## [.description] -- @@ -38967,16 +39240,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-failure-threshold[`quarkus.knative.liveness-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-failure-threshold[`quarkus.openshift.liveness-probe.failure-threshold`]## [.description] -- @@ -38984,16 +39257,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_LIVENESS_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-port[`quarkus.knative.readiness-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-port[`quarkus.openshift.readiness-probe.http-action-port`]## [.description] -- @@ -39001,16 +39274,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-port-name[`quarkus.knative.readiness-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-port-name[`quarkus.openshift.readiness-probe.http-action-port-name`]## [.description] -- @@ -39018,16 +39291,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-path[`quarkus.knative.readiness-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-path[`quarkus.openshift.readiness-probe.http-action-path`]## [.description] -- @@ -39035,16 +39308,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-http-action-scheme[`quarkus.knative.readiness-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-http-action-scheme[`quarkus.openshift.readiness-probe.http-action-scheme`]## [.description] -- @@ -39052,16 +39325,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-exec-action[`quarkus.knative.readiness-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-exec-action[`quarkus.openshift.readiness-probe.exec-action`]## [.description] -- @@ -39069,16 +39342,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-tcp-socket-action[`quarkus.knative.readiness-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-tcp-socket-action[`quarkus.openshift.readiness-probe.tcp-socket-action`]## [.description] -- @@ -39086,16 +39359,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-grpc-action[`quarkus.knative.readiness-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-grpc-action[`quarkus.openshift.readiness-probe.grpc-action`]## [.description] -- @@ -39103,16 +39376,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-grpc-action-enabled[`quarkus.knative.readiness-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-grpc-action-enabled[`quarkus.openshift.readiness-probe.grpc-action-enabled`]## [.description] -- @@ -39120,16 +39393,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-initial-delay[`quarkus.knative.readiness-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-initial-delay[`quarkus.openshift.readiness-probe.initial-delay`]## [.description] -- @@ -39137,16 +39410,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-period[`quarkus.knative.readiness-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-period[`quarkus.openshift.readiness-probe.period`]## [.description] -- @@ -39154,16 +39427,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-timeout[`quarkus.knative.readiness-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-timeout[`quarkus.openshift.readiness-probe.timeout`]## [.description] -- @@ -39171,16 +39444,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-success-threshold[`quarkus.knative.readiness-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-success-threshold[`quarkus.openshift.readiness-probe.success-threshold`]## [.description] -- @@ -39188,16 +39461,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-failure-threshold[`quarkus.knative.readiness-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-failure-threshold[`quarkus.openshift.readiness-probe.failure-threshold`]## [.description] -- @@ -39205,16 +39478,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_READINESS_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_READINESS_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-http-action-port[`quarkus.knative.startup-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-port[`quarkus.openshift.startup-probe.http-action-port`]## [.description] -- @@ -39222,16 +39495,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-http-action-port-name[`quarkus.knative.startup-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-port-name[`quarkus.openshift.startup-probe.http-action-port-name`]## [.description] -- @@ -39239,16 +39512,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-http-action-path[`quarkus.knative.startup-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-path[`quarkus.openshift.startup-probe.http-action-path`]## [.description] -- @@ -39256,16 +39529,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-http-action-scheme[`quarkus.knative.startup-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-http-action-scheme[`quarkus.openshift.startup-probe.http-action-scheme`]## [.description] -- @@ -39273,16 +39546,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-exec-action[`quarkus.knative.startup-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-exec-action[`quarkus.openshift.startup-probe.exec-action`]## [.description] -- @@ -39290,16 +39563,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-tcp-socket-action[`quarkus.knative.startup-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-tcp-socket-action[`quarkus.openshift.startup-probe.tcp-socket-action`]## [.description] -- @@ -39307,16 +39580,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-grpc-action[`quarkus.knative.startup-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-grpc-action[`quarkus.openshift.startup-probe.grpc-action`]## [.description] -- @@ -39324,16 +39597,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-grpc-action-enabled[`quarkus.knative.startup-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-grpc-action-enabled[`quarkus.openshift.startup-probe.grpc-action-enabled`]## [.description] -- @@ -39341,16 +39614,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-initial-delay[`quarkus.knative.startup-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-initial-delay[`quarkus.openshift.startup-probe.initial-delay`]## [.description] -- @@ -39358,16 +39631,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-period[`quarkus.knative.startup-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-period[`quarkus.openshift.startup-probe.period`]## [.description] -- @@ -39375,16 +39648,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-timeout[`quarkus.knative.startup-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-timeout[`quarkus.openshift.startup-probe.timeout`]## [.description] -- @@ -39392,16 +39665,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-success-threshold[`quarkus.knative.startup-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-success-threshold[`quarkus.openshift.startup-probe.success-threshold`]## [.description] -- @@ -39409,16 +39682,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-failure-threshold[`quarkus.knative.startup-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-failure-threshold[`quarkus.openshift.startup-probe.failure-threshold`]## [.description] -- @@ -39426,16 +39699,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_STARTUP_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_STARTUP_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-annotations]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-annotations[`quarkus.knative.prometheus.annotations`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-annotations]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-annotations[`quarkus.openshift.prometheus.annotations`]## [.description] -- @@ -39443,16 +39716,16 @@ When true (the default), emit a set of annotations to identify services that sho ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_ANNOTATIONS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_ANNOTATIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_ANNOTATIONS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_ANNOTATIONS+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-generate-service-monitor]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-generate-service-monitor[`quarkus.knative.prometheus.generate-service-monitor`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-generate-service-monitor]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-generate-service-monitor[`quarkus.openshift.prometheus.generate-service-monitor`]## [.description] -- @@ -39460,16 +39733,16 @@ When true (the default), emit a set of annotations to identify services that sho ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_GENERATE_SERVICE_MONITOR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_GENERATE_SERVICE_MONITOR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_GENERATE_SERVICE_MONITOR+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_GENERATE_SERVICE_MONITOR+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-prefix]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-prefix[`quarkus.knative.prometheus.prefix`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-prefix]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-prefix[`quarkus.openshift.prometheus.prefix`]## [.description] -- @@ -39477,16 +39750,16 @@ Define the annotation prefix used for scrape values, this value will be used as ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_PREFIX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_PREFIX+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_PREFIX+++` endif::add-copy-button-to-env-var[] -- |string |`prometheus.io` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-scrape]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-scrape[`quarkus.knative.prometheus.scrape`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-scrape]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-scrape[`quarkus.openshift.prometheus.scrape`]## [.description] -- @@ -39494,16 +39767,16 @@ Define the annotation used to indicate services that should be scraped. By defau ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_SCRAPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_SCRAPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_SCRAPE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_SCRAPE+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-path[`quarkus.knative.prometheus.path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-path[`quarkus.openshift.prometheus.path`]## [.description] -- @@ -39511,16 +39784,16 @@ Define the annotation used to indicate the path to scrape. By default, `/path` w ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-port[`quarkus.knative.prometheus.port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-port[`quarkus.openshift.prometheus.port`]## [.description] -- @@ -39528,16 +39801,16 @@ Define the annotation used to indicate the port to scrape. By default, `/port` w ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_PORT+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-prometheus-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-prometheus-scheme[`quarkus.knative.prometheus.scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-prometheus-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-prometheus-scheme[`quarkus.openshift.prometheus.scheme`]## [.description] -- @@ -39545,16 +39818,16 @@ Define the annotation used to indicate the scheme to use for scraping By default ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PROMETHEUS_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PROMETHEUS_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PROMETHEUS_SCHEME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PROMETHEUS_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-mounts-mounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-mounts-mounts-name[`quarkus.knative.mounts."mounts".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-mounts-mounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-mounts-mounts-name[`quarkus.openshift.mounts."mounts".name`]## [.description] -- @@ -39562,16 +39835,16 @@ The name of the volumeName to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-mounts-mounts-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-mounts-mounts-path[`quarkus.knative.mounts."mounts".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-mounts-mounts-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-mounts-mounts-path[`quarkus.openshift.mounts."mounts".path`]## [.description] -- @@ -39579,16 +39852,16 @@ The path to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-mounts-mounts-sub-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-mounts-mounts-sub-path[`quarkus.knative.mounts."mounts".sub-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-mounts-mounts-sub-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-mounts-mounts-sub-path[`quarkus.openshift.mounts."mounts".sub-path`]## [.description] -- @@ -39596,16 +39869,16 @@ Path within the volumeName from which the container's volumeName should be mount ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__SUB_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__SUB_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__SUB_PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__SUB_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-mounts-mounts-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-mounts-mounts-read-only[`quarkus.knative.mounts."mounts".read-only`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-mounts-mounts-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-mounts-mounts-read-only[`quarkus.openshift.mounts."mounts".read-only`]## [.description] -- @@ -39613,16 +39886,16 @@ ReadOnly ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__READ_ONLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__READ_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_MOUNTS__MOUNTS__READ_ONLY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__READ_ONLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-secret-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-secret-name[`quarkus.knative.secret-volumes."secret-volumes".secret-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-secret-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-secret-name[`quarkus.openshift.secret-volumes."secret-volumes".secret-name`]## [.description] -- @@ -39630,16 +39903,16 @@ The name of the secret to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__SECRET_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__SECRET_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__SECRET_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__SECRET_NAME+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-default-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-default-mode[`quarkus.knative.secret-volumes."secret-volumes".default-mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-default-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-default-mode[`quarkus.openshift.secret-volumes."secret-volumes".default-mode`]## [.description] -- @@ -39647,16 +39920,16 @@ Default mode. When specifying an octal number, leading zero must be present. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__DEFAULT_MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__DEFAULT_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__DEFAULT_MODE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__DEFAULT_MODE+++` endif::add-copy-button-to-env-var[] -- |string |`0600` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-items-items-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-items-items-path[`quarkus.knative.secret-volumes."secret-volumes".items."items".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-items-items-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-items-items-path[`quarkus.openshift.secret-volumes."secret-volumes".items."items".path`]## [.description] -- @@ -39664,16 +39937,16 @@ The path where the file will be mounted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__PATH+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-items-items-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-items-items-mode[`quarkus.knative.secret-volumes."secret-volumes".items."items".mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-items-items-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-items-items-mode[`quarkus.openshift.secret-volumes."secret-volumes".items."items".mode`]## [.description] -- @@ -39681,16 +39954,16 @@ It must be a value between 0000 and 0777. If not specified, the volume defaultMo ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__MODE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__MODE+++` endif::add-copy-button-to-env-var[] -- |int |`-1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-optional]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-secret-volumes-secret-volumes-optional[`quarkus.knative.secret-volumes."secret-volumes".optional`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-optional]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-secret-volumes-secret-volumes-optional[`quarkus.openshift.secret-volumes."secret-volumes".optional`]## [.description] -- @@ -39698,16 +39971,16 @@ Optional ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__OPTIONAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__OPTIONAL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__OPTIONAL+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__OPTIONAL+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-config-map-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-config-map-name[`quarkus.knative.config-map-volumes."config-map-volumes".config-map-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-config-map-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-config-map-name[`quarkus.openshift.config-map-volumes."config-map-volumes".config-map-name`]## [.description] -- @@ -39715,16 +39988,16 @@ The name of the ConfigMap to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__CONFIG_MAP_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__CONFIG_MAP_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__CONFIG_MAP_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__CONFIG_MAP_NAME+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-default-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-default-mode[`quarkus.knative.config-map-volumes."config-map-volumes".default-mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-default-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-default-mode[`quarkus.openshift.config-map-volumes."config-map-volumes".default-mode`]## [.description] -- @@ -39732,16 +40005,16 @@ Default mode. When specifying an octal number, leading zero must be present. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__DEFAULT_MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__DEFAULT_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__DEFAULT_MODE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__DEFAULT_MODE+++` endif::add-copy-button-to-env-var[] -- |string |`0600` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-items-items-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-items-items-path[`quarkus.knative.config-map-volumes."config-map-volumes".items."items".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-items-items-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-items-items-path[`quarkus.openshift.config-map-volumes."config-map-volumes".items."items".path`]## [.description] -- @@ -39749,16 +40022,16 @@ The path where the file will be mounted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__PATH+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-items-items-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-items-items-mode[`quarkus.knative.config-map-volumes."config-map-volumes".items."items".mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-items-items-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-items-items-mode[`quarkus.openshift.config-map-volumes."config-map-volumes".items."items".mode`]## [.description] -- @@ -39766,16 +40039,16 @@ It must be a value between 0000 and 0777. If not specified, the volume defaultMo ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__MODE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__MODE+++` endif::add-copy-button-to-env-var[] -- |int |`-1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-optional]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-config-map-volumes-config-map-volumes-optional[`quarkus.knative.config-map-volumes."config-map-volumes".optional`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-optional]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-config-map-volumes-config-map-volumes-optional[`quarkus.openshift.config-map-volumes."config-map-volumes".optional`]## [.description] -- @@ -39783,16 +40056,16 @@ Optional ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__OPTIONAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__OPTIONAL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__OPTIONAL+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__OPTIONAL+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-empty-dir-volumes]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-empty-dir-volumes[`quarkus.knative.empty-dir-volumes`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-empty-dir-volumes]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-empty-dir-volumes[`quarkus.openshift.empty-dir-volumes`]## [.description] -- @@ -39800,16 +40073,16 @@ EmptyDir volumes ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_EMPTY_DIR_VOLUMES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_EMPTY_DIR_VOLUMES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_EMPTY_DIR_VOLUMES+++` +Environment variable: `+++QUARKUS_OPENSHIFT_EMPTY_DIR_VOLUMES+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-git-repo-volumes-git-repo-volumes-repository]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-git-repo-volumes-git-repo-volumes-repository[`quarkus.knative.git-repo-volumes."git-repo-volumes".repository`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-git-repo-volumes-git-repo-volumes-repository]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-git-repo-volumes-git-repo-volumes-repository[`quarkus.openshift.git-repo-volumes."git-repo-volumes".repository`]## [.description] -- @@ -39817,16 +40090,16 @@ Git repository URL. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REPOSITORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REPOSITORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REPOSITORY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REPOSITORY+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-git-repo-volumes-git-repo-volumes-directory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-git-repo-volumes-git-repo-volumes-directory[`quarkus.knative.git-repo-volumes."git-repo-volumes".directory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-git-repo-volumes-git-repo-volumes-directory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-git-repo-volumes-git-repo-volumes-directory[`quarkus.openshift.git-repo-volumes."git-repo-volumes".directory`]## [.description] -- @@ -39834,16 +40107,16 @@ The directory of the repository to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__DIRECTORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__DIRECTORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__DIRECTORY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__DIRECTORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-git-repo-volumes-git-repo-volumes-revision]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-git-repo-volumes-git-repo-volumes-revision[`quarkus.knative.git-repo-volumes."git-repo-volumes".revision`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-git-repo-volumes-git-repo-volumes-revision]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-git-repo-volumes-git-repo-volumes-revision[`quarkus.openshift.git-repo-volumes."git-repo-volumes".revision`]## [.description] -- @@ -39851,16 +40124,16 @@ The commit hash to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REVISION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REVISION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REVISION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REVISION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-pvc-volumes-pvc-volumes-claim-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-pvc-volumes-pvc-volumes-claim-name[`quarkus.knative.pvc-volumes."pvc-volumes".claim-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-pvc-volumes-pvc-volumes-claim-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-pvc-volumes-pvc-volumes-claim-name[`quarkus.openshift.pvc-volumes."pvc-volumes".claim-name`]## [.description] -- @@ -39868,16 +40141,16 @@ The name of the claim to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__CLAIM_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__CLAIM_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__CLAIM_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__CLAIM_NAME+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-pvc-volumes-pvc-volumes-default-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-pvc-volumes-pvc-volumes-default-mode[`quarkus.knative.pvc-volumes."pvc-volumes".default-mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-pvc-volumes-pvc-volumes-default-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-pvc-volumes-pvc-volumes-default-mode[`quarkus.openshift.pvc-volumes."pvc-volumes".default-mode`]## [.description] -- @@ -39885,16 +40158,16 @@ Default mode. When specifying an octal number, leading zero must be present. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__DEFAULT_MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__DEFAULT_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__DEFAULT_MODE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__DEFAULT_MODE+++` endif::add-copy-button-to-env-var[] -- |string |`0600` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-pvc-volumes-pvc-volumes-optional]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-pvc-volumes-pvc-volumes-optional[`quarkus.knative.pvc-volumes."pvc-volumes".optional`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-pvc-volumes-pvc-volumes-optional]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-pvc-volumes-pvc-volumes-optional[`quarkus.openshift.pvc-volumes."pvc-volumes".optional`]## [.description] -- @@ -39902,16 +40175,16 @@ Optional ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__OPTIONAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__OPTIONAL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__OPTIONAL+++` +Environment variable: `+++QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__OPTIONAL+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-volume-id]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-volume-id[`quarkus.knative.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".volume-id`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-volume-id]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-volume-id[`quarkus.openshift.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".volume-id`]## [.description] -- @@ -39919,16 +40192,16 @@ The name of the disk to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__VOLUME_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__VOLUME_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__VOLUME_ID+++` +Environment variable: `+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__VOLUME_ID+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-partition]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-partition[`quarkus.knative.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".partition`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-partition]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-partition[`quarkus.openshift.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".partition`]## [.description] -- @@ -39936,16 +40209,16 @@ The partition. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__PARTITION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__PARTITION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__PARTITION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__PARTITION+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-fs-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-fs-type[`quarkus.knative.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".fs-type`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-fs-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-fs-type[`quarkus.openshift.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".fs-type`]## [.description] -- @@ -39953,16 +40226,16 @@ Filesystem type. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__FS_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__FS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__FS_TYPE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__FS_TYPE+++` endif::add-copy-button-to-env-var[] -- |string |`ext4` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-read-only[`quarkus.knative.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".read-only`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-aws-elastic-block-store-volumes-aws-elastic-block-store-volumes-read-only[`quarkus.openshift.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".read-only`]## [.description] -- @@ -39970,16 +40243,16 @@ Whether the volumeName is read only or not. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__READ_ONLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__READ_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__READ_ONLY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__READ_ONLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-file-volumes-azure-file-volumes-share-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-file-volumes-azure-file-volumes-share-name[`quarkus.knative.azure-file-volumes."azure-file-volumes".share-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-file-volumes-azure-file-volumes-share-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-file-volumes-azure-file-volumes-share-name[`quarkus.openshift.azure-file-volumes."azure-file-volumes".share-name`]## [.description] -- @@ -39987,16 +40260,16 @@ The share name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SHARE_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SHARE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SHARE_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SHARE_NAME+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-file-volumes-azure-file-volumes-secret-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-file-volumes-azure-file-volumes-secret-name[`quarkus.knative.azure-file-volumes."azure-file-volumes".secret-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-file-volumes-azure-file-volumes-secret-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-file-volumes-azure-file-volumes-secret-name[`quarkus.openshift.azure-file-volumes."azure-file-volumes".secret-name`]## [.description] -- @@ -40004,16 +40277,16 @@ The secret name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SECRET_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SECRET_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SECRET_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SECRET_NAME+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-file-volumes-azure-file-volumes-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-file-volumes-azure-file-volumes-read-only[`quarkus.knative.azure-file-volumes."azure-file-volumes".read-only`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-file-volumes-azure-file-volumes-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-file-volumes-azure-file-volumes-read-only[`quarkus.openshift.azure-file-volumes."azure-file-volumes".read-only`]## [.description] -- @@ -40021,16 +40294,16 @@ Whether the volumeName is read only or not. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__READ_ONLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__READ_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__READ_ONLY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__READ_ONLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-disk-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-disk-name[`quarkus.knative.azure-disk-volumes."azure-disk-volumes".disk-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-disk-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-disk-name[`quarkus.openshift.azure-disk-volumes."azure-disk-volumes".disk-name`]## [.description] -- @@ -40038,16 +40311,16 @@ The name of the disk to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_NAME+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-disk-uri]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-disk-uri[`quarkus.knative.azure-disk-volumes."azure-disk-volumes".disk-uri`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-disk-uri]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-disk-uri[`quarkus.openshift.azure-disk-volumes."azure-disk-volumes".disk-uri`]## [.description] -- @@ -40055,16 +40328,16 @@ The URI of the vhd blob object OR the resourceID of an Azure managed data disk i ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_URI+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_URI+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_URI+++` +Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_URI+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-kind[`quarkus.knative.azure-disk-volumes."azure-disk-volumes".kind`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-kind[`quarkus.openshift.azure-disk-volumes."azure-disk-volumes".kind`]## [.description] -- @@ -40072,16 +40345,16 @@ Kind of disk. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__KIND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__KIND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__KIND+++` +Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__KIND+++` endif::add-copy-button-to-env-var[] -- a|`managed`, `shared` |`managed` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-caching-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-caching-mode[`quarkus.knative.azure-disk-volumes."azure-disk-volumes".caching-mode`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-caching-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-caching-mode[`quarkus.openshift.azure-disk-volumes."azure-disk-volumes".caching-mode`]## [.description] -- @@ -40089,16 +40362,16 @@ Disk caching mode. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__CACHING_MODE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__CACHING_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__CACHING_MODE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__CACHING_MODE+++` endif::add-copy-button-to-env-var[] -- a|`read-write`, `read-only`, `none` |`read-write` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-fs-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-fs-type[`quarkus.knative.azure-disk-volumes."azure-disk-volumes".fs-type`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-fs-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-fs-type[`quarkus.openshift.azure-disk-volumes."azure-disk-volumes".fs-type`]## [.description] -- @@ -40106,16 +40379,16 @@ File system type. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__FS_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__FS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__FS_TYPE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__FS_TYPE+++` endif::add-copy-button-to-env-var[] -- |string |`ext4` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-azure-disk-volumes-azure-disk-volumes-read-only[`quarkus.knative.azure-disk-volumes."azure-disk-volumes".read-only`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-azure-disk-volumes-azure-disk-volumes-read-only[`quarkus.openshift.azure-disk-volumes."azure-disk-volumes".read-only`]## [.description] -- @@ -40123,33 +40396,16 @@ Whether the volumeName is read only or not. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__READ_ONLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__READ_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__READ_ONLY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__READ_ONLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-container-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-container-name[`quarkus.knative.container-name`]## - -[.description] --- -If set, it will change the name of the container according to the configuration - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINER_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINER_NAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-image[`quarkus.knative.init-containers."init-containers".image`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-image[`quarkus.openshift.init-containers."init-containers".image`]## [.description] -- @@ -40157,16 +40413,16 @@ The container image. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-working-dir[`quarkus.knative.init-containers."init-containers".working-dir`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-working-dir[`quarkus.openshift.init-containers."init-containers".working-dir`]## [.description] -- @@ -40174,16 +40430,16 @@ Working directory. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__WORKING_DIR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__WORKING_DIR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__WORKING_DIR+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__WORKING_DIR+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-command[`quarkus.knative.init-containers."init-containers".command`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-command[`quarkus.openshift.init-containers."init-containers".command`]## [.description] -- @@ -40191,16 +40447,16 @@ The commands ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__COMMAND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__COMMAND+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__COMMAND+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-arguments[`quarkus.knative.init-containers."init-containers".arguments`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-arguments[`quarkus.openshift.init-containers."init-containers".arguments`]## [.description] -- @@ -40208,16 +40464,16 @@ The arguments ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ARGUMENTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ARGUMENTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ARGUMENTS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ARGUMENTS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-service-account[`quarkus.knative.init-containers."init-containers".service-account`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-service-account[`quarkus.openshift.init-containers."init-containers".service-account`]## [.description] -- @@ -40225,16 +40481,16 @@ The service account. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__SERVICE_ACCOUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__SERVICE_ACCOUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__SERVICE_ACCOUNT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__SERVICE_ACCOUNT+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-host]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-host[`quarkus.knative.init-containers."init-containers".host`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-host]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-host[`quarkus.openshift.init-containers."init-containers".host`]## [.description] -- @@ -40242,16 +40498,16 @@ The host under which the application is going to be exposed. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__HOST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__HOST+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__HOST+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-container-port[`quarkus.knative.init-containers."init-containers".ports."ports".container-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-container-port[`quarkus.openshift.init-containers."init-containers".ports."ports".container-port`]## [.description] -- @@ -40259,16 +40515,16 @@ The port number. Refers to the container port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__CONTAINER_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__CONTAINER_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__CONTAINER_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__CONTAINER_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-host-port[`quarkus.knative.init-containers."init-containers".ports."ports".host-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-host-port[`quarkus.openshift.init-containers."init-containers".ports."ports".host-port`]## [.description] -- @@ -40276,16 +40532,16 @@ The host port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__HOST_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__HOST_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__HOST_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__HOST_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-path[`quarkus.knative.init-containers."init-containers".ports."ports".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-path[`quarkus.openshift.init-containers."init-containers".ports."ports".path`]## [.description] -- @@ -40293,16 +40549,16 @@ The application path (refers to web application path). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PATH+++` endif::add-copy-button-to-env-var[] -- |string |`/` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-protocol]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-protocol[`quarkus.knative.init-containers."init-containers".ports."ports".protocol`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-protocol]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-protocol[`quarkus.openshift.init-containers."init-containers".ports."ports".protocol`]## [.description] -- @@ -40310,16 +40566,16 @@ The protocol. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PROTOCOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PROTOCOL+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PROTOCOL+++` endif::add-copy-button-to-env-var[] -- a|`tcp`, `udp`, `sctp`, `http`, `proxy` |`tcp` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-node-port[`quarkus.knative.init-containers."init-containers".ports."ports".node-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-node-port[`quarkus.openshift.init-containers."init-containers".ports."ports".node-port`]## [.description] -- @@ -40327,16 +40583,16 @@ The nodePort to which this port should be mapped to. This only takes affect when ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__NODE_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__NODE_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__NODE_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__NODE_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-tls]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-ports-ports-tls[`quarkus.knative.init-containers."init-containers".ports."ports".tls`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-tls]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-ports-ports-tls[`quarkus.openshift.init-containers."init-containers".ports."ports".tls`]## [.description] -- @@ -40344,16 +40600,16 @@ If enabled, the port will be configured to use the schema HTTPS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__TLS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__TLS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__TLS+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-image-pull-policy[`quarkus.knative.init-containers."init-containers".image-pull-policy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-image-pull-policy[`quarkus.openshift.init-containers."init-containers".image-pull-policy`]## [.description] -- @@ -40361,16 +40617,16 @@ Image pull policy. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_POLICY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_POLICY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_POLICY+++` endif::add-copy-button-to-env-var[] -- a|`always`, `if-not-present`, `never` |`always` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-image-pull-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-image-pull-secrets[`quarkus.knative.init-containers."init-containers".image-pull-secrets`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-image-pull-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-image-pull-secrets[`quarkus.openshift.init-containers."init-containers".image-pull-secrets`]## [.description] -- @@ -40378,16 +40634,16 @@ The image pull secret ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_SECRETS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_SECRETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_SECRETS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_SECRETS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-port[`quarkus.knative.init-containers."init-containers".liveness-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-port[`quarkus.openshift.init-containers."init-containers".liveness-probe.http-action-port`]## [.description] -- @@ -40395,16 +40651,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-port-name[`quarkus.knative.init-containers."init-containers".liveness-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-port-name[`quarkus.openshift.init-containers."init-containers".liveness-probe.http-action-port-name`]## [.description] -- @@ -40412,16 +40668,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-path[`quarkus.knative.init-containers."init-containers".liveness-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-path[`quarkus.openshift.init-containers."init-containers".liveness-probe.http-action-path`]## [.description] -- @@ -40429,16 +40685,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-http-action-scheme[`quarkus.knative.init-containers."init-containers".liveness-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-http-action-scheme[`quarkus.openshift.init-containers."init-containers".liveness-probe.http-action-scheme`]## [.description] -- @@ -40446,16 +40702,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-exec-action[`quarkus.knative.init-containers."init-containers".liveness-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-exec-action[`quarkus.openshift.init-containers."init-containers".liveness-probe.exec-action`]## [.description] -- @@ -40463,16 +40719,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-tcp-socket-action[`quarkus.knative.init-containers."init-containers".liveness-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-tcp-socket-action[`quarkus.openshift.init-containers."init-containers".liveness-probe.tcp-socket-action`]## [.description] -- @@ -40480,16 +40736,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-grpc-action[`quarkus.knative.init-containers."init-containers".liveness-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-grpc-action[`quarkus.openshift.init-containers."init-containers".liveness-probe.grpc-action`]## [.description] -- @@ -40497,16 +40753,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-grpc-action-enabled[`quarkus.knative.init-containers."init-containers".liveness-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-grpc-action-enabled[`quarkus.openshift.init-containers."init-containers".liveness-probe.grpc-action-enabled`]## [.description] -- @@ -40514,16 +40770,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-initial-delay[`quarkus.knative.init-containers."init-containers".liveness-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-initial-delay[`quarkus.openshift.init-containers."init-containers".liveness-probe.initial-delay`]## [.description] -- @@ -40531,16 +40787,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-period[`quarkus.knative.init-containers."init-containers".liveness-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-period[`quarkus.openshift.init-containers."init-containers".liveness-probe.period`]## [.description] -- @@ -40548,16 +40804,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-timeout[`quarkus.knative.init-containers."init-containers".liveness-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-timeout[`quarkus.openshift.init-containers."init-containers".liveness-probe.timeout`]## [.description] -- @@ -40565,16 +40821,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-success-threshold[`quarkus.knative.init-containers."init-containers".liveness-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-success-threshold[`quarkus.openshift.init-containers."init-containers".liveness-probe.success-threshold`]## [.description] -- @@ -40582,16 +40838,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-failure-threshold[`quarkus.knative.init-containers."init-containers".liveness-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-failure-threshold[`quarkus.openshift.init-containers."init-containers".liveness-probe.failure-threshold`]## [.description] -- @@ -40599,16 +40855,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-port[`quarkus.knative.init-containers."init-containers".readiness-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-port[`quarkus.openshift.init-containers."init-containers".readiness-probe.http-action-port`]## [.description] -- @@ -40616,16 +40872,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-port-name[`quarkus.knative.init-containers."init-containers".readiness-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-port-name[`quarkus.openshift.init-containers."init-containers".readiness-probe.http-action-port-name`]## [.description] -- @@ -40633,16 +40889,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-path[`quarkus.knative.init-containers."init-containers".readiness-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-path[`quarkus.openshift.init-containers."init-containers".readiness-probe.http-action-path`]## [.description] -- @@ -40650,16 +40906,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-http-action-scheme[`quarkus.knative.init-containers."init-containers".readiness-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-http-action-scheme[`quarkus.openshift.init-containers."init-containers".readiness-probe.http-action-scheme`]## [.description] -- @@ -40667,16 +40923,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-exec-action[`quarkus.knative.init-containers."init-containers".readiness-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-exec-action[`quarkus.openshift.init-containers."init-containers".readiness-probe.exec-action`]## [.description] -- @@ -40684,16 +40940,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-tcp-socket-action[`quarkus.knative.init-containers."init-containers".readiness-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-tcp-socket-action[`quarkus.openshift.init-containers."init-containers".readiness-probe.tcp-socket-action`]## [.description] -- @@ -40701,16 +40957,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-grpc-action[`quarkus.knative.init-containers."init-containers".readiness-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-grpc-action[`quarkus.openshift.init-containers."init-containers".readiness-probe.grpc-action`]## [.description] -- @@ -40718,16 +40974,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-grpc-action-enabled[`quarkus.knative.init-containers."init-containers".readiness-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-grpc-action-enabled[`quarkus.openshift.init-containers."init-containers".readiness-probe.grpc-action-enabled`]## [.description] -- @@ -40735,16 +40991,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-initial-delay[`quarkus.knative.init-containers."init-containers".readiness-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-initial-delay[`quarkus.openshift.init-containers."init-containers".readiness-probe.initial-delay`]## [.description] -- @@ -40752,16 +41008,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-period[`quarkus.knative.init-containers."init-containers".readiness-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-period[`quarkus.openshift.init-containers."init-containers".readiness-probe.period`]## [.description] -- @@ -40769,16 +41025,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-timeout[`quarkus.knative.init-containers."init-containers".readiness-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-timeout[`quarkus.openshift.init-containers."init-containers".readiness-probe.timeout`]## [.description] -- @@ -40786,16 +41042,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-success-threshold[`quarkus.knative.init-containers."init-containers".readiness-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-success-threshold[`quarkus.openshift.init-containers."init-containers".readiness-probe.success-threshold`]## [.description] -- @@ -40803,16 +41059,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-failure-threshold[`quarkus.knative.init-containers."init-containers".readiness-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-failure-threshold[`quarkus.openshift.init-containers."init-containers".readiness-probe.failure-threshold`]## [.description] -- @@ -40820,16 +41076,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-name[`quarkus.knative.init-containers."init-containers".mounts."mounts".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-name[`quarkus.openshift.init-containers."init-containers".mounts."mounts".name`]## [.description] -- @@ -40837,16 +41093,16 @@ The name of the volumeName to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-path[`quarkus.knative.init-containers."init-containers".mounts."mounts".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-path[`quarkus.openshift.init-containers."init-containers".mounts."mounts".path`]## [.description] -- @@ -40854,16 +41110,16 @@ The path to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-sub-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-sub-path[`quarkus.knative.init-containers."init-containers".mounts."mounts".sub-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-sub-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-sub-path[`quarkus.openshift.init-containers."init-containers".mounts."mounts".sub-path`]## [.description] -- @@ -40871,16 +41127,16 @@ Path within the volumeName from which the container's volumeName should be mount ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__SUB_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__SUB_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__SUB_PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__SUB_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-mounts-mounts-read-only[`quarkus.knative.init-containers."init-containers".mounts."mounts".read-only`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-mounts-mounts-read-only[`quarkus.openshift.init-containers."init-containers".mounts."mounts".read-only`]## [.description] -- @@ -40888,16 +41144,16 @@ ReadOnly ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__READ_ONLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__READ_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__READ_ONLY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__READ_ONLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-limits-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-limits-cpu[`quarkus.knative.init-containers."init-containers".resources.limits.cpu`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-limits-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-limits-cpu[`quarkus.openshift.init-containers."init-containers".resources.limits.cpu`]## [.description] -- @@ -40905,16 +41161,16 @@ CPU Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_CPU+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_CPU+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_CPU+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_CPU+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-limits-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-limits-memory[`quarkus.knative.init-containers."init-containers".resources.limits.memory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-limits-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-limits-memory[`quarkus.openshift.init-containers."init-containers".resources.limits.memory`]## [.description] -- @@ -40922,16 +41178,16 @@ Memory Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_MEMORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_MEMORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_MEMORY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_MEMORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-requests-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-requests-cpu[`quarkus.knative.init-containers."init-containers".resources.requests.cpu`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-requests-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-requests-cpu[`quarkus.openshift.init-containers."init-containers".resources.requests.cpu`]## [.description] -- @@ -40939,16 +41195,16 @@ CPU Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_CPU+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_CPU+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_CPU+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_CPU+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-requests-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-resources-requests-memory[`quarkus.knative.init-containers."init-containers".resources.requests.memory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-requests-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-resources-requests-memory[`quarkus.openshift.init-containers."init-containers".resources.requests.memory`]## [.description] -- @@ -40956,16 +41212,16 @@ Memory Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_MEMORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_MEMORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_MEMORY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_MEMORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-secrets[`quarkus.knative.init-containers."init-containers".env.secrets`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-secrets[`quarkus.openshift.init-containers."init-containers".env.secrets`]## [.description] -- @@ -40973,16 +41229,16 @@ The optional list of Secret names to load environment variables from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_SECRETS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_SECRETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_SECRETS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_SECRETS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-configmaps]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-configmaps[`quarkus.knative.init-containers."init-containers".env.configmaps`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-configmaps]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-configmaps[`quarkus.openshift.init-containers."init-containers".env.configmaps`]## [.description] -- @@ -40990,16 +41246,16 @@ The optional list of ConfigMap names to load environment variables from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_CONFIGMAPS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_CONFIGMAPS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_CONFIGMAPS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_CONFIGMAPS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-fields-environment-variable-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-fields-environment-variable-name[`quarkus.knative.init-containers."init-containers".env.fields."environment-variable-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-fields-environment-variable-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-fields-environment-variable-name[`quarkus.openshift.init-containers."init-containers".env.fields."environment-variable-name"`]## [.description] -- @@ -41007,16 +41263,16 @@ The map associating environment variable names to their associated field referen ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++` endif::add-copy-button-to-env-var[] -- |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-vars-vars]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-vars-vars[`quarkus.knative.init-containers."init-containers".env.vars."vars"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-vars-vars]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-vars-vars[`quarkus.openshift.init-containers."init-containers".env.vars."vars"`]## [.description] -- @@ -41024,16 +41280,16 @@ The map associating environment name to its associated value. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_VARS__VARS_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_VARS__VARS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_VARS__VARS_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_VARS__VARS_+++` endif::add-copy-button-to-env-var[] -- |Map> | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-mapping-mapping-from-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-mapping-mapping-from-secret[`quarkus.knative.init-containers."init-containers".env.mapping."mapping".from-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-mapping-mapping-from-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-mapping-mapping-from-secret[`quarkus.openshift.init-containers."init-containers".env.mapping."mapping".from-secret`]## [.description] -- @@ -41041,16 +41297,16 @@ The optional name of the Secret from which a value is to be extracted. Mutually ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-mapping-mapping-from-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-mapping-mapping-from-configmap[`quarkus.knative.init-containers."init-containers".env.mapping."mapping".from-configmap`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-mapping-mapping-from-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-mapping-mapping-from-configmap[`quarkus.openshift.init-containers."init-containers".env.mapping."mapping".from-configmap`]## [.description] -- @@ -41058,16 +41314,16 @@ The optional name of the ConfigMap from which a value is to be extracted. Mutual ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-mapping-mapping-with-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-mapping-mapping-with-key[`quarkus.knative.init-containers."init-containers".env.mapping."mapping".with-key`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-mapping-mapping-with-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-mapping-mapping-with-key[`quarkus.openshift.init-containers."init-containers".env.mapping."mapping".with-key`]## [.description] -- @@ -41075,16 +41331,16 @@ The key identifying the field from which the value is extracted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-using-prefix-prefixes-for-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-using-prefix-prefixes-for-secret[`quarkus.knative.init-containers."init-containers".env.using-prefix."prefixes".for-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-using-prefix-prefixes-for-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-using-prefix-prefixes-for-secret[`quarkus.openshift.init-containers."init-containers".env.using-prefix."prefixes".for-secret`]## [.description] -- @@ -41092,16 +41348,16 @@ The optional prefix to use when adding the environment variable to the container ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-using-prefix-prefixes-for-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-env-using-prefix-prefixes-for-configmap[`quarkus.knative.init-containers."init-containers".env.using-prefix."prefixes".for-configmap`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-using-prefix-prefixes-for-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-env-using-prefix-prefixes-for-configmap[`quarkus.openshift.init-containers."init-containers".env.using-prefix."prefixes".for-configmap`]## [.description] -- @@ -41109,16 +41365,16 @@ The optional prefix to use when adding the environment variable to the container ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-image[`quarkus.knative.containers."containers".image`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-image[`quarkus.openshift.sidecars."sidecars".image`]## [.description] -- @@ -41126,16 +41382,16 @@ The container image. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-working-dir[`quarkus.knative.containers."containers".working-dir`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-working-dir]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-working-dir[`quarkus.openshift.sidecars."sidecars".working-dir`]## [.description] -- @@ -41143,16 +41399,16 @@ Working directory. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__WORKING_DIR+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__WORKING_DIR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__WORKING_DIR+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__WORKING_DIR+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-command[`quarkus.knative.containers."containers".command`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-command]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-command[`quarkus.openshift.sidecars."sidecars".command`]## [.description] -- @@ -41160,16 +41416,16 @@ The commands ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__COMMAND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__COMMAND+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__COMMAND+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-arguments[`quarkus.knative.containers."containers".arguments`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-arguments]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-arguments[`quarkus.openshift.sidecars."sidecars".arguments`]## [.description] -- @@ -41177,16 +41433,16 @@ The arguments ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ARGUMENTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ARGUMENTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ARGUMENTS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ARGUMENTS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-service-account[`quarkus.knative.containers."containers".service-account`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-service-account]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-service-account[`quarkus.openshift.sidecars."sidecars".service-account`]## [.description] -- @@ -41194,16 +41450,16 @@ The service account. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__SERVICE_ACCOUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__SERVICE_ACCOUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__SERVICE_ACCOUNT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__SERVICE_ACCOUNT+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-host]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-host[`quarkus.knative.containers."containers".host`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-host]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-host[`quarkus.openshift.sidecars."sidecars".host`]## [.description] -- @@ -41211,16 +41467,16 @@ The host under which the application is going to be exposed. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__HOST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__HOST+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__HOST+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-container-port[`quarkus.knative.containers."containers".ports."ports".container-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-container-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-container-port[`quarkus.openshift.sidecars."sidecars".ports."ports".container-port`]## [.description] -- @@ -41228,16 +41484,16 @@ The port number. Refers to the container port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__CONTAINER_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__CONTAINER_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__CONTAINER_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__CONTAINER_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-host-port[`quarkus.knative.containers."containers".ports."ports".host-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-host-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-host-port[`quarkus.openshift.sidecars."sidecars".ports."ports".host-port`]## [.description] -- @@ -41245,16 +41501,16 @@ The host port. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__HOST_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__HOST_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__HOST_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__HOST_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-path[`quarkus.knative.containers."containers".ports."ports".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-path[`quarkus.openshift.sidecars."sidecars".ports."ports".path`]## [.description] -- @@ -41262,16 +41518,16 @@ The application path (refers to web application path). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__PATH+++` endif::add-copy-button-to-env-var[] -- |string |`/` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-protocol]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-protocol[`quarkus.knative.containers."containers".ports."ports".protocol`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-protocol]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-protocol[`quarkus.openshift.sidecars."sidecars".ports."ports".protocol`]## [.description] -- @@ -41279,16 +41535,16 @@ The protocol. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__PROTOCOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__PROTOCOL+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__PROTOCOL+++` endif::add-copy-button-to-env-var[] -- a|`tcp`, `udp`, `sctp`, `http`, `proxy` |`tcp` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-node-port[`quarkus.knative.containers."containers".ports."ports".node-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-node-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-node-port[`quarkus.openshift.sidecars."sidecars".ports."ports".node-port`]## [.description] -- @@ -41296,16 +41552,16 @@ The nodePort to which this port should be mapped to. This only takes affect when ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__NODE_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__NODE_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__NODE_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__NODE_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-tls]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-ports-ports-tls[`quarkus.knative.containers."containers".ports."ports".tls`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-tls]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-ports-ports-tls[`quarkus.openshift.sidecars."sidecars".ports."ports".tls`]## [.description] -- @@ -41313,16 +41569,16 @@ If enabled, the port will be configured to use the schema HTTPS. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__TLS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__TLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__TLS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__TLS+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-image-pull-policy[`quarkus.knative.containers."containers".image-pull-policy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-image-pull-policy[`quarkus.openshift.sidecars."sidecars".image-pull-policy`]## [.description] -- @@ -41330,16 +41586,16 @@ Image pull policy. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE_PULL_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE_PULL_POLICY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE_PULL_POLICY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE_PULL_POLICY+++` endif::add-copy-button-to-env-var[] -- a|`always`, `if-not-present`, `never` |`always` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-image-pull-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-image-pull-secrets[`quarkus.knative.containers."containers".image-pull-secrets`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-image-pull-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-image-pull-secrets[`quarkus.openshift.sidecars."sidecars".image-pull-secrets`]## [.description] -- @@ -41347,16 +41603,16 @@ The image pull secret ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE_PULL_SECRETS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE_PULL_SECRETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE_PULL_SECRETS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE_PULL_SECRETS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-port[`quarkus.knative.containers."containers".liveness-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-port[`quarkus.openshift.sidecars."sidecars".liveness-probe.http-action-port`]## [.description] -- @@ -41364,16 +41620,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-port-name[`quarkus.knative.containers."containers".liveness-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-port-name[`quarkus.openshift.sidecars."sidecars".liveness-probe.http-action-port-name`]## [.description] -- @@ -41381,16 +41637,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-path[`quarkus.knative.containers."containers".liveness-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-path[`quarkus.openshift.sidecars."sidecars".liveness-probe.http-action-path`]## [.description] -- @@ -41398,16 +41654,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-http-action-scheme[`quarkus.knative.containers."containers".liveness-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-http-action-scheme[`quarkus.openshift.sidecars."sidecars".liveness-probe.http-action-scheme`]## [.description] -- @@ -41415,16 +41671,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-exec-action[`quarkus.knative.containers."containers".liveness-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-exec-action[`quarkus.openshift.sidecars."sidecars".liveness-probe.exec-action`]## [.description] -- @@ -41432,16 +41688,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-tcp-socket-action[`quarkus.knative.containers."containers".liveness-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-tcp-socket-action[`quarkus.openshift.sidecars."sidecars".liveness-probe.tcp-socket-action`]## [.description] -- @@ -41449,16 +41705,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-grpc-action[`quarkus.knative.containers."containers".liveness-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-grpc-action[`quarkus.openshift.sidecars."sidecars".liveness-probe.grpc-action`]## [.description] -- @@ -41466,16 +41722,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-grpc-action-enabled[`quarkus.knative.containers."containers".liveness-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-grpc-action-enabled[`quarkus.openshift.sidecars."sidecars".liveness-probe.grpc-action-enabled`]## [.description] -- @@ -41483,16 +41739,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-initial-delay[`quarkus.knative.containers."containers".liveness-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-initial-delay[`quarkus.openshift.sidecars."sidecars".liveness-probe.initial-delay`]## [.description] -- @@ -41500,16 +41756,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-period[`quarkus.knative.containers."containers".liveness-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-period[`quarkus.openshift.sidecars."sidecars".liveness-probe.period`]## [.description] -- @@ -41517,16 +41773,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-timeout[`quarkus.knative.containers."containers".liveness-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-timeout[`quarkus.openshift.sidecars."sidecars".liveness-probe.timeout`]## [.description] -- @@ -41534,16 +41790,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-success-threshold[`quarkus.knative.containers."containers".liveness-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-success-threshold[`quarkus.openshift.sidecars."sidecars".liveness-probe.success-threshold`]## [.description] -- @@ -41551,16 +41807,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-failure-threshold[`quarkus.knative.containers."containers".liveness-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-failure-threshold[`quarkus.openshift.sidecars."sidecars".liveness-probe.failure-threshold`]## [.description] -- @@ -41568,16 +41824,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-port[`quarkus.knative.containers."containers".readiness-probe.http-action-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-port[`quarkus.openshift.sidecars."sidecars".readiness-probe.http-action-port`]## [.description] -- @@ -41585,16 +41841,16 @@ The port number to use when configuring the `http get` action. If not configured ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-port-name[`quarkus.knative.containers."containers".readiness-probe.http-action-port-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-port-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-port-name[`quarkus.openshift.sidecars."sidecars".readiness-probe.http-action-port-name`]## [.description] -- @@ -41602,16 +41858,16 @@ The port name for selecting the port of the `HTTP get` action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-path[`quarkus.knative.containers."containers".readiness-probe.http-action-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-path[`quarkus.openshift.sidecars."sidecars".readiness-probe.http-action-path`]## [.description] -- @@ -41619,16 +41875,16 @@ The http path to use for the probe. For this to work, the container port also ne ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-http-action-scheme[`quarkus.knative.containers."containers".readiness-probe.http-action-scheme`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-scheme]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-http-action-scheme[`quarkus.openshift.sidecars."sidecars".readiness-probe.http-action-scheme`]## [.description] -- @@ -41636,16 +41892,16 @@ The scheme of the `HTTP get` action. Can be either "HTTP" or "HTTPS". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_SCHEME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_SCHEME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-exec-action[`quarkus.knative.containers."containers".readiness-probe.exec-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-exec-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-exec-action[`quarkus.openshift.sidecars."sidecars".readiness-probe.exec-action`]## [.description] -- @@ -41653,16 +41909,16 @@ The command to use for the probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_EXEC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_EXEC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_EXEC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_EXEC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-tcp-socket-action[`quarkus.knative.containers."containers".readiness-probe.tcp-socket-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-tcp-socket-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-tcp-socket-action[`quarkus.openshift.sidecars."sidecars".readiness-probe.tcp-socket-action`]## [.description] -- @@ -41670,16 +41926,16 @@ The tcp socket to use for the probe (the format is host:port). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_TCP_SOCKET_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_TCP_SOCKET_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-grpc-action[`quarkus.knative.containers."containers".readiness-probe.grpc-action`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-grpc-action]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-grpc-action[`quarkus.openshift.sidecars."sidecars".readiness-probe.grpc-action`]## [.description] -- @@ -41687,16 +41943,16 @@ The gRPC port to use for the probe (the format is either port or port:service). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_GRPC_ACTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_GRPC_ACTION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-grpc-action-enabled[`quarkus.knative.containers."containers".readiness-probe.grpc-action-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-grpc-action-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-grpc-action-enabled[`quarkus.openshift.sidecars."sidecars".readiness-probe.grpc-action-enabled`]## [.description] -- @@ -41704,16 +41960,16 @@ If enabled and `grpc-action` is not provided, it will use the generated service ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-initial-delay[`quarkus.knative.containers."containers".readiness-probe.initial-delay`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-initial-delay]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-initial-delay[`quarkus.openshift.sidecars."sidecars".readiness-probe.initial-delay`]## [.description] -- @@ -41721,16 +41977,16 @@ The amount of time to wait before starting to probe. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_INITIAL_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-period[`quarkus.knative.containers."containers".readiness-probe.period`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-period[`quarkus.openshift.sidecars."sidecars".readiness-probe.period`]## [.description] -- @@ -41738,16 +41994,16 @@ The period in which the action should be called. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_PERIOD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-timeout[`quarkus.knative.containers."containers".readiness-probe.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-timeout[`quarkus.openshift.sidecars."sidecars".readiness-probe.timeout`]## [.description] -- @@ -41755,16 +42011,16 @@ The amount of time to wait for each action. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_TIMEOUT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-success-threshold[`quarkus.knative.containers."containers".readiness-probe.success-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-success-threshold[`quarkus.openshift.sidecars."sidecars".readiness-probe.success-threshold`]## [.description] -- @@ -41772,16 +42028,16 @@ The success threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_SUCCESS_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_SUCCESS_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`1` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-failure-threshold[`quarkus.knative.containers."containers".readiness-probe.failure-threshold`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-failure-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-failure-threshold[`quarkus.openshift.sidecars."sidecars".readiness-probe.failure-threshold`]## [.description] -- @@ -41789,16 +42045,16 @@ The failure threshold to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_FAILURE_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_FAILURE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- |int |`3` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-name[`quarkus.knative.containers."containers".mounts."mounts".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-name[`quarkus.openshift.sidecars."sidecars".mounts."mounts".name`]## [.description] -- @@ -41806,16 +42062,16 @@ The name of the volumeName to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-path[`quarkus.knative.containers."containers".mounts."mounts".path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-path[`quarkus.openshift.sidecars."sidecars".mounts."mounts".path`]## [.description] -- @@ -41823,16 +42079,16 @@ The path to mount. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-sub-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-sub-path[`quarkus.knative.containers."containers".mounts."mounts".sub-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-sub-path]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-sub-path[`quarkus.openshift.sidecars."sidecars".mounts."mounts".sub-path`]## [.description] -- @@ -41840,16 +42096,16 @@ Path within the volumeName from which the container's volumeName should be mount ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__SUB_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__SUB_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__SUB_PATH+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__SUB_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-mounts-mounts-read-only[`quarkus.knative.containers."containers".mounts."mounts".read-only`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-read-only]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-mounts-mounts-read-only[`quarkus.openshift.sidecars."sidecars".mounts."mounts".read-only`]## [.description] -- @@ -41857,16 +42113,16 @@ ReadOnly ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__READ_ONLY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__READ_ONLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__READ_ONLY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__READ_ONLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-resources-limits-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-resources-limits-cpu[`quarkus.knative.containers."containers".resources.limits.cpu`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-limits-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-limits-cpu[`quarkus.openshift.sidecars."sidecars".resources.limits.cpu`]## [.description] -- @@ -41874,16 +42130,16 @@ CPU Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_LIMITS_CPU+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_LIMITS_CPU+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_LIMITS_CPU+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_LIMITS_CPU+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-resources-limits-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-resources-limits-memory[`quarkus.knative.containers."containers".resources.limits.memory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-limits-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-limits-memory[`quarkus.openshift.sidecars."sidecars".resources.limits.memory`]## [.description] -- @@ -41891,16 +42147,16 @@ Memory Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_LIMITS_MEMORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_LIMITS_MEMORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_LIMITS_MEMORY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_LIMITS_MEMORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-resources-requests-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-resources-requests-cpu[`quarkus.knative.containers."containers".resources.requests.cpu`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-requests-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-requests-cpu[`quarkus.openshift.sidecars."sidecars".resources.requests.cpu`]## [.description] -- @@ -41908,16 +42164,16 @@ CPU Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_REQUESTS_CPU+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_REQUESTS_CPU+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_REQUESTS_CPU+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_REQUESTS_CPU+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-resources-requests-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-resources-requests-memory[`quarkus.knative.containers."containers".resources.requests.memory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-requests-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-resources-requests-memory[`quarkus.openshift.sidecars."sidecars".resources.requests.memory`]## [.description] -- @@ -41925,16 +42181,16 @@ Memory Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_REQUESTS_MEMORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_REQUESTS_MEMORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_REQUESTS_MEMORY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_REQUESTS_MEMORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-secrets[`quarkus.knative.containers."containers".env.secrets`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-secrets[`quarkus.openshift.sidecars."sidecars".env.secrets`]## [.description] -- @@ -41942,16 +42198,16 @@ The optional list of Secret names to load environment variables from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_SECRETS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_SECRETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_SECRETS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_SECRETS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-configmaps]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-configmaps[`quarkus.knative.containers."containers".env.configmaps`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-configmaps]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-configmaps[`quarkus.openshift.sidecars."sidecars".env.configmaps`]## [.description] -- @@ -41959,16 +42215,16 @@ The optional list of ConfigMap names to load environment variables from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_CONFIGMAPS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_CONFIGMAPS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_CONFIGMAPS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_CONFIGMAPS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-fields-environment-variable-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-fields-environment-variable-name[`quarkus.knative.containers."containers".env.fields."environment-variable-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-fields-environment-variable-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-fields-environment-variable-name[`quarkus.openshift.sidecars."sidecars".env.fields."environment-variable-name"`]## [.description] -- @@ -41976,16 +42232,16 @@ The map associating environment variable names to their associated field referen ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++` endif::add-copy-button-to-env-var[] -- |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-vars-vars]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-vars-vars[`quarkus.knative.containers."containers".env.vars."vars"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-vars-vars]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-vars-vars[`quarkus.openshift.sidecars."sidecars".env.vars."vars"`]## [.description] -- @@ -41993,16 +42249,16 @@ The map associating environment name to its associated value. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_VARS__VARS_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_VARS__VARS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_VARS__VARS_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_VARS__VARS_+++` endif::add-copy-button-to-env-var[] -- |Map> | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-mapping-mapping-from-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-mapping-mapping-from-secret[`quarkus.knative.containers."containers".env.mapping."mapping".from-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-mapping-mapping-from-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-mapping-mapping-from-secret[`quarkus.openshift.sidecars."sidecars".env.mapping."mapping".from-secret`]## [.description] -- @@ -42010,16 +42266,16 @@ The optional name of the Secret from which a value is to be extracted. Mutually ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_SECRET+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-mapping-mapping-from-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-mapping-mapping-from-configmap[`quarkus.knative.containers."containers".env.mapping."mapping".from-configmap`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-mapping-mapping-from-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-mapping-mapping-from-configmap[`quarkus.openshift.sidecars."sidecars".env.mapping."mapping".from-configmap`]## [.description] -- @@ -42027,16 +42283,16 @@ The optional name of the ConfigMap from which a value is to be extracted. Mutual ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-mapping-mapping-with-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-mapping-mapping-with-key[`quarkus.knative.containers."containers".env.mapping."mapping".with-key`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-mapping-mapping-with-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-mapping-mapping-with-key[`quarkus.openshift.sidecars."sidecars".env.mapping."mapping".with-key`]## [.description] -- @@ -42044,16 +42300,16 @@ The key identifying the field from which the value is extracted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__WITH_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__WITH_KEY+++` endif::add-copy-button-to-env-var[] -- |string |required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-using-prefix-prefixes-for-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-using-prefix-prefixes-for-secret[`quarkus.knative.containers."containers".env.using-prefix."prefixes".for-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-using-prefix-prefixes-for-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-using-prefix-prefixes-for-secret[`quarkus.openshift.sidecars."sidecars".env.using-prefix."prefixes".for-secret`]## [.description] -- @@ -42061,16 +42317,16 @@ The optional prefix to use when adding the environment variable to the container ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-env-using-prefix-prefixes-for-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-env-using-prefix-prefixes-for-configmap[`quarkus.knative.containers."containers".env.using-prefix."prefixes".for-configmap`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-using-prefix-prefixes-for-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-env-using-prefix-prefixes-for-configmap[`quarkus.openshift.sidecars."sidecars".env.using-prefix."prefixes".for-configmap`]## [.description] -- @@ -42078,16 +42334,16 @@ The optional prefix to use when adding the environment variable to the container ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-host-aliases-host-aliases-ip]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-host-aliases-host-aliases-ip[`quarkus.knative.host-aliases."host-aliases".ip`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-host-aliases-host-aliases-ip]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-host-aliases-host-aliases-ip[`quarkus.openshift.host-aliases."host-aliases".ip`]## [.description] -- @@ -42095,16 +42351,16 @@ The ip address ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_HOST_ALIASES__HOST_ALIASES__IP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_HOST_ALIASES__HOST_ALIASES__IP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_HOST_ALIASES__HOST_ALIASES__IP+++` +Environment variable: `+++QUARKUS_OPENSHIFT_HOST_ALIASES__HOST_ALIASES__IP+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-host-aliases-host-aliases-hostnames]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-host-aliases-host-aliases-hostnames[`quarkus.knative.host-aliases."host-aliases".hostnames`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-host-aliases-host-aliases-hostnames]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-host-aliases-host-aliases-hostnames[`quarkus.openshift.host-aliases."host-aliases".hostnames`]## [.description] -- @@ -42112,16 +42368,16 @@ The hostnames to resolve to the ip ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_HOST_ALIASES__HOST_ALIASES__HOSTNAMES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_HOST_ALIASES__HOST_ALIASES__HOSTNAMES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_HOST_ALIASES__HOST_ALIASES__HOSTNAMES+++` +Environment variable: `+++QUARKUS_OPENSHIFT_HOST_ALIASES__HOST_ALIASES__HOSTNAMES+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-resources-limits-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-resources-limits-cpu[`quarkus.knative.resources.limits.cpu`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-resources-limits-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-resources-limits-cpu[`quarkus.openshift.resources.limits.cpu`]## [.description] -- @@ -42129,16 +42385,16 @@ CPU Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RESOURCES_LIMITS_CPU+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RESOURCES_LIMITS_CPU+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RESOURCES_LIMITS_CPU+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RESOURCES_LIMITS_CPU+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-resources-limits-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-resources-limits-memory[`quarkus.knative.resources.limits.memory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-resources-limits-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-resources-limits-memory[`quarkus.openshift.resources.limits.memory`]## [.description] -- @@ -42146,16 +42402,16 @@ Memory Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RESOURCES_LIMITS_MEMORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RESOURCES_LIMITS_MEMORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RESOURCES_LIMITS_MEMORY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RESOURCES_LIMITS_MEMORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-resources-requests-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-resources-requests-cpu[`quarkus.knative.resources.requests.cpu`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-resources-requests-cpu]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-resources-requests-cpu[`quarkus.openshift.resources.requests.cpu`]## [.description] -- @@ -42163,16 +42419,16 @@ CPU Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RESOURCES_REQUESTS_CPU+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RESOURCES_REQUESTS_CPU+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RESOURCES_REQUESTS_CPU+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RESOURCES_REQUESTS_CPU+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-resources-requests-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-resources-requests-memory[`quarkus.knative.resources.requests.memory`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-resources-requests-memory]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-resources-requests-memory[`quarkus.openshift.resources.requests.memory`]## [.description] -- @@ -42180,1885 +42436,2276 @@ Memory Requirements ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RESOURCES_REQUESTS_MEMORY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RESOURCES_REQUESTS_MEMORY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RESOURCES_REQUESTS_MEMORY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RESOURCES_REQUESTS_MEMORY+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-name[`quarkus.knative.rbac.roles."roles".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-container-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-container-name[`quarkus.openshift.container-name`]## [.description] -- -The name of the role. +If set, it will change the name of the container according to the configuration ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CONTAINER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CONTAINER_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-namespace[`quarkus.knative.rbac.roles."roles".namespace`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-expose]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-expose[`quarkus.openshift.route.expose`]## [.description] -- -The namespace of the role. +If true, the service will be exposed ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__NAMESPACE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_EXPOSE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__NAMESPACE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_EXPOSE+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-labels-label-name[`quarkus.knative.rbac.roles."roles".labels."label-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-host]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-host[`quarkus.openshift.route.host`]## [.description] -- -Labels to add into the Role resource. +The host under which the application is going to be exposed ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_HOST+++` endif::add-copy-button-to-env-var[] -- -|Map +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-api-groups]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-api-groups[`quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".api-groups`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-target-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-target-port[`quarkus.openshift.route.target-port`]## [.description] -- -API groups of the policy rule. +The target named port. If not provided, it will be deducted from the Service resource ports. Options are: "http" and "https". ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TARGET_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TARGET_PORT+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|string +|`http` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-non-resource-urls]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-non-resource-urls[`quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".non-resource-urls`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-annotations-annotation-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-annotations-annotation-name[`quarkus.openshift.route.annotations."annotation-name"`]## [.description] -- -Non resource URLs of the policy rule. +Custom annotations to add to exposition (route or ingress) resources ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_ANNOTATIONS__ANNOTATION_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_ANNOTATIONS__ANNOTATION_NAME_+++` endif::add-copy-button-to-env-var[] -- -|list of string +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-resource-names]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-resource-names[`quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".resource-names`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-labels-label-name[`quarkus.openshift.route.labels."label-name"`]## [.description] -- -Resource names of the policy rule. +Custom labels to add to exposition (route or ingress) resources ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|list of string +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-resources]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-resources[`quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".resources`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-tls-ca-certificate]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-tls-ca-certificate[`quarkus.openshift.route.tls.ca-certificate`]## [.description] -- -Resources of the policy rule. +The cert authority certificate contents. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_CA_CERTIFICATE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TLS_CA_CERTIFICATE+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-verbs]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-roles-roles-policy-rules-policy-rules-verbs[`quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".verbs`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-tls-certificate]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-tls-certificate[`quarkus.openshift.route.tls.certificate`]## [.description] -- -Verbs of the policy rule. +The certificate contents. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__VERBS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_CERTIFICATE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__VERBS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TLS_CERTIFICATE+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-name[`quarkus.knative.rbac.cluster-roles."cluster-roles".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-tls-destination-ca-certificate]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-tls-destination-ca-certificate[`quarkus.openshift.route.tls.destination-ca-certificate`]## [.description] -- -The name of the cluster role. +The contents of the ca certificate of the final destination. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_DESTINATION_CA_CERTIFICATE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TLS_DESTINATION_CA_CERTIFICATE+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-labels-label-name[`quarkus.knative.rbac.cluster-roles."cluster-roles".labels."label-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-tls-insecure-edge-termination-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-tls-insecure-edge-termination-policy[`quarkus.openshift.route.tls.insecure-edge-termination-policy`]## [.description] -- -Labels to add into the ClusterRole resource. +The desired behavior for insecure connections to a route. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_INSECURE_EDGE_TERMINATION_POLICY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TLS_INSECURE_EDGE_TERMINATION_POLICY+++` endif::add-copy-button-to-env-var[] -- -|Map +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-api-groups]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-api-groups[`quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".api-groups`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-tls-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-tls-key[`quarkus.openshift.route.tls.key`]## [.description] -- -API groups of the policy rule. +The key file contents. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TLS_KEY+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-non-resource-urls]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-non-resource-urls[`quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".non-resource-urls`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-route-tls-termination]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-route-tls-termination[`quarkus.openshift.route.tls.termination`]## [.description] -- -Non resource URLs of the policy rule. +The termination type. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_TERMINATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ROUTE_TLS_TERMINATION+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resource-names]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resource-names[`quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resource-names`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-add-version-to-label-selectors]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-add-version-to-label-selectors[`quarkus.openshift.add-version-to-label-selectors`]## [.description] -- -Resource names of the policy rule. +If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and DeploymentConfig ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ADD_VERSION_TO_LABEL_SELECTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ADD_VERSION_TO_LABEL_SELECTORS+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resources]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resources[`quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resources`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-add-name-to-label-selectors]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-add-name-to-label-selectors[`quarkus.openshift.add-name-to-label-selectors`]## [.description] -- -Resources of the policy rule. +If true, the 'app.kubernetes.io/name' label will be part of the selectors of Service and Deployment ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ADD_NAME_TO_LABEL_SELECTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ADD_NAME_TO_LABEL_SELECTORS+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-verbs]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-verbs[`quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".verbs`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-parallelism]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-parallelism[`quarkus.openshift.job.parallelism`]## [.description] -- -Verbs of the policy rule. +Specifies the maximum desired number of pods the job should run at any given time. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__VERBS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_PARALLELISM+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__VERBS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_JOB_PARALLELISM+++` endif::add-copy-button-to-env-var[] -- -|list of string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-name[`quarkus.knative.rbac.service-accounts."service-accounts".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-completions]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-completions[`quarkus.openshift.job.completions`]## [.description] -- -The name of the service account. +Specifies the desired number of successfully finished pods the job should be run with. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_COMPLETIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_JOB_COMPLETIONS+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-namespace[`quarkus.knative.rbac.service-accounts."service-accounts".namespace`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-completion-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-completion-mode[`quarkus.openshift.job.completion-mode`]## [.description] -- -The namespace of the service account. +CompletionMode specifies how Pod completions are tracked. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAMESPACE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_COMPLETION_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAMESPACE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_JOB_COMPLETION_MODE+++` endif::add-copy-button-to-env-var[] -- -|string -| +a|`non-indexed`, `indexed` +|`non-indexed` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-labels-label-name[`quarkus.knative.rbac.service-accounts."service-accounts".labels."label-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-backoff-limit]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-backoff-limit[`quarkus.openshift.job.backoff-limit`]## [.description] -- -Labels of the service account. +Specifies the number of retries before marking this job failed. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_BACKOFF_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_JOB_BACKOFF_LIMIT+++` endif::add-copy-button-to-env-var[] -- -|Map +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-use-as-default]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-service-accounts-service-accounts-use-as-default[`quarkus.knative.rbac.service-accounts."service-accounts".use-as-default`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-active-deadline-seconds]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-active-deadline-seconds[`quarkus.openshift.job.active-deadline-seconds`]## [.description] -- -If true, this service account will be used in the generated Deployment resource. +Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__USE_AS_DEFAULT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_ACTIVE_DEADLINE_SECONDS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__USE_AS_DEFAULT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_JOB_ACTIVE_DEADLINE_SECONDS+++` endif::add-copy-button-to-env-var[] -- -|boolean +|long | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-name[`quarkus.knative.rbac.role-bindings."role-bindings".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-ttl-seconds-after-finished]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-ttl-seconds-after-finished[`quarkus.openshift.job.ttl-seconds-after-finished`]## [.description] -- -Name of the RoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name. +Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_TTL_SECONDS_AFTER_FINISHED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_JOB_TTL_SECONDS_AFTER_FINISHED+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-labels-label-name[`quarkus.knative.rbac.role-bindings."role-bindings".labels."label-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-suspend]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-suspend[`quarkus.openshift.job.suspend`]## [.description] -- -Labels to add into the RoleBinding resource. +Suspend specifies whether the Job controller should create Pods or not. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_SUSPEND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_JOB_SUSPEND+++` endif::add-copy-button-to-env-var[] -- -|Map -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-role-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-role-name[`quarkus.knative.rbac.role-bindings."role-bindings".role-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-job-restart-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-job-restart-policy[`quarkus.openshift.job.restart-policy`]## [.description] -- -The name of the Role resource to use by the RoleRef element in the generated Role Binding resource. By default, it's "view" role name. +Restart policy when the job container fails. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__ROLE_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JOB_RESTART_POLICY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__ROLE_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_JOB_RESTART_POLICY+++` endif::add-copy-button-to-env-var[] -- -|string -| +a|`on-failure`, `never` +|`on-failure` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-cluster-wide]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-cluster-wide[`quarkus.knative.rbac.role-bindings."role-bindings".cluster-wide`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-schedule]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-schedule[`quarkus.openshift.cron-job.schedule`]## [.description] -- -If the Role sets in the `role-name` property is cluster wide or not. +The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__CLUSTER_WIDE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_SCHEDULE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__CLUSTER_WIDE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_SCHEDULE+++` endif::add-copy-button-to-env-var[] -- -|boolean +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-name[`quarkus.knative.rbac.role-bindings."role-bindings".subjects."subjects".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-concurrency-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-concurrency-policy[`quarkus.openshift.cron-job.concurrency-policy`]## [.description] -- -The "name" resource to use by the Subject element in the generated Role Binding resource. +ConcurrencyPolicy describes how the job will be handled. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_CONCURRENCY_POLICY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_CONCURRENCY_POLICY+++` endif::add-copy-button-to-env-var[] -- -|string -| +a|`allow`, `forbid`, `replace` +|`allow` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-kind[`quarkus.knative.rbac.role-bindings."role-bindings".subjects."subjects".kind`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-starting-deadline-seconds]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-starting-deadline-seconds[`quarkus.openshift.cron-job.starting-deadline-seconds`]## [.description] -- -The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind. +Deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_STARTING_DEADLINE_SECONDS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_STARTING_DEADLINE_SECONDS+++` endif::add-copy-button-to-env-var[] -- -|string -|`ServiceAccount` +|long +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-api-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-api-group[`quarkus.knative.rbac.role-bindings."role-bindings".subjects."subjects".api-group`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-failed-jobs-history-limit]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-failed-jobs-history-limit[`quarkus.openshift.cron-job.failed-jobs-history-limit`]## [.description] -- -The "apiGroup" resource that matches with the "kind" property. By default, it's empty. +The number of failed finished jobs to retain. The default value is 1. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_FAILED_JOBS_HISTORY_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_FAILED_JOBS_HISTORY_LIMIT+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-role-bindings-role-bindings-subjects-subjects-namespace[`quarkus.knative.rbac.role-bindings."role-bindings".subjects."subjects".namespace`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-successful-jobs-history-limit]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-successful-jobs-history-limit[`quarkus.openshift.cron-job.successful-jobs-history-limit`]## [.description] -- -The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources. +The number of successful finished jobs to retain. The default value is 3. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_SUCCESSFUL_JOBS_HISTORY_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_SUCCESSFUL_JOBS_HISTORY_LIMIT+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-name[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-parallelism]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-parallelism[`quarkus.openshift.cron-job.parallelism`]## [.description] -- -Name of the ClusterRoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name. +Specifies the maximum desired number of pods the job should run at any given time. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_PARALLELISM+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_PARALLELISM+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-labels-label-name[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".labels."label-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-completions]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-completions[`quarkus.openshift.cron-job.completions`]## [.description] -- -Labels to add into the RoleBinding resource. +Specifies the desired number of successfully finished pods the job should be run with. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__LABELS__LABEL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_COMPLETIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__LABELS__LABEL_NAME_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_COMPLETIONS+++` endif::add-copy-button-to-env-var[] -- -|Map +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-role-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-role-name[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".role-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-completion-mode]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-completion-mode[`quarkus.openshift.cron-job.completion-mode`]## [.description] -- -The name of the ClusterRole resource to use by the RoleRef element in the generated ClusterRoleBinding resource. +CompletionMode specifies how Pod completions are tracked. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__ROLE_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_COMPLETION_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__ROLE_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_COMPLETION_MODE+++` endif::add-copy-button-to-env-var[] -- -|string -|required icon:exclamation-circle[title=Configuration property is required] +a|`non-indexed`, `indexed` +|`non-indexed` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-name[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-backoff-limit]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-backoff-limit[`quarkus.openshift.cron-job.backoff-limit`]## [.description] -- -The "name" resource to use by the Subject element in the generated Role Binding resource. +Specifies the number of retries before marking this job failed. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_BACKOFF_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_BACKOFF_LIMIT+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-kind[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".kind`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-active-deadline-seconds]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-active-deadline-seconds[`quarkus.openshift.cron-job.active-deadline-seconds`]## [.description] -- -The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind. +Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_ACTIVE_DEADLINE_SECONDS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_ACTIVE_DEADLINE_SECONDS+++` endif::add-copy-button-to-env-var[] -- -|string -|`ServiceAccount` +|long +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-api-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-api-group[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".api-group`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-ttl-seconds-after-finished]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-ttl-seconds-after-finished[`quarkus.openshift.cron-job.ttl-seconds-after-finished`]## [.description] -- -The "apiGroup" resource that matches with the "kind" property. By default, it's empty. +Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_TTL_SECONDS_AFTER_FINISHED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_TTL_SECONDS_AFTER_FINISHED+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-namespace[`quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".namespace`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-suspend]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-suspend[`quarkus.openshift.cron-job.suspend`]## [.description] -- -The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources. +Suspend specifies whether the Job controller should create Pods or not. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_SUSPEND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_SUSPEND+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-add-version-to-label-selectors]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-add-version-to-label-selectors[`quarkus.knative.add-version-to-label-selectors`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-cron-job-restart-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-cron-job-restart-policy[`quarkus.openshift.cron-job.restart-policy`]## [.description] -- -If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and Deployment +Restart policy when the job container fails. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ADD_VERSION_TO_LABEL_SELECTORS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_CRON_JOB_RESTART_POLICY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ADD_VERSION_TO_LABEL_SELECTORS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_CRON_JOB_RESTART_POLICY+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +a|`on-failure`, `never` +|`on-failure` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-add-name-to-label-selectors]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-add-name-to-label-selectors[`quarkus.knative.add-name-to-label-selectors`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-name[`quarkus.openshift.rbac.roles."roles".name`]## [.description] -- -If true, the 'app.kubernetes.io/name' label will be part of the selectors of Service and Deployment +The name of the role. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ADD_NAME_TO_LABEL_SELECTORS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ADD_NAME_TO_LABEL_SELECTORS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__NAME+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-idempotent]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-idempotent[`quarkus.knative.idempotent`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-namespace[`quarkus.openshift.rbac.roles."roles".namespace`]## [.description] -- -Switch used to control whether non-idempotent fields are included in generated kubernetes resources to improve git-ops compatibility +The namespace of the role. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_IDEMPOTENT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__NAMESPACE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_IDEMPOTENT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__NAMESPACE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-vcs-uri-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-vcs-uri-enabled[`quarkus.knative.vcs-uri.enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-labels-label-name[`quarkus.openshift.rbac.roles."roles".labels."label-name"`]## [.description] -- -Whether the vcs-uri annotation should be added to the generated configuration. +Labels to add into the Role resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_VCS_URI_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_VCS_URI_ENABLED+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|Map +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-vcs-uri-override]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-vcs-uri-override[`quarkus.knative.vcs-uri.override`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-api-groups]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-api-groups[`quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".api-groups`]## [.description] -- -Optional override of the vcs-uri annotation. +API groups of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_VCS_URI_OVERRIDE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_VCS_URI_OVERRIDE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-secrets[`quarkus.knative.env.secrets`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-non-resource-urls]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-non-resource-urls[`quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".non-resource-urls`]## [.description] -- -The optional list of Secret names to load environment variables from. +Non resource URLs of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_SECRETS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ENV_SECRETS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-configmaps]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-configmaps[`quarkus.knative.env.configmaps`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-resource-names]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-resource-names[`quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".resource-names`]## [.description] -- -The optional list of ConfigMap names to load environment variables from. +Resource names of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_CONFIGMAPS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ENV_CONFIGMAPS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++` endif::add-copy-button-to-env-var[] -- |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-fields-environment-variable-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-fields-environment-variable-name[`quarkus.knative.env.fields."environment-variable-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-resources]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-resources[`quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".resources`]## [.description] -- -The map associating environment variable names to their associated field references they take their value from. +Resources of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++` endif::add-copy-button-to-env-var[] -- -|Map +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-vars-vars]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-vars-vars[`quarkus.knative.env.vars."vars"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-verbs]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-roles-roles-policy-rules-policy-rules-verbs[`quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".verbs`]## [.description] -- -The map associating environment name to its associated value. +Verbs of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_VARS__VARS_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__VERBS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ENV_VARS__VARS_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__VERBS+++` endif::add-copy-button-to-env-var[] -- -|Map> +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-mapping-mapping-from-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-mapping-mapping-from-secret[`quarkus.knative.env.mapping."mapping".from-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-name[`quarkus.openshift.rbac.cluster-roles."cluster-roles".name`]## [.description] -- -The optional name of the Secret from which a value is to be extracted. Mutually exclusive with `from-configmap`. +The name of the cluster role. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__FROM_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__FROM_SECRET+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-mapping-mapping-from-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-mapping-mapping-from-configmap[`quarkus.knative.env.mapping."mapping".from-configmap`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-labels-label-name[`quarkus.openshift.rbac.cluster-roles."cluster-roles".labels."label-name"`]## [.description] -- -The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with `from-secret`. +Labels to add into the ClusterRole resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-mapping-mapping-with-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-mapping-mapping-with-key[`quarkus.knative.env.mapping."mapping".with-key`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-api-groups]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-api-groups[`quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".api-groups`]## [.description] -- -The key identifying the field from which the value is extracted. +API groups of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__WITH_KEY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__WITH_KEY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS+++` endif::add-copy-button-to-env-var[] -- -|string -|required icon:exclamation-circle[title=Configuration property is required] +|list of string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-using-prefix-prefixes-for-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-using-prefix-prefixes-for-secret[`quarkus.knative.env.using-prefix."prefixes".for-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-non-resource-urls]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-non-resource-urls[`quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".non-resource-urls`]## [.description] -- -The optional prefix to use when adding the environment variable to the container. +Non resource URLs of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-env-using-prefix-prefixes-for-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-env-using-prefix-prefixes-for-configmap[`quarkus.knative.env.using-prefix."prefixes".for-configmap`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resource-names]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resource-names[`quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resource-names`]## [.description] -- -The optional prefix to use when adding the environment variable to the container. +Resource names of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-cluster-local]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-cluster-local[`quarkus.knative.cluster-local`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resources]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-resources[`quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resources`]## [.description] -- -Whether this service is cluster-local. Cluster local services are not exposed to the outside world. More information in link:https://knative.dev/docs/serving/services/private-services/[this link]. +Resources of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_CLUSTER_LOCAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_CLUSTER_LOCAL+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCES+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|list of string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-min-scale]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-min-scale[`quarkus.knative.min-scale`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-verbs]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-roles-cluster-roles-policy-rules-policy-rules-verbs[`quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".verbs`]## [.description] -- -This value controls the minimum number of replicas each revision should have. Knative will attempt to never have less than this number of replicas at any point in time. +Verbs of the policy rule. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_MIN_SCALE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__VERBS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_MIN_SCALE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__VERBS+++` endif::add-copy-button-to-env-var[] -- -|int +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-max-scale]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-max-scale[`quarkus.knative.max-scale`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-name[`quarkus.openshift.rbac.service-accounts."service-accounts".name`]## [.description] -- -This value controls the maximum number of replicas each revision should have. Knative will attempt to never have more than this number of replicas running, or in the process of being created, at any point in time. +The name of the service account. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_MAX_SCALE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_MAX_SCALE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-scale-to-zero-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-scale-to-zero-enabled[`quarkus.knative.scale-to-zero-enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-namespace[`quarkus.openshift.rbac.service-accounts."service-accounts".namespace`]## [.description] -- -The scale-to-zero values control whether Knative allows revisions to scale down to zero, or stops at “1”. +The namespace of the service account. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SCALE_TO_ZERO_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAMESPACE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SCALE_TO_ZERO_ENABLED+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAMESPACE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-revision-auto-scaling-auto-scaler-class]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-revision-auto-scaling-auto-scaler-class[`quarkus.knative.revision-auto-scaling.auto-scaler-class`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-labels-label-name[`quarkus.openshift.rbac.service-accounts."service-accounts".labels."label-name"`]## [.description] -- -The Autoscaler class. Knative Serving comes with its own autoscaler, the KPA (Knative Pod Autoscaler) but can also be configured to use Kubernetes’ HPA (Horizontal Pod Autoscaler) or even a custom third-party autoscaler. Possible values (kpa, hpa, default: kpa). +Labels of the service account. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_AUTO_SCALER_CLASS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_AUTO_SCALER_CLASS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:kpa[Kubernetes Pod Autoscaler], tooltip:hpa[Horizontal Pod Autoscaler] +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-revision-auto-scaling-metric]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-revision-auto-scaling-metric[`quarkus.knative.revision-auto-scaling.metric`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-use-as-default]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-service-accounts-service-accounts-use-as-default[`quarkus.openshift.rbac.service-accounts."service-accounts".use-as-default`]## [.description] -- -The autoscaling metric to use. Possible values (concurrency, rps, cpu). +If true, this service account will be used in the generated Deployment resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_METRIC+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__USE_AS_DEFAULT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_METRIC+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__USE_AS_DEFAULT+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:concurrency[Concurrency], tooltip:rps[Requests per second], tooltip:cpu[CPU] +|boolean | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-revision-auto-scaling-target]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-revision-auto-scaling-target[`quarkus.knative.revision-auto-scaling.target`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-name[`quarkus.openshift.rbac.role-bindings."role-bindings".name`]## [.description] -- -The autoscaling target. +Name of the RoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_TARGET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_TARGET+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-revision-auto-scaling-container-concurrency]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-revision-auto-scaling-container-concurrency[`quarkus.knative.revision-auto-scaling.container-concurrency`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-labels-label-name[`quarkus.openshift.rbac.role-bindings."role-bindings".labels."label-name"`]## [.description] -- -The exact amount of requests allowed to the replica at a time. Its default value is “0”, which means an unlimited number of requests are allowed to flow into the replica. +Labels to add into the RoleBinding resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_CONTAINER_CONCURRENCY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_CONTAINER_CONCURRENCY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|int +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-revision-auto-scaling-target-utilization-percentage]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-revision-auto-scaling-target-utilization-percentage[`quarkus.knative.revision-auto-scaling.target-utilization-percentage`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-role-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-role-name[`quarkus.openshift.rbac.role-bindings."role-bindings".role-name`]## [.description] -- -This value specifies a percentage of the target to actually be targeted by the autoscaler. +The name of the Role resource to use by the RoleRef element in the generated Role Binding resource. By default, it's "view" role name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_TARGET_UTILIZATION_PERCENTAGE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__ROLE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_REVISION_AUTO_SCALING_TARGET_UTILIZATION_PERCENTAGE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__ROLE_NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-global-auto-scaling-auto-scaler-class]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-global-auto-scaling-auto-scaler-class[`quarkus.knative.global-auto-scaling.auto-scaler-class`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-cluster-wide]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-cluster-wide[`quarkus.openshift.rbac.role-bindings."role-bindings".cluster-wide`]## [.description] -- -The Autoscaler class. Knative Serving comes with its own autoscaler, the KPA (Knative Pod Autoscaler) but can also be configured to use Kubernetes’ HPA (Horizontal Pod Autoscaler) or even a custom third-party autoscaler. Possible values (kpa, hpa, default: kpa). +If the Role sets in the `role-name` property is cluster wide or not. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_AUTO_SCALER_CLASS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__CLUSTER_WIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_AUTO_SCALER_CLASS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__CLUSTER_WIDE+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:kpa[Kubernetes Pod Autoscaler], tooltip:hpa[Horizontal Pod Autoscaler] +|boolean | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-global-auto-scaling-container-concurrency]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-global-auto-scaling-container-concurrency[`quarkus.knative.global-auto-scaling.container-concurrency`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-name[`quarkus.openshift.rbac.role-bindings."role-bindings".subjects."subjects".name`]## [.description] -- -The exact amount of requests allowed to the replica at a time. Its default value is “0”, which means an unlimited number of requests are allowed to flow Integer>o the replica. +The "name" resource to use by the Subject element in the generated Role Binding resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_CONTAINER_CONCURRENCY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_CONTAINER_CONCURRENCY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-global-auto-scaling-target-utilization-percentage]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-global-auto-scaling-target-utilization-percentage[`quarkus.knative.global-auto-scaling.target-utilization-percentage`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-kind[`quarkus.openshift.rbac.role-bindings."role-bindings".subjects."subjects".kind`]## [.description] -- -This value specifies a percentage of the target to actually be targeted by the autoscaler. +The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_TARGET_UTILIZATION_PERCENTAGE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_TARGET_UTILIZATION_PERCENTAGE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++` endif::add-copy-button-to-env-var[] -- -|int -| +|string +|`ServiceAccount` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-global-auto-scaling-requests-per-second]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-global-auto-scaling-requests-per-second[`quarkus.knative.global-auto-scaling.requests-per-second`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-api-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-api-group[`quarkus.openshift.rbac.role-bindings."role-bindings".subjects."subjects".api-group`]## [.description] -- -The requests per second per replica. +The "apiGroup" resource that matches with the "kind" property. By default, it's empty. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_REQUESTS_PER_SECOND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_REQUESTS_PER_SECOND+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-revision-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-revision-name[`quarkus.knative.revision-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-role-bindings-role-bindings-subjects-subjects-namespace[`quarkus.openshift.rbac.role-bindings."role-bindings".subjects."subjects".namespace`]## [.description] -- -The name of the revision. +The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_REVISION_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_REVISION_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-traffic-traffic-tag]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-traffic-traffic-tag[`quarkus.knative.traffic."traffic".tag`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-name[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".name`]## [.description] -- -Tag is optionally used to expose a dedicated url for referencing this target exclusively. +Name of the ClusterRoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__TAG+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__TAG+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-traffic-traffic-revision-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-traffic-traffic-revision-name[`quarkus.knative.traffic."traffic".revision-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-labels-label-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-labels-label-name[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".labels."label-name"`]## [.description] -- -RevisionName of a specific revision to which to send this portion of traffic. +Labels to add into the RoleBinding resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__REVISION_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__LABELS__LABEL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__REVISION_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__LABELS__LABEL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-traffic-traffic-latest-revision]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-traffic-traffic-latest-revision[`quarkus.knative.traffic."traffic".latest-revision`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-role-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-role-name[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".role-name`]## [.description] -- -LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty. +The name of the ClusterRole resource to use by the RoleRef element in the generated ClusterRoleBinding resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__LATEST_REVISION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__ROLE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__LATEST_REVISION+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__ROLE_NAME+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +|required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-traffic-traffic-percent]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-traffic-traffic-percent[`quarkus.knative.traffic."traffic".percent`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-name[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".name`]## [.description] -- -Percent indicates that percentage based routing should be used and the value indicates the percent of traffic that is to be routed to this Revision or Configuration. `0` (zero) mean no traffic, `100` means all traffic. +The "name" resource to use by the Subject element in the generated Role Binding resource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__PERCENT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__PERCENT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME+++` endif::add-copy-button-to-env-var[] -- -|long -|`100` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-app-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-app-secret[`quarkus.knative.app-secret`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-kind]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-kind[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".kind`]## [.description] -- -If set, the secret will mounted to the application container and its contents will be used for application configuration. +The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_APP_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_APP_SECRET+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND+++` endif::add-copy-button-to-env-var[] -- |string -| +|`ServiceAccount` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-app-config-map]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-app-config-map[`quarkus.knative.app-config-map`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-api-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-api-group[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".api-group`]## [.description] -- -If set, the config map will be mounted to the application container and its contents will be used for application configuration. +The "apiGroup" resource that matches with the "kind" property. By default, it's empty. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_APP_CONFIG_MAP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_APP_CONFIG_MAP+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-level]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-level[`quarkus.knative.security-context.se-linux-options.level`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-namespace]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-rbac-cluster-role-bindings-cluster-role-bindings-subjects-subjects-namespace[`quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".namespace`]## [.description] -- -The SELinux level label that applies to the container. +The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_LEVEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_LEVEL+++` +Environment variable: `+++QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-role]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-role[`quarkus.knative.security-context.se-linux-options.role`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-secrets]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-secrets[`quarkus.openshift.env.secrets`]## [.description] -- -The SELinux role label that applies to the container. +The optional list of Secret names to load environment variables from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_ROLE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_SECRETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_ROLE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ENV_SECRETS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-type[`quarkus.knative.security-context.se-linux-options.type`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-configmaps]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-configmaps[`quarkus.openshift.env.configmaps`]## [.description] -- -The SELinux type label that applies to the container. +The optional list of ConfigMap names to load environment variables from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_CONFIGMAPS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_TYPE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ENV_CONFIGMAPS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-user]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-se-linux-options-user[`quarkus.knative.security-context.se-linux-options.user`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-fields-environment-variable-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-fields-environment-variable-name[`quarkus.openshift.env.fields."environment-variable-name"`]## [.description] -- -The SELinux user label that applies to the container. +The map associating environment variable names to their associated field references they take their value from. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_USER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_USER+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-windows-options-gmsa-credential-spec-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-windows-options-gmsa-credential-spec-name[`quarkus.knative.security-context.windows-options.gmsa-credential-spec-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-vars-vars]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-vars-vars[`quarkus.openshift.env.vars."vars"`]## [.description] -- -The name of the GMSA credential spec to use. +The map associating environment name to its associated value. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_VARS__VARS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ENV_VARS__VARS_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map> | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-windows-options-gmsa-credential-spec]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-windows-options-gmsa-credential-spec[`quarkus.knative.security-context.windows-options.gmsa-credential-spec`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-mapping-mapping-from-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-mapping-mapping-from-secret[`quarkus.openshift.env.mapping."mapping".from-secret`]## [.description] -- -GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. +The optional name of the Secret from which a value is to be extracted. Mutually exclusive with `from-configmap`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__FROM_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__FROM_SECRET+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-windows-options-run-as-user-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-windows-options-run-as-user-name[`quarkus.knative.security-context.windows-options.run-as-user-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-mapping-mapping-from-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-mapping-mapping-from-configmap[`quarkus.openshift.env.mapping."mapping".from-configmap`]## [.description] -- -The UserName in Windows to run the entrypoint of the container process. +The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with `from-secret`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_RUN_AS_USER_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_RUN_AS_USER_NAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__FROM_CONFIGMAP+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-windows-options-host-process]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-windows-options-host-process[`quarkus.knative.security-context.windows-options.host-process`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-mapping-mapping-with-key]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-mapping-mapping-with-key[`quarkus.openshift.env.mapping."mapping".with-key`]## [.description] -- -HostProcess determines if a container should be run as a 'Host Process' container. +The key identifying the field from which the value is extracted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_HOST_PROCESS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__WITH_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_HOST_PROCESS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__WITH_KEY+++` endif::add-copy-button-to-env-var[] -- -|boolean -| +|string +|required icon:exclamation-circle[title=Configuration property is required] -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-run-as-user]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-run-as-user[`quarkus.knative.security-context.run-as-user`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-using-prefix-prefixes-for-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-using-prefix-prefixes-for-secret[`quarkus.openshift.env.using-prefix."prefixes".for-secret`]## [.description] -- -The UID to run the entrypoint of the container process. +The optional prefix to use when adding the environment variable to the container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_USER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_USER+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ENV_USING_PREFIX__PREFIXES__FOR_SECRET+++` endif::add-copy-button-to-env-var[] -- -|long +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-run-as-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-run-as-group[`quarkus.knative.security-context.run-as-group`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-env-using-prefix-prefixes-for-configmap]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-env-using-prefix-prefixes-for-configmap[`quarkus.openshift.env.using-prefix."prefixes".for-configmap`]## [.description] -- -The GID to run the entrypoint of the container process. +The optional prefix to use when adding the environment variable to the container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_GROUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_GROUP+++` +Environment variable: `+++QUARKUS_OPENSHIFT_ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP+++` endif::add-copy-button-to-env-var[] -- -|long +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-run-as-non-root]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-run-as-non-root[`quarkus.knative.security-context.run-as-non-root`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-app-secret]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-app-secret[`quarkus.openshift.app-secret`]## [.description] -- -Indicates that the container must run as a non-root user. +If set, the secret will mounted to the application container and its contents will be used for application configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_NON_ROOT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_APP_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_NON_ROOT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_APP_SECRET+++` endif::add-copy-button-to-env-var[] -- -|boolean +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-supplemental-groups]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-supplemental-groups[`quarkus.knative.security-context.supplemental-groups`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-app-config-map]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-app-config-map[`quarkus.openshift.app-config-map`]## [.description] -- -A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. +If set, the config amp will be mounted to the application container and its contents will be used for application configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SUPPLEMENTAL_GROUPS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_APP_CONFIG_MAP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SUPPLEMENTAL_GROUPS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_APP_CONFIG_MAP+++` endif::add-copy-button-to-env-var[] -- -|list of long +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-fs-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-fs-group[`quarkus.knative.security-context.fs-group`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-level]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-level[`quarkus.openshift.security-context.se-linux-options.level`]## [.description] -- -A special supplemental group that applies to all containers in a pod. +The SELinux level label that applies to the container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_FS_GROUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_LEVEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_FS_GROUP+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_LEVEL+++` endif::add-copy-button-to-env-var[] -- -|long +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-sysctls-sysctl-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-sysctls-sysctl-name[`quarkus.knative.security-context.sysctls."sysctl-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-role]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-role[`quarkus.openshift.security-context.se-linux-options.role`]## [.description] -- -Sysctls hold a list of namespaced sysctls used for the pod. +The SELinux role label that applies to the container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SYSCTLS__SYSCTL_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_ROLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_SYSCTLS__SYSCTL_NAME_+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_ROLE+++` endif::add-copy-button-to-env-var[] -- -|Map +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-security-context-fs-group-change-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-security-context-fs-group-change-policy[`quarkus.knative.security-context.fs-group-change-policy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-type]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-type[`quarkus.openshift.security-context.se-linux-options.type`]## [.description] -- -It holds policies that will be used for applying fsGroup to a volume when volume is mounted. Values: OnRootMismatch, Always +The SELinux type label that applies to the container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_SECURITY_CONTEXT_FS_GROUP_CHANGE_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_SECURITY_CONTEXT_FS_GROUP_CHANGE_POLICY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_TYPE+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:on-root-mismatch[It indicates that volume's ownership and permissions will be changed only when permission and ownership of root directory does not match with expected permissions on the volume.], tooltip:always[It indicates that volume's ownership and permissions should always be changed whenever volume is mounted inside a Pod. This the default behavior.] +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-deploy]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-deploy[`quarkus.knative.deploy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-user]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-se-linux-options-user[`quarkus.openshift.security-context.se-linux-options.user`]## [.description] -- -If set to true, Quarkus will attempt to deploy the application to the target knative cluster +The SELinux user label that applies to the container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_DEPLOY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_USER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_DEPLOY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_USER+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-deploy-strategy]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-deploy-strategy[`quarkus.knative.deploy-strategy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-windows-options-gmsa-credential-spec-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-windows-options-gmsa-credential-spec-name[`quarkus.openshift.security-context.windows-options.gmsa-credential-spec-name`]## [.description] -- -If deploy is enabled, it will follow this strategy to update the resources to the target Knative cluster. +The name of the GMSA credential spec to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KNATIVE_DEPLOY_STRATEGY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KNATIVE_DEPLOY_STRATEGY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC_NAME+++` endif::add-copy-button-to-env-var[] -- -a|`create-or-update`, `create`, `replace`, `server-side-apply` -|`create-or-update` - - -h|[.extension-name]##Kubernetes Client Internal## -h|Type -h|Default +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-trust-certs]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-trust-certs[`quarkus.kubernetes-client.trust-certs`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-windows-options-gmsa-credential-spec]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-windows-options-gmsa-credential-spec[`quarkus.openshift.security-context.windows-options.gmsa-credential-spec`]## [.description] -- -Whether the client should trust a self-signed certificate if so presented by the API server +GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_TRUST_CERTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_TRUST_CERTS+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC+++` endif::add-copy-button-to-env-var[] -- -|boolean +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-api-server-url]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-api-server-url[`quarkus.kubernetes-client.api-server-url`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-windows-options-run-as-user-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-windows-options-run-as-user-name[`quarkus.openshift.security-context.windows-options.run-as-user-name`]## [.description] -- -URL of the Kubernetes API server +The UserName in Windows to run the entrypoint of the container process. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_API_SERVER_URL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_RUN_AS_USER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_API_SERVER_URL+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_RUN_AS_USER_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-namespace]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-namespace[`quarkus.kubernetes-client.namespace`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-windows-options-host-process]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-windows-options-host-process[`quarkus.openshift.security-context.windows-options.host-process`]## [.description] -- -Default namespace to use +HostProcess determines if a container should be run as a 'Host Process' container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_NAMESPACE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_HOST_PROCESS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_NAMESPACE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_HOST_PROCESS+++` endif::add-copy-button-to-env-var[] -- -|string +|boolean | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-ca-cert-file]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-ca-cert-file[`quarkus.kubernetes-client.ca-cert-file`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-run-as-user]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-run-as-user[`quarkus.openshift.security-context.run-as-user`]## [.description] -- -CA certificate file +The UID to run the entrypoint of the container process. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CA_CERT_FILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_USER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CA_CERT_FILE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_USER+++` endif::add-copy-button-to-env-var[] -- -|string +|long | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-ca-cert-data]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-ca-cert-data[`quarkus.kubernetes-client.ca-cert-data`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-run-as-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-run-as-group[`quarkus.openshift.security-context.run-as-group`]## [.description] -- -CA certificate data +The GID to run the entrypoint of the container process. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CA_CERT_DATA+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_GROUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CA_CERT_DATA+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_GROUP+++` endif::add-copy-button-to-env-var[] -- -|string +|long | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-client-cert-file]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-client-cert-file[`quarkus.kubernetes-client.client-cert-file`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-run-as-non-root]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-run-as-non-root[`quarkus.openshift.security-context.run-as-non-root`]## [.description] -- -Client certificate file +Indicates that the container must run as a non-root user. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CLIENT_CERT_FILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_NON_ROOT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CLIENT_CERT_FILE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_NON_ROOT+++` endif::add-copy-button-to-env-var[] -- -|string +|boolean | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-client-cert-data]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-client-cert-data[`quarkus.kubernetes-client.client-cert-data`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-supplemental-groups]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-supplemental-groups[`quarkus.openshift.security-context.supplemental-groups`]## [.description] -- -Client certificate data +A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CLIENT_CERT_DATA+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SUPPLEMENTAL_GROUPS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CLIENT_CERT_DATA+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SUPPLEMENTAL_GROUPS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of long | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-file]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-file[`quarkus.kubernetes-client.client-key-file`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-fs-group]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-fs-group[`quarkus.openshift.security-context.fs-group`]## [.description] -- -Client key file +A special supplemental group that applies to all containers in a pod. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_FILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_FS_GROUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_FILE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_FS_GROUP+++` endif::add-copy-button-to-env-var[] -- -|string +|long | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-data]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-data[`quarkus.kubernetes-client.client-key-data`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-sysctls-sysctl-name]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-sysctls-sysctl-name[`quarkus.openshift.security-context.sysctls."sysctl-name"`]## [.description] -- -Client key data +Sysctls hold a list of namespaced sysctls used for the pod. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_DATA+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SYSCTLS__SYSCTL_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_DATA+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SYSCTLS__SYSCTL_NAME_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-algo]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-algo[`quarkus.kubernetes-client.client-key-algo`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-security-context-fs-group-change-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-security-context-fs-group-change-policy[`quarkus.openshift.security-context.fs-group-change-policy`]## [.description] -- -Client key algorithm +It holds policies that will be used for applying fsGroup to a volume when volume is mounted. Values: OnRootMismatch, Always ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_ALGO+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_FS_GROUP_CHANGE_POLICY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_ALGO+++` +Environment variable: `+++QUARKUS_OPENSHIFT_SECURITY_CONTEXT_FS_GROUP_CHANGE_POLICY+++` endif::add-copy-button-to-env-var[] -- -|string +a|tooltip:on-root-mismatch[It indicates that volume's ownership and permissions will be changed only when permission and ownership of root directory does not match with expected permissions on the volume.], tooltip:always[It indicates that volume's ownership and permissions should always be changed whenever volume is mounted inside a Pod. This the default behavior.] | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-passphrase]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-passphrase[`quarkus.kubernetes-client.client-key-passphrase`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-remote-debug-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-remote-debug-enabled[`quarkus.openshift.remote-debug.enabled`]## [.description] -- -Client key passphrase +If true, the debug mode in pods will be enabled. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_PASSPHRASE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_PASSPHRASE+++` +Environment variable: `+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-username]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-username[`quarkus.kubernetes-client.username`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-remote-debug-transport]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-remote-debug-transport[`quarkus.openshift.remote-debug.transport`]## [.description] -- -Kubernetes auth username +The transport to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_USERNAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_TRANSPORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_USERNAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_TRANSPORT+++` endif::add-copy-button-to-env-var[] -- |string -| +|`dt_socket` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-password]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-password[`quarkus.kubernetes-client.password`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-remote-debug-suspend]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-remote-debug-suspend[`quarkus.openshift.remote-debug.suspend`]## [.description] -- -Kubernetes auth password +If enabled, it means the JVM will wait for the debugger to attach before executing the main class. If false, the JVM will immediately execute the main class, while listening for the debugger connection. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_SUSPEND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_PASSWORD+++` +Environment variable: `+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_SUSPEND+++` endif::add-copy-button-to-env-var[] -- |string -| +|`n` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-token]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-token[`quarkus.kubernetes-client.token`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-remote-debug-address-port]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-remote-debug-address-port[`quarkus.openshift.remote-debug.address-port`]## [.description] -- -Kubernetes oauth token +It specifies the address at which the debug socket will listen. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_TOKEN+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_ADDRESS_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_TOKEN+++` +Environment variable: `+++QUARKUS_OPENSHIFT_REMOTE_DEBUG_ADDRESS_PORT+++` endif::add-copy-button-to-env-var[] -- -|string -| +|int +|`5005` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-watch-reconnect-interval]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-watch-reconnect-interval[`quarkus.kubernetes-client.watch-reconnect-interval`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-deploy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-deploy[`quarkus.openshift.deploy`]## [.description] -- -Watch reconnect interval +If set to true, Quarkus will attempt to deploy the application to the target Openshift cluster ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_INTERVAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_DEPLOY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_INTERVAL+++` +Environment variable: `+++QUARKUS_OPENSHIFT_DEPLOY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT1S` +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-watch-reconnect-limit]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-watch-reconnect-limit[`quarkus.kubernetes-client.watch-reconnect-limit`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-deploy-strategy]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-deploy-strategy[`quarkus.openshift.deploy-strategy`]## [.description] -- -Maximum reconnect attempts in case of watch failure By default there is no limit to the number of reconnect attempts +If deploy is enabled, it will follow this strategy to update the resources to the target OpenShift cluster. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_LIMIT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_DEPLOY_STRATEGY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_LIMIT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_DEPLOY_STRATEGY+++` endif::add-copy-button-to-env-var[] -- -|int -|`-1` +a|`create-or-update`, `create`, `replace`, `server-side-apply` +|`create-or-update` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-connection-timeout]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-connection-timeout[`quarkus.kubernetes-client.connection-timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-tasks-init-tasks-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-tasks-init-tasks-enabled[`quarkus.openshift.init-tasks."init-tasks".enabled`]## [.description] -- -Maximum amount of time to wait for a connection with the API server to be established +If true, the init task will be generated. Otherwise, the init task resource generation will be skipped. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CONNECTION_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CONNECTION_TIMEOUT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__ENABLED+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT10S` +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-request-timeout]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-request-timeout[`quarkus.kubernetes-client.request-timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-tasks-init-tasks-wait-for-container-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-tasks-init-tasks-wait-for-container-image[`quarkus.openshift.init-tasks."init-tasks".wait-for-container.image`]## [.description] -- -Maximum amount of time to wait for a request to the API server to be completed +The init task image to use by the init-container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_REQUEST_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_REQUEST_TIMEOUT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT10S` +|string +|`groundnuty/k8s-wait-for:no-root-v1.7` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-limit]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-limit[`quarkus.kubernetes-client.request-retry-backoff-limit`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-task-defaults-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-task-defaults-enabled[`quarkus.openshift.init-task-defaults.enabled`]## [.description] -- -Maximum number of retry attempts for API requests that fail with an HTTP code of >= 500 +If true, the init task will be generated. Otherwise, the init task resource generation will be skipped. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_LIMIT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_LIMIT+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|int -|`0` +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-interval]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-interval[`quarkus.kubernetes-client.request-retry-backoff-interval`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-task-defaults-wait-for-container-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-task-defaults-wait-for-container-image[`quarkus.openshift.init-task-defaults.wait-for-container.image`]## [.description] -- -Time interval between retry attempts for API requests that fail with an HTTP code of >= 500 +The init task image to use by the init-container. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_INTERVAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_INTERVAL+++` +Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT1S` +|string +|`groundnuty/k8s-wait-for:no-root-v1.7` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-http-proxy]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-http-proxy[`quarkus.kubernetes-client.http-proxy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-idempotent]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-idempotent[`quarkus.openshift.idempotent`]## [.description] -- -HTTP proxy used to access the Kubernetes API server +Switch used to control whether non-idempotent fields are included in generated kubernetes resources to improve git-ops compatibility ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_HTTP_PROXY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_IDEMPOTENT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_HTTP_PROXY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_IDEMPOTENT+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-https-proxy]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-https-proxy[`quarkus.kubernetes-client.https-proxy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-vcs-uri-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-vcs-uri-enabled[`quarkus.openshift.vcs-uri.enabled`]## [.description] -- -HTTPS proxy used to access the Kubernetes API server +Whether the vcs-uri annotation should be added to the generated configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_HTTPS_PROXY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_VCS_URI_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_HTTPS_PROXY+++` +Environment variable: `+++QUARKUS_OPENSHIFT_VCS_URI_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-proxy-username]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-proxy-username[`quarkus.kubernetes-client.proxy-username`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-vcs-uri-override]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-vcs-uri-override[`quarkus.openshift.vcs-uri.override`]## [.description] -- -Proxy username +Optional override of the vcs-uri annotation. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_PROXY_USERNAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_VCS_URI_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_PROXY_USERNAME+++` +Environment variable: `+++QUARKUS_OPENSHIFT_VCS_URI_OVERRIDE+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-proxy-password]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-proxy-password[`quarkus.kubernetes-client.proxy-password`]## + +h|[.extension-name]##Kubernetes Client Internal## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-trust-certs]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-trust-certs[`quarkus.kubernetes-client.trust-certs`]## [.description] -- -Proxy password +Whether the client should trust a self-signed certificate if so presented by the API server ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_PROXY_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_TRUST_CERTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_PROXY_PASSWORD+++` +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_TRUST_CERTS+++` endif::add-copy-button-to-env-var[] -- -|string +|boolean | -a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-no-proxy]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-no-proxy[`quarkus.kubernetes-client.no-proxy`]## +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-api-server-url]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-api-server-url[`quarkus.kubernetes-client.api-server-url`]## [.description] -- -IP addresses or hosts to exclude from proxying +URL of the Kubernetes API server ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_NO_PROXY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_API_SERVER_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_NO_PROXY+++` +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_API_SERVER_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-namespace]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-namespace[`quarkus.kubernetes-client.namespace`]## + +[.description] +-- +Default namespace to use + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_NAMESPACE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_NAMESPACE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-ca-cert-file]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-ca-cert-file[`quarkus.kubernetes-client.ca-cert-file`]## + +[.description] +-- +CA certificate file + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CA_CERT_FILE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CA_CERT_FILE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-ca-cert-data]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-ca-cert-data[`quarkus.kubernetes-client.ca-cert-data`]## + +[.description] +-- +CA certificate data + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CA_CERT_DATA+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CA_CERT_DATA+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-client-cert-file]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-client-cert-file[`quarkus.kubernetes-client.client-cert-file`]## + +[.description] +-- +Client certificate file + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CLIENT_CERT_FILE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CLIENT_CERT_FILE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-client-cert-data]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-client-cert-data[`quarkus.kubernetes-client.client-cert-data`]## + +[.description] +-- +Client certificate data + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CLIENT_CERT_DATA+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CLIENT_CERT_DATA+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-file]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-file[`quarkus.kubernetes-client.client-key-file`]## + +[.description] +-- +Client key file + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_FILE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_FILE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-data]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-data[`quarkus.kubernetes-client.client-key-data`]## + +[.description] +-- +Client key data + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_DATA+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_DATA+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-algo]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-algo[`quarkus.kubernetes-client.client-key-algo`]## + +[.description] +-- +Client key algorithm + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_ALGO+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_ALGO+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-passphrase]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-client-key-passphrase[`quarkus.kubernetes-client.client-key-passphrase`]## + +[.description] +-- +Client key passphrase + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_PASSPHRASE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_PASSPHRASE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-username]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-username[`quarkus.kubernetes-client.username`]## + +[.description] +-- +Kubernetes auth username + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-password]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-password[`quarkus.kubernetes-client.password`]## + +[.description] +-- +Kubernetes auth password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-token]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-token[`quarkus.kubernetes-client.token`]## + +[.description] +-- +Kubernetes oauth token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-watch-reconnect-interval]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-watch-reconnect-interval[`quarkus.kubernetes-client.watch-reconnect-interval`]## + +[.description] +-- +Watch reconnect interval + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_INTERVAL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-watch-reconnect-limit]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-watch-reconnect-limit[`quarkus.kubernetes-client.watch-reconnect-limit`]## + +[.description] +-- +Maximum reconnect attempts in case of watch failure By default there is no limit to the number of reconnect attempts + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-connection-timeout]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-connection-timeout[`quarkus.kubernetes-client.connection-timeout`]## + +[.description] +-- +Maximum amount of time to wait for a connection with the API server to be established + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-request-timeout]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-request-timeout[`quarkus.kubernetes-client.request-timeout`]## + +[.description] +-- +Maximum amount of time to wait for a request to the API server to be completed + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_REQUEST_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_REQUEST_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-limit]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-limit[`quarkus.kubernetes-client.request-retry-backoff-limit`]## + +[.description] +-- +Maximum number of retry attempts for API requests that fail with an HTTP code of >= 500 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-interval]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-interval[`quarkus.kubernetes-client.request-retry-backoff-interval`]## + +[.description] +-- +Time interval between retry attempts for API requests that fail with an HTTP code of >= 500 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_INTERVAL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-http-proxy]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-http-proxy[`quarkus.kubernetes-client.http-proxy`]## + +[.description] +-- +HTTP proxy used to access the Kubernetes API server + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_HTTP_PROXY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_HTTP_PROXY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-https-proxy]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-https-proxy[`quarkus.kubernetes-client.https-proxy`]## + +[.description] +-- +HTTPS proxy used to access the Kubernetes API server + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_HTTPS_PROXY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_HTTPS_PROXY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-proxy-username]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-proxy-username[`quarkus.kubernetes-client.proxy-username`]## + +[.description] +-- +Proxy username + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-proxy-password]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-proxy-password[`quarkus.kubernetes-client.proxy-password`]## + +[.description] +-- +Proxy password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-no-proxy]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-no-proxy[`quarkus.kubernetes-client.no-proxy`]## + +[.description] +-- +IP addresses or hosts to exclude from proxying + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_CLIENT_NO_PROXY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_NO_PROXY+++` endif::add-copy-button-to-env-var[] -- |list of string @@ -47105,7 +47752,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MAILER_POOL_CLEANER_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`PT1S` a| [[quarkus-mailer_quarkus-mailer-keep-alive-timeout]] [.property-path]##link:#quarkus-mailer_quarkus-mailer-keep-alive-timeout[`quarkus.mailer.keep-alive-timeout`]## @@ -47122,7 +47769,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MAILER_KEEP_ALIVE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`PT300S` a| [[quarkus-mailer_quarkus-mailer-ntlm-workstation]] [.property-path]##link:#quarkus-mailer_quarkus-mailer-ntlm-workstation[`quarkus.mailer.ntlm.workstation`]## @@ -47763,7 +48410,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__POOL_CLEANER_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`PT1S` a| [[quarkus-mailer_quarkus-mailer-mailer-name-keep-alive-timeout]] [.property-path]##link:#quarkus-mailer_quarkus-mailer-mailer-name-keep-alive-timeout[`quarkus.mailer."mailer-name".keep-alive-timeout`]## @@ -47780,7 +48427,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__KEEP_ALIVE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`PT300S` a| [[quarkus-mailer_quarkus-mailer-mailer-name-ntlm-workstation]] [.property-path]##link:#quarkus-mailer_quarkus-mailer-mailer-name-ntlm-workstation[`quarkus.mailer."mailer-name".ntlm.workstation`]## @@ -48655,6 +49302,23 @@ endif::add-copy-button-to-env-var[] |boolean |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-exchanges-exchange-name-vhost]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-exchanges-exchange-name-vhost[`quarkus.rabbitmq.devservices.exchanges."exchange-name".vhost`]## + +[.description] +-- +What virtual host should the exchange be associated with? + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_EXCHANGES__EXCHANGE_NAME__VHOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_EXCHANGES__EXCHANGE_NAME__VHOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-exchanges-exchange-name-arguments-argument-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-exchanges-exchange-name-arguments-argument-name[`quarkus.rabbitmq.devservices.exchanges."exchange-name".arguments."argument-name"`]## [.description] @@ -48706,6 +49370,23 @@ endif::add-copy-button-to-env-var[] |boolean |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-queues-queue-name-vhost]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-queues-queue-name-vhost[`quarkus.rabbitmq.devservices.queues."queue-name".vhost`]## + +[.description] +-- +What virtual host should the queue be associated with? + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_QUEUES__QUEUE_NAME__VHOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_QUEUES__QUEUE_NAME__VHOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-queues-queue-name-arguments-argument-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-queues-queue-name-arguments-argument-name[`quarkus.rabbitmq.devservices.queues."queue-name".arguments."argument-name"`]## [.description] @@ -48791,6 +49472,23 @@ endif::add-copy-button-to-env-var[] |string |`queue` +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-bindings-binding-name-vhost]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-bindings-binding-name-vhost[`quarkus.rabbitmq.devservices.bindings."binding-name".vhost`]## + +[.description] +-- +What virtual host should the binding be associated with? + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_BINDINGS__BINDING_NAME__VHOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_BINDINGS__BINDING_NAME__VHOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-bindings-binding-name-arguments-argument-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-bindings-binding-name-arguments-argument-name[`quarkus.rabbitmq.devservices.bindings."binding-name".arguments."argument-name"`]## [.description] @@ -48808,6 +49506,23 @@ endif::add-copy-button-to-env-var[] |Map | +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-vhosts]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-vhosts[`quarkus.rabbitmq.devservices.vhosts`]## + +[.description] +-- +Virtual hosts that should be predefined after starting the RabbitMQ broker. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_VHOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_VHOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-container-env-environment-variable-name[`quarkus.rabbitmq.devservices.container-env."environment-variable-name"`]## [.description] @@ -49251,7 +49966,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MICROMETER_EXPORT_JSON_EXPIRY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`P3D` a|icon:lock[title=Fixed at build time] [[quarkus-micrometer_quarkus-micrometer-export-prometheus-enabled]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-export-prometheus-enabled[`quarkus.micrometer.export.prometheus.enabled`]## @@ -49705,7 +50420,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_MAX_CONNECTION_IDLE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-max-connection-life-time]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-max-connection-life-time[`quarkus.mongodb.max-connection-life-time`]## @@ -49722,7 +50437,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_MAX_CONNECTION_LIFE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-maintenance-frequency]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-maintenance-frequency[`quarkus.mongodb.maintenance-frequency`]## @@ -49739,7 +50454,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_MAINTENANCE_FREQUENCY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-maintenance-initial-delay]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-maintenance-initial-delay[`quarkus.mongodb.maintenance-initial-delay`]## @@ -49756,7 +50471,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_MAINTENANCE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-connect-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-connect-timeout[`quarkus.mongodb.connect-timeout`]## @@ -49773,7 +50488,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-read-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-read-timeout[`quarkus.mongodb.read-timeout`]## @@ -49790,7 +50505,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-tls-insecure]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-tls-insecure[`quarkus.mongodb.tls-insecure`]## @@ -49858,7 +50573,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_SERVER_SELECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-local-threshold]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-local-threshold[`quarkus.mongodb.local-threshold`]## @@ -49875,7 +50590,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_LOCAL_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-heartbeat-frequency]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-heartbeat-frequency[`quarkus.mongodb.heartbeat-frequency`]## @@ -49892,7 +50607,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_HEARTBEAT_FREQUENCY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-read-concern]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-read-concern[`quarkus.mongodb.read-concern`]## @@ -50011,7 +50726,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_DNS_LOOKUP_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-mongodb-client_quarkus-mongodb-dns-log-activity]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-dns-log-activity[`quarkus.mongodb.dns.log-activity`]## @@ -50173,7 +50888,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAX_CONNECTION_IDLE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-max-connection-life-time]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-max-connection-life-time[`quarkus.mongodb."mongo-client-configs".max-connection-life-time`]## @@ -50190,7 +50905,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAX_CONNECTION_LIFE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-maintenance-frequency]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-maintenance-frequency[`quarkus.mongodb."mongo-client-configs".maintenance-frequency`]## @@ -50207,7 +50922,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAINTENANCE_FREQUENCY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-maintenance-initial-delay]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-maintenance-initial-delay[`quarkus.mongodb."mongo-client-configs".maintenance-initial-delay`]## @@ -50224,7 +50939,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAINTENANCE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-connect-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-connect-timeout[`quarkus.mongodb."mongo-client-configs".connect-timeout`]## @@ -50241,7 +50956,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-read-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-read-timeout[`quarkus.mongodb."mongo-client-configs".read-timeout`]## @@ -50258,7 +50973,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-tls-insecure]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-tls-insecure[`quarkus.mongodb."mongo-client-configs".tls-insecure`]## @@ -50326,7 +51041,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__SERVER_SELECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-local-threshold]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-local-threshold[`quarkus.mongodb."mongo-client-configs".local-threshold`]## @@ -50343,7 +51058,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__LOCAL_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-heartbeat-frequency]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-heartbeat-frequency[`quarkus.mongodb."mongo-client-configs".heartbeat-frequency`]## @@ -50360,7 +51075,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__HEARTBEAT_FREQUENCY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-read-concern]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-read-concern[`quarkus.mongodb."mongo-client-configs".read-concern`]## @@ -50650,7 +51365,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_WRITE_CONCERN_W_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | @@ -50869,7 +51584,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__WRITE_CONCERN_W_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | @@ -51054,7 +51769,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TRANSACTION_MANAGER_DEFAULT_TRANSACTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-narayana-jta_quarkus-transaction-manager-enable-recovery]] [.property-path]##link:#quarkus-narayana-jta_quarkus-transaction-manager-enable-recovery[`quarkus.transaction-manager.enable-recovery`]## @@ -51277,7 +51992,7 @@ endif::add-copy-button-to-env-var[] | -h|[.extension-name]##Observability Dev Services## +h|[.extension-name]##Observability## h|Type h|Default @@ -51409,7 +52124,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`PT1M` a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-image-name]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-image-name[`quarkus.observability.lgtm.image-name`]## @@ -51427,7 +52142,7 @@ Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] -- |string -|`docker.io/grafana/otel-lgtm:0.4.0` +|`docker.io/grafana/otel-lgtm:0.7.5` a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-network-aliases]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-network-aliases[`quarkus.observability.lgtm.network-aliases`]## @@ -51463,22 +52178,22 @@ endif::add-copy-button-to-env-var[] |string |`quarkus-dev-service-lgtm` -a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-otlp-port]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-otlp-port[`quarkus.observability.lgtm.otlp-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-otlp-protocol]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-otlp-protocol[`quarkus.observability.lgtm.otlp-protocol`]## [.description] -- -The port on which LGTM's OTLP port will be exposed. +The LGTM's OTLP protocol. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_LGTM_OTLP_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_LGTM_OTLP_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_OTLP_PORT+++` +Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_OTLP_PROTOCOL+++` endif::add-copy-button-to-env-var[] -- -|int -|`4318` +|string +|`http/protobuf` a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-enabled]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-enabled[`quarkus.observability.enabled`]## @@ -51539,421 +52254,317 @@ h|[.extension-name]##OpenID Connect Adapter## h|Type h|Default -h|[[quarkus-oidc_section_quarkus-keycloak-devservices]] [.section-name.section-level0]##link:#quarkus-oidc_section_quarkus-keycloak-devservices[Dev Services]## -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-enabled[`quarkus.keycloak.devservices.enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-enabled[`quarkus.oidc.enabled`]## [.description] -- -Flag to enable (default) or disable Dev Services. When enabled, Dev Services for Keycloak automatically configures and starts Keycloak in Dev or Test mode, and when Docker is running. +If the OIDC extension is enabled. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_ENABLED+++` +Environment variable: `+++QUARKUS_OIDC_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-image-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-image-name[`quarkus.keycloak.devservices.image-name`]## - -[.description] --- -The container image name for Dev Services providers. Defaults to a Quarkus-based Keycloak image. For a WildFly-based distribution, use an image like `quay.io/keycloak/keycloak:19.0.3-legacy`. Keycloak Quarkus and WildFly images are initialized differently. Dev Services for Keycloak will assume it is a Keycloak Quarkus image unless the image version ends with `-legacy`. Override with `quarkus.keycloak.devservices.keycloak-x-image`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++` -endif::add-copy-button-to-env-var[] --- -|string -|`quay.io/keycloak/keycloak:25.0.6` - -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]## +a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-devui-grant-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-devui-grant-type[`quarkus.oidc.devui.grant.type`]## [.description] -- -Indicates if a Keycloak-X image is used. By default, the image is identified by `keycloak-x` in the image name. For custom images, override with `quarkus.keycloak.devservices.keycloak-x-image`. You do not need to set this property if the default check works. +Grant type which will be used to acquire a token to test the OIDC 'service' applications ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_KEYCLOAK_X_IMAGE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVUI_GRANT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_KEYCLOAK_X_IMAGE+++` +Environment variable: `+++QUARKUS_OIDC_DEVUI_GRANT_TYPE+++` endif::add-copy-button-to-env-var[] -- -|boolean +a|tooltip:client['client_credentials' grant], tooltip:password['password' grant], tooltip:code['authorization_code' grant], tooltip:implicit['implicit' grant] | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-shared]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-shared[`quarkus.keycloak.devservices.shared`]## - -[.description] --- -Determines if the Keycloak container is shared. When shared, Quarkus uses label-based service discovery to find and reuse a running Keycloak container, so a second one is not started. Otherwise, if a matching container is not is found, a new container is started. The service discovery uses the `quarkus-dev-service-label` label, whose value is set by the `service-name` property. Container sharing is available only in dev mode. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_SHARED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_SHARED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-service-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-service-name[`quarkus.keycloak.devservices.service-name`]## - -[.description] --- -The value of the `quarkus-dev-service-keycloak` label for identifying the Keycloak container. Used in shared mode to locate an existing container with this label. If not found, a new container is initialized with this label. Applicable only in dev mode. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_SERVICE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_SERVICE_NAME+++` -endif::add-copy-button-to-env-var[] --- -|string -|`quarkus` - -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-realm-path]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-realm-path[`quarkus.keycloak.devservices.realm-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-devui-grant-options-option-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-devui-grant-options-option-name[`quarkus.oidc.devui.grant-options."option-name"`]## [.description] -- -A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties. +Grant options ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVUI_GRANT_OPTIONS__OPTION_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH+++` +Environment variable: `+++QUARKUS_OIDC_DEVUI_GRANT_OPTIONS__OPTION_NAME_+++` endif::add-copy-button-to-env-var[] -- -|list of string +|Map> | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-resource-aliases-alias-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-resource-aliases-alias-name[`quarkus.keycloak.devservices.resource-aliases."alias-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-devui-web-client-timeout]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-devui-web-client-timeout[`quarkus.oidc.devui.web-client-timeout`]## [.description] -- -Aliases to additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between an alias and a class or file system resource path. +The WebClient timeout. Use this property to configure how long an HTTP client used by Dev UI handlers will wait for a response when requesting tokens from OpenId Connect Provider and sending them to the service endpoint. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_ALIASES__ALIAS_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVUI_WEB_CLIENT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_ALIASES__ALIAS_NAME_+++` +Environment variable: `+++QUARKUS_OIDC_DEVUI_WEB_CLIENT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|Map -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`4S` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-resource-mappings-resource-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-resource-mappings-resource-name[`quarkus.keycloak.devservices.resource-mappings."resource-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-default-token-cache-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-default-token-cache-enabled[`quarkus.oidc.default-token-cache-enabled`]## [.description] -- -Additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between a class or file system resource path alias and the Keycloak container location. +Enable the registration of the Default TokenIntrospection and UserInfo Cache implementation bean. Note: This only enables the default implementation. It requires configuration to be activated. See `OidcConfig++#++tokenCache`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_MAPPINGS__RESOURCE_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEFAULT_TOKEN_CACHE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_MAPPINGS__RESOURCE_NAME_+++` +Environment variable: `+++QUARKUS_OIDC_DEFAULT_TOKEN_CACHE_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|Map -| +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-java-opts]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-java-opts[`quarkus.keycloak.devservices.java-opts`]## +a| [[quarkus-oidc_quarkus-oidc-auth-server-url]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-auth-server-url[`quarkus.oidc.auth-server-url`]## [.description] -- -The `JAVA_OPTS` passed to the keycloak JVM +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_JAVA_OPTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTH_SERVER_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_JAVA_OPTS+++` +Environment variable: `+++QUARKUS_OIDC_AUTH_SERVER_URL+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-show-logs]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-show-logs[`quarkus.keycloak.devservices.show-logs`]## +a| [[quarkus-oidc_quarkus-oidc-discovery-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-discovery-enabled[`quarkus.oidc.discovery-enabled`]## [.description] -- -Show Keycloak log messages with a "Keycloak:" prefix. +Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_SHOW_LOGS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DISCOVERY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_SHOW_LOGS+++` +Environment variable: `+++QUARKUS_OIDC_DISCOVERY_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-start-command]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-start-command[`quarkus.keycloak.devservices.start-command`]## +a| [[quarkus-oidc_quarkus-oidc-registration-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-registration-path[`quarkus.oidc.registration-path`]## [.description] -- -Keycloak start command. Use this property to experiment with Keycloak start options, see `https://www.keycloak.org/server/all-config`. Note, it is ignored when loading legacy Keycloak WildFly images. +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_START_COMMAND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_REGISTRATION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_START_COMMAND+++` +Environment variable: `+++QUARKUS_OIDC_REGISTRATION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-realm-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-realm-name[`quarkus.keycloak.devservices.realm-name`]## +a| [[quarkus-oidc_quarkus-oidc-connection-delay]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-connection-delay[`quarkus.oidc.connection-delay`]## [.description] -- -The name of the Keycloak realm. This property is used to create the realm if the realm file pointed to by the `realm-path` property does not exist. The default value is `quarkus` in this case. It is recommended to always set this property so that Dev Services for Keycloak can identify the realm name without parsing the realm file. +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_REALM_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CONNECTION_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_REALM_NAME+++` +Environment variable: `+++QUARKUS_OIDC_CONNECTION_DELAY+++` endif::add-copy-button-to-env-var[] -- -|string +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-create-realm]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-create-realm[`quarkus.keycloak.devservices.create-realm`]## +a| [[quarkus-oidc_quarkus-oidc-connection-retry-count]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-connection-retry-count[`quarkus.oidc.connection-retry-count`]## [.description] -- -Specifies whether to create the Keycloak realm when no realm file is found at the `realm-path`. Set to `false` if the realm is to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by `io.quarkus.test.common.QuarkusTestResourceLifecycleManager`. +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_REALM+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CONNECTION_RETRY_COUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_REALM+++` +Environment variable: `+++QUARKUS_OIDC_CONNECTION_RETRY_COUNT+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|int +|`3` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-users-users]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-users-users[`quarkus.keycloak.devservices.users."users"`]## +a| [[quarkus-oidc_quarkus-oidc-connection-timeout]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-connection-timeout[`quarkus.oidc.connection-timeout`]## [.description] -- -A map of Keycloak usernames to passwords. If empty, default users `alice` and `bob` are created with their names as passwords. This map is used for user creation when no realm file is found at the `realm-path`. +The number of seconds after which the current OIDC connection request times out. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_USERS__USERS_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_USERS__USERS_+++` +Environment variable: `+++QUARKUS_OIDC_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|Map -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-roles-role-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-roles-role-name[`quarkus.keycloak.devservices.roles."role-name"`]## +a| [[quarkus-oidc_quarkus-oidc-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-use-blocking-dns-lookup[`quarkus.oidc.use-blocking-dns-lookup`]## [.description] -- -A map of roles for Keycloak users. If empty, default roles are assigned: `alice` receives `admin` and `user` roles, while other users receive `user` role. This map is used for role creation when no realm file is found at the `realm-path`. +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_ROLES__ROLE_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_USE_BLOCKING_DNS_LOOKUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_ROLES__ROLE_NAME_+++` +Environment variable: `+++QUARKUS_OIDC_USE_BLOCKING_DNS_LOOKUP+++` endif::add-copy-button-to-env-var[] -- -|Map> -| +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-port]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-port[`quarkus.keycloak.devservices.port`]## +a| [[quarkus-oidc_quarkus-oidc-max-pool-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-max-pool-size[`quarkus.oidc.max-pool-size`]## [.description] -- -The specific port for the dev service to listen on. - -If not specified, a random port is selected. +The maximum size of the connection pool used by the WebClient. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_MAX_POOL_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_PORT+++` +Environment variable: `+++QUARKUS_OIDC_MAX_POOL_SIZE+++` endif::add-copy-button-to-env-var[] -- |int | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-container-env-environment-variable-name[`quarkus.keycloak.devservices.container-env."environment-variable-name"`]## +a| [[quarkus-oidc_quarkus-oidc-proxy-host]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-host[`quarkus.oidc.proxy.host`]## [.description] -- -Environment variables to be passed to the container. +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_+++` +Environment variable: `+++QUARKUS_OIDC_PROXY_HOST+++` endif::add-copy-button-to-env-var[] -- -|Map +|string | - -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-enabled[`quarkus.oidc.enabled`]## +a| [[quarkus-oidc_quarkus-oidc-proxy-port]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-port[`quarkus.oidc.proxy.port`]## [.description] -- -If the OIDC extension is enabled. +The port number of the Proxy. The default value is `80`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_ENABLED+++` +Environment variable: `+++QUARKUS_OIDC_PROXY_PORT+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|int +|`80` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-devui-grant-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-devui-grant-type[`quarkus.oidc.devui.grant.type`]## +a| [[quarkus-oidc_quarkus-oidc-proxy-username]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-username[`quarkus.oidc.proxy.username`]## [.description] -- -Grant type which will be used to acquire a token to test the OIDC 'service' applications +The username, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVUI_GRANT_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_DEVUI_GRANT_TYPE+++` +Environment variable: `+++QUARKUS_OIDC_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:client['client_credentials' grant], tooltip:password['password' grant], tooltip:code['authorization_code' grant], tooltip:implicit['implicit' grant] +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-devui-grant-options-option-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-devui-grant-options-option-name[`quarkus.oidc.devui.grant-options."option-name"`]## +a| [[quarkus-oidc_quarkus-oidc-proxy-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-password[`quarkus.oidc.proxy.password`]## [.description] -- -Grant options +The password, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVUI_GRANT_OPTIONS__OPTION_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_DEVUI_GRANT_OPTIONS__OPTION_NAME_+++` +Environment variable: `+++QUARKUS_OIDC_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] -- -|Map> +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-devui-web-client-timeout]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-devui-web-client-timeout[`quarkus.oidc.devui.web-client-timeout`]## - -[.description] --- -The WebClient timeout. Use this property to configure how long an HTTP client used by Dev UI handlers will wait for a response when requesting tokens from OpenId Connect Provider and sending them to the service endpoint. This timeout is also used by the OIDC dev service admin client. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVUI_WEB_CLIENT_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_DEVUI_WEB_CLIENT_TIMEOUT+++` -endif::add-copy-button-to-env-var[] --- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`4S` - -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-default-token-cache-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-default-token-cache-enabled[`quarkus.oidc.default-token-cache-enabled`]## +a| [[quarkus-oidc_quarkus-oidc-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-tls-configuration-name[`quarkus.oidc.tls.tls-configuration-name`]## [.description] -- -Enable the registration of the Default TokenIntrospection and UserInfo Cache implementation bean. Note: This only enables the default implementation. It requires configuration to be activated. See `OidcConfig++#++tokenCache`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEFAULT_TOKEN_CACHE_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_DEFAULT_TOKEN_CACHE_ENABLED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` +The name of the TLS configuration to use. -a| [[quarkus-oidc_quarkus-oidc-auth-server-url]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-auth-server-url[`quarkus.oidc.auth-server-url`]## +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. -[.description] --- -The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTH_SERVER_URL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_AUTH_SERVER_URL+++` +Environment variable: `+++QUARKUS_OIDC_TLS_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-discovery-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-discovery-enabled[`quarkus.oidc.discovery-enabled`]## - -[.description] --- -Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DISCOVERY_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_DISCOVERY_ENABLED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` - a| [[quarkus-oidc_quarkus-oidc-token-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-path[`quarkus.oidc.token-path`]## [.description] @@ -52022,91 +52633,6 @@ endif::add-copy-button-to-env-var[] |string | -a| [[quarkus-oidc_quarkus-oidc-connection-delay]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-connection-delay[`quarkus.oidc.connection-delay`]## - -[.description] --- -The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CONNECTION_DELAY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CONNECTION_DELAY+++` -endif::add-copy-button-to-env-var[] --- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| - -a| [[quarkus-oidc_quarkus-oidc-connection-retry-count]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-connection-retry-count[`quarkus.oidc.connection-retry-count`]## - -[.description] --- -The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CONNECTION_RETRY_COUNT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CONNECTION_RETRY_COUNT+++` -endif::add-copy-button-to-env-var[] --- -|int -|`3` - -a| [[quarkus-oidc_quarkus-oidc-connection-timeout]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-connection-timeout[`quarkus.oidc.connection-timeout`]## - -[.description] --- -The number of seconds after which the current OIDC connection request times out. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CONNECTION_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CONNECTION_TIMEOUT+++` -endif::add-copy-button-to-env-var[] --- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` - -a| [[quarkus-oidc_quarkus-oidc-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-use-blocking-dns-lookup[`quarkus.oidc.use-blocking-dns-lookup`]## - -[.description] --- -Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_USE_BLOCKING_DNS_LOOKUP+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_USE_BLOCKING_DNS_LOOKUP+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-oidc_quarkus-oidc-max-pool-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-max-pool-size[`quarkus.oidc.max-pool-size`]## - -[.description] --- -The maximum size of the connection pool used by the WebClient. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_MAX_POOL_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_MAX_POOL_SIZE+++` -endif::add-copy-button-to-env-var[] --- -|int -| - a| [[quarkus-oidc_quarkus-oidc-credentials-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-secret[`quarkus.oidc.credentials.secret`]## [.description] @@ -52230,7 +52756,7 @@ a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-secret]] [.property-path]##link:# [.description] -- -If provided, indicates that JWT is signed using a secret key. +If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. ifdef::add-copy-button-to-env-var[] @@ -52298,7 +52824,7 @@ a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key]] [.property-path]##link:#qua [.description] -- -String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -52315,7 +52841,7 @@ a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-file]] [.property-path]##link [.description] -- -If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -52332,7 +52858,7 @@ a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-store-file]] [.property-path] [.description] -- -If provided, indicates that JWT is signed using a private key from a keystore. +If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. ifdef::add-copy-button-to-env-var[] @@ -52532,279 +53058,6 @@ endif::add-copy-button-to-env-var[] |boolean |`false` -a| [[quarkus-oidc_quarkus-oidc-proxy-host]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-host[`quarkus.oidc.proxy.host`]## - -[.description] --- -The host name or IP address of the Proxy. + -Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_HOST+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_PROXY_HOST+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-proxy-port]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-port[`quarkus.oidc.proxy.port`]## - -[.description] --- -The port number of the Proxy. The default value is `80`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_PROXY_PORT+++` -endif::add-copy-button-to-env-var[] --- -|int -|`80` - -a| [[quarkus-oidc_quarkus-oidc-proxy-username]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-username[`quarkus.oidc.proxy.username`]## - -[.description] --- -The username, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_PROXY_USERNAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-proxy-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-password[`quarkus.oidc.proxy.password`]## - -[.description] --- -The password, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_PROXY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tls-verification]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-verification[`quarkus.oidc.tls.verification`]## - -[.description] --- -Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is `required`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_VERIFICATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_VERIFICATION+++` -endif::add-copy-button-to-env-var[] --- -a|tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.], tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.], tooltip:none[All certificates are trusted and hostname verification is disabled.] -| - -a| [[quarkus-oidc_quarkus-oidc-tls-key-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-key-store-file[`quarkus.oidc.tls.key-store-file`]## - -[.description] --- -An optional keystore that holds the certificate information instead of specifying separate files. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_KEY_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_KEY_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc_quarkus-oidc-tls-key-store-file-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-key-store-file-type[`quarkus.oidc.tls.key-store-file-type`]## - -[.description] --- -The type of the keystore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_KEY_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_KEY_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tls-key-store-provider]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-key-store-provider[`quarkus.oidc.tls.key-store-provider`]## - -[.description] --- -The provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_KEY_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_KEY_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tls-key-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-key-store-password[`quarkus.oidc.tls.key-store-password`]## - -[.description] --- -The password of the keystore file. If not given, the default value, `password`, is used. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_KEY_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_KEY_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tls-key-store-key-alias]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-key-store-key-alias[`quarkus.oidc.tls.key-store-key-alias`]## - -[.description] --- -The alias of a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_KEY_STORE_KEY_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_KEY_STORE_KEY_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tls-key-store-key-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-key-store-key-password[`quarkus.oidc.tls.key-store-key-password`]## - -[.description] --- -The password of the key, if it is different from the `key-store-password`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_KEY_STORE_KEY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_KEY_STORE_KEY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tls-trust-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-trust-store-file[`quarkus.oidc.tls.trust-store-file`]## - -[.description] --- -The truststore that holds the certificate information of the certificates to trust. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_TRUST_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_TRUST_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc_quarkus-oidc-tls-trust-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-trust-store-password[`quarkus.oidc.tls.trust-store-password`]## - -[.description] --- -The password of the truststore file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_TRUST_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_TRUST_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tls-trust-store-cert-alias]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-trust-store-cert-alias[`quarkus.oidc.tls.trust-store-cert-alias`]## - -[.description] --- -The alias of the truststore certificate. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_TRUST_STORE_CERT_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_TRUST_STORE_CERT_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tls-trust-store-file-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-trust-store-file-type[`quarkus.oidc.tls.trust-store-file-type`]## - -[.description] --- -The type of the truststore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_TRUST_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_TRUST_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tls-trust-store-provider]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-trust-store-provider[`quarkus.oidc.tls.trust-store-provider`]## - -[.description] --- -The provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_TRUST_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_TRUST_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a| [[quarkus-oidc_quarkus-oidc-tenant-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-id[`quarkus.oidc.tenant-id`]## [.description] @@ -52854,7 +53107,7 @@ Environment variable: `+++QUARKUS_OIDC_APPLICATION_TYPE+++` endif::add-copy-button-to-env-var[] -- a|tooltip:web-app[A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users.], tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.], tooltip:hybrid[A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method is used if the Authorization header is set and Authorization Code Flow - if not.] -|tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.] +|tooltip:service[A {@code SERVICE} is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.] a| [[quarkus-oidc_quarkus-oidc-authorization-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authorization-path[`quarkus.oidc.authorization-path`]## @@ -53195,7 +53448,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_TOKEN_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-token-issued-at-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-issued-at-required[`quarkus.oidc.token.issued-at-required`]## @@ -53263,7 +53516,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_TOKEN_REFRESH_TOKEN_TIME_SKEW+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-token-forced-jwk-refresh-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-forced-jwk-refresh-interval[`quarkus.oidc.token.forced-jwk-refresh-interval`]## @@ -53280,7 +53533,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_TOKEN_FORCED_JWK_REFRESH_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10M` a| [[quarkus-oidc_quarkus-oidc-token-header]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-header[`quarkus.oidc.token.header`]## @@ -53552,7 +53805,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10M` a| [[quarkus-oidc_quarkus-oidc-logout-backchannel-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-backchannel-clean-up-timer-interval[`quarkus.oidc.logout.backchannel.clean-up-timer-interval`]## @@ -53569,7 +53822,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-logout-backchannel-logout-token-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-backchannel-logout-token-key[`quarkus.oidc.logout.backchannel.logout-token-key`]## @@ -54118,7 +54371,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_SESSION_AGE_EXTENSION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-oidc_quarkus-oidc-authentication-state-cookie-age]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-state-cookie-age[`quarkus.oidc.authentication.state-cookie-age`]## @@ -54135,7 +54388,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_STATE_COOKIE_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-oidc_quarkus-oidc-authentication-java-script-auto-redirect]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-java-script-auto-redirect[`quarkus.oidc.authentication.java-script-auto-redirect`]## @@ -54188,7 +54441,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-oidc_quarkus-oidc-authentication-pkce-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-pkce-required[`quarkus.oidc.authentication.pkce-required`]## @@ -54457,7 +54710,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10M` a| [[quarkus-oidc_quarkus-oidc-jwks-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-jwks-clean-up-timer-interval[`quarkus.oidc.jwks.clean-up-timer-interval`]## @@ -54474,7 +54727,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-jwks-try-all]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-jwks-try-all[`quarkus.oidc.jwks.try-all`]## @@ -54542,7 +54795,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_TOKEN_CACHE_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`3M` a| [[quarkus-oidc_quarkus-oidc-token-cache-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-cache-clean-up-timer-interval[`quarkus.oidc.token-cache.clean-up-timer-interval`]## @@ -54559,7 +54812,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_TOKEN_CACHE_CLEAN_UP_TIMER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-resolve-tenants-with-issuer]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-resolve-tenants-with-issuer[`quarkus.oidc.resolve-tenants-with-issuer`]## @@ -54587,7 +54840,7 @@ a| [[quarkus-oidc_quarkus-oidc-tenant-auth-server-url]] [.property-path]##link:# [.description] -- -The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. ifdef::add-copy-button-to-env-var[] @@ -54617,157 +54870,264 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a| [[quarkus-oidc_quarkus-oidc-tenant-token-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-path[`quarkus.oidc."tenant".token-path`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-registration-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-registration-path[`quarkus.oidc."tenant".registration-path`]## [.description] -- -The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__REGISTRATION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_PATH+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__REGISTRATION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tenant-revoke-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-revoke-path[`quarkus.oidc."tenant".revoke-path`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-connection-delay]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-delay[`quarkus.oidc."tenant".connection-delay`]## [.description] -- -The relative path or absolute URL of the OIDC token revocation endpoint. +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__REVOKE_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__REVOKE_PATH+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-connection-retry-count]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-retry-count[`quarkus.oidc."tenant".connection-retry-count`]## + +[.description] +-- +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +a| [[quarkus-oidc_quarkus-oidc-tenant-connection-timeout]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-timeout[`quarkus.oidc."tenant".connection-timeout`]## + +[.description] +-- +The number of seconds after which the current OIDC connection request times out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-oidc_quarkus-oidc-tenant-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-use-blocking-dns-lookup[`quarkus.oidc."tenant".use-blocking-dns-lookup`]## + +[.description] +-- +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__USE_BLOCKING_DNS_LOOKUP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__USE_BLOCKING_DNS_LOOKUP+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-max-pool-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-max-pool-size[`quarkus.oidc."tenant".max-pool-size`]## + +[.description] +-- +The maximum size of the connection pool used by the WebClient. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__MAX_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__MAX_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-host]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-host[`quarkus.oidc."tenant".proxy.host`]## + +[.description] +-- +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_HOST+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tenant-client-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-client-id[`quarkus.oidc."tenant".client-id`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-port]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-port[`quarkus.oidc."tenant".proxy.port`]## [.description] -- -The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. +The port number of the Proxy. The default value is `80`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CLIENT_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__CLIENT_ID+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`80` + +a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-username]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-username[`quarkus.oidc."tenant".proxy.username`]## + +[.description] +-- +The username, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tenant-client-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-client-name[`quarkus.oidc."tenant".client-name`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-password[`quarkus.oidc."tenant".proxy.password`]## [.description] -- -The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. +The password, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CLIENT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__CLIENT_NAME+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tenant-connection-delay]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-delay[`quarkus.oidc."tenant".connection-delay`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-tls-configuration-name[`quarkus.oidc."tenant".tls.tls-configuration-name`]## [.description] -- -The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_DELAY+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|string | -a| [[quarkus-oidc_quarkus-oidc-tenant-connection-retry-count]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-retry-count[`quarkus.oidc."tenant".connection-retry-count`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-token-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-path[`quarkus.oidc."tenant".token-path`]## [.description] -- -The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. +The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_RETRY_COUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_RETRY_COUNT+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_PATH+++` endif::add-copy-button-to-env-var[] -- -|int -|`3` +|string +| -a| [[quarkus-oidc_quarkus-oidc-tenant-connection-timeout]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-timeout[`quarkus.oidc."tenant".connection-timeout`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-revoke-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-revoke-path[`quarkus.oidc."tenant".revoke-path`]## [.description] -- -The number of seconds after which the current OIDC connection request times out. +The relative path or absolute URL of the OIDC token revocation endpoint. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__REVOKE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_TIMEOUT+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__REVOKE_PATH+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` +|string +| -a| [[quarkus-oidc_quarkus-oidc-tenant-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-use-blocking-dns-lookup[`quarkus.oidc."tenant".use-blocking-dns-lookup`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-client-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-client-id[`quarkus.oidc."tenant".client-id`]## [.description] -- -Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. +The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__USE_BLOCKING_DNS_LOOKUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CLIENT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__USE_BLOCKING_DNS_LOOKUP+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__CLIENT_ID+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-oidc_quarkus-oidc-tenant-max-pool-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-max-pool-size[`quarkus.oidc."tenant".max-pool-size`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-client-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-client-name[`quarkus.oidc."tenant".client-name`]## [.description] -- -The maximum size of the connection pool used by the WebClient. +The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__MAX_POOL_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CLIENT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__MAX_POOL_SIZE+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__CLIENT_NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-secret[`quarkus.oidc."tenant".credentials.secret`]## @@ -54893,7 +55253,7 @@ a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-secret]] [.property-path]# [.description] -- -If provided, indicates that JWT is signed using a secret key. +If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. ifdef::add-copy-button-to-env-var[] @@ -54961,7 +55321,7 @@ a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key]] [.property-path]##li [.description] -- -String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -54978,7 +55338,7 @@ a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-file]] [.property-path [.description] -- -If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -54995,7 +55355,7 @@ a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-store-file]] [.propert [.description] -- -If provided, indicates that JWT is signed using a private key from a keystore. +If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. ifdef::add-copy-button-to-env-var[] @@ -55195,279 +55555,6 @@ endif::add-copy-button-to-env-var[] |boolean |`false` -a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-host]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-host[`quarkus.oidc."tenant".proxy.host`]## - -[.description] --- -The host name or IP address of the Proxy. + -Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_HOST+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_HOST+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-port]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-port[`quarkus.oidc."tenant".proxy.port`]## - -[.description] --- -The port number of the Proxy. The default value is `80`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_PORT+++` -endif::add-copy-button-to-env-var[] --- -|int -|`80` - -a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-username]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-username[`quarkus.oidc."tenant".proxy.username`]## - -[.description] --- -The username, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_USERNAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-password[`quarkus.oidc."tenant".proxy.password`]## - -[.description] --- -The password, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-verification]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-verification[`quarkus.oidc."tenant".tls.verification`]## - -[.description] --- -Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is `required`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_VERIFICATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_VERIFICATION+++` -endif::add-copy-button-to-env-var[] --- -a|tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.], tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.], tooltip:none[All certificates are trusted and hostname verification is disabled.] -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-key-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-key-store-file[`quarkus.oidc."tenant".tls.key-store-file`]## - -[.description] --- -An optional keystore that holds the certificate information instead of specifying separate files. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-key-store-file-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-key-store-file-type[`quarkus.oidc."tenant".tls.key-store-file-type`]## - -[.description] --- -The type of the keystore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-key-store-provider]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-key-store-provider[`quarkus.oidc."tenant".tls.key-store-provider`]## - -[.description] --- -The provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-key-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-key-store-password[`quarkus.oidc."tenant".tls.key-store-password`]## - -[.description] --- -The password of the keystore file. If not given, the default value, `password`, is used. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-key-store-key-alias]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-key-store-key-alias[`quarkus.oidc."tenant".tls.key-store-key-alias`]## - -[.description] --- -The alias of a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_KEY_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_KEY_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-key-store-key-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-key-store-key-password[`quarkus.oidc."tenant".tls.key-store-key-password`]## - -[.description] --- -The password of the key, if it is different from the `key-store-password`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_KEY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_KEY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-file[`quarkus.oidc."tenant".tls.trust-store-file`]## - -[.description] --- -The truststore that holds the certificate information of the certificates to trust. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-password[`quarkus.oidc."tenant".tls.trust-store-password`]## - -[.description] --- -The password of the truststore file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-cert-alias]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-cert-alias[`quarkus.oidc."tenant".tls.trust-store-cert-alias`]## - -[.description] --- -The alias of the truststore certificate. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_CERT_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_CERT_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-file-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-file-type[`quarkus.oidc."tenant".tls.trust-store-file-type`]## - -[.description] --- -The type of the truststore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-provider]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-provider[`quarkus.oidc."tenant".tls.trust-store-provider`]## - -[.description] --- -The provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a| [[quarkus-oidc_quarkus-oidc-tenant-tenant-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tenant-id[`quarkus.oidc."tenant".tenant-id`]## [.description] @@ -55517,7 +55604,7 @@ Environment variable: `+++QUARKUS_OIDC__TENANT__APPLICATION_TYPE+++` endif::add-copy-button-to-env-var[] -- a|tooltip:web-app[A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users.], tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.], tooltip:hybrid[A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method is used if the Authorization header is set and Authorization Code Flow - if not.] -|tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.] +|tooltip:service[A {@code SERVICE} is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.] a| [[quarkus-oidc_quarkus-oidc-tenant-authorization-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authorization-path[`quarkus.oidc."tenant".authorization-path`]## @@ -55858,7 +55945,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-tenant-token-issued-at-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-issued-at-required[`quarkus.oidc."tenant".token.issued-at-required`]## @@ -55926,7 +56013,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_REFRESH_TOKEN_TIME_SKEW+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-tenant-token-forced-jwk-refresh-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-forced-jwk-refresh-interval[`quarkus.oidc."tenant".token.forced-jwk-refresh-interval`]## @@ -55943,7 +56030,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_FORCED_JWK_REFRESH_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10M` a| [[quarkus-oidc_quarkus-oidc-tenant-token-header]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-header[`quarkus.oidc."tenant".token.header`]## @@ -56215,7 +56302,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10M` a| [[quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-clean-up-timer-interval[`quarkus.oidc."tenant".logout.backchannel.clean-up-timer-interval`]## @@ -56232,7 +56319,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-logout-token-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-logout-token-key[`quarkus.oidc."tenant".logout.backchannel.logout-token-key`]## @@ -56781,7 +56868,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_AGE_EXTENSION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-state-cookie-age]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-state-cookie-age[`quarkus.oidc."tenant".authentication.state-cookie-age`]## @@ -56798,7 +56885,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_STATE_COOKIE_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-java-script-auto-redirect]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-java-script-auto-redirect[`quarkus.oidc."tenant".authentication.java-script-auto-redirect`]## @@ -56851,7 +56938,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-pkce-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-pkce-required[`quarkus.oidc."tenant".authentication.pkce-required`]## @@ -57120,7 +57207,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10M` a| [[quarkus-oidc_quarkus-oidc-tenant-jwks-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-jwks-clean-up-timer-interval[`quarkus.oidc."tenant".jwks.clean-up-timer-interval`]## @@ -57137,7 +57224,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-tenant-jwks-try-all]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-jwks-try-all[`quarkus.oidc."tenant".jwks.try-all`]## @@ -57201,7 +57288,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-auth-server-url]] [.property-path]# [.description] -- -The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. ifdef::add-copy-button-to-env-var[] @@ -57231,157 +57318,264 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a| [[quarkus-oidc-client_quarkus-oidc-client-token-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-token-path[`quarkus.oidc-client.token-path`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-registration-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-registration-path[`quarkus.oidc-client.registration-path`]## [.description] -- -The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TOKEN_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TOKEN_PATH+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-revoke-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-revoke-path[`quarkus.oidc-client.revoke-path`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-connection-delay]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-delay[`quarkus.oidc-client.connection-delay`]## [.description] -- -The relative path or absolute URL of the OIDC token revocation endpoint. +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REVOKE_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_REVOKE_PATH+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc-client_quarkus-oidc-client-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-retry-count[`quarkus.oidc-client.connection-retry-count`]## + +[.description] +-- +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +a| [[quarkus-oidc-client_quarkus-oidc-client-connection-timeout]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-timeout[`quarkus.oidc-client.connection-timeout`]## + +[.description] +-- +The number of seconds after which the current OIDC connection request times out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-oidc-client_quarkus-oidc-client-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-use-blocking-dns-lookup[`quarkus.oidc-client.use-blocking-dns-lookup`]## + +[.description] +-- +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc-client_quarkus-oidc-client-max-pool-size]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-max-pool-size[`quarkus.oidc-client.max-pool-size`]## + +[.description] +-- +The maximum size of the connection pool used by the WebClient. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-host]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-host[`quarkus.oidc-client.proxy.host`]## + +[.description] +-- +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_HOST+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-id[`quarkus.oidc-client.client-id`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-port]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-port[`quarkus.oidc-client.proxy.port`]## [.description] -- -The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. +The port number of the Proxy. The default value is `80`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_ID+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`80` + +a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-username]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-username[`quarkus.oidc-client.proxy.username`]## + +[.description] +-- +The username, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-client-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-name[`quarkus.oidc-client.client-name`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-password[`quarkus.oidc-client.proxy.password`]## [.description] -- -The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. +The password, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_NAME+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-connection-delay]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-delay[`quarkus.oidc-client.connection-delay`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-tls-configuration-name[`quarkus.oidc-client.tls.tls-configuration-name`]## [.description] -- -The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_DELAY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|string | -a| [[quarkus-oidc-client_quarkus-oidc-client-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-retry-count[`quarkus.oidc-client.connection-retry-count`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-token-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-token-path[`quarkus.oidc-client.token-path`]## [.description] -- -The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. +The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TOKEN_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_TOKEN_PATH+++` endif::add-copy-button-to-env-var[] -- -|int -|`3` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-connection-timeout]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-timeout[`quarkus.oidc-client.connection-timeout`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-revoke-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-revoke-path[`quarkus.oidc-client.revoke-path`]## [.description] -- -The number of seconds after which the current OIDC connection request times out. +The relative path or absolute URL of the OIDC token revocation endpoint. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REVOKE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REVOKE_PATH+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-use-blocking-dns-lookup[`quarkus.oidc-client.use-blocking-dns-lookup`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-id[`quarkus.oidc-client.client-id`]## [.description] -- -Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. +The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_ID+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-max-pool-size]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-max-pool-size[`quarkus.oidc-client.max-pool-size`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-client-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-name[`quarkus.oidc-client.client-name`]## [.description] -- -The maximum size of the connection pool used by the WebClient. +The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-secret]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-credentials-secret[`quarkus.oidc-client.credentials.secret`]## @@ -57507,7 +57701,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-jwt-secret]] [.property [.description] -- -If provided, indicates that JWT is signed using a secret key. +If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. ifdef::add-copy-button-to-env-var[] @@ -57575,7 +57769,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-jwt-key]] [.property-pa [.description] -- -String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -57592,7 +57786,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-jwt-key-file]] [.proper [.description] -- -If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -57609,7 +57803,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-jwt-key-store-file]] [. [.description] -- -If provided, indicates that JWT is signed using a private key from a keystore. +If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. ifdef::add-copy-button-to-env-var[] @@ -57809,279 +58003,6 @@ endif::add-copy-button-to-env-var[] |boolean |`false` -a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-host]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-host[`quarkus.oidc-client.proxy.host`]## - -[.description] --- -The host name or IP address of the Proxy. + -Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_HOST+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_HOST+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-port]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-port[`quarkus.oidc-client.proxy.port`]## - -[.description] --- -The port number of the Proxy. The default value is `80`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_PORT+++` -endif::add-copy-button-to-env-var[] --- -|int -|`80` - -a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-username]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-username[`quarkus.oidc-client.proxy.username`]## - -[.description] --- -The username, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_USERNAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-password[`quarkus.oidc-client.proxy.password`]## - -[.description] --- -The password, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-verification]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-verification[`quarkus.oidc-client.tls.verification`]## - -[.description] --- -Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is `required`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_VERIFICATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_VERIFICATION+++` -endif::add-copy-button-to-env-var[] --- -a|tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.], tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.], tooltip:none[All certificates are trusted and hostname verification is disabled.] -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-file]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-file[`quarkus.oidc-client.tls.key-store-file`]## - -[.description] --- -An optional keystore that holds the certificate information instead of specifying separate files. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-file-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-file-type[`quarkus.oidc-client.tls.key-store-file-type`]## - -[.description] --- -The type of the keystore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-provider]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-provider[`quarkus.oidc-client.tls.key-store-provider`]## - -[.description] --- -The provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-password[`quarkus.oidc-client.tls.key-store-password`]## - -[.description] --- -The password of the keystore file. If not given, the default value, `password`, is used. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-key-alias]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-key-alias[`quarkus.oidc-client.tls.key-store-key-alias`]## - -[.description] --- -The alias of a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_KEY_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_KEY_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-key-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-key-password[`quarkus.oidc-client.tls.key-store-key-password`]## - -[.description] --- -The password of the key, if it is different from the `key-store-password`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_KEY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_KEY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-file]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-file[`quarkus.oidc-client.tls.trust-store-file`]## - -[.description] --- -The truststore that holds the certificate information of the certificates to trust. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-password[`quarkus.oidc-client.tls.trust-store-password`]## - -[.description] --- -The password of the truststore file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-cert-alias]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-cert-alias[`quarkus.oidc-client.tls.trust-store-cert-alias`]## - -[.description] --- -The alias of the truststore certificate. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_CERT_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_CERT_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-file-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-file-type[`quarkus.oidc-client.tls.trust-store-file-type`]## - -[.description] --- -The type of the truststore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-provider]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-provider[`quarkus.oidc-client.tls.trust-store-provider`]## - -[.description] --- -The provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a| [[quarkus-oidc-client_quarkus-oidc-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id[`quarkus.oidc-client.id`]## [.description] @@ -58137,7 +58058,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-refresh-token-time-skew]] [.propert [.description] -- -Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen. +Refresh token time skew. If this property is enabled then the configured duration is converted to seconds and is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen. ifdef::add-copy-button-to-env-var[] @@ -58147,7 +58068,24 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_CLIENT_REFRESH_TOKEN_TIME_SKEW+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc-client_quarkus-oidc-client-access-token-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-access-token-expires-in[`quarkus.oidc-client.access-token-expires-in`]## + +[.description] +-- +Access token expiration period relative to the current time. This property is only checked when an access token grant response does not include an access token expiration property. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ACCESS_TOKEN_EXPIRES_IN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_ACCESS_TOKEN_EXPIRES_IN+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc-client_quarkus-oidc-client-absolute-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-absolute-expires-in[`quarkus.oidc-client.absolute-expires-in`]## @@ -58311,7 +58249,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-auth-server-url]] [.property-pat [.description] -- -The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. ifdef::add-copy-button-to-env-var[] @@ -58341,157 +58279,264 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a| [[quarkus-oidc-client_quarkus-oidc-client-id-token-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-token-path[`quarkus.oidc-client."id".token-path`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-registration-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-registration-path[`quarkus.oidc-client."id".registration-path`]## [.description] -- -The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TOKEN_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__REGISTRATION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TOKEN_PATH+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__REGISTRATION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-id-revoke-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-revoke-path[`quarkus.oidc-client."id".revoke-path`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-delay]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-delay[`quarkus.oidc-client."id".connection-delay`]## [.description] -- -The relative path or absolute URL of the OIDC token revocation endpoint. +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__REVOKE_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__REVOKE_PATH+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-retry-count[`quarkus.oidc-client."id".connection-retry-count`]## + +[.description] +-- +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-timeout]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-timeout[`quarkus.oidc-client."id".connection-timeout`]## + +[.description] +-- +The number of seconds after which the current OIDC connection request times out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-oidc-client_quarkus-oidc-client-id-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-use-blocking-dns-lookup[`quarkus.oidc-client."id".use-blocking-dns-lookup`]## + +[.description] +-- +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__USE_BLOCKING_DNS_LOOKUP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__USE_BLOCKING_DNS_LOOKUP+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc-client_quarkus-oidc-client-id-max-pool-size]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-max-pool-size[`quarkus.oidc-client."id".max-pool-size`]## + +[.description] +-- +The maximum size of the connection pool used by the WebClient. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__MAX_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__MAX_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-host]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-host[`quarkus.oidc-client."id".proxy.host`]## + +[.description] +-- +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_HOST+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-id-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-client-id[`quarkus.oidc-client."id".client-id`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-port]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-port[`quarkus.oidc-client."id".proxy.port`]## [.description] -- -The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. +The port number of the Proxy. The default value is `80`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CLIENT_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CLIENT_ID+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`80` + +a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-username]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-username[`quarkus.oidc-client."id".proxy.username`]## + +[.description] +-- +The username, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-id-client-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-client-name[`quarkus.oidc-client."id".client-name`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-password[`quarkus.oidc-client."id".proxy.password`]## [.description] -- -The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. +The password, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CLIENT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CLIENT_NAME+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-delay]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-delay[`quarkus.oidc-client."id".connection-delay`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-tls-configuration-name[`quarkus.oidc-client."id".tls.tls-configuration-name`]## [.description] -- -The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_DELAY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|string | -a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-retry-count[`quarkus.oidc-client."id".connection-retry-count`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-token-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-token-path[`quarkus.oidc-client."id".token-path`]## [.description] -- -The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. +The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_RETRY_COUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TOKEN_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_RETRY_COUNT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TOKEN_PATH+++` endif::add-copy-button-to-env-var[] -- -|int -|`3` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-timeout]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-timeout[`quarkus.oidc-client."id".connection-timeout`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-revoke-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-revoke-path[`quarkus.oidc-client."id".revoke-path`]## [.description] -- -The number of seconds after which the current OIDC connection request times out. +The relative path or absolute URL of the OIDC token revocation endpoint. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__REVOKE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_TIMEOUT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__REVOKE_PATH+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-id-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-use-blocking-dns-lookup[`quarkus.oidc-client."id".use-blocking-dns-lookup`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-client-id[`quarkus.oidc-client."id".client-id`]## [.description] -- -Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. +The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__USE_BLOCKING_DNS_LOOKUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CLIENT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__USE_BLOCKING_DNS_LOOKUP+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CLIENT_ID+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-id-max-pool-size]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-max-pool-size[`quarkus.oidc-client."id".max-pool-size`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-client-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-client-name[`quarkus.oidc-client."id".client-name`]## [.description] -- -The maximum size of the connection pool used by the WebClient. +The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__MAX_POOL_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CLIENT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__MAX_POOL_SIZE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CLIENT_NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-secret]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-credentials-secret[`quarkus.oidc-client."id".credentials.secret`]## @@ -58617,7 +58662,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-jwt-secret]] [.prope [.description] -- -If provided, indicates that JWT is signed using a secret key. +If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. ifdef::add-copy-button-to-env-var[] @@ -58685,7 +58730,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-jwt-key]] [.property [.description] -- -String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -58702,7 +58747,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-jwt-key-file]] [.pro [.description] -- -If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -58719,7 +58764,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-jwt-key-store-file]] [.description] -- -If provided, indicates that JWT is signed using a private key from a keystore. +If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. ifdef::add-copy-button-to-env-var[] @@ -58919,279 +58964,6 @@ endif::add-copy-button-to-env-var[] |boolean |`false` -a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-host]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-host[`quarkus.oidc-client."id".proxy.host`]## - -[.description] --- -The host name or IP address of the Proxy. + -Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_HOST+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_HOST+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-port]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-port[`quarkus.oidc-client."id".proxy.port`]## - -[.description] --- -The port number of the Proxy. The default value is `80`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_PORT+++` -endif::add-copy-button-to-env-var[] --- -|int -|`80` - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-username]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-username[`quarkus.oidc-client."id".proxy.username`]## - -[.description] --- -The username, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_USERNAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-password[`quarkus.oidc-client."id".proxy.password`]## - -[.description] --- -The password, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-verification]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-verification[`quarkus.oidc-client."id".tls.verification`]## - -[.description] --- -Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is `required`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_VERIFICATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_VERIFICATION+++` -endif::add-copy-button-to-env-var[] --- -a|tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.], tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.], tooltip:none[All certificates are trusted and hostname verification is disabled.] -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-file]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-file[`quarkus.oidc-client."id".tls.key-store-file`]## - -[.description] --- -An optional keystore that holds the certificate information instead of specifying separate files. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-file-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-file-type[`quarkus.oidc-client."id".tls.key-store-file-type`]## - -[.description] --- -The type of the keystore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-provider]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-provider[`quarkus.oidc-client."id".tls.key-store-provider`]## - -[.description] --- -The provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-password[`quarkus.oidc-client."id".tls.key-store-password`]## - -[.description] --- -The password of the keystore file. If not given, the default value, `password`, is used. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-key-alias]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-key-alias[`quarkus.oidc-client."id".tls.key-store-key-alias`]## - -[.description] --- -The alias of a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_KEY_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_KEY_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-key-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-key-password[`quarkus.oidc-client."id".tls.key-store-key-password`]## - -[.description] --- -The password of the key, if it is different from the `key-store-password`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_KEY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_KEY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-file]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-file[`quarkus.oidc-client."id".tls.trust-store-file`]## - -[.description] --- -The truststore that holds the certificate information of the certificates to trust. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-password[`quarkus.oidc-client."id".tls.trust-store-password`]## - -[.description] --- -The password of the truststore file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-cert-alias]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-cert-alias[`quarkus.oidc-client."id".tls.trust-store-cert-alias`]## - -[.description] --- -The alias of the truststore certificate. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_CERT_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_CERT_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-file-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-file-type[`quarkus.oidc-client."id".tls.trust-store-file-type`]## - -[.description] --- -The type of the truststore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-provider]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-provider[`quarkus.oidc-client."id".tls.trust-store-provider`]## - -[.description] --- -The provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a| [[quarkus-oidc-client_quarkus-oidc-client-id-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-id[`quarkus.oidc-client."id".id`]## [.description] @@ -59247,7 +59019,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-refresh-token-time-skew]] [.prop [.description] -- -Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen. +Refresh token time skew. If this property is enabled then the configured duration is converted to seconds and is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen. ifdef::add-copy-button-to-env-var[] @@ -59257,7 +59029,24 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__REFRESH_TOKEN_TIME_SKEW+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc-client_quarkus-oidc-client-id-access-token-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-access-token-expires-in[`quarkus.oidc-client."id".access-token-expires-in`]## + +[.description] +-- +Access token expiration period relative to the current time. This property is only checked when an access token grant response does not include an access token expiration property. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__ACCESS_TOKEN_EXPIRES_IN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__ACCESS_TOKEN_EXPIRES_IN+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc-client_quarkus-oidc-client-id-absolute-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-absolute-expires-in[`quarkus.oidc-client."id".absolute-expires-in`]## @@ -59472,7 +59261,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_DB_TOKEN_STATE_MANAGER_DELETE_EXPIRED_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`8H` a| [[quarkus-oidc-db-token-state-manager_quarkus-oidc-db-token-state-manager-create-database-table-if-not-exists]] [.property-path]##link:#quarkus-oidc-db-token-state-manager_quarkus-oidc-db-token-state-manager-create-database-table-if-not-exists[`quarkus.oidc.db-token-state-manager.create-database-table-if-not-exists`]## @@ -59493,3296 +59282,3898 @@ endif::add-copy-button-to-env-var[] |`true` -h|[.extension-name]##OpenTelemetry## +h|[.extension-name]##OpenID Connect Dynamic Client Registration## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-enabled[`quarkus.otel.enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-enabled[`quarkus.oidc-client-registration.enabled`]## [.description] -- -If false, disable the OpenTelemetry usage at build time. All other Otel properties will be ignored at runtime. - -Will pick up value from legacy property quarkus.opentelemetry.enabled - -Defaults to `true`. +If the OIDC client registration extension is enabled. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_ENABLED+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-traces-exporter]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-exporter[`quarkus.otel.traces.exporter`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-auth-server-url]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-auth-server-url[`quarkus.oidc-client-registration.auth-server-url`]## [.description] -- -List of exporters supported by Quarkus. - -List of exporters to be used for tracing, separated by commas. Has one of the values on `ExporterType` `otlp`, `cdi`, `none` or the full qualified name of a class implementing `io.opentelemetry.sdk.trace.export.SpanExporter` - -Default on Quarkus is `ExporterType.Constants++#++CDI_VALUE`. +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_EXPORTER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_AUTH_SERVER_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_TRACES_EXPORTER+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_AUTH_SERVER_URL+++` endif::add-copy-button-to-env-var[] -- -|list of string -|`cdi` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-traces-sampler]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-sampler[`quarkus.otel.traces.sampler`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-discovery-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-discovery-enabled[`quarkus.oidc-client-registration.discovery-enabled`]## [.description] -- -The sampler to use for tracing. - -Has one of the values on `SamplerType` `always_on`, `always_off`, `traceidratio`, `parentbased_always_on`, `parentbased_always_off`, `parentbased_traceidratio` or the Sampler SPI name. This will use the OTel SPI hooks for the `io.opentelemetry.sdk.trace.samplers.Sampler` implementation set in the provider: `io.opentelemetry.sdk.autoconfigure.spi.traces.ConfigurableSamplerProvider`. - -Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.sampler.name` or defaults to `SamplerType.Constants++#++PARENT_BASED_ALWAYS_ON`. +Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_SAMPLER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_DISCOVERY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_TRACES_SAMPLER+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_DISCOVERY_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -|`parentbased_always_on` +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-traces-eusp-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-eusp-enabled[`quarkus.otel.traces.eusp.enabled`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-registration-path]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-registration-path[`quarkus.oidc-client-registration.registration-path`]## [.description] -- -If OpenTelemetry End User attributes should be added as Span attributes on a best-efforts basis. +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTRATION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTRATION_PATH+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-metrics-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-metrics-enabled[`quarkus.otel.metrics.enabled`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-delay]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-delay[`quarkus.oidc-client-registration.connection-delay`]## [.description] -- -Enable metrics with OpenTelemetry. - -This property is not available in the Open Telemetry SDK. It's Quarkus specific. - -Support for metrics will be enabled if OpenTelemetry support is enabled and either this value is true, or this value is unset. +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_METRICS_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_METRICS_ENABLED+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_DELAY+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-metrics-exporter]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-metrics-exporter[`quarkus.otel.metrics.exporter`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-retry-count[`quarkus.oidc-client-registration.connection-retry-count`]## [.description] -- -The Metrics exporter to use. +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_METRICS_EXPORTER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_RETRY_COUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_METRICS_EXPORTER+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_RETRY_COUNT+++` endif::add-copy-button-to-env-var[] -- -|list of string -|`cdi` +|int +|`3` -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-logs-exporter]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-logs-exporter[`quarkus.otel.logs.exporter`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-timeout]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-timeout[`quarkus.oidc-client-registration.connection-timeout`]## [.description] -- -No Log exporter for now. +The number of seconds after which the current OIDC connection request times out. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_LOGS_EXPORTER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_LOGS_EXPORTER+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|list of string -|`none` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-propagators]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-propagators[`quarkus.otel.propagators`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-use-blocking-dns-lookup[`quarkus.oidc-client-registration.use-blocking-dns-lookup`]## [.description] -- -The propagators to be used. Use a comma-separated list for multiple propagators. - -Has values from `PropagatorType` or the full qualified name of a class implementing `io.opentelemetry.context.propagation.TextMapPropagator`. - -Default is `PropagatorType.Constants++#++TRACE_CONTEXT`,`PropagatorType.Constants++#++BAGGAGE` (W3C). +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_PROPAGATORS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_USE_BLOCKING_DNS_LOOKUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_PROPAGATORS+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_USE_BLOCKING_DNS_LOOKUP+++` endif::add-copy-button-to-env-var[] -- -|list of string -|`tracecontext,baggage` +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-instrument-grpc]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-grpc[`quarkus.otel.instrument.grpc`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-max-pool-size]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-max-pool-size[`quarkus.oidc-client-registration.max-pool-size`]## [.description] -- -Enables instrumentation for gRPC. +The maximum size of the connection pool used by the WebClient. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_GRPC+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_MAX_POOL_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_GRPC+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_MAX_POOL_SIZE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|int +| -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-instrument-messaging]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-messaging[`quarkus.otel.instrument.messaging`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-host]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-host[`quarkus.oidc-client-registration.proxy.host`]## [.description] -- -Enables instrumentation for Messaging. +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_MESSAGING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_MESSAGING+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_HOST+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-instrument-resteasy-client]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-resteasy-client[`quarkus.otel.instrument.resteasy-client`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-port]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-port[`quarkus.oidc-client-registration.proxy.port`]## [.description] -- -Enables instrumentation for REST Client backed by RESTEasy Classic. +The port number of the Proxy. The default value is `80`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_RESTEASY_CLIENT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_RESTEASY_CLIENT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_PORT+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|int +|`80` -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-instrument-rest]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-rest[`quarkus.otel.instrument.rest`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-username]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-username[`quarkus.oidc-client-registration.proxy.username`]## [.description] -- -Enables instrumentation for Quarkus REST. +The username, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_REST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_REST+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-instrument-resteasy]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-resteasy[`quarkus.otel.instrument.resteasy`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-password]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-password[`quarkus.oidc-client-registration.proxy.password`]## [.description] -- -Enables instrumentation for RESTEasy Classic. +The password, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_RESTEASY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_RESTEASY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-security-events-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-security-events-enabled[`quarkus.otel.security-events.enabled`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-tls-tls-configuration-name[`quarkus.oidc-client-registration.tls.tls-configuration-name`]## [.description] -- -Whether exporting of the security events is enabled. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SECURITY_EVENTS_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_TLS_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_SECURITY_EVENTS_ENABLED+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_TLS_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-security-events-event-types]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-security-events-event-types[`quarkus.otel.security-events.event-types`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id[`quarkus.oidc-client-registration.id`]## [.description] -- -Selects security event types. +OIDC Client Registration id ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SECURITY_EVENTS_EVENT_TYPES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_SECURITY_EVENTS_EVENT_TYPES+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_ID+++` endif::add-copy-button-to-env-var[] -- -a|list of `all`, `authentication-success`, `authentication-failure`, `authorization-success`, `authorization-failure`, `other` -|`all` +|string +| -a| [[quarkus-opentelemetry_quarkus-otel-sdk-disabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-sdk-disabled[`quarkus.otel.sdk.disabled`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-registration-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-registration-enabled[`quarkus.oidc-client-registration.registration-enabled`]## [.description] -- -If true, disable the OpenTelemetry SDK. Runtime configuration. - -Defaults to `false`. +If this client registration configuration is enabled. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SDK_DISABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTRATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_SDK_DISABLED+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTRATION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +|`true` -a| [[quarkus-opentelemetry_quarkus-otel-traces-suppress-non-application-uris]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-suppress-non-application-uris[`quarkus.otel.traces.suppress-non-application-uris`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-register-early]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-register-early[`quarkus.oidc-client-registration.register-early`]## [.description] -- -Suppress non-application uris from trace collection. This will suppress tracing of `/q` endpoints. - -Providing a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting. - -This is a Quarkus specific property. Suppressing non-application uris is enabled by default. - -Fallbacks to the legacy property `quarkus.opentelemetry.tracer.suppress-non-application-uris` or defaults to `true`. +If the client configured with `metadata` must be registered at startup. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_SUPPRESS_NON_APPLICATION_URIS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTER_EARLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_TRACES_SUPPRESS_NON_APPLICATION_URIS+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTER_EARLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` -a| [[quarkus-opentelemetry_quarkus-otel-traces-include-static-resources]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-include-static-resources[`quarkus.otel.traces.include-static-resources`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-initial-token]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-initial-token[`quarkus.oidc-client-registration.initial-token`]## [.description] -- -Include static resources from trace collection. - -This is a Quarkus specific property. Include static resources is disabled by default. Providing a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting. - -Fallbacks to the legacy property `quarkus.opentelemetry.tracer.include-static-resources` or defaults to `false`. +Initial access token ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_INCLUDE_STATIC_RESOURCES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_INITIAL_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_TRACES_INCLUDE_STATIC_RESOURCES+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_INITIAL_TOKEN+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-opentelemetry_quarkus-otel-traces-sampler-arg]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-sampler-arg[`quarkus.otel.traces.sampler.arg`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-client-name]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-client-name[`quarkus.oidc-client-registration.metadata.client-name`]## [.description] -- -Sampler argument. Depends on the `quarkus.otel.traces.sampler` property. Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio`. - -When setting the stock sampler to `traceidratio` or `parentbased_traceidratio` you need to set a `double` compatible value between `0.0d` and `1.0d`, like `0.01d` or `0.5d`. It is kept as a `String` to allow the flexible customisation of alternative samplers. - -Defaults to `1.0d`. +Client name ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_CLIENT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_CLIENT_NAME+++` endif::add-copy-button-to-env-var[] -- |string -|`1.0d` +| -a| [[quarkus-opentelemetry_quarkus-otel-metric-export-interval]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-metric-export-interval[`quarkus.otel.metric.export.interval`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-redirect-uri]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-redirect-uri[`quarkus.oidc-client-registration.metadata.redirect-uri`]## [.description] -- -The interval, between the start of two metric export attempts. - -Default is 1min. +Redirect URI ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_METRIC_EXPORT_INTERVAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_REDIRECT_URI+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_METRIC_EXPORT_INTERVAL+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_REDIRECT_URI+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`60S` +|string +| -a| [[quarkus-opentelemetry_quarkus-otel-attribute-value-length-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-attribute-value-length-limit[`quarkus.otel.attribute.value.length.limit`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-post-logout-uri]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-post-logout-uri[`quarkus.oidc-client-registration.metadata.post-logout-uri`]## [.description] -- -The maximum length of attribute values. Applies to spans and logs. - -By default, there is no limit. +Post Logout URI ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_POST_LOGOUT_URI+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_POST_LOGOUT_URI+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-opentelemetry_quarkus-otel-attribute-count-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-attribute-count-limit[`quarkus.otel.attribute.count.limit`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-extra-props-extra-props]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-extra-props-extra-props[`quarkus.oidc-client-registration.metadata.extra-props."extra-props"`]## [.description] -- -The maximum number of attributes. Applies to spans, span events, span links, and logs. - -Default is `128`. +Additional metadata properties ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_ATTRIBUTE_COUNT_LIMIT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_EXTRA_PROPS__EXTRA_PROPS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_ATTRIBUTE_COUNT_LIMIT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_EXTRA_PROPS__EXTRA_PROPS_+++` endif::add-copy-button-to-env-var[] -- -|int -|`128` +|Map +| -a| [[quarkus-opentelemetry_quarkus-otel-span-attribute-value-length-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-span-attribute-value-length-limit[`quarkus.otel.span.attribute.value.length.limit`]## +h|[[quarkus-oidc-client-registration_section_quarkus-oidc-client-registration]] [.section-name.section-level0]##link:#quarkus-oidc-client-registration_section_quarkus-oidc-client-registration[Additional named client registrations]## +h|Type +h|Default + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-auth-server-url]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-auth-server-url[`quarkus.oidc-client-registration."id".auth-server-url`]## [.description] -- -The maximum length of span attribute values. Takes precedence over `otel.attribute.value.length.limit`. - -By default, there is no limit. +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__AUTH_SERVER_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__AUTH_SERVER_URL+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a| [[quarkus-opentelemetry_quarkus-otel-span-attribute-count-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-span-attribute-count-limit[`quarkus.otel.span.attribute.count.limit`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-discovery-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-discovery-enabled[`quarkus.oidc-client-registration."id".discovery-enabled`]## [.description] -- -The maximum number of attributes per span. Takes precedence over `otel.attribute.count.limit`. - -Default is `128`. +Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__DISCOVERY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__DISCOVERY_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|int -|`128` +|boolean +|`true` -a| [[quarkus-opentelemetry_quarkus-otel-span-event-count-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-span-event-count-limit[`quarkus.otel.span.event.count.limit`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-registration-path]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-registration-path[`quarkus.oidc-client-registration."id".registration-path`]## [.description] -- -The maximum number of events per span. - -Default is `128`. +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SPAN_EVENT_COUNT_LIMIT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTRATION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_SPAN_EVENT_COUNT_LIMIT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTRATION_PATH+++` endif::add-copy-button-to-env-var[] -- -|int -|`128` +|string +| -a| [[quarkus-opentelemetry_quarkus-otel-span-link-count-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-span-link-count-limit[`quarkus.otel.span.link.count.limit`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-delay]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-delay[`quarkus.oidc-client-registration."id".connection-delay`]## [.description] -- -The maximum number of links per span. - -Default is `128`. +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SPAN_LINK_COUNT_LIMIT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_SPAN_LINK_COUNT_LIMIT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_DELAY+++` endif::add-copy-button-to-env-var[] -- -|int -|`128` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| -a| [[quarkus-opentelemetry_quarkus-otel-bsp-schedule-delay]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-bsp-schedule-delay[`quarkus.otel.bsp.schedule.delay`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-retry-count[`quarkus.oidc-client-registration."id".connection-retry-count`]## [.description] -- -The interval, in milliseconds, between two consecutive exports. - -Default is `5000`. +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BSP_SCHEDULE_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_RETRY_COUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_BSP_SCHEDULE_DELAY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_RETRY_COUNT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`5S` +|int +|`3` -a| [[quarkus-opentelemetry_quarkus-otel-bsp-max-queue-size]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-bsp-max-queue-size[`quarkus.otel.bsp.max.queue.size`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-timeout]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-timeout[`quarkus.oidc-client-registration."id".connection-timeout`]## [.description] -- -The maximum queue size. - -Default is `2048`. +The number of seconds after which the current OIDC connection request times out. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BSP_MAX_QUEUE_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_BSP_MAX_QUEUE_SIZE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|int -|`2048` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10S` -a| [[quarkus-opentelemetry_quarkus-otel-bsp-max-export-batch-size]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-bsp-max-export-batch-size[`quarkus.otel.bsp.max.export.batch.size`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-use-blocking-dns-lookup[`quarkus.oidc-client-registration."id".use-blocking-dns-lookup`]## [.description] -- -The maximum batch size. - -Default is `512`. +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BSP_MAX_EXPORT_BATCH_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__USE_BLOCKING_DNS_LOOKUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_BSP_MAX_EXPORT_BATCH_SIZE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__USE_BLOCKING_DNS_LOOKUP+++` endif::add-copy-button-to-env-var[] -- -|int -|`512` +|boolean +|`false` -a| [[quarkus-opentelemetry_quarkus-otel-bsp-export-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-bsp-export-timeout[`quarkus.otel.bsp.export.timeout`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-max-pool-size]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-max-pool-size[`quarkus.oidc-client-registration."id".max-pool-size`]## [.description] -- -The maximum allowed time, in milliseconds, to export data. - -Default is `30s`. +The maximum size of the connection pool used by the WebClient. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BSP_EXPORT_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__MAX_POOL_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_BSP_EXPORT_TIMEOUT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__MAX_POOL_SIZE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`30S` +|int +| -a| [[quarkus-opentelemetry_quarkus-otel-resource-attributes]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-resource-attributes[`quarkus.otel.resource.attributes`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-host]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-host[`quarkus.oidc-client-registration."id".proxy.host`]## [.description] -- -Specify resource attributes in the following format: `key1=val1,key2=val2,key3=val3`. +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_RESOURCE_ATTRIBUTES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_RESOURCE_ATTRIBUTES+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_HOST+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a| [[quarkus-opentelemetry_quarkus-otel-service-name]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-service-name[`quarkus.otel.service.name`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-port]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-port[`quarkus.oidc-client-registration."id".proxy.port`]## [.description] -- -Specify logical service name. Takes precedence over service.name defined with otel.resource.attributes and from quarkus.application.name. - -Defaults to `quarkus.application.name`. +The port number of the Proxy. The default value is `80`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SERVICE_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_SERVICE_NAME+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_PORT+++` endif::add-copy-button-to-env-var[] -- -|string -|`${quarkus.application.name:unset}` +|int +|`80` -a| [[quarkus-opentelemetry_quarkus-otel-experimental-resource-disabled-keys]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-experimental-resource-disabled-keys[`quarkus.otel.experimental.resource.disabled-keys`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-username]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-username[`quarkus.oidc-client-registration."id".proxy.username`]## [.description] -- -Specify resource attribute keys that are filtered. +The username, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPERIMENTAL_RESOURCE_DISABLED_KEYS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPERIMENTAL_RESOURCE_DISABLED_KEYS+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a| [[quarkus-opentelemetry_quarkus-otel-experimental-shutdown-wait-time]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-experimental-shutdown-wait-time[`quarkus.otel.experimental.shutdown-wait-time`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-password]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-password[`quarkus.oidc-client-registration."id".proxy.password`]## [.description] -- -The maximum amount of time Quarkus will wait for the OpenTelemetry SDK to flush unsent spans and shutdown. +The password, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPERIMENTAL_SHUTDOWN_WAIT_TIME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPERIMENTAL_SHUTDOWN_WAIT_TIME+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`1S` +|string +| -a| [[quarkus-opentelemetry_quarkus-otel-instrument-vertx-http]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-vertx-http[`quarkus.otel.instrument.vertx-http`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-tls-tls-configuration-name[`quarkus.oidc-client-registration."id".tls.tls-configuration-name`]## [.description] -- -Enables instrumentation for Vert.x HTTP. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_VERTX_HTTP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__TLS_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_VERTX_HTTP+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__TLS_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +| -a| [[quarkus-opentelemetry_quarkus-otel-instrument-vertx-event-bus]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-vertx-event-bus[`quarkus.otel.instrument.vertx-event-bus`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-id]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-id[`quarkus.oidc-client-registration."id".id`]## [.description] -- -Enables instrumentation for Vert.x Event Bus. +OIDC Client Registration id ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_VERTX_EVENT_BUS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_VERTX_EVENT_BUS+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__ID+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +| -a| [[quarkus-opentelemetry_quarkus-otel-instrument-vertx-sql-client]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-vertx-sql-client[`quarkus.otel.instrument.vertx-sql-client`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-registration-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-registration-enabled[`quarkus.oidc-client-registration."id".registration-enabled`]## [.description] -- -Enables instrumentation for Vert.x SQL Client. +If this client registration configuration is enabled. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_VERTX_SQL_CLIENT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTRATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_VERTX_SQL_CLIENT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTRATION_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` -a| [[quarkus-opentelemetry_quarkus-otel-instrument-vertx-redis-client]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-vertx-redis-client[`quarkus.otel.instrument.vertx-redis-client`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-register-early]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-register-early[`quarkus.oidc-client-registration."id".register-early`]## [.description] -- -Enables instrumentation for Vert.x Redis Client. +If the client configured with `metadata` must be registered at startup. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_VERTX_REDIS_CLIENT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTER_EARLY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_VERTX_REDIS_CLIENT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTER_EARLY+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` -a| [[quarkus-opentelemetry_quarkus-otel-mp-compatibility]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-mp-compatibility[`quarkus.otel.mp.compatibility`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-initial-token]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-initial-token[`quarkus.oidc-client-registration."id".initial-token`]## [.description] -- -Prioritize OpenTelemetry configuration `otel.` on top of Quarkus OpenTelemetry configuration `quarkus.otel`. - -By default, Quarkus configuration has priority over OpenTelemetry configuration. +Initial access token ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_MP_COMPATIBILITY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__INITIAL_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_MP_COMPATIBILITY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__INITIAL_TOKEN+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-endpoint]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-endpoint[`quarkus.otel.exporter.otlp.endpoint`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-client-name]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-client-name[`quarkus.oidc-client-registration."id".metadata.client-name`]## [.description] -- -Sets the OTLP endpoint to send telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`. - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..endpoint` where is one of the supported signal types, like `traces` or `metrics`. - -If protocol is `http/protobuf` the version and signal will be appended to the path (e.g. v1/traces or v1/metrics) and the default port will be `OtlpExporterRuntimeConfig++#++DEFAULT_HTTP_BASE_URI`. +Client name ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_ENDPOINT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_CLIENT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_ENDPOINT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_CLIENT_NAME+++` endif::add-copy-button-to-env-var[] -- |string -|`http://localhost:4317/` +| -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-headers]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-headers[`quarkus.otel.exporter.otlp.headers`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-redirect-uri]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-redirect-uri[`quarkus.oidc-client-registration."id".metadata.redirect-uri`]## [.description] -- -Key-value pairs to be used as headers associated with exporter requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the "=" character. i.e.: key1=value1,key2=value2 - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..headers` where is one of the supported signal types, like `traces` or `metrics`. +Redirect URI ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_HEADERS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_REDIRECT_URI+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_HEADERS+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_REDIRECT_URI+++` endif::add-copy-button-to-env-var[] -- -|list of string +|string | -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-compression]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-compression[`quarkus.otel.exporter.otlp.compression`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-post-logout-uri]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-post-logout-uri[`quarkus.oidc-client-registration."id".metadata.post-logout-uri`]## [.description] -- -Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`. - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..compression` where is one of the supported signal types, like `traces` or `metrics`. +Post Logout URI ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_COMPRESSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_POST_LOGOUT_URI+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_COMPRESSION+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_POST_LOGOUT_URI+++` endif::add-copy-button-to-env-var[] -- -a|`gzip`, `none` +|string | -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-timeout[`quarkus.otel.exporter.otlp.timeout`]## +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-extra-props-extra-props]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-extra-props-extra-props[`quarkus.oidc-client-registration."id".metadata.extra-props."extra-props"`]## [.description] -- -Sets the maximum time to wait for the collector to process an exported batch of telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s. - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..timeout` where is one of the supported signal types, like `traces` or `metrics`. +Additional metadata properties ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_EXTRA_PROPS__EXTRA_PROPS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TIMEOUT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_EXTRA_PROPS__EXTRA_PROPS_+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10s` +|Map +| + -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-protocol[`quarkus.otel.exporter.otlp.protocol`]## + +h|[.extension-name]##OpenTelemetry## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-enabled[`quarkus.otel.enabled`]## [.description] -- -OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different. - -Currently, only `grpc` and `http/protobuf` are allowed. +If false, disable the OpenTelemetry usage at build time. All other Otel properties will be ignored at runtime. -Please mind that changing the protocol requires changing the port in the endpoint as well. +Will pick up value from legacy property quarkus.opentelemetry.enabled -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..protocol` where is one of the supported signal types, like `traces` or `metrics`. +Defaults to `true`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_PROTOCOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_PROTOCOL+++` +Environment variable: `+++QUARKUS_OTEL_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -|`grpc` +|boolean +|`true` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-key-cert-keys]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-key-cert-keys[`quarkus.otel.exporter.otlp.key-cert.keys`]## +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-traces-exporter]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-exporter[`quarkus.otel.traces.exporter`]## [.description] -- -Comma-separated list of the path to the key files (Pem format). +List of exporters supported by Quarkus. + +List of exporters to be used for tracing, separated by commas. Has one of the values on `ExporterType` `otlp`, `cdi`, `none` or the full qualified name of a class implementing `io.opentelemetry.sdk.trace.export.SpanExporter` + +Default on Quarkus is `ExporterType.Constants++#++CDI_VALUE`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_KEY_CERT_KEYS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_EXPORTER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_KEY_CERT_KEYS+++` +Environment variable: `+++QUARKUS_OTEL_TRACES_EXPORTER+++` endif::add-copy-button-to-env-var[] -- |list of string -| +|`cdi` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-key-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-key-cert-certs[`quarkus.otel.exporter.otlp.key-cert.certs`]## +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-traces-sampler]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-sampler[`quarkus.otel.traces.sampler`]## [.description] -- -Comma-separated list of the path to the certificate files (Pem format). +The sampler to use for tracing. + +Has one of the values on `SamplerType` `always_on`, `always_off`, `traceidratio`, `parentbased_always_on`, `parentbased_always_off`, `parentbased_traceidratio` or the Sampler SPI name. This will use the OTel SPI hooks for the `io.opentelemetry.sdk.trace.samplers.Sampler` implementation set in the provider: `io.opentelemetry.sdk.autoconfigure.spi.traces.ConfigurableSamplerProvider`. + +Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.sampler.name` or defaults to `SamplerType.Constants++#++PARENT_BASED_ALWAYS_ON`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_KEY_CERT_CERTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_SAMPLER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_KEY_CERT_CERTS+++` +Environment variable: `+++QUARKUS_OTEL_TRACES_SAMPLER+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|string +|`parentbased_always_on` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-trust-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-trust-cert-certs[`quarkus.otel.exporter.otlp.trust-cert.certs`]## +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-traces-eusp-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-eusp-enabled[`quarkus.otel.traces.eusp.enabled`]## [.description] -- -Comma-separated list of the trust certificate files (Pem format). +If OpenTelemetry End User attributes should be added as Span attributes on a best-efforts basis. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRUST_CERT_CERTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRUST_CERT_CERTS+++` +Environment variable: `+++QUARKUS_OTEL_TRACES_EUSP_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|boolean +|`false` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-tls-configuration-name]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-tls-configuration-name[`quarkus.otel.exporter.otlp.tls-configuration-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-metrics-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-metrics-enabled[`quarkus.otel.metrics.enabled`]## [.description] -- -The name of the TLS configuration to use. +Enable metrics with OpenTelemetry. -If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. +This property is not available in the Open Telemetry SDK. It's Quarkus specific. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..tls-configuration-name` where is one of the supported signal types, like `traces` or `metrics`. +Support for metrics will be enabled if OpenTelemetry support is enabled and either this value is true, or this value is unset. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TLS_CONFIGURATION_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_METRICS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TLS_CONFIGURATION_NAME+++` +Environment variable: `+++QUARKUS_OTEL_METRICS_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-enabled[`quarkus.otel.exporter.otlp.proxy-options.enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-metrics-exporter]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-metrics-exporter[`quarkus.otel.metrics.exporter`]## [.description] -- -If proxy connection must be used. - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.enabled` where is one of the supported signal types, like `traces` or `metrics`. +The Metrics exporter to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_METRICS_EXPORTER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_ENABLED+++` +Environment variable: `+++QUARKUS_OTEL_METRICS_EXPORTER+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|list of string +|`cdi` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-username]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-username[`quarkus.otel.exporter.otlp.proxy-options.username`]## +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-logs-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-logs-enabled[`quarkus.otel.logs.enabled`]## [.description] -- -Set proxy username. +Enable logs with OpenTelemetry. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.username` where is one of the supported signal types, like `traces` or `metrics`. +This property is not available in the Open Telemetry SDK. It's Quarkus specific. + +Support for logs will be enabled if OpenTelemetry support is enabled and either this value is true, or this value is unset. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_USERNAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_LOGS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_USERNAME+++` +Environment variable: `+++QUARKUS_OTEL_LOGS_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -| - -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-password]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-password[`quarkus.otel.exporter.otlp.proxy-options.password`]## +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-logs-exporter]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-logs-exporter[`quarkus.otel.logs.exporter`]## [.description] -- -Set proxy password. - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.password` where is one of the supported signal types, like `traces` or `metrics`. +The Logs exporter to use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_LOGS_EXPORTER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_PASSWORD+++` +Environment variable: `+++QUARKUS_OTEL_LOGS_EXPORTER+++` endif::add-copy-button-to-env-var[] -- -|string -| +|list of string +|`cdi` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-port]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-port[`quarkus.otel.exporter.otlp.proxy-options.port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-propagators]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-propagators[`quarkus.otel.propagators`]## [.description] -- -Set proxy port. +The propagators to be used. Use a comma-separated list for multiple propagators. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.port` where is one of the supported signal types, like `traces` or `metrics`. +Has values from `PropagatorType` or the full qualified name of a class implementing `io.opentelemetry.context.propagation.TextMapPropagator`. + +Default is `PropagatorType.Constants++#++TRACE_CONTEXT`,`PropagatorType.Constants++#++BAGGAGE` (W3C). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_PROPAGATORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_PORT+++` +Environment variable: `+++QUARKUS_OTEL_PROPAGATORS+++` endif::add-copy-button-to-env-var[] -- -|int -| +|list of string +|`tracecontext,baggage` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-host]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-host[`quarkus.otel.exporter.otlp.proxy-options.host`]## +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-instrument-grpc]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-grpc[`quarkus.otel.instrument.grpc`]## [.description] -- -Set proxy host. - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.host` where is one of the supported signal types, like `traces` or `metrics`. +Enables instrumentation for gRPC. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_HOST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_GRPC+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_HOST+++` +Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_GRPC+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`true` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-endpoint]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-endpoint[`quarkus.otel.exporter.otlp.traces.endpoint`]## +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-instrument-messaging]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-messaging[`quarkus.otel.instrument.messaging`]## [.description] -- -Sets the OTLP endpoint to send telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`. - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..endpoint` where is one of the supported signal types, like `traces` or `metrics`. - -If protocol is `http/protobuf` the version and signal will be appended to the path (e.g. v1/traces or v1/metrics) and the default port will be `OtlpExporterRuntimeConfig++#++DEFAULT_HTTP_BASE_URI`. +Enables instrumentation for Messaging. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_ENDPOINT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_MESSAGING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_ENDPOINT+++` +Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_MESSAGING+++` endif::add-copy-button-to-env-var[] -- -|string -|`http://localhost:4317/` +|boolean +|`true` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-headers]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-headers[`quarkus.otel.exporter.otlp.traces.headers`]## +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-instrument-resteasy-client]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-resteasy-client[`quarkus.otel.instrument.resteasy-client`]## [.description] -- -Key-value pairs to be used as headers associated with exporter requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the "=" character. i.e.: key1=value1,key2=value2 - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..headers` where is one of the supported signal types, like `traces` or `metrics`. +Enables instrumentation for REST Client backed by RESTEasy Classic. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_HEADERS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_RESTEASY_CLIENT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_HEADERS+++` +Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_RESTEASY_CLIENT+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|boolean +|`true` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-compression]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-compression[`quarkus.otel.exporter.otlp.traces.compression`]## +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-instrument-rest]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-rest[`quarkus.otel.instrument.rest`]## [.description] -- -Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`. - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..compression` where is one of the supported signal types, like `traces` or `metrics`. +Enables instrumentation for Quarkus REST. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_COMPRESSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_REST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_COMPRESSION+++` +Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_REST+++` endif::add-copy-button-to-env-var[] -- -a|`gzip`, `none` -| +|boolean +|`true` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-timeout[`quarkus.otel.exporter.otlp.traces.timeout`]## +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-instrument-resteasy]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-resteasy[`quarkus.otel.instrument.resteasy`]## [.description] -- -Sets the maximum time to wait for the collector to process an exported batch of telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s. - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..timeout` where is one of the supported signal types, like `traces` or `metrics`. +Enables instrumentation for RESTEasy Classic. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_RESTEASY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TIMEOUT+++` +Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_RESTEASY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10s` +|boolean +|`true` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-protocol[`quarkus.otel.exporter.otlp.traces.protocol`]## +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-security-events-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-security-events-enabled[`quarkus.otel.security-events.enabled`]## [.description] -- -OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different. +Whether exporting of the security events is enabled. -Currently, only `grpc` and `http/protobuf` are allowed. -Please mind that changing the protocol requires changing the port in the endpoint as well. +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SECURITY_EVENTS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_SECURITY_EVENTS_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..protocol` where is one of the supported signal types, like `traces` or `metrics`. +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-security-events-event-types]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-security-events-event-types[`quarkus.otel.security-events.event-types`]## + +[.description] +-- +Selects security event types. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROTOCOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SECURITY_EVENTS_EVENT_TYPES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROTOCOL+++` +Environment variable: `+++QUARKUS_OTEL_SECURITY_EVENTS_EVENT_TYPES+++` endif::add-copy-button-to-env-var[] -- -|string -|`grpc` +a|list of `all`, `authentication-success`, `authentication-failure`, `authorization-success`, `authorization-failure`, `other` +|`all` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-key-cert-keys]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-key-cert-keys[`quarkus.otel.exporter.otlp.traces.key-cert.keys`]## +a| [[quarkus-opentelemetry_quarkus-otel-sdk-disabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-sdk-disabled[`quarkus.otel.sdk.disabled`]## [.description] -- -Comma-separated list of the path to the key files (Pem format). +If true, disable the OpenTelemetry SDK. Runtime configuration. + +Defaults to `false`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_KEY_CERT_KEYS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SDK_DISABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_KEY_CERT_KEYS+++` +Environment variable: `+++QUARKUS_OTEL_SDK_DISABLED+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|boolean +|`false` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-key-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-key-cert-certs[`quarkus.otel.exporter.otlp.traces.key-cert.certs`]## +a| [[quarkus-opentelemetry_quarkus-otel-traces-suppress-non-application-uris]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-suppress-non-application-uris[`quarkus.otel.traces.suppress-non-application-uris`]## [.description] -- -Comma-separated list of the path to the certificate files (Pem format). +Suppress non-application uris from trace collection. This will suppress tracing of `/q` endpoints. + +Providing a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting. + +This is a Quarkus specific property. Suppressing non-application uris is enabled by default. + +Fallbacks to the legacy property `quarkus.opentelemetry.tracer.suppress-non-application-uris` or defaults to `true`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_KEY_CERT_CERTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_SUPPRESS_NON_APPLICATION_URIS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_KEY_CERT_CERTS+++` +Environment variable: `+++QUARKUS_OTEL_TRACES_SUPPRESS_NON_APPLICATION_URIS+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|boolean +|`true` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-trust-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-trust-cert-certs[`quarkus.otel.exporter.otlp.traces.trust-cert.certs`]## +a| [[quarkus-opentelemetry_quarkus-otel-traces-include-static-resources]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-include-static-resources[`quarkus.otel.traces.include-static-resources`]## [.description] -- -Comma-separated list of the trust certificate files (Pem format). +Include static resources from trace collection. + +This is a Quarkus specific property. Include static resources is disabled by default. Providing a custom `io.opentelemetry.sdk.trace.samplers.Sampler` CDI Bean will ignore this setting. + +Fallbacks to the legacy property `quarkus.opentelemetry.tracer.include-static-resources` or defaults to `false`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TRUST_CERT_CERTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_INCLUDE_STATIC_RESOURCES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TRUST_CERT_CERTS+++` +Environment variable: `+++QUARKUS_OTEL_TRACES_INCLUDE_STATIC_RESOURCES+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|boolean +|`false` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-tls-configuration-name]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-tls-configuration-name[`quarkus.otel.exporter.otlp.traces.tls-configuration-name`]## +a| [[quarkus-opentelemetry_quarkus-otel-traces-sampler-arg]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-traces-sampler-arg[`quarkus.otel.traces.sampler.arg`]## [.description] -- -The name of the TLS configuration to use. +Sampler argument. Depends on the `quarkus.otel.traces.sampler` property. Fallbacks to the legacy property `quarkus.opentelemetry.tracer.sampler.ratio`. -If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. +When setting the stock sampler to `traceidratio` or `parentbased_traceidratio` you need to set a `double` compatible value between `0.0d` and `1.0d`, like `0.01d` or `0.5d`. It is kept as a `String` to allow the flexible customisation of alternative samplers. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..tls-configuration-name` where is one of the supported signal types, like `traces` or `metrics`. +Defaults to `1.0d`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++` +Environment variable: `+++QUARKUS_OTEL_TRACES_SAMPLER_ARG+++` endif::add-copy-button-to-env-var[] -- |string -| +|`1.0d` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-enabled[`quarkus.otel.exporter.otlp.traces.proxy-options.enabled`]## +a| [[quarkus-opentelemetry_quarkus-otel-metric-export-interval]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-metric-export-interval[`quarkus.otel.metric.export.interval`]## [.description] -- -If proxy connection must be used. +The interval, between the start of two metric export attempts. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.enabled` where is one of the supported signal types, like `traces` or `metrics`. +Default is 1min. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_METRIC_EXPORT_INTERVAL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_ENABLED+++` +Environment variable: `+++QUARKUS_OTEL_METRIC_EXPORT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`60S` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-username]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-username[`quarkus.otel.exporter.otlp.traces.proxy-options.username`]## +a| [[quarkus-opentelemetry_quarkus-otel-logs-handler-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-logs-handler-enabled[`quarkus.otel.logs.handler.enabled`]## [.description] -- -Set proxy username. +Determine whether to enable the OpenTelemetry logging handler. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.username` where is one of the supported signal types, like `traces` or `metrics`. +This is a Quarkus specific property. The OpenTelemetry logging handler is enabled by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_USERNAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_LOGS_HANDLER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_USERNAME+++` +Environment variable: `+++QUARKUS_OTEL_LOGS_HANDLER_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`true` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-password]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-password[`quarkus.otel.exporter.otlp.traces.proxy-options.password`]## +a| [[quarkus-opentelemetry_quarkus-otel-attribute-value-length-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-attribute-value-length-limit[`quarkus.otel.attribute.value.length.limit`]## [.description] -- -Set proxy password. +The maximum length of attribute values. Applies to spans and logs. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.password` where is one of the supported signal types, like `traces` or `metrics`. +By default, there is no limit. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_PASSWORD+++` +Environment variable: `+++QUARKUS_OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-port]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-port[`quarkus.otel.exporter.otlp.traces.proxy-options.port`]## +a| [[quarkus-opentelemetry_quarkus-otel-attribute-count-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-attribute-count-limit[`quarkus.otel.attribute.count.limit`]## [.description] -- -Set proxy port. +The maximum number of attributes. Applies to spans, span events, span links, and logs. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.port` where is one of the supported signal types, like `traces` or `metrics`. +Default is `128`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_ATTRIBUTE_COUNT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_PORT+++` +Environment variable: `+++QUARKUS_OTEL_ATTRIBUTE_COUNT_LIMIT+++` endif::add-copy-button-to-env-var[] -- |int -| +|`128` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-host]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-host[`quarkus.otel.exporter.otlp.traces.proxy-options.host`]## +a| [[quarkus-opentelemetry_quarkus-otel-span-attribute-value-length-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-span-attribute-value-length-limit[`quarkus.otel.span.attribute.value.length.limit`]## [.description] -- -Set proxy host. +The maximum length of span attribute values. Takes precedence over `otel.attribute.value.length.limit`. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.host` where is one of the supported signal types, like `traces` or `metrics`. +By default, there is no limit. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_HOST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_HOST+++` +Environment variable: `+++QUARKUS_OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-endpoint]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-endpoint[`quarkus.otel.exporter.otlp.metrics.endpoint`]## +a| [[quarkus-opentelemetry_quarkus-otel-span-attribute-count-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-span-attribute-count-limit[`quarkus.otel.span.attribute.count.limit`]## [.description] -- -Sets the OTLP endpoint to send telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`. - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..endpoint` where is one of the supported signal types, like `traces` or `metrics`. +The maximum number of attributes per span. Takes precedence over `otel.attribute.count.limit`. -If protocol is `http/protobuf` the version and signal will be appended to the path (e.g. v1/traces or v1/metrics) and the default port will be `OtlpExporterRuntimeConfig++#++DEFAULT_HTTP_BASE_URI`. +Default is `128`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_ENDPOINT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_ENDPOINT+++` +Environment variable: `+++QUARKUS_OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT+++` endif::add-copy-button-to-env-var[] -- -|string -|`http://localhost:4317/` +|int +|`128` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-headers]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-headers[`quarkus.otel.exporter.otlp.metrics.headers`]## +a| [[quarkus-opentelemetry_quarkus-otel-span-event-count-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-span-event-count-limit[`quarkus.otel.span.event.count.limit`]## [.description] -- -Key-value pairs to be used as headers associated with exporter requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the "=" character. i.e.: key1=value1,key2=value2 +The maximum number of events per span. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..headers` where is one of the supported signal types, like `traces` or `metrics`. +Default is `128`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_HEADERS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SPAN_EVENT_COUNT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_HEADERS+++` +Environment variable: `+++QUARKUS_OTEL_SPAN_EVENT_COUNT_LIMIT+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|int +|`128` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-compression]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-compression[`quarkus.otel.exporter.otlp.metrics.compression`]## +a| [[quarkus-opentelemetry_quarkus-otel-span-link-count-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-span-link-count-limit[`quarkus.otel.span.link.count.limit`]## [.description] -- -Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`. +The maximum number of links per span. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..compression` where is one of the supported signal types, like `traces` or `metrics`. +Default is `128`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_COMPRESSION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SPAN_LINK_COUNT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_COMPRESSION+++` +Environment variable: `+++QUARKUS_OTEL_SPAN_LINK_COUNT_LIMIT+++` endif::add-copy-button-to-env-var[] -- -a|`gzip`, `none` -| +|int +|`128` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-timeout[`quarkus.otel.exporter.otlp.metrics.timeout`]## +a| [[quarkus-opentelemetry_quarkus-otel-bsp-schedule-delay]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-bsp-schedule-delay[`quarkus.otel.bsp.schedule.delay`]## [.description] -- -Sets the maximum time to wait for the collector to process an exported batch of telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s. +The interval, in milliseconds, between two consecutive exports. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..timeout` where is one of the supported signal types, like `traces` or `metrics`. +Default is `5000`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BSP_SCHEDULE_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TIMEOUT+++` +Environment variable: `+++QUARKUS_OTEL_BSP_SCHEDULE_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10s` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`5S` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-protocol[`quarkus.otel.exporter.otlp.metrics.protocol`]## +a| [[quarkus-opentelemetry_quarkus-otel-bsp-max-queue-size]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-bsp-max-queue-size[`quarkus.otel.bsp.max.queue.size`]## [.description] -- -OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different. - -Currently, only `grpc` and `http/protobuf` are allowed. - -Please mind that changing the protocol requires changing the port in the endpoint as well. +The maximum queue size. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..protocol` where is one of the supported signal types, like `traces` or `metrics`. +Default is `2048`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROTOCOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BSP_MAX_QUEUE_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROTOCOL+++` +Environment variable: `+++QUARKUS_OTEL_BSP_MAX_QUEUE_SIZE+++` endif::add-copy-button-to-env-var[] -- -|string -|`grpc` +|int +|`2048` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-key-cert-keys]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-key-cert-keys[`quarkus.otel.exporter.otlp.metrics.key-cert.keys`]## +a| [[quarkus-opentelemetry_quarkus-otel-bsp-max-export-batch-size]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-bsp-max-export-batch-size[`quarkus.otel.bsp.max.export.batch.size`]## [.description] -- -Comma-separated list of the path to the key files (Pem format). +The maximum batch size. + +Default is `512`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_KEY_CERT_KEYS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BSP_MAX_EXPORT_BATCH_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_KEY_CERT_KEYS+++` +Environment variable: `+++QUARKUS_OTEL_BSP_MAX_EXPORT_BATCH_SIZE+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|int +|`512` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-key-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-key-cert-certs[`quarkus.otel.exporter.otlp.metrics.key-cert.certs`]## +a| [[quarkus-opentelemetry_quarkus-otel-bsp-export-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-bsp-export-timeout[`quarkus.otel.bsp.export.timeout`]## [.description] -- -Comma-separated list of the path to the certificate files (Pem format). +The maximum allowed time, in milliseconds, to export data. + +Default is `30s`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_KEY_CERT_CERTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BSP_EXPORT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_KEY_CERT_CERTS+++` +Environment variable: `+++QUARKUS_OTEL_BSP_EXPORT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`30S` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-trust-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-trust-cert-certs[`quarkus.otel.exporter.otlp.metrics.trust-cert.certs`]## +a| [[quarkus-opentelemetry_quarkus-otel-blrp-schedule-delay]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-blrp-schedule-delay[`quarkus.otel.blrp.schedule.delay`]## [.description] -- -Comma-separated list of the trust certificate files (Pem format). +The interval, in milliseconds, between two consecutive exports. + +Default is `1000`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TRUST_CERT_CERTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BLRP_SCHEDULE_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TRUST_CERT_CERTS+++` +Environment variable: `+++QUARKUS_OTEL_BLRP_SCHEDULE_DELAY+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`1S` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-tls-configuration-name]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-tls-configuration-name[`quarkus.otel.exporter.otlp.metrics.tls-configuration-name`]## +a| [[quarkus-opentelemetry_quarkus-otel-blrp-max-queue-size]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-blrp-max-queue-size[`quarkus.otel.blrp.max.queue.size`]## [.description] -- -The name of the TLS configuration to use. - -If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. +The maximum queue size. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..tls-configuration-name` where is one of the supported signal types, like `traces` or `metrics`. +Default is `2048`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TLS_CONFIGURATION_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BLRP_MAX_QUEUE_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TLS_CONFIGURATION_NAME+++` +Environment variable: `+++QUARKUS_OTEL_BLRP_MAX_QUEUE_SIZE+++` endif::add-copy-button-to-env-var[] -- -|string -| +|int +|`2048` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-enabled[`quarkus.otel.exporter.otlp.metrics.proxy-options.enabled`]## +a| [[quarkus-opentelemetry_quarkus-otel-blrp-max-export-batch-size]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-blrp-max-export-batch-size[`quarkus.otel.blrp.max.export.batch.size`]## [.description] -- -If proxy connection must be used. +The maximum batch size. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.enabled` where is one of the supported signal types, like `traces` or `metrics`. +Default is `512`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BLRP_MAX_EXPORT_BATCH_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_ENABLED+++` +Environment variable: `+++QUARKUS_OTEL_BLRP_MAX_EXPORT_BATCH_SIZE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|int +|`512` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-username]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-username[`quarkus.otel.exporter.otlp.metrics.proxy-options.username`]## +a| [[quarkus-opentelemetry_quarkus-otel-blrp-export-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-blrp-export-timeout[`quarkus.otel.blrp.export.timeout`]## [.description] -- -Set proxy username. +The maximum allowed time, in milliseconds, to export data. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.username` where is one of the supported signal types, like `traces` or `metrics`. +Default is `30s`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_USERNAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BLRP_EXPORT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_USERNAME+++` +Environment variable: `+++QUARKUS_OTEL_BLRP_EXPORT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|string -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`30S` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-password]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-password[`quarkus.otel.exporter.otlp.metrics.proxy-options.password`]## +a| [[quarkus-opentelemetry_quarkus-otel-resource-attributes]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-resource-attributes[`quarkus.otel.resource.attributes`]## [.description] -- -Set proxy password. - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.password` where is one of the supported signal types, like `traces` or `metrics`. +Specify resource attributes in the following format: `key1=val1,key2=val2,key3=val3`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_RESOURCE_ATTRIBUTES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_PASSWORD+++` +Environment variable: `+++QUARKUS_OTEL_RESOURCE_ATTRIBUTES+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-port]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-port[`quarkus.otel.exporter.otlp.metrics.proxy-options.port`]## +a| [[quarkus-opentelemetry_quarkus-otel-service-name]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-service-name[`quarkus.otel.service.name`]## [.description] -- -Set proxy port. +Specify logical service name. Takes precedence over service.name defined with otel.resource.attributes and from quarkus.application.name. -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.port` where is one of the supported signal types, like `traces` or `metrics`. +Defaults to `quarkus.application.name`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_PORT+++` +Environment variable: `+++QUARKUS_OTEL_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] -- -|int -| +|string +|`${quarkus.application.name:unset}` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-host]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-host[`quarkus.otel.exporter.otlp.metrics.proxy-options.host`]## +a| [[quarkus-opentelemetry_quarkus-otel-experimental-resource-disabled-keys]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-experimental-resource-disabled-keys[`quarkus.otel.experimental.resource.disabled-keys`]## [.description] -- -Set proxy host. - -There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.host` where is one of the supported signal types, like `traces` or `metrics`. +Specify resource attribute keys that are filtered. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_HOST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPERIMENTAL_RESOURCE_DISABLED_KEYS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_HOST+++` +Environment variable: `+++QUARKUS_OTEL_EXPERIMENTAL_RESOURCE_DISABLED_KEYS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-temporality-preference]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-temporality-preference[`quarkus.otel.exporter.otlp.metrics.temporality-preference`]## +a| [[quarkus-opentelemetry_quarkus-otel-experimental-shutdown-wait-time]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-experimental-shutdown-wait-time[`quarkus.otel.experimental.shutdown-wait-time`]## [.description] -- -The preferred output aggregation temporality. Options include DELTA, LOWMEMORY, and CUMULATIVE. - -If CUMULATIVE, all instruments will have cumulative temporality. If DELTA, counter (sync and async) and histograms will be delta, up down counters (sync and async) will be cumulative. If LOWMEMORY, sync counter and histograms will be delta, async counter and up down counters (sync and async) will be cumulative. - -Default is CUMULATIVE. +The maximum amount of time Quarkus will wait for the OpenTelemetry SDK to flush unsent spans and shutdown. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPERIMENTAL_SHUTDOWN_WAIT_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE+++` +Environment variable: `+++QUARKUS_OTEL_EXPERIMENTAL_SHUTDOWN_WAIT_TIME+++` endif::add-copy-button-to-env-var[] -- -|string -|`cumulative` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`2S` -a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-default-histogram-aggregation]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-default-histogram-aggregation[`quarkus.otel.exporter.otlp.metrics.default-histogram-aggregation`]## +a| [[quarkus-opentelemetry_quarkus-otel-instrument-vertx-http]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-vertx-http[`quarkus.otel.instrument.vertx-http`]## [.description] -- -The preferred default histogram aggregation. - -Options include BASE2_EXPONENTIAL_BUCKET_HISTOGRAM and EXPLICIT_BUCKET_HISTOGRAM. - -Default is EXPLICIT_BUCKET_HISTOGRAM. +Enables instrumentation for Vert.x HTTP. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_VERTX_HTTP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION+++` +Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_VERTX_HTTP+++` endif::add-copy-button-to-env-var[] -- -|string -|`explicit_bucket_histogram` - - -h|[.extension-name]##Picocli## -h|Type -h|Default +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-picocli_quarkus-picocli-native-image-processing-enable]] [.property-path]##link:#quarkus-picocli_quarkus-picocli-native-image-processing-enable[`quarkus.picocli.native-image.processing.enable`]## +a| [[quarkus-opentelemetry_quarkus-otel-instrument-vertx-event-bus]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-vertx-event-bus[`quarkus.otel.instrument.vertx-event-bus`]## [.description] -- -Set this to false to use the `picocli-codegen` annotation processor instead of build steps. - -CAUTION: this will have serious build-time performance impact since this is run on every restart in dev mode, use with care! - -This property is intended to be used only in cases where an incompatible change in the picocli library causes problems in the build steps used to support GraalVM Native images. - -In such cases this property allows users to make the trade-off between fast build cycles with the older version of picocli, and temporarily accept slower build cycles with the latest version of picocli until the updated extension is available. +Enables instrumentation for Vert.x Event Bus. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PICOCLI_NATIVE_IMAGE_PROCESSING_ENABLE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_VERTX_EVENT_BUS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PICOCLI_NATIVE_IMAGE_PROCESSING_ENABLE+++` +Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_VERTX_EVENT_BUS+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` -a| [[quarkus-picocli_quarkus-picocli-top-command]] [.property-path]##link:#quarkus-picocli_quarkus-picocli-top-command[`quarkus.picocli.top-command`]## +a| [[quarkus-opentelemetry_quarkus-otel-instrument-vertx-sql-client]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-vertx-sql-client[`quarkus.otel.instrument.vertx-sql-client`]## [.description] -- -Name of bean annotated with `io.quarkus.picocli.runtime.annotations.TopCommand` or FQCN of class which will be used as entry point for Picocli CommandLine instance. This class needs to be annotated with `picocli.CommandLine.Command`. +Enables instrumentation for Vert.x SQL Client. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_PICOCLI_TOP_COMMAND+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_VERTX_SQL_CLIENT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_PICOCLI_TOP_COMMAND+++` +Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_VERTX_SQL_CLIENT+++` endif::add-copy-button-to-env-var[] -- -|string -| - - -h|[.extension-name]##Quarkus - Vert.x GraphQL## -h|Type -h|Default +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-graphql_quarkus-vertx-graphql-ui-always-include]] [.property-path]##link:#quarkus-vertx-graphql_quarkus-vertx-graphql-ui-always-include[`quarkus.vertx-graphql.ui.always-include`]## +a| [[quarkus-opentelemetry_quarkus-otel-instrument-vertx-redis-client]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-vertx-redis-client[`quarkus.otel.instrument.vertx-redis-client`]## [.description] -- -If GraphQL UI should be included every time. By default, this is only included when the application is running in dev mode. +Enables instrumentation for Vert.x Redis Client. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_VERTX_GRAPHQL_UI_ALWAYS_INCLUDE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENT_VERTX_REDIS_CLIENT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_VERTX_GRAPHQL_UI_ALWAYS_INCLUDE+++` +Environment variable: `+++QUARKUS_OTEL_INSTRUMENT_VERTX_REDIS_CLIENT+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-vertx-graphql_quarkus-vertx-graphql-ui-path]] [.property-path]##link:#quarkus-vertx-graphql_quarkus-vertx-graphql-ui-path[`quarkus.vertx-graphql.ui.path`]## +a| [[quarkus-opentelemetry_quarkus-otel-mp-compatibility]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-mp-compatibility[`quarkus.otel.mp.compatibility`]## [.description] -- -The path where GraphQL UI is available. +Prioritize OpenTelemetry configuration `otel.` on top of Quarkus OpenTelemetry configuration `quarkus.otel`. -The value `/` is not allowed as it blocks the application from serving anything else. +By default, Quarkus configuration has priority over OpenTelemetry configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_VERTX_GRAPHQL_UI_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_MP_COMPATIBILITY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_VERTX_GRAPHQL_UI_PATH+++` +Environment variable: `+++QUARKUS_OTEL_MP_COMPATIBILITY+++` endif::add-copy-button-to-env-var[] -- -|string -|`graphql-ui` - - -h|[.extension-name]##Quarkus Extension for Spring Cloud Config Client## -h|Type -h|Default +|boolean +|`false` -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-enabled]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-enabled[`quarkus.spring-cloud-config.enabled`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-endpoint]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-endpoint[`quarkus.otel.exporter.otlp.endpoint`]## [.description] -- -If enabled, will try to read the configuration from a Spring Cloud Config Server +Sets the OTLP endpoint to send telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..endpoint` where is one of the supported signal types, like `traces` or `metrics`. + +If protocol is `http/protobuf` the version and signal will be appended to the path (e.g. v1/traces or v1/metrics) and the default port will be `OtlpExporterRuntimeConfig++#++DEFAULT_HTTP_BASE_URI`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_ENABLED+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_ENDPOINT+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +|`http://localhost:4317/` -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-fail-fast]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-fail-fast[`quarkus.spring-cloud-config.fail-fast`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-headers]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-headers[`quarkus.otel.exporter.otlp.headers`]## [.description] -- -If set to true, the application will not stand up if it cannot obtain configuration from the Config Server +Key-value pairs to be used as headers associated with exporter requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the "=" character. i.e.: key1=value1,key2=value2 + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..headers` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_FAIL_FAST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_HEADERS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_FAIL_FAST+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_HEADERS+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|list of string +| -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-url]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-url[`quarkus.spring-cloud-config.url`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-compression]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-compression[`quarkus.otel.exporter.otlp.compression`]## [.description] -- -The Base URI where the Spring Cloud Config Server is available +Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..compression` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_URL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_COMPRESSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_URL+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_COMPRESSION+++` endif::add-copy-button-to-env-var[] -- -|string -|`http://localhost:8888` +a|`gzip`, `none` +| -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-name]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-name[`quarkus.spring-cloud-config.name`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-timeout[`quarkus.otel.exporter.otlp.timeout`]## [.description] -- -Name of the application on Spring Cloud Config server. Could be a list of names to load multiple files (value separated by a comma) +Sets the maximum time to wait for the collector to process an exported batch of telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..timeout` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_NAME+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|string -|`${quarkus.application.name:}` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10s` -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-label]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-label[`quarkus.spring-cloud-config.label`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-protocol[`quarkus.otel.exporter.otlp.protocol`]## [.description] -- -The label to be used to pull remote configuration properties. The default is set on the Spring Cloud Config Server (generally "master" when the server uses a Git backend). +OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different. + +Currently, only `grpc` and `http/protobuf` are allowed. + +Please mind that changing the protocol requires changing the port in the endpoint as well. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..protocol` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_LABEL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_LABEL+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_PROTOCOL+++` endif::add-copy-button-to-env-var[] -- |string -| +|`grpc` -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-connection-timeout]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-connection-timeout[`quarkus.spring-cloud-config.connection-timeout`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-key-cert-keys]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-key-cert-keys[`quarkus.otel.exporter.otlp.key-cert.keys`]## [.description] -- -The amount of time to wait when initially establishing a connection before giving up and timing out. - -Specify `0` to wait indefinitely. +Comma-separated list of the path to the key files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_CONNECTION_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_KEY_CERT_KEYS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_CONNECTION_TIMEOUT+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_KEY_CERT_KEYS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` +|list of string +| -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-read-timeout]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-read-timeout[`quarkus.spring-cloud-config.read-timeout`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-key-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-key-cert-certs[`quarkus.otel.exporter.otlp.key-cert.certs`]## [.description] -- -The amount of time to wait for a read on a socket before an exception is thrown. - -Specify `0` to wait indefinitely. +Comma-separated list of the path to the certificate files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_READ_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_KEY_CERT_CERTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_READ_TIMEOUT+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_KEY_CERT_CERTS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`60S` +|list of string +| -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-username]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-username[`quarkus.spring-cloud-config.username`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-trust-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-trust-cert-certs[`quarkus.otel.exporter.otlp.trust-cert.certs`]## [.description] -- -The username to be used if the Config Server has BASIC Auth enabled +Comma-separated list of the trust certificate files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_USERNAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRUST_CERT_CERTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_USERNAME+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRUST_CERT_CERTS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-password]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-password[`quarkus.spring-cloud-config.password`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-tls-configuration-name]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-tls-configuration-name[`quarkus.otel.exporter.otlp.tls-configuration-name`]## [.description] -- -The password to be used if the Config Server has BASIC Auth enabled +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..tls-configuration-name` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_PASSWORD+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-trust-store]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-trust-store[`quarkus.spring-cloud-config.trust-store`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-enabled[`quarkus.otel.exporter.otlp.proxy-options.enabled`]## [.description] -- -TrustStore to be used containing the SSL certificate used by the Config server Can be either a classpath resource or a file system path +If proxy connection must be used. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.enabled` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|path -| +|boolean +|`false` -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-trust-store-password]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-trust-store-password[`quarkus.spring-cloud-config.trust-store-password`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-username]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-username[`quarkus.otel.exporter.otlp.proxy-options.username`]## [.description] -- -Password of TrustStore to be used containing the SSL certificate used by the Config server +Set proxy username. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.username` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE_PASSWORD+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_USERNAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-key-store]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-key-store[`quarkus.spring-cloud-config.key-store`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-password]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-password[`quarkus.otel.exporter.otlp.proxy-options.password`]## [.description] -- -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 +Set proxy password. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.password` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_PASSWORD+++` endif::add-copy-button-to-env-var[] -- -|path +|string | -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-key-store-password]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-key-store-password[`quarkus.spring-cloud-config.key-store-password`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-port]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-port[`quarkus.otel.exporter.otlp.proxy-options.port`]## [.description] -- -Password of KeyStore to be used containing the SSL certificate for authentication with the Config server +Set proxy port. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.port` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE_PASSWORD+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_PORT+++` endif::add-copy-button-to-env-var[] -- -|string +|int | -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-key-password]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-key-password[`quarkus.spring-cloud-config.key-password`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-host]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-proxy-options-host[`quarkus.otel.exporter.otlp.proxy-options.host`]## [.description] -- -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 +Set proxy host. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.host` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_KEY_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_KEY_PASSWORD+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_PROXY_OPTIONS_HOST+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-trust-certs]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-trust-certs[`quarkus.spring-cloud-config.trust-certs`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-endpoint]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-endpoint[`quarkus.otel.exporter.otlp.traces.endpoint`]## [.description] -- -When using HTTPS and no keyStore has been specified, whether to trust all certificates +Sets the OTLP endpoint to send telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..endpoint` where is one of the supported signal types, like `traces` or `metrics`. + +If protocol is `http/protobuf` the version and signal will be appended to the path (e.g. v1/traces or v1/metrics) and the default port will be `OtlpExporterRuntimeConfig++#++DEFAULT_HTTP_BASE_URI`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_TRUST_CERTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_TRUST_CERTS+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_ENDPOINT+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`${quarkus.tls.trust-all:false}` +|string +|`http://localhost:4317/` -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-headers-header-name]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-headers-header-name[`quarkus.spring-cloud-config.headers."header-name"`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-headers]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-headers[`quarkus.otel.exporter.otlp.traces.headers`]## [.description] -- -Custom headers to pass the Spring Cloud Config Server when performing the HTTP request +Key-value pairs to be used as headers associated with exporter requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the "=" character. i.e.: key1=value1,key2=value2 + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..headers` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_HEADERS__HEADER_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_HEADERS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_HEADERS__HEADER_NAME_+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_HEADERS+++` endif::add-copy-button-to-env-var[] -- -|Map +|list of string | -a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-profiles]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-profiles[`quarkus.spring-cloud-config.profiles`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-compression]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-compression[`quarkus.otel.exporter.otlp.traces.compression`]## [.description] -- -The profiles to use for lookup +Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..compression` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_PROFILES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_COMPRESSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_PROFILES+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_COMPRESSION+++` endif::add-copy-button-to-env-var[] -- -|list of string +a|`gzip`, `none` | - -h|[.extension-name]##Quartz## -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-clustered]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-clustered[`quarkus.quartz.clustered`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-timeout[`quarkus.otel.exporter.otlp.traces.timeout`]## [.description] -- -Enable cluster mode or not. +Sets the maximum time to wait for the collector to process an exported batch of telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s. -If enabled make sure to set the appropriate cluster properties. +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..timeout` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_CLUSTERED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_CLUSTERED+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10s` -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-cluster-checkin-interval]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-cluster-checkin-interval[`quarkus.quartz.cluster-checkin-interval`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-protocol[`quarkus.otel.exporter.otlp.traces.protocol`]## [.description] -- -The frequency (in milliseconds) at which the scheduler instance checks-in with other instances of the cluster. +OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different. -Ignored if using a `ram` store i.e `StoreType++#++RAM`. +Currently, only `grpc` and `http/protobuf` are allowed. + +Please mind that changing the protocol requires changing the port in the endpoint as well. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..protocol` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_CLUSTER_CHECKIN_INTERVAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_CLUSTER_CHECKIN_INTERVAL+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROTOCOL+++` endif::add-copy-button-to-env-var[] -- -|long -|`15000` +|string +|`grpc` -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-store-type]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-store-type[`quarkus.quartz.store-type`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-key-cert-keys]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-key-cert-keys[`quarkus.otel.exporter.otlp.traces.key-cert.keys`]## [.description] -- -The type of store to use. - -When using `StoreType++#++JDBC_CMT` or `StoreType++#++JDBC_TX` configuration values make sure that you have the datasource configured. See link:https://quarkus.io/guides/datasource[Configuring your datasource] for more information. - -To create Quartz tables, you can perform a schema migration via the link:https://quarkus.io/guides/flyway[Flyway extension] using a SQL script matching your database picked from link:https://github.com/quartz-scheduler/quartz/blob/master/quartz-core/src/main/resources/org/quartz/impl/jdbcjobstore[Quartz repository]. +Comma-separated list of the path to the key files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_STORE_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_KEY_CERT_KEYS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_STORE_TYPE+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_KEY_CERT_KEYS+++` endif::add-copy-button-to-env-var[] -- -a|`ram`, `jdbc-tx`, `jdbc-cmt` -|`ram` +|list of string +| -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-datasource]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-datasource[`quarkus.quartz.datasource`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-key-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-key-cert-certs[`quarkus.otel.exporter.otlp.traces.key-cert.certs`]## [.description] -- -The name of the datasource to use. - -Ignored if using a `ram` store i.e `StoreType++#++RAM`. - -Optionally needed when using the `jdbc-tx` or `jdbc-cmt` store types. If not specified, defaults to using the default datasource. +Comma-separated list of the path to the certificate files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_DATASOURCE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_KEY_CERT_CERTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_DATASOURCE+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_KEY_CERT_CERTS+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-table-prefix]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-table-prefix[`quarkus.quartz.table-prefix`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-trust-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-trust-cert-certs[`quarkus.otel.exporter.otlp.traces.trust-cert.certs`]## [.description] -- -The prefix for quartz job store tables. - -Ignored if using a `ram` store i.e `StoreType++#++RAM` +Comma-separated list of the trust certificate files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_TABLE_PREFIX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TRUST_CERT_CERTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_TABLE_PREFIX+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TRUST_CERT_CERTS+++` endif::add-copy-button-to-env-var[] -- -|string -|`QRTZ_` +|list of string +| -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-select-with-lock-sql]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-select-with-lock-sql[`quarkus.quartz.select-with-lock-sql`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-tls-configuration-name]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-tls-configuration-name[`quarkus.otel.exporter.otlp.traces.tls-configuration-name`]## [.description] -- -The SQL string that selects a row in the "LOCKS" table and places a lock on the row. - -Ignored if using a `ram` store i.e `StoreType++#++RAM`. +The name of the TLS configuration to use. -If not set, the default value of Quartz applies, for which the "++{++0++}++" is replaced during run-time with the `table-prefix`, the "++{++1++}++" with the `instance-name`. +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. -An example SQL string `SELECT ++*++ FROM ++{++0++}++LOCKS WHERE SCHED_NAME = ++{++1++}++ AND LOCK_NAME = ? FOR UPDATE` +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..tls-configuration-name` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_SELECT_WITH_LOCK_SQL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_SELECT_WITH_LOCK_SQL+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-serialize-job-data]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-serialize-job-data[`quarkus.quartz.serialize-job-data`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-enabled[`quarkus.otel.exporter.otlp.traces.proxy-options.enabled`]## [.description] -- -Instructs JDBCJobStore to serialize JobDataMaps in the BLOB column. - -Ignored if using a `ram` store i.e `StoreType++#++RAM`. - -If this is set to `true`, the JDBCJobStore will store the JobDataMaps in their serialize form in the BLOB Column. This is useful when you want to store complex JobData objects other than String. This is equivalent of setting `org.quartz.jobStore.useProperties` to `false`. *NOTE: When this option is set to `true`, all the non-String classes used in JobDataMaps have to be registered for serialization when building a native image* +If proxy connection must be used. -If this is set to `false` (the default), the values can be stored as name-value pairs rather than storing more complex objects in their serialized form in the BLOB column. This can be handy, as you avoid the class versioning issues that can arise from serializing your non-String classes into a BLOB. This is equivalent of setting `org.quartz.jobStore.useProperties` to `true`. +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.enabled` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_SERIALIZE_JOB_DATA+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_SERIALIZE_JOB_DATA+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_ENABLED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-quartz_quarkus-quartz-instance-name]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-instance-name[`quarkus.quartz.instance-name`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-username]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-username[`quarkus.otel.exporter.otlp.traces.proxy-options.username`]## [.description] -- -The name of the Quartz instance. +Set proxy username. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.username` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_INSTANCE_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_INSTANCE_NAME+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_USERNAME+++` endif::add-copy-button-to-env-var[] -- |string -|`QuarkusQuartzScheduler` +| -a| [[quarkus-quartz_quarkus-quartz-instance-id]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-instance-id[`quarkus.quartz.instance-id`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-password]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-password[`quarkus.otel.exporter.otlp.traces.proxy-options.password`]## [.description] -- -The identifier of Quartz instance that must be unique for all schedulers working as if they are the same _logical_ Scheduler within a cluster. Use the default value `AUTO` or some of the configured link:https://quarkus.io/guides/quartz#quarkus-quartz_quarkus.quartz.instance-id-generators-instance-id-generators[instance ID generators] if you wish the identifier to be generated for you. +Set proxy password. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.password` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_INSTANCE_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_INSTANCE_ID+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string -|`AUTO` +| -a| [[quarkus-quartz_quarkus-quartz-batch-trigger-acquisition-fire-ahead-time-window]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-batch-trigger-acquisition-fire-ahead-time-window[`quarkus.quartz.batch-trigger-acquisition-fire-ahead-time-window`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-port]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-port[`quarkus.otel.exporter.otlp.traces.proxy-options.port`]## [.description] -- -The amount of time in milliseconds that a trigger is allowed to be acquired and fired ahead of its scheduled fire time. +Set proxy port. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.port` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_BATCH_TRIGGER_ACQUISITION_FIRE_AHEAD_TIME_WINDOW+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_BATCH_TRIGGER_ACQUISITION_FIRE_AHEAD_TIME_WINDOW+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_PORT+++` endif::add-copy-button-to-env-var[] -- -|long -|`0` +|int +| -a| [[quarkus-quartz_quarkus-quartz-batch-trigger-acquisition-max-count]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-batch-trigger-acquisition-max-count[`quarkus.quartz.batch-trigger-acquisition-max-count`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-host]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-proxy-options-host[`quarkus.otel.exporter.otlp.traces.proxy-options.host`]## [.description] -- -The maximum number of triggers that a scheduler node is allowed to acquire (for firing) at once. +Set proxy host. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.host` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_BATCH_TRIGGER_ACQUISITION_MAX_COUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_BATCH_TRIGGER_ACQUISITION_MAX_COUNT+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_PROXY_OPTIONS_HOST+++` endif::add-copy-button-to-env-var[] -- -|int -|`1` +|string +| -a| [[quarkus-quartz_quarkus-quartz-thread-count]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-thread-count[`quarkus.quartz.thread-count`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-endpoint]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-endpoint[`quarkus.otel.exporter.otlp.metrics.endpoint`]## [.description] -- -The size of scheduler thread pool. This will initialize the number of worker threads in the pool. +Sets the OTLP endpoint to send telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..endpoint` where is one of the supported signal types, like `traces` or `metrics`. + +If protocol is `http/protobuf` the version and signal will be appended to the path (e.g. v1/traces or v1/metrics) and the default port will be `OtlpExporterRuntimeConfig++#++DEFAULT_HTTP_BASE_URI`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_THREAD_COUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_THREAD_COUNT+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_ENDPOINT+++` endif::add-copy-button-to-env-var[] -- -|int -|`25` +|string +|`http://localhost:4317/` -a| [[quarkus-quartz_quarkus-quartz-thread-priority]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-thread-priority[`quarkus.quartz.thread-priority`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-headers]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-headers[`quarkus.otel.exporter.otlp.metrics.headers`]## [.description] -- -Thread priority of worker threads in the pool. +Key-value pairs to be used as headers associated with exporter requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the "=" character. i.e.: key1=value1,key2=value2 + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..headers` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_THREAD_PRIORITY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_HEADERS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_THREAD_PRIORITY+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_HEADERS+++` endif::add-copy-button-to-env-var[] -- -|int -|`5` +|list of string +| -a| [[quarkus-quartz_quarkus-quartz-misfire-threshold]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-misfire-threshold[`quarkus.quartz.misfire-threshold`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-compression]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-compression[`quarkus.otel.exporter.otlp.metrics.compression`]## [.description] -- -Defines how late the schedulers should be to be considered misfired. +Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..compression` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_MISFIRE_THRESHOLD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_COMPRESSION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_MISFIRE_THRESHOLD+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_COMPRESSION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`60S` +a|`gzip`, `none` +| -a| [[quarkus-quartz_quarkus-quartz-shutdown-wait-time]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-shutdown-wait-time[`quarkus.quartz.shutdown-wait-time`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-timeout[`quarkus.otel.exporter.otlp.metrics.timeout`]## [.description] -- -The maximum amount of time Quarkus will wait for currently running jobs to finish. If the value is `0`, then Quarkus will not wait at all for these jobs to finish - it will call `org.quartz.Scheduler.shutdown(false)` in this case. +Sets the maximum time to wait for the collector to process an exported batch of telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..timeout` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_SHUTDOWN_WAIT_TIME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_SHUTDOWN_WAIT_TIME+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10s` -a| [[quarkus-quartz_quarkus-quartz-simple-trigger-misfire-policy]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-simple-trigger-misfire-policy[`quarkus.quartz.simple-trigger.misfire-policy`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-protocol[`quarkus.otel.exporter.otlp.metrics.protocol`]## [.description] -- -The quartz misfire policy for this job. +OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different. + +Currently, only `grpc` and `http/protobuf` are allowed. + +Please mind that changing the protocol requires changing the port in the endpoint as well. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..protocol` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_SIMPLE_TRIGGER_MISFIRE_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_SIMPLE_TRIGGER_MISFIRE_POLICY+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROTOCOL+++` endif::add-copy-button-to-env-var[] -- -a|`smart-policy`, `ignore-misfire-policy`, `fire-now`, `simple-trigger-reschedule-now-with-existing-repeat-count`, `simple-trigger-reschedule-now-with-remaining-repeat-count`, `simple-trigger-reschedule-next-with-remaining-count`, `simple-trigger-reschedule-next-with-existing-count`, `cron-trigger-do-nothing` -|`smart-policy` +|string +|`grpc` -a| [[quarkus-quartz_quarkus-quartz-cron-trigger-misfire-policy]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-cron-trigger-misfire-policy[`quarkus.quartz.cron-trigger.misfire-policy`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-key-cert-keys]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-key-cert-keys[`quarkus.otel.exporter.otlp.metrics.key-cert.keys`]## [.description] -- -The quartz misfire policy for this job. +Comma-separated list of the path to the key files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_CRON_TRIGGER_MISFIRE_POLICY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_KEY_CERT_KEYS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_CRON_TRIGGER_MISFIRE_POLICY+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_KEY_CERT_KEYS+++` endif::add-copy-button-to-env-var[] -- -a|`smart-policy`, `ignore-misfire-policy`, `fire-now`, `simple-trigger-reschedule-now-with-existing-repeat-count`, `simple-trigger-reschedule-now-with-remaining-repeat-count`, `simple-trigger-reschedule-next-with-remaining-count`, `simple-trigger-reschedule-next-with-existing-count`, `cron-trigger-do-nothing` -|`smart-policy` +|list of string +| -a| [[quarkus-quartz_quarkus-quartz-run-blocking-scheduled-method-on-quartz-thread]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-run-blocking-scheduled-method-on-quartz-thread[`quarkus.quartz.run-blocking-scheduled-method-on-quartz-thread`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-key-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-key-cert-certs[`quarkus.otel.exporter.otlp.metrics.key-cert.certs`]## [.description] -- -When set to `true`, blocking scheduled methods are invoked on a thread managed by Quartz instead of a thread from the regular Quarkus thread pool (default). - -When this option is enabled, blocking scheduled methods do not run on a `duplicated context`. +Comma-separated list of the path to the certificate files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_RUN_BLOCKING_SCHEDULED_METHOD_ON_QUARTZ_THREAD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_KEY_CERT_CERTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_RUN_BLOCKING_SCHEDULED_METHOD_ON_QUARTZ_THREAD+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_KEY_CERT_CERTS+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` - -h|[[quarkus-quartz_section_quarkus-quartz-misfire-policy]] [.section-name.section-level0]##link:#quarkus-quartz_section_quarkus-quartz-misfire-policy[Misfire policy per job configuration]## -h|Type -h|Default +|list of string +| -a| [[quarkus-quartz_quarkus-quartz-misfire-policy-identity]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-misfire-policy-identity[`quarkus.quartz.misfire-policy."identity"`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-trust-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-trust-cert-certs[`quarkus.otel.exporter.otlp.metrics.trust-cert.certs`]## [.description] -- -The quartz misfire policy for this job. +Comma-separated list of the trust certificate files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_MISFIRE_POLICY__IDENTITY_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TRUST_CERT_CERTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_MISFIRE_POLICY__IDENTITY_+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TRUST_CERT_CERTS+++` endif::add-copy-button-to-env-var[] -- -a|`smart-policy`, `ignore-misfire-policy`, `fire-now`, `simple-trigger-reschedule-now-with-existing-repeat-count`, `simple-trigger-reschedule-now-with-remaining-repeat-count`, `simple-trigger-reschedule-next-with-remaining-count`, `simple-trigger-reschedule-next-with-existing-count`, `cron-trigger-do-nothing` -|`smart-policy` +|list of string +| +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-tls-configuration-name]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-tls-configuration-name[`quarkus.otel.exporter.otlp.metrics.tls-configuration-name`]## -h|[[quarkus-quartz_section_quarkus-quartz-instance-id-generators]] [.section-name.section-level0]##link:#quarkus-quartz_section_quarkus-quartz-instance-id-generators[Instance ID generators]## -h|Type -h|Default +[.description] +-- +The name of the TLS configuration to use. -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-instance-id-generators-generator-name-class]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-instance-id-generators-generator-name-class[`quarkus.quartz.instance-id-generators."generator-name".class`]## +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..tls-configuration-name` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-enabled[`quarkus.otel.exporter.otlp.metrics.proxy-options.enabled`]## [.description] -- -Class name for the configuration. +If proxy connection must be used. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.enabled` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_INSTANCE_ID_GENERATORS__GENERATOR_NAME__CLASS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_INSTANCE_ID_GENERATORS__GENERATOR_NAME__CLASS+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-username]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-username[`quarkus.otel.exporter.otlp.metrics.proxy-options.username`]## + +[.description] +-- +Set proxy username. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.username` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_USERNAME+++` endif::add-copy-button-to-env-var[] -- |string -|required icon:exclamation-circle[title=Configuration property is required] +| -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-instance-id-generators-generator-name-properties-property-key]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-instance-id-generators-generator-name-properties-property-key[`quarkus.quartz.instance-id-generators."generator-name".properties."property-key"`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-password]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-password[`quarkus.otel.exporter.otlp.metrics.proxy-options.password`]## [.description] -- -The properties passed to the class. +Set proxy password. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.password` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_INSTANCE_ID_GENERATORS__GENERATOR_NAME__PROPERTIES__PROPERTY_KEY_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_INSTANCE_ID_GENERATORS__GENERATOR_NAME__PROPERTIES__PROPERTY_KEY_+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_PASSWORD+++` endif::add-copy-button-to-env-var[] -- -|Map +|string | +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-port]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-port[`quarkus.otel.exporter.otlp.metrics.proxy-options.port`]## -h|[[quarkus-quartz_section_quarkus-quartz-trigger-listeners]] [.section-name.section-level0]##link:#quarkus-quartz_section_quarkus-quartz-trigger-listeners[Trigger listeners]## -h|Type -h|Default +[.description] +-- +Set proxy port. -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-trigger-listeners-listener-name-class]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-trigger-listeners-listener-name-class[`quarkus.quartz.trigger-listeners."listener-name".class`]## +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.port` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-host]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-proxy-options-host[`quarkus.otel.exporter.otlp.metrics.proxy-options.host`]## [.description] -- -Class name for the configuration. +Set proxy host. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.host` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_TRIGGER_LISTENERS__LISTENER_NAME__CLASS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_TRIGGER_LISTENERS__LISTENER_NAME__CLASS+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_HOST+++` endif::add-copy-button-to-env-var[] -- |string -|required icon:exclamation-circle[title=Configuration property is required] +| -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-trigger-listeners-listener-name-properties-property-key]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-trigger-listeners-listener-name-properties-property-key[`quarkus.quartz.trigger-listeners."listener-name".properties."property-key"`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-temporality-preference]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-temporality-preference[`quarkus.otel.exporter.otlp.metrics.temporality-preference`]## [.description] -- -The properties passed to the class. +The preferred output aggregation temporality. Options include DELTA, LOWMEMORY, and CUMULATIVE. + +If CUMULATIVE, all instruments will have cumulative temporality. If DELTA, counter (sync and async) and histograms will be delta, up down counters (sync and async) will be cumulative. If LOWMEMORY, sync counter and histograms will be delta, async counter and up down counters (sync and async) will be cumulative. + +Default is CUMULATIVE. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_TRIGGER_LISTENERS__LISTENER_NAME__PROPERTIES__PROPERTY_KEY_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_TRIGGER_LISTENERS__LISTENER_NAME__PROPERTIES__PROPERTY_KEY_+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE+++` endif::add-copy-button-to-env-var[] -- -|Map +|string +|`cumulative` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-default-histogram-aggregation]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-default-histogram-aggregation[`quarkus.otel.exporter.otlp.metrics.default-histogram-aggregation`]## + +[.description] +-- +The preferred default histogram aggregation. + +Options include BASE2_EXPONENTIAL_BUCKET_HISTOGRAM and EXPLICIT_BUCKET_HISTOGRAM. + +Default is EXPLICIT_BUCKET_HISTOGRAM. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`explicit_bucket_histogram` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-endpoint]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-endpoint[`quarkus.otel.exporter.otlp.logs.endpoint`]## + +[.description] +-- +Sets the OTLP endpoint to send telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..endpoint` where is one of the supported signal types, like `traces` or `metrics`. + +If protocol is `http/protobuf` the version and signal will be appended to the path (e.g. v1/traces or v1/metrics) and the default port will be `OtlpExporterRuntimeConfig++#++DEFAULT_HTTP_BASE_URI`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`http://localhost:4317/` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-headers]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-headers[`quarkus.otel.exporter.otlp.logs.headers`]## + +[.description] +-- +Key-value pairs to be used as headers associated with exporter requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the "=" character. i.e.: key1=value1,key2=value2 + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..headers` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_HEADERS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_HEADERS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string | +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-compression]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-compression[`quarkus.otel.exporter.otlp.logs.compression`]## -h|[[quarkus-quartz_section_quarkus-quartz-job-listeners]] [.section-name.section-level0]##link:#quarkus-quartz_section_quarkus-quartz-job-listeners[Job listeners]## -h|Type -h|Default +[.description] +-- +Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..compression` where is one of the supported signal types, like `traces` or `metrics`. -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-job-listeners-listener-name-class]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-job-listeners-listener-name-class[`quarkus.quartz.job-listeners."listener-name".class`]## + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_COMPRESSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_COMPRESSION+++` +endif::add-copy-button-to-env-var[] +-- +a|`gzip`, `none` +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-timeout[`quarkus.otel.exporter.otlp.logs.timeout`]## [.description] -- -Class name for the configuration. +Sets the maximum time to wait for the collector to process an exported batch of telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..timeout` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_JOB_LISTENERS__LISTENER_NAME__CLASS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_JOB_LISTENERS__LISTENER_NAME__CLASS+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10s` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-protocol[`quarkus.otel.exporter.otlp.logs.protocol`]## + +[.description] +-- +OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different. + +Currently, only `grpc` and `http/protobuf` are allowed. + +Please mind that changing the protocol requires changing the port in the endpoint as well. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..protocol` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROTOCOL+++` endif::add-copy-button-to-env-var[] -- |string -|required icon:exclamation-circle[title=Configuration property is required] +|`grpc` -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-job-listeners-listener-name-properties-property-key]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-job-listeners-listener-name-properties-property-key[`quarkus.quartz.job-listeners."listener-name".properties."property-key"`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-key-cert-keys]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-key-cert-keys[`quarkus.otel.exporter.otlp.logs.key-cert.keys`]## [.description] -- -The properties passed to the class. +Comma-separated list of the path to the key files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_JOB_LISTENERS__LISTENER_NAME__PROPERTIES__PROPERTY_KEY_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_KEY_CERT_KEYS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_JOB_LISTENERS__LISTENER_NAME__PROPERTIES__PROPERTY_KEY_+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_KEY_CERT_KEYS+++` endif::add-copy-button-to-env-var[] -- -|Map +|list of string | +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-key-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-key-cert-certs[`quarkus.otel.exporter.otlp.logs.key-cert.certs`]## -h|[[quarkus-quartz_section_quarkus-quartz-plugins]] [.section-name.section-level0]##link:#quarkus-quartz_section_quarkus-quartz-plugins[Plugins]## -h|Type -h|Default +[.description] +-- +Comma-separated list of the path to the certificate files (Pem format). -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-plugins-plugin-name-class]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-plugins-plugin-name-class[`quarkus.quartz.plugins."plugin-name".class`]## + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_KEY_CERT_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_KEY_CERT_CERTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-trust-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-trust-cert-certs[`quarkus.otel.exporter.otlp.logs.trust-cert.certs`]## [.description] -- -Class name for the configuration. +Comma-separated list of the trust certificate files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_PLUGINS__PLUGIN_NAME__CLASS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TRUST_CERT_CERTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_PLUGINS__PLUGIN_NAME__CLASS+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TRUST_CERT_CERTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-tls-configuration-name]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-tls-configuration-name[`quarkus.otel.exporter.otlp.logs.tls-configuration-name`]## + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..tls-configuration-name` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- |string -|required icon:exclamation-circle[title=Configuration property is required] +| -a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-plugins-plugin-name-properties-property-key]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-plugins-plugin-name-properties-property-key[`quarkus.quartz.plugins."plugin-name".properties."property-key"`]## +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-enabled[`quarkus.otel.exporter.otlp.logs.proxy-options.enabled`]## [.description] -- -The properties passed to the class. +If proxy connection must be used. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.enabled` where is one of the supported signal types, like `traces` or `metrics`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_PLUGINS__PLUGIN_NAME__PROPERTIES__PROPERTY_KEY_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUARTZ_PLUGINS__PLUGIN_NAME__PROPERTIES__PROPERTY_KEY_+++` +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|Map +|boolean +|`false` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-username]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-username[`quarkus.otel.exporter.otlp.logs.proxy-options.username`]## + +[.description] +-- +Set proxy username. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.username` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string | +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-password]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-password[`quarkus.otel.exporter.otlp.logs.proxy-options.password`]## +[.description] +-- +Set proxy password. -h|[.extension-name]##Qute## +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.password` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-port]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-port[`quarkus.otel.exporter.otlp.logs.proxy-options.port`]## + +[.description] +-- +Set proxy port. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.port` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-host]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-host[`quarkus.otel.exporter.otlp.logs.proxy-options.host`]## + +[.description] +-- +Set proxy host. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.host` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[.extension-name]##Picocli## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-suffixes]] [.property-path]##link:#quarkus-qute_quarkus-qute-suffixes[`quarkus.qute.suffixes`]## +a|icon:lock[title=Fixed at build time] [[quarkus-picocli_quarkus-picocli-native-image-processing-enable]] [.property-path]##link:#quarkus-picocli_quarkus-picocli-native-image-processing-enable[`quarkus.picocli.native-image.processing.enable`]## [.description] -- -The list of suffixes used when attempting to locate a template file. +Set this to false to use the `picocli-codegen` annotation processor instead of build steps. -By default, `engine.getTemplate("foo")` would result in several lookups: `foo`, `foo.html`, `foo.txt`, etc. +CAUTION: this will have serious build-time performance impact since this is run on every restart in dev mode, use with care! + +This property is intended to be used only in cases where an incompatible change in the picocli library causes problems in the build steps used to support GraalVM Native images. + +In such cases this property allows users to make the trade-off between fast build cycles with the older version of picocli, and temporarily accept slower build cycles with the latest version of picocli until the updated extension is available. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_SUFFIXES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PICOCLI_NATIVE_IMAGE_PROCESSING_ENABLE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_SUFFIXES+++` +Environment variable: `+++QUARKUS_PICOCLI_NATIVE_IMAGE_PROCESSING_ENABLE+++` endif::add-copy-button-to-env-var[] -- -|list of string -|`qute.html,qute.txt,html,txt` +|boolean +|`true` -a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-content-types-file-suffix]] [.property-path]##link:#quarkus-qute_quarkus-qute-content-types-file-suffix[`quarkus.qute.content-types."file-suffix"`]## +a| [[quarkus-picocli_quarkus-picocli-top-command]] [.property-path]##link:#quarkus-picocli_quarkus-picocli-top-command[`quarkus.picocli.top-command`]## [.description] -- -The additional map of suffixes to content types. This map is used when working with template variants. By default, the `java.net.URLConnection++#++getFileNameMap()` is used to determine the content type of a template file. +Name of bean annotated with `io.quarkus.picocli.runtime.annotations.TopCommand` or FQCN of class which will be used as entry point for Picocli CommandLine instance. This class needs to be annotated with `picocli.CommandLine.Command`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_CONTENT_TYPES__FILE_SUFFIX_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PICOCLI_TOP_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_CONTENT_TYPES__FILE_SUFFIX_+++` +Environment variable: `+++QUARKUS_PICOCLI_TOP_COMMAND+++` endif::add-copy-button-to-env-var[] -- -|Map +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-type-check-excludes]] [.property-path]##link:#quarkus-qute_quarkus-qute-type-check-excludes[`quarkus.qute.type-check-excludes`]## + +h|[.extension-name]##Quarkus - Vert.x GraphQL## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-graphql_quarkus-vertx-graphql-ui-always-include]] [.property-path]##link:#quarkus-vertx-graphql_quarkus-vertx-graphql-ui-always-include[`quarkus.vertx-graphql.ui.always-include`]## [.description] -- -The list of exclude rules used to intentionally ignore some parts of an expression when performing type-safe validation. +If GraphQL UI should be included every time. By default, this is only included when the application is running in dev mode. -An element value must have at least two parts separated by dot. The last part is used to match the property/method name. The prepended parts are used to match the class name. The value `++*++` can be used to match any name. -Examples: +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_VERTX_GRAPHQL_UI_ALWAYS_INCLUDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_VERTX_GRAPHQL_UI_ALWAYS_INCLUDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` - - `org.acme.Foo.name` - exclude the property/method `name` on the `org.acme.Foo` class - - `org.acme.Foo.++*++` - exclude any property/method on the `org.acme.Foo` class - - `++*++.age` - exclude the property/method `age` on any class +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-graphql_quarkus-vertx-graphql-ui-path]] [.property-path]##link:#quarkus-vertx-graphql_quarkus-vertx-graphql-ui-path[`quarkus.vertx-graphql.ui.path`]## + +[.description] +-- +The path where GraphQL UI is available. + +The value `/` is not allowed as it blocks the application from serving anything else. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_TYPE_CHECK_EXCLUDES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_VERTX_GRAPHQL_UI_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_TYPE_CHECK_EXCLUDES+++` +Environment variable: `+++QUARKUS_VERTX_GRAPHQL_UI_PATH+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|string +|`graphql-ui` -a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-template-path-exclude]] [.property-path]##link:#quarkus-qute_quarkus-qute-template-path-exclude[`quarkus.qute.template-path-exclude`]## + +h|[.extension-name]##Quarkus Extension for Spring Cloud Config Client## +h|Type +h|Default + +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-enabled]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-enabled[`quarkus.spring-cloud-config.enabled`]## [.description] -- -This regular expression is used to exclude template files from the `templates` directory. Excluded templates are neither parsed nor validated during build and are not available at runtime. +If enabled, will try to read the configuration from a Spring Cloud Config Server -The matched input is the file path relative from the `templates` directory and the `/` is used as a path separator. -By default, the hidden files are excluded. The name of a hidden file starts with a dot. +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-fail-fast]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-fail-fast[`quarkus.spring-cloud-config.fail-fast`]## + +[.description] +-- +If set to true, the application will not stand up if it cannot obtain configuration from the Config Server ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_TEMPLATE_PATH_EXCLUDE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_FAIL_FAST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_TEMPLATE_PATH_EXCLUDE+++` +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_FAIL_FAST+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html[Pattern] -|`^\..*\|.*\/\..*$` +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-iteration-metadata-prefix]] [.property-path]##link:#quarkus-qute_quarkus-qute-iteration-metadata-prefix[`quarkus.qute.iteration-metadata-prefix`]## +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-url]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-url[`quarkus.spring-cloud-config.url`]## [.description] -- -The prefix is used to access the iteration metadata inside a loop section. +The Base URI where the Spring Cloud Config Server is available -A valid prefix consists of alphanumeric characters and underscores. Three special constants can be used: - - `` - the alias of an iterated element suffixed with an underscore is used, e.g. `item_hasNext` and `it_count` - - `` - the alias of an iterated element suffixed with a question mark is used, e.g. `item?hasNext` and `it?count` - - `` - no prefix is used, e.g. `hasNext` and `count` By default, the `` constant is set. +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`http://localhost:8888` + +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-name]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-name[`quarkus.spring-cloud-config.name`]## + +[.description] +-- +Name of the application on Spring Cloud Config server. Could be a list of names to load multiple files (value separated by a comma) ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_ITERATION_METADATA_PREFIX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_ITERATION_METADATA_PREFIX+++` +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_NAME+++` endif::add-copy-button-to-env-var[] -- |string -|`` +|`${quarkus.application.name:}` -a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-escape-content-types]] [.property-path]##link:#quarkus-qute_quarkus-qute-escape-content-types[`quarkus.qute.escape-content-types`]## +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-label]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-label[`quarkus.spring-cloud-config.label`]## [.description] -- -The list of content types for which the `'`, `"`, `<`, `>` and `&` characters are escaped if a template variant is set. +The label to be used to pull remote configuration properties. The default is set on the Spring Cloud Config Server (generally "master" when the server uses a Git backend). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_ESCAPE_CONTENT_TYPES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_LABEL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_ESCAPE_CONTENT_TYPES+++` +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_LABEL+++` endif::add-copy-button-to-env-var[] -- -|list of string -|`text/html,text/xml,application/xml,application/xhtml+xml` +|string +| -a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-default-charset]] [.property-path]##link:#quarkus-qute_quarkus-qute-default-charset[`quarkus.qute.default-charset`]## +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-connection-timeout]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-connection-timeout[`quarkus.spring-cloud-config.connection-timeout`]## [.description] -- -The default charset of the templates files. +The amount of time to wait when initially establishing a connection before giving up and timing out. + +Specify `0` to wait indefinitely. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_DEFAULT_CHARSET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_DEFAULT_CHARSET+++` +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html[Charset] -|`UTF-8` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10S` -a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-dev-mode-no-restart-templates]] [.property-path]##link:#quarkus-qute_quarkus-qute-dev-mode-no-restart-templates[`quarkus.qute.dev-mode.no-restart-templates`]## +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-read-timeout]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-read-timeout[`quarkus.spring-cloud-config.read-timeout`]## [.description] -- -By default, a template modification results in an application restart that triggers build-time validations. +The amount of time to wait for a read on a socket before an exception is thrown. -This regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed. +Specify `0` to wait indefinitely. -The matched input is the template path that starts with a template root, and the `/` is used as a path separator. For example, `templates/foo.html`. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-username]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-username[`quarkus.spring-cloud-config.username`]## + +[.description] +-- +The username to be used if the Config Server has BASIC Auth enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++` +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_USERNAME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html[Pattern] +|string | -a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-test-mode-record-rendered-results]] [.property-path]##link:#quarkus-qute_quarkus-qute-test-mode-record-rendered-results[`quarkus.qute.test-mode.record-rendered-results`]## +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-password]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-password[`quarkus.spring-cloud-config.password`]## [.description] -- -By default, the rendering results of injected and type-safe templates are recorded in the managed `RenderedResults` which is registered as a CDI bean. +The password to be used if the Config Server has BASIC Auth enabled ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_TEST_MODE_RECORD_RENDERED_RESULTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_TEST_MODE_RECORD_RENDERED_RESULTS+++` +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_PASSWORD+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|string +| -a| [[quarkus-qute_quarkus-qute-property-not-found-strategy]] [.property-path]##link:#quarkus-qute_quarkus-qute-property-not-found-strategy[`quarkus.qute.property-not-found-strategy`]## +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-trust-store]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-trust-store[`quarkus.spring-cloud-config.trust-store`]## [.description] -- -The strategy used when a standalone expression evaluates to a "not found" value at runtime and the `quarkus.qute.strict-rendering` config property is set to `false` +TrustStore to be used containing the SSL certificate used by the Config server Can be either a classpath resource or a file system path -This strategy is never used when evaluating section parameters, e.g. `++{#++if foo.name++}++`. In such case, it's the responsibility of the section to handle this situation appropriately. -By default, the `NOT_FOUND` constant is written to the output. However, in the development mode the `PropertyNotFoundStrategy++#++THROW_EXCEPTION` is used by default, i.e. when the strategy is not specified. +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-trust-store-password]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-trust-store-password[`quarkus.spring-cloud-config.trust-store-password`]## + +[.description] +-- +Password of TrustStore to be used containing the SSL certificate used by the Config server ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_PROPERTY_NOT_FOUND_STRATEGY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_PROPERTY_NOT_FOUND_STRATEGY+++` +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:default[Output the `NOT_FOUND` constant.], tooltip:noop[No operation - no output.], tooltip:throw-exception[Throw a `TemplateException`.], tooltip:output-original[Output the original expression string, e.g. `++{++foo.name++}++`.] +|string | -a| [[quarkus-qute_quarkus-qute-remove-standalone-lines]] [.property-path]##link:#quarkus-qute_quarkus-qute-remove-standalone-lines[`quarkus.qute.remove-standalone-lines`]## +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-key-store]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-key-store[`quarkus.spring-cloud-config.key-store`]## [.description] -- -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. +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 ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_REMOVE_STANDALONE_LINES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_REMOVE_STANDALONE_LINES+++` +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|path +| -a| [[quarkus-qute_quarkus-qute-strict-rendering]] [.property-path]##link:#quarkus-qute_quarkus-qute-strict-rendering[`quarkus.qute.strict-rendering`]## +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-key-store-password]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-key-store-password[`quarkus.spring-cloud-config.key-store-password`]## [.description] -- -If set to `true` then any expression that is evaluated to a `Results.NotFound` value will always result in a `TemplateException` and the rendering is aborted. +Password of KeyStore to be used containing the SSL certificate for authentication with the Config server -Note that the `quarkus.qute.property-not-found-strategy` config property is completely ignored if strict rendering is enabled. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-key-password]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-key-password[`quarkus.spring-cloud-config.key-password`]## + +[.description] +-- +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 ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_STRICT_RENDERING+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_KEY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_STRICT_RENDERING+++` +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_KEY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-trust-certs]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-trust-certs[`quarkus.spring-cloud-config.trust-certs`]## + +[.description] +-- +When using HTTPS and no keyStore has been specified, whether to trust all certificates + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_TRUST_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_TRUST_CERTS+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` +|`${quarkus.tls.trust-all:false}` -a| [[quarkus-qute_quarkus-qute-timeout]] [.property-path]##link:#quarkus-qute_quarkus-qute-timeout[`quarkus.qute.timeout`]## +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-headers-header-name]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-headers-header-name[`quarkus.spring-cloud-config.headers."header-name"`]## [.description] -- -The global rendering timeout in milliseconds. It is used if no `timeout` template instance attribute is set. +Custom headers to pass the Spring Cloud Config Server when performing the HTTP request ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_HEADERS__HEADER_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_TIMEOUT+++` +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_HEADERS__HEADER_NAME_+++` endif::add-copy-button-to-env-var[] -- -|long -|`10000` +|Map +| -a| [[quarkus-qute_quarkus-qute-use-async-timeout]] [.property-path]##link:#quarkus-qute_quarkus-qute-use-async-timeout[`quarkus.qute.use-async-timeout`]## +a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-profiles]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-profiles[`quarkus.spring-cloud-config.profiles`]## [.description] -- -If set to `true` then the timeout should also be used for asynchronous rendering methods, such as `TemplateInstance++#++createUni()` and `TemplateInstance++#++renderAsync()`. +The profiles to use for lookup ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_USE_ASYNC_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_PROFILES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_QUTE_USE_ASYNC_TIMEOUT+++` +Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_PROFILES+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|list of string +| -h|[.extension-name]##Reactive datasource configuration## +h|[.extension-name]##Quartz## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-reactive-datasource_quarkus-datasource-reactive]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive[`quarkus.datasource.reactive`]## +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-clustered]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-clustered[`quarkus.quartz.clustered`]## [.description] -- -If we create a Reactive datasource for this datasource. +Enable cluster mode or not. + +If enabled make sure to set the appropriate cluster properties. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_CLUSTERED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE+++` +Environment variable: `+++QUARKUS_QUARTZ_CLUSTERED+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` +|`false` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-cache-prepared-statements]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-cache-prepared-statements[`quarkus.datasource.reactive.cache-prepared-statements`]## +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-cluster-checkin-interval]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-cluster-checkin-interval[`quarkus.quartz.cluster-checkin-interval`]## [.description] -- -Whether prepared statements should be cached on the client side. +The frequency (in milliseconds) at which the scheduler instance checks-in with other instances of the cluster. + +Ignored if using a `ram` store i.e `StoreType++#++RAM`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_CACHE_PREPARED_STATEMENTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_CLUSTER_CHECKIN_INTERVAL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_CACHE_PREPARED_STATEMENTS+++` +Environment variable: `+++QUARKUS_QUARTZ_CLUSTER_CHECKIN_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|long +|`15000` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-url]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-url[`quarkus.datasource.reactive.url`]## +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-store-type]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-store-type[`quarkus.quartz.store-type`]## [.description] -- -The datasource URLs. +The type of store to use. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. +When using `StoreType++#++JDBC_CMT` or `StoreType++#++JDBC_TX` configuration values make sure that you have the datasource configured. See link:https://quarkus.io/guides/datasource[Configuring your datasource] for more information. + +To create Quartz tables, you can perform a schema migration via the link:https://quarkus.io/guides/flyway[Flyway extension] using a SQL script matching your database picked from link:https://github.com/quartz-scheduler/quartz/blob/master/quartz-core/src/main/resources/org/quartz/impl/jdbcjobstore[Quartz repository]. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_URL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_URL+++` +Environment variable: `+++QUARKUS_QUARTZ_STORE_TYPE+++` endif::add-copy-button-to-env-var[] -- -|list of string +a|`ram`, `jdbc-tx`, `jdbc-cmt` +|`ram` + +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-datasource]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-datasource[`quarkus.quartz.datasource`]## + +[.description] +-- +The name of the datasource to use. + +Ignored if using a `ram` store i.e `StoreType++#++RAM`. + +Optionally needed when using the `jdbc-tx` or `jdbc-cmt` store types. If not specified, defaults to using the default datasource. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_DATASOURCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_QUARTZ_DATASOURCE+++` +endif::add-copy-button-to-env-var[] +-- +|string | -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-max-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-max-size[`quarkus.datasource.reactive.max-size`]## +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-table-prefix]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-table-prefix[`quarkus.quartz.table-prefix`]## [.description] -- -The datasource pool maximum size. +The prefix for quartz job store tables. + +Ignored if using a `ram` store i.e `StoreType++#++RAM` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_MAX_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_TABLE_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_MAX_SIZE+++` +Environment variable: `+++QUARKUS_QUARTZ_TABLE_PREFIX+++` endif::add-copy-button-to-env-var[] -- -|int -|`20` +|string +|`QRTZ_` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-event-loop-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-event-loop-size[`quarkus.datasource.reactive.event-loop-size`]## +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-select-with-lock-sql]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-select-with-lock-sql[`quarkus.quartz.select-with-lock-sql`]## [.description] -- -When a new connection object is created, the pool assigns it an event loop. +The SQL string that selects a row in the "LOCKS" table and places a lock on the row. -When `++#++event-loop-size` is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If `++#++event-loop-size` is set to zero or a negative value, the pool assigns the current event loop to the new connection. +Ignored if using a `ram` store i.e `StoreType++#++RAM`. + +If not set, the default value of Quartz applies, for which the "++{++0++}++" is replaced during run-time with the `table-prefix`, the "++{++1++}++" with the `instance-name`. + +An example SQL string `SELECT ++*++ FROM ++{++0++}++LOCKS WHERE SCHED_NAME = ++{++1++}++ AND LOCK_NAME = ? FOR UPDATE` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_EVENT_LOOP_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_SELECT_WITH_LOCK_SQL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_EVENT_LOOP_SIZE+++` +Environment variable: `+++QUARKUS_QUARTZ_SELECT_WITH_LOCK_SQL+++` endif::add-copy-button-to-env-var[] -- -|int +|string | -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-all]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-all[`quarkus.datasource.reactive.trust-all`]## +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-serialize-job-data]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-serialize-job-data[`quarkus.quartz.serialize-job-data`]## [.description] -- -Whether all server certificates should be trusted. +Instructs JDBCJobStore to serialize JobDataMaps in the BLOB column. + +Ignored if using a `ram` store i.e `StoreType++#++RAM`. + +If this is set to `true`, the JDBCJobStore will store the JobDataMaps in their serialize form in the BLOB Column. This is useful when you want to store complex JobData objects other than String. This is equivalent of setting `org.quartz.jobStore.useProperties` to `false`. *NOTE: When this option is set to `true`, all the non-String classes used in JobDataMaps have to be registered for serialization when building a native image* + +If this is set to `false` (the default), the values can be stored as name-value pairs rather than storing more complex objects in their serialized form in the BLOB column. This can be handy, as you avoid the class versioning issues that can arise from serializing your non-String classes into a BLOB. This is equivalent of setting `org.quartz.jobStore.useProperties` to `true`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_ALL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_SERIALIZE_JOB_DATA+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_ALL+++` +Environment variable: `+++QUARKUS_QUARTZ_SERIALIZE_JOB_DATA+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem[`quarkus.datasource.reactive.trust-certificate-pem`]## +a| [[quarkus-quartz_quarkus-quartz-instance-name]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-instance-name[`quarkus.quartz.instance-name`]## [.description] -- -PEM Trust config is disabled by default. +The name of the Quartz instance. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PEM+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_INSTANCE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PEM+++` +Environment variable: `+++QUARKUS_QUARTZ_INSTANCE_NAME+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +|`QuarkusQuartzScheduler` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem-certs[`quarkus.datasource.reactive.trust-certificate-pem.certs`]## +a| [[quarkus-quartz_quarkus-quartz-instance-id]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-instance-id[`quarkus.quartz.instance-id`]## [.description] -- -Comma-separated list of the trust certificate files (Pem format). +The identifier of Quartz instance that must be unique for all schedulers working as if they are the same _logical_ Scheduler within a cluster. Use the default value `AUTO` or some of the configured link:https://quarkus.io/guides/quartz#quarkus-quartz_quarkus.quartz.instance-id-generators-instance-id-generators[instance ID generators] if you wish the identifier to be generated for you. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_INSTANCE_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++` +Environment variable: `+++QUARKUS_QUARTZ_INSTANCE_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`AUTO` + +a| [[quarkus-quartz_quarkus-quartz-batch-trigger-acquisition-fire-ahead-time-window]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-batch-trigger-acquisition-fire-ahead-time-window[`quarkus.quartz.batch-trigger-acquisition-fire-ahead-time-window`]## + +[.description] +-- +The amount of time in milliseconds that a trigger is allowed to be acquired and fired ahead of its scheduled fire time. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_BATCH_TRIGGER_ACQUISITION_FIRE_AHEAD_TIME_WINDOW+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_QUARTZ_BATCH_TRIGGER_ACQUISITION_FIRE_AHEAD_TIME_WINDOW+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`0` + +a| [[quarkus-quartz_quarkus-quartz-batch-trigger-acquisition-max-count]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-batch-trigger-acquisition-max-count[`quarkus.quartz.batch-trigger-acquisition-max-count`]## + +[.description] +-- +The maximum number of triggers that a scheduler node is allowed to acquire (for firing) at once. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_BATCH_TRIGGER_ACQUISITION_MAX_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_QUARTZ_BATCH_TRIGGER_ACQUISITION_MAX_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1` + +a| [[quarkus-quartz_quarkus-quartz-thread-count]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-thread-count[`quarkus.quartz.thread-count`]## + +[.description] +-- +The size of scheduler thread pool. This will initialize the number of worker threads in the pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_THREAD_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_QUARTZ_THREAD_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`25` + +a| [[quarkus-quartz_quarkus-quartz-thread-priority]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-thread-priority[`quarkus.quartz.thread-priority`]## + +[.description] +-- +Thread priority of worker threads in the pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_THREAD_PRIORITY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_QUARTZ_THREAD_PRIORITY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`5` + +a| [[quarkus-quartz_quarkus-quartz-misfire-threshold]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-misfire-threshold[`quarkus.quartz.misfire-threshold`]## + +[.description] +-- +Defines how late the schedulers should be to be considered misfired. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_MISFIRE_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_QUARTZ_MISFIRE_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-quartz_quarkus-quartz-shutdown-wait-time]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-shutdown-wait-time[`quarkus.quartz.shutdown-wait-time`]## + +[.description] +-- +The maximum amount of time Quarkus will wait for currently running jobs to finish. If the value is `0`, then Quarkus will not wait at all for these jobs to finish - it will call `org.quartz.Scheduler.shutdown(false)` in this case. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_SHUTDOWN_WAIT_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_QUARTZ_SHUTDOWN_WAIT_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-quartz_quarkus-quartz-simple-trigger-misfire-policy]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-simple-trigger-misfire-policy[`quarkus.quartz.simple-trigger.misfire-policy`]## + +[.description] +-- +The quartz misfire policy for this job. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_SIMPLE_TRIGGER_MISFIRE_POLICY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_QUARTZ_SIMPLE_TRIGGER_MISFIRE_POLICY+++` +endif::add-copy-button-to-env-var[] +-- +a|`smart-policy`, `ignore-misfire-policy`, `fire-now`, `simple-trigger-reschedule-now-with-existing-repeat-count`, `simple-trigger-reschedule-now-with-remaining-repeat-count`, `simple-trigger-reschedule-next-with-remaining-count`, `simple-trigger-reschedule-next-with-existing-count`, `cron-trigger-do-nothing` +|`smart-policy` + +a| [[quarkus-quartz_quarkus-quartz-cron-trigger-misfire-policy]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-cron-trigger-misfire-policy[`quarkus.quartz.cron-trigger.misfire-policy`]## + +[.description] +-- +The quartz misfire policy for this job. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_CRON_TRIGGER_MISFIRE_POLICY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_QUARTZ_CRON_TRIGGER_MISFIRE_POLICY+++` +endif::add-copy-button-to-env-var[] +-- +a|`smart-policy`, `ignore-misfire-policy`, `fire-now`, `simple-trigger-reschedule-now-with-existing-repeat-count`, `simple-trigger-reschedule-now-with-remaining-repeat-count`, `simple-trigger-reschedule-next-with-remaining-count`, `simple-trigger-reschedule-next-with-existing-count`, `cron-trigger-do-nothing` +|`smart-policy` + +a| [[quarkus-quartz_quarkus-quartz-run-blocking-scheduled-method-on-quartz-thread]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-run-blocking-scheduled-method-on-quartz-thread[`quarkus.quartz.run-blocking-scheduled-method-on-quartz-thread`]## + +[.description] +-- +When set to `true`, blocking scheduled methods are invoked on a thread managed by Quartz instead of a thread from the regular Quarkus thread pool (default). + +When this option is enabled, blocking scheduled methods do not run on a `duplicated context`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_RUN_BLOCKING_SCHEDULED_METHOD_ON_QUARTZ_THREAD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_QUARTZ_RUN_BLOCKING_SCHEDULED_METHOD_ON_QUARTZ_THREAD+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|boolean +|`false` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks[`quarkus.datasource.reactive.trust-certificate-jks`]## +h|[[quarkus-quartz_section_quarkus-quartz-misfire-policy]] [.section-name.section-level0]##link:#quarkus-quartz_section_quarkus-quartz-misfire-policy[Misfire policy per job configuration]## +h|Type +h|Default + +a| [[quarkus-quartz_quarkus-quartz-misfire-policy-identity]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-misfire-policy-identity[`quarkus.quartz.misfire-policy."identity"`]## [.description] -- -JKS config is disabled by default. +The quartz misfire policy for this job. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_MISFIRE_POLICY__IDENTITY_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS+++` +Environment variable: `+++QUARKUS_QUARTZ_MISFIRE_POLICY__IDENTITY_+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +a|`smart-policy`, `ignore-misfire-policy`, `fire-now`, `simple-trigger-reschedule-now-with-existing-repeat-count`, `simple-trigger-reschedule-now-with-remaining-repeat-count`, `simple-trigger-reschedule-next-with-remaining-count`, `simple-trigger-reschedule-next-with-existing-count`, `cron-trigger-do-nothing` +|`smart-policy` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-path[`quarkus.datasource.reactive.trust-certificate-jks.path`]## + +h|[[quarkus-quartz_section_quarkus-quartz-instance-id-generators]] [.section-name.section-level0]##link:#quarkus-quartz_section_quarkus-quartz-instance-id-generators[Instance ID generators]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-instance-id-generators-generator-name-class]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-instance-id-generators-generator-name-class[`quarkus.quartz.instance-id-generators."generator-name".class`]## [.description] -- -Path of the key file (JKS format). +Class name for the configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_INSTANCE_ID_GENERATORS__GENERATOR_NAME__CLASS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++` +Environment variable: `+++QUARKUS_QUARTZ_INSTANCE_ID_GENERATORS__GENERATOR_NAME__CLASS+++` endif::add-copy-button-to-env-var[] -- |string -| +|required icon:exclamation-circle[title=Configuration property is required] -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-password[`quarkus.datasource.reactive.trust-certificate-jks.password`]## +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-instance-id-generators-generator-name-properties-property-key]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-instance-id-generators-generator-name-properties-property-key[`quarkus.quartz.instance-id-generators."generator-name".properties."property-key"`]## [.description] -- -Password of the key file. +The properties passed to the class. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_INSTANCE_ID_GENERATORS__GENERATOR_NAME__PROPERTIES__PROPERTY_KEY_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++` +Environment variable: `+++QUARKUS_QUARTZ_INSTANCE_ID_GENERATORS__GENERATOR_NAME__PROPERTIES__PROPERTY_KEY_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx[`quarkus.datasource.reactive.trust-certificate-pfx`]## + +h|[[quarkus-quartz_section_quarkus-quartz-trigger-listeners]] [.section-name.section-level0]##link:#quarkus-quartz_section_quarkus-quartz-trigger-listeners[Trigger listeners]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-trigger-listeners-listener-name-class]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-trigger-listeners-listener-name-class[`quarkus.quartz.trigger-listeners."listener-name".class`]## [.description] -- -PFX config is disabled by default. +Class name for the configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_TRIGGER_LISTENERS__LISTENER_NAME__CLASS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX+++` +Environment variable: `+++QUARKUS_QUARTZ_TRIGGER_LISTENERS__LISTENER_NAME__CLASS+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +|required icon:exclamation-circle[title=Configuration property is required] -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-path[`quarkus.datasource.reactive.trust-certificate-pfx.path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-trigger-listeners-listener-name-properties-property-key]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-trigger-listeners-listener-name-properties-property-key[`quarkus.quartz.trigger-listeners."listener-name".properties."property-key"`]## [.description] -- -Path to the key file (PFX format). +The properties passed to the class. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_TRIGGER_LISTENERS__LISTENER_NAME__PROPERTIES__PROPERTY_KEY_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++` +Environment variable: `+++QUARKUS_QUARTZ_TRIGGER_LISTENERS__LISTENER_NAME__PROPERTIES__PROPERTY_KEY_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-password[`quarkus.datasource.reactive.trust-certificate-pfx.password`]## + +h|[[quarkus-quartz_section_quarkus-quartz-job-listeners]] [.section-name.section-level0]##link:#quarkus-quartz_section_quarkus-quartz-job-listeners[Job listeners]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-job-listeners-listener-name-class]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-job-listeners-listener-name-class[`quarkus.quartz.job-listeners."listener-name".class`]## [.description] -- -Password of the key. +Class name for the configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_JOB_LISTENERS__LISTENER_NAME__CLASS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++` +Environment variable: `+++QUARKUS_QUARTZ_JOB_LISTENERS__LISTENER_NAME__CLASS+++` endif::add-copy-button-to-env-var[] -- |string -| +|required icon:exclamation-circle[title=Configuration property is required] -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem[`quarkus.datasource.reactive.key-certificate-pem`]## +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-job-listeners-listener-name-properties-property-key]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-job-listeners-listener-name-properties-property-key[`quarkus.quartz.job-listeners."listener-name".properties."property-key"`]## [.description] -- -PEM Key/cert config is disabled by default. +The properties passed to the class. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_JOB_LISTENERS__LISTENER_NAME__PROPERTIES__PROPERTY_KEY_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM+++` +Environment variable: `+++QUARKUS_QUARTZ_JOB_LISTENERS__LISTENER_NAME__PROPERTIES__PROPERTY_KEY_+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|Map +| -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-keys]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-keys[`quarkus.datasource.reactive.key-certificate-pem.keys`]## + +h|[[quarkus-quartz_section_quarkus-quartz-plugins]] [.section-name.section-level0]##link:#quarkus-quartz_section_quarkus-quartz-plugins[Plugins]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-plugins-plugin-name-class]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-plugins-plugin-name-class[`quarkus.quartz.plugins."plugin-name".class`]## [.description] -- -Comma-separated list of the path to the key files (Pem format). +Class name for the configuration. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_PLUGINS__PLUGIN_NAME__CLASS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++` +Environment variable: `+++QUARKUS_QUARTZ_PLUGINS__PLUGIN_NAME__CLASS+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|string +|required icon:exclamation-circle[title=Configuration property is required] -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-certs[`quarkus.datasource.reactive.key-certificate-pem.certs`]## +a|icon:lock[title=Fixed at build time] [[quarkus-quartz_quarkus-quartz-plugins-plugin-name-properties-property-key]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-plugins-plugin-name-properties-property-key[`quarkus.quartz.plugins."plugin-name".properties."property-key"`]## [.description] -- -Comma-separated list of the path to the certificate files (Pem format). +The properties passed to the class. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUARTZ_PLUGINS__PLUGIN_NAME__PROPERTIES__PROPERTY_KEY_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++` +Environment variable: `+++QUARKUS_QUARTZ_PLUGINS__PLUGIN_NAME__PROPERTIES__PROPERTY_KEY_+++` endif::add-copy-button-to-env-var[] -- -|list of string +|Map | -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks[`quarkus.datasource.reactive.key-certificate-jks`]## + + +h|[.extension-name]##Qute## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-suffixes]] [.property-path]##link:#quarkus-qute_quarkus-qute-suffixes[`quarkus.qute.suffixes`]## [.description] -- -JKS config is disabled by default. +The list of suffixes used when attempting to locate a template file. + +By default, `engine.getTemplate("foo")` would result in several lookups: `foo`, `foo.html`, `foo.txt`, etc. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_SUFFIXES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS+++` +Environment variable: `+++QUARKUS_QUTE_SUFFIXES+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|list of string +|`qute.html,qute.txt,html,txt` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-path[`quarkus.datasource.reactive.key-certificate-jks.path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-content-types-file-suffix]] [.property-path]##link:#quarkus-qute_quarkus-qute-content-types-file-suffix[`quarkus.qute.content-types."file-suffix"`]## [.description] -- -Path of the key file (JKS format). +The additional map of suffixes to content types. This map is used when working with template variants. By default, the `java.net.URLConnection++#++getFileNameMap()` is used to determine the content type of a template file. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_CONTENT_TYPES__FILE_SUFFIX_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS_PATH+++` +Environment variable: `+++QUARKUS_QUTE_CONTENT_TYPES__FILE_SUFFIX_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-password[`quarkus.datasource.reactive.key-certificate-jks.password`]## +a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-type-check-excludes]] [.property-path]##link:#quarkus-qute_quarkus-qute-type-check-excludes[`quarkus.qute.type-check-excludes`]## [.description] -- -Password of the key file. +The list of exclude rules used to intentionally ignore some parts of an expression when performing type-safe validation. + +An element value must have at least two parts separated by dot. The last part is used to match the property/method name. The prepended parts are used to match the class name. The value `++*++` can be used to match any name. + +Examples: + + - `org.acme.Foo.name` - exclude the property/method `name` on the `org.acme.Foo` class + - `org.acme.Foo.++*++` - exclude any property/method on the `org.acme.Foo` class + - `++*++.age` - exclude the property/method `age` on any class ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_TYPE_CHECK_EXCLUDES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++` +Environment variable: `+++QUARKUS_QUTE_TYPE_CHECK_EXCLUDES+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx[`quarkus.datasource.reactive.key-certificate-pfx`]## +a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-template-path-exclude]] [.property-path]##link:#quarkus-qute_quarkus-qute-template-path-exclude[`quarkus.qute.template-path-exclude`]## [.description] -- -PFX config is disabled by default. +This regular expression is used to exclude template files from the `templates` directory. Excluded templates are neither parsed nor validated during build and are not available at runtime. + +The matched input is the file path relative from the `templates` directory and the `/` is used as a path separator. + +By default, the hidden files are excluded. The name of a hidden file starts with a dot. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_TEMPLATE_PATH_EXCLUDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX+++` +Environment variable: `+++QUARKUS_QUTE_TEMPLATE_PATH_EXCLUDE+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html[Pattern] +|`^\..*\|.*\/\..*$` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-path[`quarkus.datasource.reactive.key-certificate-pfx.path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-iteration-metadata-prefix]] [.property-path]##link:#quarkus-qute_quarkus-qute-iteration-metadata-prefix[`quarkus.qute.iteration-metadata-prefix`]## [.description] -- -Path to the key file (PFX format). +The prefix is used to access the iteration metadata inside a loop section. + +A valid prefix consists of alphanumeric characters and underscores. Three special constants can be used: + + - `` - the alias of an iterated element suffixed with an underscore is used, e.g. `item_hasNext` and `it_count` + - `` - the alias of an iterated element suffixed with a question mark is used, e.g. `item?hasNext` and `it?count` + - `` - no prefix is used, e.g. `hasNext` and `count` By default, the `` constant is set. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_ITERATION_METADATA_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX_PATH+++` +Environment variable: `+++QUARKUS_QUTE_ITERATION_METADATA_PREFIX+++` endif::add-copy-button-to-env-var[] -- |string -| +|`` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-password[`quarkus.datasource.reactive.key-certificate-pfx.password`]## +a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-escape-content-types]] [.property-path]##link:#quarkus-qute_quarkus-qute-escape-content-types[`quarkus.qute.escape-content-types`]## [.description] -- -Password of the key. +The list of content types for which the `'`, `"`, `<`, `>` and `&` characters are escaped if a template variant is set. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_ESCAPE_CONTENT_TYPES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++` +Environment variable: `+++QUARKUS_QUTE_ESCAPE_CONTENT_TYPES+++` endif::add-copy-button-to-env-var[] -- -|string -| +|list of string +|`text/html,text/xml,application/xml,application/xhtml+xml` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-attempts]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-attempts[`quarkus.datasource.reactive.reconnect-attempts`]## +a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-default-charset]] [.property-path]##link:#quarkus-qute_quarkus-qute-default-charset[`quarkus.qute.default-charset`]## [.description] -- -The number of reconnection attempts when a pooled connection cannot be established on first try. +The default charset of the templates files. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_RECONNECT_ATTEMPTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_DEFAULT_CHARSET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_RECONNECT_ATTEMPTS+++` +Environment variable: `+++QUARKUS_QUTE_DEFAULT_CHARSET+++` endif::add-copy-button-to-env-var[] -- -|int -|`0` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html[Charset] +|`UTF-8` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-interval]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-interval[`quarkus.datasource.reactive.reconnect-interval`]## +a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-dev-mode-no-restart-templates]] [.property-path]##link:#quarkus-qute_quarkus-qute-dev-mode-no-restart-templates[`quarkus.qute.dev-mode.no-restart-templates`]## [.description] -- -The interval between reconnection attempts when a pooled connection cannot be established on first try. +By default, a template modification results in an application restart that triggers build-time validations. + +This regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed. + +The matched input is the template path that starts with a template root, and the `/` is used as a path separator. For example, `templates/foo.html`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_RECONNECT_INTERVAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_RECONNECT_INTERVAL+++` +Environment variable: `+++QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT1S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html[Pattern] +| -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-hostname-verification-algorithm]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-hostname-verification-algorithm[`quarkus.datasource.reactive.hostname-verification-algorithm`]## +a|icon:lock[title=Fixed at build time] [[quarkus-qute_quarkus-qute-test-mode-record-rendered-results]] [.property-path]##link:#quarkus-qute_quarkus-qute-test-mode-record-rendered-results[`quarkus.qute.test-mode.record-rendered-results`]## [.description] -- -The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or `NONE`. `NONE` is the default value and disables the verification. +By default, the rendering results of injected and type-safe templates are recorded in the managed `RenderedResults` which is registered as a CDI bean. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_TEST_MODE_RECORD_RENDERED_RESULTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++` +Environment variable: `+++QUARKUS_QUTE_TEST_MODE_RECORD_RENDERED_RESULTS+++` endif::add-copy-button-to-env-var[] -- -|string -|`NONE` +|boolean +|`true` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-idle-timeout]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-idle-timeout[`quarkus.datasource.reactive.idle-timeout`]## +a| [[quarkus-qute_quarkus-qute-property-not-found-strategy]] [.property-path]##link:#quarkus-qute_quarkus-qute-property-not-found-strategy[`quarkus.qute.property-not-found-strategy`]## [.description] -- -The maximum time a connection remains unused in the pool before it is closed. +The strategy used when a standalone expression evaluates to a "not found" value at runtime and the `quarkus.qute.strict-rendering` config property is set to `false` + +This strategy is never used when evaluating section parameters, e.g. `++{#++if foo.name++}++`. In such case, it's the responsibility of the section to handle this situation appropriately. + +By default, the `NOT_FOUND` constant is written to the output. However, in the development mode the `PropertyNotFoundStrategy++#++THROW_EXCEPTION` is used by default, i.e. when the strategy is not specified. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_IDLE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_PROPERTY_NOT_FOUND_STRATEGY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_IDLE_TIMEOUT+++` +Environment variable: `+++QUARKUS_QUTE_PROPERTY_NOT_FOUND_STRATEGY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`no timeout` +a|tooltip:default[Output the `NOT_FOUND` constant.], tooltip:noop[No operation - no output.], tooltip:throw-exception[Throw a `TemplateException`.], tooltip:output-original[Output the original expression string, e.g. `++{++foo.name++}++`.] +| -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-max-lifetime]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-max-lifetime[`quarkus.datasource.reactive.max-lifetime`]## +a| [[quarkus-qute_quarkus-qute-remove-standalone-lines]] [.property-path]##link:#quarkus-qute_quarkus-qute-remove-standalone-lines[`quarkus.qute.remove-standalone-lines`]## [.description] -- -The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary. +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. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_MAX_LIFETIME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_REMOVE_STANDALONE_LINES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_MAX_LIFETIME+++` +Environment variable: `+++QUARKUS_QUTE_REMOVE_STANDALONE_LINES+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`no timeout` +|boolean +|`true` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-shared]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-shared[`quarkus.datasource.reactive.shared`]## +a| [[quarkus-qute_quarkus-qute-strict-rendering]] [.property-path]##link:#quarkus-qute_quarkus-qute-strict-rendering[`quarkus.qute.strict-rendering`]## [.description] -- -Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used. +If set to `true` then any expression that is evaluated to a `Results.NotFound` value will always result in a `TemplateException` and the rendering is aborted. + +Note that the `quarkus.qute.property-not-found-strategy` config property is completely ignored if strict rendering is enabled. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_SHARED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_STRICT_RENDERING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_SHARED+++` +Environment variable: `+++QUARKUS_QUTE_STRICT_RENDERING+++` endif::add-copy-button-to-env-var[] -- |boolean -|`false` +|`true` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-name]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-name[`quarkus.datasource.reactive.name`]## +a| [[quarkus-qute_quarkus-qute-timeout]] [.property-path]##link:#quarkus-qute_quarkus-qute-timeout[`quarkus.qute.timeout`]## [.description] -- -Set the pool name, used when the pool is shared among datasources, otherwise ignored. +The global rendering timeout in milliseconds. It is used if no `timeout` template instance attribute is set. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_NAME+++` +Environment variable: `+++QUARKUS_QUTE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|string -| +|long +|`10000` -a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-additional-properties-property-key]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-additional-properties-property-key[`quarkus.datasource.reactive.additional-properties."property-key"`]## +a| [[quarkus-qute_quarkus-qute-use-async-timeout]] [.property-path]##link:#quarkus-qute_quarkus-qute-use-async-timeout[`quarkus.qute.use-async-timeout`]## [.description] -- -Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated. +If set to `true` then the timeout should also be used for asynchronous rendering methods, such as `TemplateInstance++#++createUni()` and `TemplateInstance++#++renderAsync()`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_QUTE_USE_ASYNC_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++` +Environment variable: `+++QUARKUS_QUTE_USE_ASYNC_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|Map -| +|boolean +|`true` + -h|[[quarkus-reactive-datasource_section_quarkus-datasource]] [.section-name.section-level0]##link:#quarkus-reactive-datasource_section_quarkus-datasource[Additional named datasources]## +h|[.extension-name]##Reactive datasource configuration## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive[`quarkus.datasource."datasource-name".reactive`]## +a|icon:lock[title=Fixed at build time] [[quarkus-reactive-datasource_quarkus-datasource-reactive]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive[`quarkus.datasource.reactive`]## + +`quarkus.datasource."datasource-name".reactive` [.description] -- @@ -62790,16 +63181,18 @@ If we create a Reactive datasource for this datasource. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE+++` endif::add-copy-button-to-env-var[] -- |boolean |`true` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-cache-prepared-statements]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-cache-prepared-statements[`quarkus.datasource."datasource-name".reactive.cache-prepared-statements`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-cache-prepared-statements]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-cache-prepared-statements[`quarkus.datasource.reactive.cache-prepared-statements`]## + +`quarkus.datasource."datasource-name".reactive.cache-prepared-statements` [.description] -- @@ -62807,16 +63200,18 @@ Whether prepared statements should be cached on the client side. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_CACHE_PREPARED_STATEMENTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_CACHE_PREPARED_STATEMENTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_CACHE_PREPARED_STATEMENTS+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_CACHE_PREPARED_STATEMENTS+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-url]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-url[`quarkus.datasource."datasource-name".reactive.url`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-url]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-url[`quarkus.datasource.reactive.url`]## + +`quarkus.datasource."datasource-name".reactive.url` [.description] -- @@ -62826,16 +63221,18 @@ If multiple values are set, this datasource will create a pool with a list of se ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_URL+++` endif::add-copy-button-to-env-var[] -- |list of string | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-max-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-max-size[`quarkus.datasource."datasource-name".reactive.max-size`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-max-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-max-size[`quarkus.datasource.reactive.max-size`]## + +`quarkus.datasource."datasource-name".reactive.max-size` [.description] -- @@ -62843,16 +63240,18 @@ The datasource pool maximum size. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_MAX_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_SIZE+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_MAX_SIZE+++` endif::add-copy-button-to-env-var[] -- |int |`20` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-event-loop-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-event-loop-size[`quarkus.datasource."datasource-name".reactive.event-loop-size`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-event-loop-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-event-loop-size[`quarkus.datasource.reactive.event-loop-size`]## + +`quarkus.datasource."datasource-name".reactive.event-loop-size` [.description] -- @@ -62862,16 +63261,18 @@ When `++#++event-loop-size` is set to a strictly positive value, the pool assign ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_EVENT_LOOP_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_EVENT_LOOP_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_EVENT_LOOP_SIZE+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_EVENT_LOOP_SIZE+++` endif::add-copy-button-to-env-var[] -- |int | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-all]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-all[`quarkus.datasource."datasource-name".reactive.trust-all`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-all]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-all[`quarkus.datasource.reactive.trust-all`]## + +`quarkus.datasource."datasource-name".reactive.trust-all` [.description] -- @@ -62879,16 +63280,18 @@ Whether all server certificates should be trusted. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_ALL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_ALL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_ALL+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_ALL+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pem[`quarkus.datasource."datasource-name".reactive.trust-certificate-pem`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem[`quarkus.datasource.reactive.trust-certificate-pem`]## + +`quarkus.datasource."datasource-name".reactive.trust-certificate-pem` [.description] -- @@ -62896,16 +63299,18 @@ PEM Trust config is disabled by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PEM+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PEM+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pem-certs[`quarkus.datasource."datasource-name".reactive.trust-certificate-pem.certs`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem-certs[`quarkus.datasource.reactive.trust-certificate-pem.certs`]## + +`quarkus.datasource."datasource-name".reactive.trust-certificate-pem.certs` [.description] -- @@ -62913,16 +63318,18 @@ Comma-separated list of the trust certificate files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks[`quarkus.datasource."datasource-name".reactive.trust-certificate-jks`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks[`quarkus.datasource.reactive.trust-certificate-jks`]## + +`quarkus.datasource."datasource-name".reactive.trust-certificate-jks` [.description] -- @@ -62930,16 +63337,18 @@ JKS config is disabled by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-path[`quarkus.datasource."datasource-name".reactive.trust-certificate-jks.path`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-path[`quarkus.datasource.reactive.trust-certificate-jks.path`]## + +`quarkus.datasource."datasource-name".reactive.trust-certificate-jks.path` [.description] -- @@ -62947,16 +63356,18 @@ Path of the key file (JKS format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-password[`quarkus.datasource."datasource-name".reactive.trust-certificate-jks.password`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-password[`quarkus.datasource.reactive.trust-certificate-jks.password`]## + +`quarkus.datasource."datasource-name".reactive.trust-certificate-jks.password` [.description] -- @@ -62964,16 +63375,18 @@ Password of the key file. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx[`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx[`quarkus.datasource.reactive.trust-certificate-pfx`]## + +`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx` [.description] -- @@ -62981,16 +63394,18 @@ PFX config is disabled by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-path[`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.path`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-path[`quarkus.datasource.reactive.trust-certificate-pfx.path`]## + +`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.path` [.description] -- @@ -62998,16 +63413,18 @@ Path to the key file (PFX format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-password[`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.password`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-password[`quarkus.datasource.reactive.trust-certificate-pfx.password`]## + +`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.password` [.description] -- @@ -63015,16 +63432,18 @@ Password of the key. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem[`quarkus.datasource."datasource-name".reactive.key-certificate-pem`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem[`quarkus.datasource.reactive.key-certificate-pem`]## + +`quarkus.datasource."datasource-name".reactive.key-certificate-pem` [.description] -- @@ -63032,16 +63451,18 @@ PEM Key/cert config is disabled by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem-keys]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem-keys[`quarkus.datasource."datasource-name".reactive.key-certificate-pem.keys`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-keys]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-keys[`quarkus.datasource.reactive.key-certificate-pem.keys`]## + +`quarkus.datasource."datasource-name".reactive.key-certificate-pem.keys` [.description] -- @@ -63049,16 +63470,18 @@ Comma-separated list of the path to the key files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem-certs[`quarkus.datasource."datasource-name".reactive.key-certificate-pem.certs`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-certs[`quarkus.datasource.reactive.key-certificate-pem.certs`]## + +`quarkus.datasource."datasource-name".reactive.key-certificate-pem.certs` [.description] -- @@ -63066,16 +63489,18 @@ Comma-separated list of the path to the certificate files (Pem format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++` endif::add-copy-button-to-env-var[] -- |list of string | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks[`quarkus.datasource."datasource-name".reactive.key-certificate-jks`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks[`quarkus.datasource.reactive.key-certificate-jks`]## + +`quarkus.datasource."datasource-name".reactive.key-certificate-jks` [.description] -- @@ -63083,16 +63508,18 @@ JKS config is disabled by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks-path[`quarkus.datasource."datasource-name".reactive.key-certificate-jks.path`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-path[`quarkus.datasource.reactive.key-certificate-jks.path`]## + +`quarkus.datasource."datasource-name".reactive.key-certificate-jks.path` [.description] -- @@ -63100,16 +63527,18 @@ Path of the key file (JKS format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PATH+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks-password[`quarkus.datasource."datasource-name".reactive.key-certificate-jks.password`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-password[`quarkus.datasource.reactive.key-certificate-jks.password`]## + +`quarkus.datasource."datasource-name".reactive.key-certificate-jks.password` [.description] -- @@ -63117,16 +63546,18 @@ Password of the key file. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx[`quarkus.datasource."datasource-name".reactive.key-certificate-pfx`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx[`quarkus.datasource.reactive.key-certificate-pfx`]## + +`quarkus.datasource."datasource-name".reactive.key-certificate-pfx` [.description] -- @@ -63134,16 +63565,18 @@ PFX config is disabled by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-path[`quarkus.datasource."datasource-name".reactive.key-certificate-pfx.path`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-path[`quarkus.datasource.reactive.key-certificate-pfx.path`]## + +`quarkus.datasource."datasource-name".reactive.key-certificate-pfx.path` [.description] -- @@ -63151,16 +63584,18 @@ Path to the key file (PFX format). ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PATH+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-password[`quarkus.datasource."datasource-name".reactive.key-certificate-pfx.password`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-password[`quarkus.datasource.reactive.key-certificate-pfx.password`]## + +`quarkus.datasource."datasource-name".reactive.key-certificate-pfx.password` [.description] -- @@ -63168,16 +63603,18 @@ Password of the key. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-reconnect-attempts]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-reconnect-attempts[`quarkus.datasource."datasource-name".reactive.reconnect-attempts`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-attempts]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-attempts[`quarkus.datasource.reactive.reconnect-attempts`]## + +`quarkus.datasource."datasource-name".reactive.reconnect-attempts` [.description] -- @@ -63185,16 +63622,18 @@ The number of reconnection attempts when a pooled connection cannot be establish ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_ATTEMPTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_RECONNECT_ATTEMPTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_ATTEMPTS+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_RECONNECT_ATTEMPTS+++` endif::add-copy-button-to-env-var[] -- |int |`0` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-reconnect-interval]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-reconnect-interval[`quarkus.datasource."datasource-name".reactive.reconnect-interval`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-interval]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-interval[`quarkus.datasource.reactive.reconnect-interval`]## + +`quarkus.datasource."datasource-name".reactive.reconnect-interval` [.description] -- @@ -63202,16 +63641,18 @@ The interval between reconnection attempts when a pooled connection cannot be es ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_INTERVAL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_RECONNECT_INTERVAL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_INTERVAL+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`PT1S` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-hostname-verification-algorithm]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-hostname-verification-algorithm[`quarkus.datasource."datasource-name".reactive.hostname-verification-algorithm`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-hostname-verification-algorithm]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-hostname-verification-algorithm[`quarkus.datasource.reactive.hostname-verification-algorithm`]## + +`quarkus.datasource."datasource-name".reactive.hostname-verification-algorithm` [.description] -- @@ -63219,16 +63660,18 @@ The hostname verification algorithm to use in case the server's identity should ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++` endif::add-copy-button-to-env-var[] -- |string |`NONE` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-idle-timeout]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-idle-timeout[`quarkus.datasource."datasource-name".reactive.idle-timeout`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-idle-timeout]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-idle-timeout[`quarkus.datasource.reactive.idle-timeout`]## + +`quarkus.datasource."datasource-name".reactive.idle-timeout` [.description] -- @@ -63236,16 +63679,18 @@ The maximum time a connection remains unused in the pool before it is closed. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_IDLE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_IDLE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_IDLE_TIMEOUT+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`no timeout` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-max-lifetime]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-max-lifetime[`quarkus.datasource."datasource-name".reactive.max-lifetime`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-max-lifetime]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-max-lifetime[`quarkus.datasource.reactive.max-lifetime`]## + +`quarkus.datasource."datasource-name".reactive.max-lifetime` [.description] -- @@ -63253,16 +63698,18 @@ The maximum time a connection remains in the pool, after which it will be closed ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_LIFETIME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_MAX_LIFETIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_LIFETIME+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_MAX_LIFETIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`no timeout` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-shared]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-shared[`quarkus.datasource."datasource-name".reactive.shared`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-shared]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-shared[`quarkus.datasource.reactive.shared`]## + +`quarkus.datasource."datasource-name".reactive.shared` [.description] -- @@ -63270,16 +63717,18 @@ Set to true to share the pool among datasources. There can be multiple shared po ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_SHARED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_SHARED+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_SHARED+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-name]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-name[`quarkus.datasource."datasource-name".reactive.name`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-name]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-name[`quarkus.datasource.reactive.name`]## + +`quarkus.datasource."datasource-name".reactive.name` [.description] -- @@ -63287,16 +63736,18 @@ Set the pool name, used when the pool is shared among datasources, otherwise ign ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_NAME+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-additional-properties-property-key]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-additional-properties-property-key[`quarkus.datasource."datasource-name".reactive.additional-properties."property-key"`]## +a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-additional-properties-property-key]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-additional-properties-property-key[`quarkus.datasource.reactive.additional-properties."property-key"`]## + +`quarkus.datasource."datasource-name".reactive.additional-properties."property-key"` [.description] -- @@ -63304,17 +63755,16 @@ Other unspecified properties to be passed through the Reactive SQL Client direct ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++` +Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++` endif::add-copy-button-to-env-var[] -- |Map | - h|[.extension-name]##Reactive DB2 client## h|Type h|Default @@ -63541,11 +63991,6 @@ h|[.extension-name]##Reactive Oracle client## h|Type h|Default -h|[[quarkus-reactive-oracle-client_section_quarkus-datasource]] [.section-name.section-level0]##link:#quarkus-reactive-oracle-client_section_quarkus-datasource[Datasources]## -h|Type -h|Default - - h|[.extension-name]##Reactive PostgreSQL client## h|Type @@ -63685,7 +64130,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_REDIS_EXPIRE_AFTER_WRITE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-cache_quarkus-cache-redis-expire-after-access]] [.property-path]##link:#quarkus-redis-cache_quarkus-cache-redis-expire-after-access[`quarkus.cache.redis.expire-after-access`]## @@ -63702,7 +64147,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_REDIS_EXPIRE_AFTER_ACCESS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-cache_quarkus-cache-redis-prefix]] [.property-path]##link:#quarkus-redis-cache_quarkus-cache-redis-prefix[`quarkus.cache.redis.prefix`]## @@ -63791,7 +64236,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_WRITE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-cache_quarkus-cache-redis-cache-name-expire-after-access]] [.property-path]##link:#quarkus-redis-cache_quarkus-cache-redis-cache-name-expire-after-access[`quarkus.cache.redis."cache-name".expire-after-access`]## @@ -63808,7 +64253,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_ACCESS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-cache_quarkus-cache-redis-cache-name-prefix]] [.property-path]##link:#quarkus-redis-cache_quarkus-cache-redis-cache-name-prefix[`quarkus.cache.redis."cache-name".prefix`]## @@ -63929,7 +64374,7 @@ a| [[quarkus-redis-client_quarkus-redis-hosts]] [.property-path]##link:#quarkus- [.description] -- -The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element. +The Redis hosts to use while connecting to the Redis server. Only the cluster and sentinel modes will consider more than 1 element. The URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically. @@ -63969,7 +64414,7 @@ a| [[quarkus-redis-client_quarkus-redis-timeout]] [.property-path]##link:#quarku [.description] -- -The maximum delay to wait before a blocking command to redis server times out +The maximum delay to wait before a blocking command to Redis server times out ifdef::add-copy-button-to-env-var[] @@ -63979,14 +64424,14 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-redis-client_quarkus-redis-client-type]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-client-type[`quarkus.redis.client-type`]## [.description] -- -The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`. +The Redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`. ifdef::add-copy-button-to-env-var[] @@ -64003,7 +64448,7 @@ a| [[quarkus-redis-client_quarkus-redis-master-name]] [.property-path]##link:#qu [.description] -- -The master name (only considered in HA mode). +The master name (only considered in the Sentinel mode). ifdef::add-copy-button-to-env-var[] @@ -64020,7 +64465,7 @@ a| [[quarkus-redis-client_quarkus-redis-role]] [.property-path]##link:#quarkus-r [.description] -- -The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`. +The role name (only considered in the Sentinel mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`. ifdef::add-copy-button-to-env-var[] @@ -64037,7 +64482,7 @@ a| [[quarkus-redis-client_quarkus-redis-replicas]] [.property-path]##link:#quark [.description] -- -Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`. +Whether to use replicas nodes (only considered in Cluster mode and Replication mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`. ifdef::add-copy-button-to-env-var[] @@ -64054,9 +64499,9 @@ a| [[quarkus-redis-client_quarkus-redis-password]] [.property-path]##link:#quark [.description] -- -The default password for cluster/sentinel connections. +The default password for Redis connections. -If not set it will try to extract the value from the current default `++#++hosts`. +If not set, it will try to extract the value from the `hosts`. ifdef::add-copy-button-to-env-var[] @@ -64073,7 +64518,7 @@ a| [[quarkus-redis-client_quarkus-redis-max-pool-size]] [.property-path]##link:# [.description] -- -The maximum size of the connection pool. When working with cluster or sentinel, this value should be at least the total number of cluster members (or number of sentinels {plus} 1) +The maximum size of the connection pool. ifdef::add-copy-button-to-env-var[] @@ -64107,7 +64552,7 @@ a| [[quarkus-redis-client_quarkus-redis-pool-cleaner-interval]] [.property-path] [.description] -- -The duration indicating how often should the connection pool cleaner executes. +The duration indicating how often should the connection pool cleaner execute. ifdef::add-copy-button-to-env-var[] @@ -64117,14 +64562,14 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_POOL_CLEANER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`30s` a| [[quarkus-redis-client_quarkus-redis-pool-recycle-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-pool-recycle-timeout[`quarkus.redis.pool-recycle-timeout`]## [.description] -- -The timeout for a connection recycling. +The timeout for unused connection recycling. ifdef::add-copy-button-to-env-var[] @@ -64134,8 +64579,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_POOL_RECYCLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`15S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`3M` a| [[quarkus-redis-client_quarkus-redis-max-waiting-handlers]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-max-waiting-handlers[`quarkus.redis.max-waiting-handlers`]## @@ -64160,7 +64605,7 @@ a| [[quarkus-redis-client_quarkus-redis-max-nested-arrays]] [.property-path]##li [.description] -- -Tune how much nested arrays are allowed on a redis response. This affects the parser performance. +Tune how much nested arrays are allowed on a Redis response. This affects the parser performance. ifdef::add-copy-button-to-env-var[] @@ -64204,7 +64649,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-redis-client_quarkus-redis-protocol-negotiation]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-protocol-negotiation[`quarkus.redis.protocol-negotiation`]## @@ -64257,9 +64702,91 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_HASH_SLOT_CACHE_TTL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`1S` +a| [[quarkus-redis-client_quarkus-redis-auto-failover]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-auto-failover[`quarkus.redis.auto-failover`]## + +[.description] +-- +Whether automatic failover is enabled. This only makes sense for sentinel clients with role of `MASTER` and is ignored otherwise. + +If enabled, the sentinel client will additionally create a connection to one sentinel node and watch for failover events. When new master is elected, all connections to the old master are automatically closed and new connections to the new master are created. Automatic failover makes sense for connections executing regular commands, but not for connections used to subscribe to Redis pub/sub channels. + +Note that there is a brief period of time between the old master failing and the new master being elected when the existing connections will temporarily fail all operations. After the new master is elected, the connections will automatically fail over and start working again. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_AUTO_FAILOVER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_AUTO_FAILOVER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-redis-client_quarkus-redis-topology]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-topology[`quarkus.redis.topology`]## + +[.description] +-- +How the Redis topology is obtained. By default, the topology is discovered automatically. This is the only mode for the clustered and sentinel client. For replication client, topology may be set _statically_. + +In case of a static topology for replication Redis client, the first node in the list is considered a _master_ and the remaining nodes in the list are considered _replicas_. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_TOPOLOGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_TOPOLOGY+++` +endif::add-copy-button-to-env-var[] +-- +a|`discover`, `static` +|`discover` + +a| [[quarkus-redis-client_quarkus-redis-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-client-name[`quarkus.redis.client-name`]## + +[.description] +-- +The client name used to identify the connection. + +If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation. + +If the `RedisClientConfig++#++configureClientName()` is enabled, both this property and the `RedisClientName++#++value()` must adhere to the pattern '++[++a-zA-Z0-9++\\++-_.~++]*++'; if not, this may result in an incorrect client name after URI encoding. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-redis-client_quarkus-redis-configure-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-configure-client-name[`quarkus.redis.configure-client-name`]## + +[.description] +-- +Whether it should set the client name while connecting with Redis. + +This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}. + +This property can be used with `RedisClientConfig++#++clientName()` configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a| [[quarkus-redis-client_quarkus-redis-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tls-configuration-name[`quarkus.redis.tls-configuration-name`]## [.description] @@ -64344,7 +64871,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-hosts]] [.property-pat [.description] -- -The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element. +The Redis hosts to use while connecting to the Redis server. Only the cluster and sentinel modes will consider more than 1 element. The URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically. @@ -64384,7 +64911,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-timeout]] [.property-p [.description] -- -The maximum delay to wait before a blocking command to redis server times out +The maximum delay to wait before a blocking command to Redis server times out ifdef::add-copy-button-to-env-var[] @@ -64394,14 +64921,14 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-redis-client_quarkus-redis-redis-client-name-client-type]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-client-type[`quarkus.redis."redis-client-name".client-type`]## [.description] -- -The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`. +The Redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`. ifdef::add-copy-button-to-env-var[] @@ -64418,7 +64945,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-master-name]] [.proper [.description] -- -The master name (only considered in HA mode). +The master name (only considered in the Sentinel mode). ifdef::add-copy-button-to-env-var[] @@ -64435,7 +64962,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-role]] [.property-path [.description] -- -The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`. +The role name (only considered in the Sentinel mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`. ifdef::add-copy-button-to-env-var[] @@ -64452,7 +64979,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-replicas]] [.property- [.description] -- -Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`. +Whether to use replicas nodes (only considered in Cluster mode and Replication mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`. ifdef::add-copy-button-to-env-var[] @@ -64469,9 +64996,9 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-password]] [.property- [.description] -- -The default password for cluster/sentinel connections. +The default password for Redis connections. -If not set it will try to extract the value from the current default `++#++hosts`. +If not set, it will try to extract the value from the `hosts`. ifdef::add-copy-button-to-env-var[] @@ -64488,7 +65015,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-max-pool-size]] [.prop [.description] -- -The maximum size of the connection pool. When working with cluster or sentinel, this value should be at least the total number of cluster members (or number of sentinels {plus} 1) +The maximum size of the connection pool. ifdef::add-copy-button-to-env-var[] @@ -64522,7 +65049,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-pool-cleaner-interval] [.description] -- -The duration indicating how often should the connection pool cleaner executes. +The duration indicating how often should the connection pool cleaner execute. ifdef::add-copy-button-to-env-var[] @@ -64532,14 +65059,14 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_CLEANER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`30s` a| [[quarkus-redis-client_quarkus-redis-redis-client-name-pool-recycle-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-pool-recycle-timeout[`quarkus.redis."redis-client-name".pool-recycle-timeout`]## [.description] -- -The timeout for a connection recycling. +The timeout for unused connection recycling. ifdef::add-copy-button-to-env-var[] @@ -64549,8 +65076,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_RECYCLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`15S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +|`3M` a| [[quarkus-redis-client_quarkus-redis-redis-client-name-max-waiting-handlers]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-max-waiting-handlers[`quarkus.redis."redis-client-name".max-waiting-handlers`]## @@ -64575,7 +65102,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-max-nested-arrays]] [. [.description] -- -Tune how much nested arrays are allowed on a redis response. This affects the parser performance. +Tune how much nested arrays are allowed on a Redis response. This affects the parser performance. ifdef::add-copy-button-to-env-var[] @@ -64619,7 +65146,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-redis-client_quarkus-redis-redis-client-name-protocol-negotiation]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-protocol-negotiation[`quarkus.redis."redis-client-name".protocol-negotiation`]## @@ -64672,9 +65199,91 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__HASH_SLOT_CACHE_TTL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`1S` +a| [[quarkus-redis-client_quarkus-redis-redis-client-name-auto-failover]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-auto-failover[`quarkus.redis."redis-client-name".auto-failover`]## + +[.description] +-- +Whether automatic failover is enabled. This only makes sense for sentinel clients with role of `MASTER` and is ignored otherwise. + +If enabled, the sentinel client will additionally create a connection to one sentinel node and watch for failover events. When new master is elected, all connections to the old master are automatically closed and new connections to the new master are created. Automatic failover makes sense for connections executing regular commands, but not for connections used to subscribe to Redis pub/sub channels. + +Note that there is a brief period of time between the old master failing and the new master being elected when the existing connections will temporarily fail all operations. After the new master is elected, the connections will automatically fail over and start working again. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__AUTO_FAILOVER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__AUTO_FAILOVER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-redis-client_quarkus-redis-redis-client-name-topology]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-topology[`quarkus.redis."redis-client-name".topology`]## + +[.description] +-- +How the Redis topology is obtained. By default, the topology is discovered automatically. This is the only mode for the clustered and sentinel client. For replication client, topology may be set _statically_. + +In case of a static topology for replication Redis client, the first node in the list is considered a _master_ and the remaining nodes in the list are considered _replicas_. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TOPOLOGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TOPOLOGY+++` +endif::add-copy-button-to-env-var[] +-- +a|`discover`, `static` +|`discover` + +a| [[quarkus-redis-client_quarkus-redis-redis-client-name-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-client-name[`quarkus.redis."redis-client-name".client-name`]## + +[.description] +-- +The client name used to identify the connection. + +If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation. + +If the `RedisClientConfig++#++configureClientName()` is enabled, both this property and the `RedisClientName++#++value()` must adhere to the pattern '++[++a-zA-Z0-9++\\++-_.~++]*++'; if not, this may result in an incorrect client name after URI encoding. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-redis-client_quarkus-redis-redis-client-name-configure-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-configure-client-name[`quarkus.redis."redis-client-name".configure-client-name`]## + +[.description] +-- +Whether it should set the client name while connecting with Redis. + +This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}. + +This property can be used with `RedisClientConfig++#++clientName()` configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name[`quarkus.redis."redis-client-name".tls-configuration-name`]## [.description] @@ -65001,7 +65610,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-connection-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-connection-timeout[`quarkus.redis.tcp.connection-timeout`]## @@ -65018,7 +65627,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-non-proxy-hosts]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-non-proxy-hosts[`quarkus.redis.tcp.non-proxy-hosts`]## @@ -65137,7 +65746,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_READ_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-receive-buffer-size]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-receive-buffer-size[`quarkus.redis.tcp.receive-buffer-size`]## @@ -65188,7 +65797,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-reuse-address]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-reuse-address[`quarkus.redis.tcp.reuse-address`]## @@ -65256,7 +65865,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_SO_LINGER+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-cork]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-cork[`quarkus.redis.tcp.cork`]## @@ -65375,7 +65984,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_WRITE_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-local-address]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-local-address[`quarkus.redis.tcp.local-address`]## @@ -65812,7 +66421,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-connection-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-connection-timeout[`quarkus.redis."redis-client-name".tcp.connection-timeout`]## @@ -65829,7 +66438,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-non-proxy-hosts]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-non-proxy-hosts[`quarkus.redis."redis-client-name".tcp.non-proxy-hosts`]## @@ -65948,7 +66557,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_READ_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-receive-buffer-size]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-receive-buffer-size[`quarkus.redis."redis-client-name".tcp.receive-buffer-size`]## @@ -65999,7 +66608,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-reuse-address]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-reuse-address[`quarkus.redis."redis-client-name".tcp.reuse-address`]## @@ -66067,7 +66676,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_SO_LINGER+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-cork]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-cork[`quarkus.redis."redis-client-name".tcp.cork`]## @@ -66186,7 +66795,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_WRITE_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-local-address]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-local-address[`quarkus.redis."redis-client-name".tcp.local-address`]## @@ -66641,7 +67250,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REST_CSRF_COOKIE_MAX_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`2H` a| [[quarkus-rest-csrf_quarkus-rest-csrf-cookie-path]] [.property-path]##link:#quarkus-rest-csrf_quarkus-rest-csrf-cookie-path[`quarkus.rest-csrf.cookie-path`]## @@ -66829,6 +67438,25 @@ h|[.extension-name]##REST Client## h|Type h|Default +a|icon:lock[title=Fixed at build time] [[quarkus-rest-client_quarkus-rest-client-disable-smart-produces]] [.property-path]##link:#quarkus-rest-client_quarkus-rest-client-disable-smart-produces[`quarkus.rest-client.disable-smart-produces`]## + +[.description] +-- +By default, RESTEasy Reactive uses text/plain content type for String values and application/json for everything else. + +MicroProfile Rest Client spec requires the implementations to always default to application/json. This build item disables the "smart" behavior of RESTEasy Reactive to comply to the spec + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_DISABLE_SMART_PRODUCES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_CLIENT_DISABLE_SMART_PRODUCES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a|icon:lock[title=Fixed at build time] [[quarkus-rest-client_quarkus-rest-client-provider-autodiscovery]] [.property-path]##link:#quarkus-rest-client_quarkus-rest-client-provider-autodiscovery[`quarkus.rest-client.provider-autodiscovery`]## [.description] @@ -67516,7 +68144,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REST_CLIENT_MAX_CHUNK_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`8k` a| [[quarkus-rest-client-config_quarkus-rest-client-alpn]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-alpn[`quarkus.rest-client.alpn`]## @@ -67551,7 +68179,7 @@ Environment variable: `+++QUARKUS_REST_CLIENT_CAPTURE_STACKTRACE+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` +|`false` a| [[quarkus-rest-client-config_quarkus-rest-client-logging-scope]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-logging-scope[`quarkus.rest-client.logging.scope`]## @@ -68231,7 +68859,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__MAX_CHUNK_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`8K` a| [[quarkus-rest-client-config_quarkus-rest-client-client-alpn]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-alpn[`quarkus.rest-client."client".alpn`]## @@ -68306,7 +68934,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REST_INPUT_BUFFER_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`10k` a|icon:lock[title=Fixed at build time] [[quarkus-rest_quarkus-rest-min-chunk-size]] [.property-path]##link:#quarkus-rest_quarkus-rest-min-chunk-size[`quarkus.rest.min-chunk-size`]## @@ -68784,40 +69412,6 @@ h|[.extension-name]##RESTEasy Classic## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-resteasy_quarkus-security-jaxrs-deny-unannotated-endpoints]] [.property-path]##link:#quarkus-resteasy_quarkus-security-jaxrs-deny-unannotated-endpoints[`quarkus.security.jaxrs.deny-unannotated-endpoints`]## - -[.description] --- -if set to true, access to all JAX-RS resources will be denied by default - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SECURITY_JAXRS_DENY_UNANNOTATED_ENDPOINTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SECURITY_JAXRS_DENY_UNANNOTATED_ENDPOINTS+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-resteasy_quarkus-security-jaxrs-default-roles-allowed]] [.property-path]##link:#quarkus-resteasy_quarkus-security-jaxrs-default-roles-allowed[`quarkus.security.jaxrs.default-roles-allowed`]## - -[.description] --- -If no security annotations are affecting a method then they will default to requiring these roles, (equivalent to adding an @RolesAllowed annotation with the roles to every endpoint class). The role of '++**++' means any authenticated user, which is equivalent to the `io.quarkus.security.Authenticated` annotation. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SECURITY_JAXRS_DEFAULT_ROLES_ALLOWED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SECURITY_JAXRS_DEFAULT_ROLES_ALLOWED+++` -endif::add-copy-button-to-env-var[] --- -|list of string -| - a|icon:lock[title=Fixed at build time] [[quarkus-resteasy_quarkus-resteasy-vertx-response-buffer-size]] [.property-path]##link:#quarkus-resteasy_quarkus-resteasy-vertx-response-buffer-size[`quarkus.resteasy.vertx.response-buffer-size`]## [.description] @@ -68868,7 +69462,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_RESTEASY_GZIP_MAX_INPUT+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] |`10M` a|icon:lock[title=Fixed at build time] [[quarkus-resteasy_quarkus-resteasy-json-json-default]] [.property-path]##link:#quarkus-resteasy_quarkus-resteasy-json-json-default[`quarkus.resteasy-json.json-default`]## @@ -68888,6 +69482,40 @@ endif::add-copy-button-to-env-var[] |boolean |`true` +a|icon:lock[title=Fixed at build time] [[quarkus-resteasy_quarkus-security-jaxrs-deny-unannotated-endpoints]] [.property-path]##link:#quarkus-resteasy_quarkus-security-jaxrs-deny-unannotated-endpoints[`quarkus.security.jaxrs.deny-unannotated-endpoints`]## + +[.description] +-- +if set to true, access to all JAX-RS resources will be denied by default + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECURITY_JAXRS_DENY_UNANNOTATED_ENDPOINTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECURITY_JAXRS_DENY_UNANNOTATED_ENDPOINTS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-resteasy_quarkus-security-jaxrs-default-roles-allowed]] [.property-path]##link:#quarkus-resteasy_quarkus-security-jaxrs-default-roles-allowed[`quarkus.security.jaxrs.default-roles-allowed`]## + +[.description] +-- +If no security annotations are affecting a method then they will default to requiring these roles, (equivalent to adding an @RolesAllowed annotation with the roles to every endpoint class). The role of '++**++' means any authenticated user, which is equivalent to the `io.quarkus.security.Authenticated` annotation. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECURITY_JAXRS_DEFAULT_ROLES_ALLOWED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECURITY_JAXRS_DEFAULT_ROLES_ALLOWED+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + h|[.extension-name]##RESTEasy Classic - Server common## h|Type @@ -69286,7 +69914,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SCHEDULER_OVERDUE_GRACE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-scheduler_quarkus-scheduler-start-mode]] [.property-path]##link:#quarkus-scheduler_quarkus-scheduler-start-mode[`quarkus.scheduler.start-mode`]## @@ -69718,7 +70346,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBAUTHN_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`60s` a| [[quarkus-security-webauthn_quarkus-webauthn-attestation]] [.property-path]##link:#quarkus-security-webauthn_quarkus-webauthn-attestation[`quarkus.webauthn.attestation`]## @@ -69808,7 +70436,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBAUTHN_SESSION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`PT30M` a| [[quarkus-security-webauthn_quarkus-webauthn-new-cookie-interval]] [.property-path]##link:#quarkus-security-webauthn_quarkus-webauthn-new-cookie-interval[`quarkus.webauthn.new-cookie-interval`]## @@ -69825,7 +70453,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBAUTHN_NEW_COOKIE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`PT1M` a| [[quarkus-security-webauthn_quarkus-webauthn-cookie-name]] [.property-path]##link:#quarkus-security-webauthn_quarkus-webauthn-cookie-name[`quarkus.webauthn.cookie-name`]## @@ -69913,6 +70541,23 @@ endif::add-copy-button-to-env-var[] |string |`/` +a| [[quarkus-security-webauthn_quarkus-webauthn-cookie-max-age]] [.property-path]##link:#quarkus-security-webauthn_quarkus-webauthn-cookie-max-age[`quarkus.webauthn.cookie-max-age`]## + +[.description] +-- +Max-Age attribute for the session cookie. This is the amount of time the browser will keep the cookie. The default value is empty, which means the cookie will be kept until the browser is closed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBAUTHN_COOKIE_MAX_AGE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBAUTHN_COOKIE_MAX_AGE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] +| + h|[.extension-name]##SmallRye GraphQL## h|Type @@ -70642,108 +71287,6 @@ endif::add-copy-button-to-env-var[] |int | -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store[`quarkus.smallrye-graphql-client."clients".trust-store`]## - -[.description] --- -The trust store location. Can point to either a classpath resource or a file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store-password]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store-password[`quarkus.smallrye-graphql-client."clients".trust-store-password`]## - -[.description] --- -The trust store password. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store-type]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store-type[`quarkus.smallrye-graphql-client."clients".trust-store-type`]## - -[.description] --- -The type of the trust store. Defaults to "JKS". - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store[`quarkus.smallrye-graphql-client."clients".key-store`]## - -[.description] --- -The key store location. Can point to either a classpath resource or a file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store-password]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store-password[`quarkus.smallrye-graphql-client."clients".key-store-password`]## - -[.description] --- -The key store password. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store-type]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store-type[`quarkus.smallrye-graphql-client."clients".key-store-type`]## - -[.description] --- -The type of the key store. Defaults to "JKS". - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-proxy-host]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-proxy-host[`quarkus.smallrye-graphql-client."clients".proxy-host`]## [.description] @@ -70863,6 +71406,23 @@ endif::add-copy-button-to-env-var[] |boolean | +a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-tls-configuration-name]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-tls-configuration-name[`quarkus.smallrye-graphql-client."clients".tls-configuration-name`]## + +[.description] +-- +The name of the TLS configuration (bucket) used for client authentication in the TLS registry. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + h|[.extension-name]##SmallRye Health## h|Type @@ -71089,6 +71649,23 @@ endif::add-copy-button-to-env-var[] |boolean |`true` +a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-health_quarkus-smallrye-health-include-problem-details]] [.property-path]##link:#quarkus-smallrye-health_quarkus-smallrye-health-include-problem-details[`quarkus.smallrye-health.include-problem-details`]## + +[.description] +-- +Specify the reported DOWN responses should be aligned with RFC 9457 - Problem Details for HTTP APIs. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_HEALTH_INCLUDE_PROBLEM_DETAILS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SMALLRYE_HEALTH_INCLUDE_PROBLEM_DETAILS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a| [[quarkus-smallrye-health_quarkus-smallrye-health-ui-enable]] [.property-path]##link:#quarkus-smallrye-health_quarkus-smallrye-health-ui-enable[`quarkus.smallrye-health.ui.enable`]## [.description] @@ -73626,7 +74203,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TLS_HANDSHAKE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-tls-registry_quarkus-tls-alpn]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-alpn[`quarkus.tls.alpn`]## @@ -73727,7 +74304,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TLS_RELOAD_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-tls-registry_quarkus-tls-key-store-pem-key-certs-key]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-key-store-pem-key-certs-key[`quarkus.tls.key-store.pem."key-certs".key`]## @@ -74358,7 +74935,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-alpn]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-alpn[`quarkus.tls."tls-bucket-name".alpn`]## @@ -74459,7 +75036,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__RELOAD_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | @@ -74520,7 +75097,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SERVLET_BUFFER_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-all-config[icon:question-circle[title=More information about the MemorySize format]] | a| [[quarkus-undertow_quarkus-servlet-direct-buffers]] [.property-path]##link:#quarkus-undertow_quarkus-servlet-direct-buffers[`quarkus.servlet.direct-buffers`]## @@ -74646,7 +75223,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_MAX_EVENT_LOOP_EXECUTE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-vertx_quarkus-vertx-warning-exception-time]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-warning-exception-time[`quarkus.vertx.warning-exception-time`]## @@ -74663,7 +75240,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_WARNING_EXCEPTION_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-vertx_quarkus-vertx-max-worker-execute-time]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-max-worker-execute-time[`quarkus.vertx.max-worker-execute-time`]## @@ -74680,7 +75257,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_MAX_WORKER_EXECUTE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-vertx_quarkus-vertx-internal-blocking-pool-size]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-internal-blocking-pool-size[`quarkus.vertx.internal-blocking-pool-size`]## @@ -74750,7 +75327,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_KEEP_ALIVE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-vertx_quarkus-vertx-prefill]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-prefill[`quarkus.vertx.prefill`]## @@ -75124,7 +75701,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_EVENTBUS_CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-vertx_quarkus-vertx-eventbus-idle-timeout]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-eventbus-idle-timeout[`quarkus.vertx.eventbus.idle-timeout`]## @@ -75141,7 +75718,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_EVENTBUS_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx_quarkus-vertx-eventbus-receive-buffer-size]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-eventbus-receive-buffer-size[`quarkus.vertx.eventbus.receive-buffer-size`]## @@ -75192,7 +75769,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_EVENTBUS_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-vertx_quarkus-vertx-eventbus-reuse-address]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-eventbus-reuse-address[`quarkus.vertx.eventbus.reuse-address`]## @@ -75447,7 +76024,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_CLUSTER_PING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`20S` a| [[quarkus-vertx_quarkus-vertx-cluster-ping-reply-interval]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-cluster-ping-reply-interval[`quarkus.vertx.cluster.ping-reply-interval`]## @@ -75464,7 +76041,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_CLUSTER_PING_REPLY_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`20S` a| [[quarkus-vertx_quarkus-vertx-resolver-cache-max-time-to-live]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-resolver-cache-max-time-to-live[`quarkus.vertx.resolver.cache-max-time-to-live`]## @@ -75551,7 +76128,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_RESOLVER_QUERY_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-vertx_quarkus-vertx-resolver-hosts-path]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-resolver-hosts-path[`quarkus.vertx.resolver.hosts-path`]## @@ -75766,7 +76343,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`1M` a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-shutdown-check-interval]] [.property-path]##link:#quarkus-virtual-threads_quarkus-virtual-threads-shutdown-check-interval[`quarkus.virtual-threads.shutdown-check-interval`]## @@ -75783,7 +76360,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_CHECK_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-enabled]] [.property-path]##link:#quarkus-virtual-threads_quarkus-virtual-threads-enabled[`quarkus.virtual-threads.enabled`]## @@ -75991,7 +76568,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_AUTO_PING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy[`quarkus.websockets-next.client.unhandled-failure-strategy`]## @@ -76000,7 +76577,9 @@ a| [[quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-st -- The strategy used when an error occurs but no error handler can handle the failure. -By default, the connection is closed when an unhandled failure occurs. +By default, the error message is logged when an unhandled failure occurs. + +Note that clients should not close the WebSocket connection arbitrarily. See also RFC-6455 link:https://datatracker.ietf.org/doc/html/rfc6455#section-7.3[section 7.3]. ifdef::add-copy-button-to-env-var[] @@ -76010,8 +76589,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_UNHANDLED_FAILURE_STRATEGY+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:close[Close the connection.], tooltip:log[Log an error message.], tooltip:noop[No operation.] -|tooltip:close[Close the connection.] +a|tooltip:log-and-close[Log the error message and close the connection.], tooltip:close[Close the connection silently.], tooltip:log[Log the error message.], tooltip:noop[No operation.] +|tooltip:log[Log the error message.] a| [[quarkus-websockets-next_quarkus-websockets-next-client-tls-configuration-name]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-tls-configuration-name[`quarkus.websockets-next.client.tls-configuration-name`]## @@ -76154,7 +76733,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-websockets-next_quarkus-websockets-next-server-unhandled-failure-strategy]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-server-unhandled-failure-strategy[`quarkus.websockets-next.server.unhandled-failure-strategy`]## @@ -76163,7 +76742,7 @@ a| [[quarkus-websockets-next_quarkus-websockets-next-server-unhandled-failure-st -- The strategy used when an error occurs but no error handler can handle the failure. -By default, the connection is closed when an unhandled failure occurs. +By default, the error message is logged and the connection is closed when an unhandled failure occurs. ifdef::add-copy-button-to-env-var[] @@ -76173,8 +76752,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_UNHANDLED_FAILURE_STRATEGY+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:close[Close the connection.], tooltip:log[Log an error message.], tooltip:noop[No operation.] -|tooltip:close[Close the connection.] +a|tooltip:log-and-close[Log the error message and close the connection.], tooltip:close[Close the connection silently.], tooltip:log[Log the error message.], tooltip:noop[No operation.] +|tooltip:log-and-close[Log the error message and close the connection.] a| [[quarkus-websockets-next_quarkus-websockets-next-server-security-auth-failure-redirect-url]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-server-security-auth-failure-redirect-url[`quarkus.websockets-next.server.security.auth-failure-redirect-url`]## @@ -76275,5 +76854,3 @@ A size configuration option recognizes strings in this format (shown as a regula If no suffix is given, assume bytes. ==== ifndef::no-memory-size-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-amazon-lambda-http.adoc b/_generated-doc/latest/config/quarkus-amazon-lambda-http.adoc index 1f48887fe55..7b14f6ecddf 100644 --- a/_generated-doc/latest/config/quarkus-amazon-lambda-http.adoc +++ b/_generated-doc/latest/config/quarkus-amazon-lambda-http.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-amazon-lambda-http_quarkus-lambda-http [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-amazon-lambda-http_quarkus.lambda-http.adoc b/_generated-doc/latest/config/quarkus-amazon-lambda-http_quarkus.lambda-http.adoc index 1f48887fe55..7b14f6ecddf 100644 --- a/_generated-doc/latest/config/quarkus-amazon-lambda-http_quarkus.lambda-http.adoc +++ b/_generated-doc/latest/config/quarkus-amazon-lambda-http_quarkus.lambda-http.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-amazon-lambda-http_quarkus-lambda-http [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-amazon-lambda-rest.adoc b/_generated-doc/latest/config/quarkus-amazon-lambda-rest.adoc index 9f8fee1e0af..624cab8528b 100644 --- a/_generated-doc/latest/config/quarkus-amazon-lambda-rest.adoc +++ b/_generated-doc/latest/config/quarkus-amazon-lambda-rest.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-amazon-lambda-rest_quarkus-lambda-http [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-amazon-lambda-rest_quarkus.lambda-http.adoc b/_generated-doc/latest/config/quarkus-amazon-lambda-rest_quarkus.lambda-http.adoc index 9f8fee1e0af..624cab8528b 100644 --- a/_generated-doc/latest/config/quarkus-amazon-lambda-rest_quarkus.lambda-http.adoc +++ b/_generated-doc/latest/config/quarkus-amazon-lambda-rest_quarkus.lambda-http.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-amazon-lambda-rest_quarkus-lambda-http [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-amazon-lambda.adoc b/_generated-doc/latest/config/quarkus-amazon-lambda.adoc index 74e0bd0a94a..c4e2dcb4291 100644 --- a/_generated-doc/latest/config/quarkus-amazon-lambda.adoc +++ b/_generated-doc/latest/config/quarkus-amazon-lambda.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-amazon-lambda_quarkus-lambda [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -95,5 +94,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-amazon-lambda_quarkus.lambda.adoc b/_generated-doc/latest/config/quarkus-amazon-lambda_quarkus.lambda.adoc index 74e0bd0a94a..c4e2dcb4291 100644 --- a/_generated-doc/latest/config/quarkus-amazon-lambda_quarkus.lambda.adoc +++ b/_generated-doc/latest/config/quarkus-amazon-lambda_quarkus.lambda.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-amazon-lambda_quarkus-lambda [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -95,5 +94,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-arc.adoc b/_generated-doc/latest/config/quarkus-arc.adoc index e7f5a4042fb..b7eb09116b2 100644 --- a/_generated-doc/latest/config/quarkus-arc.adoc +++ b/_generated-doc/latest/config/quarkus-arc.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-arc_quarkus-arc [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -405,5 +404,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-arc_quarkus.arc.adoc b/_generated-doc/latest/config/quarkus-arc_quarkus.arc.adoc index e7f5a4042fb..b7eb09116b2 100644 --- a/_generated-doc/latest/config/quarkus-arc_quarkus.arc.adoc +++ b/_generated-doc/latest/config/quarkus-arc_quarkus.arc.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-arc_quarkus-arc [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -405,5 +404,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-azure-functions.adoc b/_generated-doc/latest/config/quarkus-azure-functions.adoc index cbba5ade2d2..18d4e894e1e 100644 --- a/_generated-doc/latest/config/quarkus-azure-functions.adoc +++ b/_generated-doc/latest/config/quarkus-azure-functions.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-azure-functions_quarkus-azure-functions [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -364,5 +363,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-azure-functions_quarkus.azure-functions.adoc b/_generated-doc/latest/config/quarkus-azure-functions_quarkus.azure-functions.adoc index cbba5ade2d2..18d4e894e1e 100644 --- a/_generated-doc/latest/config/quarkus-azure-functions_quarkus.azure-functions.adoc +++ b/_generated-doc/latest/config/quarkus-azure-functions_quarkus.azure-functions.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-azure-functions_quarkus-azure-functions [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -364,5 +363,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-cache.adoc b/_generated-doc/latest/config/quarkus-cache.adoc index 554dfff30fd..4c7ff5243a1 100644 --- a/_generated-doc/latest/config/quarkus-cache.adoc +++ b/_generated-doc/latest/config/quarkus-cache.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-cache_quarkus-cache [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -94,7 +93,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_CAFFEINE_EXPIRE_AFTER_WRITE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-cache_quarkus-cache-caffeine-expire-after-access]] [.property-path]##link:#quarkus-cache_quarkus-cache-caffeine-expire-after-access[`quarkus.cache.caffeine.expire-after-access`]## @@ -111,7 +110,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_CAFFEINE_EXPIRE_AFTER_ACCESS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-cache_quarkus-cache-caffeine-metrics-enabled]] [.property-path]##link:#quarkus-cache_quarkus-cache-caffeine-metrics-enabled[`quarkus.cache.caffeine.metrics-enabled`]## @@ -179,7 +178,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_CAFFEINE__CACHE_NAME__EXPIRE_AFTER_WRITE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-cache_quarkus-cache-caffeine-cache-name-expire-after-access]] [.property-path]##link:#quarkus-cache_quarkus-cache-caffeine-cache-name-expire-after-access[`quarkus.cache.caffeine."cache-name".expire-after-access`]## @@ -196,7 +195,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_CAFFEINE__CACHE_NAME__EXPIRE_AFTER_ACCESS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-cache_quarkus-cache-caffeine-cache-name-metrics-enabled]] [.property-path]##link:#quarkus-cache_quarkus-cache-caffeine-cache-name-metrics-enabled[`quarkus.cache.caffeine."cache-name".metrics-enabled`]## @@ -238,5 +237,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-cache_quarkus.cache.adoc b/_generated-doc/latest/config/quarkus-cache_quarkus.cache.adoc index 554dfff30fd..4c7ff5243a1 100644 --- a/_generated-doc/latest/config/quarkus-cache_quarkus.cache.adoc +++ b/_generated-doc/latest/config/quarkus-cache_quarkus.cache.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-cache_quarkus-cache [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -94,7 +93,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_CAFFEINE_EXPIRE_AFTER_WRITE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-cache_quarkus-cache-caffeine-expire-after-access]] [.property-path]##link:#quarkus-cache_quarkus-cache-caffeine-expire-after-access[`quarkus.cache.caffeine.expire-after-access`]## @@ -111,7 +110,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_CAFFEINE_EXPIRE_AFTER_ACCESS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-cache_quarkus-cache-caffeine-metrics-enabled]] [.property-path]##link:#quarkus-cache_quarkus-cache-caffeine-metrics-enabled[`quarkus.cache.caffeine.metrics-enabled`]## @@ -179,7 +178,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_CAFFEINE__CACHE_NAME__EXPIRE_AFTER_WRITE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-cache_quarkus-cache-caffeine-cache-name-expire-after-access]] [.property-path]##link:#quarkus-cache_quarkus-cache-caffeine-cache-name-expire-after-access[`quarkus.cache.caffeine."cache-name".expire-after-access`]## @@ -196,7 +195,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_CAFFEINE__CACHE_NAME__EXPIRE_AFTER_ACCESS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-cache_quarkus-cache-caffeine-cache-name-metrics-enabled]] [.property-path]##link:#quarkus-cache_quarkus-cache-caffeine-cache-name-metrics-enabled[`quarkus.cache.caffeine."cache-name".metrics-enabled`]## @@ -238,5 +237,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-container-image-buildpack.adoc b/_generated-doc/latest/config/quarkus-container-image-buildpack.adoc index d7fa297442a..bdfcacd656e 100644 --- a/_generated-doc/latest/config/quarkus-container-image-buildpack.adoc +++ b/_generated-doc/latest/config/quarkus-container-image-buildpack.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-container-image-buildpack_quarkus-buildpack [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -23,13 +22,13 @@ Environment variable: `+++QUARKUS_BUILDPACK_JVM_BUILDER_IMAGE+++` endif::add-copy-button-to-env-var[] -- |string -| +|`paketocommunity/builder-ubi-base:latest` a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-native-builder-image]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-native-builder-image[`quarkus.buildpack.native-builder-image`]## [.description] -- -The buildpacks builder image to use when building the project in jvm mode. +The buildpacks builder image to use when building the project in native mode. ifdef::add-copy-button-to-env-var[] @@ -42,6 +41,23 @@ endif::add-copy-button-to-env-var[] |string | +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-trust-builder-image]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-trust-builder-image[`quarkus.buildpack.trust-builder-image`]## + +[.description] +-- +Should the builder image be 'trusted' (use creator lifecycle) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_TRUST_BUILDER_IMAGE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_BUILDPACK_TRUST_BUILDER_IMAGE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-builder-env-environment-variable-name]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-builder-env-environment-variable-name[`quarkus.buildpack.builder-env."environment-variable-name"`]## [.description] @@ -80,7 +96,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quark [.description] -- -Max pull timeout for builder/run images, in seconds +Initial pull timeout for builder/run images, in seconds ifdef::add-copy-button-to-env-var[] @@ -93,11 +109,45 @@ endif::add-copy-button-to-env-var[] |int |`300` +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-pull-timeout-increase-seconds]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-pull-timeout-increase-seconds[`quarkus.buildpack.pull-timeout-increase-seconds`]## + +[.description] +-- +Increase pull timeout for builder/run images after failure, in seconds + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_PULL_TIMEOUT_INCREASE_SECONDS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_BUILDPACK_PULL_TIMEOUT_INCREASE_SECONDS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`15` + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-pull-retry-count]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-pull-retry-count[`quarkus.buildpack.pull-retry-count`]## + +[.description] +-- +How many times to retry an image pull after a failure + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_PULL_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_BUILDPACK_PULL_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-docker-host]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-docker-host[`quarkus.buildpack.docker-host`]## [.description] -- -DOCKER_HOST value to use. If not set, the env var DOCKER_HOST is used, if that is not set the value `unix:///var/run/docker.sock' (or 'npipe:///./pipe/docker_engine' for windows) is used. +DOCKER_HOST value to use. If not set, the env var DOCKER_HOST is used, if that is not set the platform will look for 'npipe:///./pipe/docker_engine' for windows, and `unix:///var/run/docker.sock' then `unix:///var/run/podman.sock` then `unix:///var/run/user//podman/podman.sock` for linux ifdef::add-copy-button-to-env-var[] @@ -163,5 +213,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-container-image-buildpack_quarkus.buildpack.adoc b/_generated-doc/latest/config/quarkus-container-image-buildpack_quarkus.buildpack.adoc index d7fa297442a..bdfcacd656e 100644 --- a/_generated-doc/latest/config/quarkus-container-image-buildpack_quarkus.buildpack.adoc +++ b/_generated-doc/latest/config/quarkus-container-image-buildpack_quarkus.buildpack.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-container-image-buildpack_quarkus-buildpack [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -23,13 +22,13 @@ Environment variable: `+++QUARKUS_BUILDPACK_JVM_BUILDER_IMAGE+++` endif::add-copy-button-to-env-var[] -- |string -| +|`paketocommunity/builder-ubi-base:latest` a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-native-builder-image]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-native-builder-image[`quarkus.buildpack.native-builder-image`]## [.description] -- -The buildpacks builder image to use when building the project in jvm mode. +The buildpacks builder image to use when building the project in native mode. ifdef::add-copy-button-to-env-var[] @@ -42,6 +41,23 @@ endif::add-copy-button-to-env-var[] |string | +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-trust-builder-image]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-trust-builder-image[`quarkus.buildpack.trust-builder-image`]## + +[.description] +-- +Should the builder image be 'trusted' (use creator lifecycle) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_TRUST_BUILDER_IMAGE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_BUILDPACK_TRUST_BUILDER_IMAGE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-builder-env-environment-variable-name]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-builder-env-environment-variable-name[`quarkus.buildpack.builder-env."environment-variable-name"`]## [.description] @@ -80,7 +96,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quark [.description] -- -Max pull timeout for builder/run images, in seconds +Initial pull timeout for builder/run images, in seconds ifdef::add-copy-button-to-env-var[] @@ -93,11 +109,45 @@ endif::add-copy-button-to-env-var[] |int |`300` +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-pull-timeout-increase-seconds]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-pull-timeout-increase-seconds[`quarkus.buildpack.pull-timeout-increase-seconds`]## + +[.description] +-- +Increase pull timeout for builder/run images after failure, in seconds + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_PULL_TIMEOUT_INCREASE_SECONDS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_BUILDPACK_PULL_TIMEOUT_INCREASE_SECONDS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`15` + +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-pull-retry-count]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-pull-retry-count[`quarkus.buildpack.pull-retry-count`]## + +[.description] +-- +How many times to retry an image pull after a failure + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_PULL_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_BUILDPACK_PULL_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-docker-host]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-docker-host[`quarkus.buildpack.docker-host`]## [.description] -- -DOCKER_HOST value to use. If not set, the env var DOCKER_HOST is used, if that is not set the value `unix:///var/run/docker.sock' (or 'npipe:///./pipe/docker_engine' for windows) is used. +DOCKER_HOST value to use. If not set, the env var DOCKER_HOST is used, if that is not set the platform will look for 'npipe:///./pipe/docker_engine' for windows, and `unix:///var/run/docker.sock' then `unix:///var/run/podman.sock` then `unix:///var/run/user//podman/podman.sock` for linux ifdef::add-copy-button-to-env-var[] @@ -163,5 +213,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-container-image-docker.adoc b/_generated-doc/latest/config/quarkus-container-image-docker.adoc index dcf4731c641..b42122a9453 100644 --- a/_generated-doc/latest/config/quarkus-container-image-docker.adoc +++ b/_generated-doc/latest/config/quarkus-container-image-docker.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-container-image-docker_quarkus-docker [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -171,5 +170,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-container-image-docker_quarkus.docker.adoc b/_generated-doc/latest/config/quarkus-container-image-docker_quarkus.docker.adoc index dcf4731c641..b42122a9453 100644 --- a/_generated-doc/latest/config/quarkus-container-image-docker_quarkus.docker.adoc +++ b/_generated-doc/latest/config/quarkus-container-image-docker_quarkus.docker.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-container-image-docker_quarkus-docker [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -171,5 +170,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-container-image-jib.adoc b/_generated-doc/latest/config/quarkus-container-image-jib.adoc index 3f8ae9ccfb2..8f8d6642f04 100644 --- a/_generated-doc/latest/config/quarkus-container-image-jib.adoc +++ b/_generated-doc/latest/config/quarkus-container-image-jib.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-container-image-jib_quarkus-jib [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -439,5 +438,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-container-image-jib_quarkus.jib.adoc b/_generated-doc/latest/config/quarkus-container-image-jib_quarkus.jib.adoc index 3f8ae9ccfb2..8f8d6642f04 100644 --- a/_generated-doc/latest/config/quarkus-container-image-jib_quarkus.jib.adoc +++ b/_generated-doc/latest/config/quarkus-container-image-jib_quarkus.jib.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-container-image-jib_quarkus-jib [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -439,5 +438,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-container-image-openshift_quarkus.openshift.adoc b/_generated-doc/latest/config/quarkus-container-image-openshift_quarkus.openshift.adoc index 3b14d62fb6e..5cfc5a55f60 100644 --- a/_generated-doc/latest/config/quarkus-container-image-openshift_quarkus.openshift.adoc +++ b/_generated-doc/latest/config/quarkus-container-image-openshift_quarkus.openshift.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-container-image-openshift_quarkus-openshift [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -209,7 +208,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_BUILD_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-container-image-openshift_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`PT5M` a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-build-log-level]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-build-log-level[`quarkus.openshift.build-log-level`]## @@ -267,5 +266,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-container-image-openshift_quarkus.s2i.adoc b/_generated-doc/latest/config/quarkus-container-image-openshift_quarkus.s2i.adoc index d1784349fa5..11560ffe2d3 100644 --- a/_generated-doc/latest/config/quarkus-container-image-openshift_quarkus.s2i.adoc +++ b/_generated-doc/latest/config/quarkus-container-image-openshift_quarkus.s2i.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-container-image-openshift_quarkus-s2i [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -175,7 +174,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S2I_BUILD_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-container-image-openshift_quarkus-s2i[icon:question-circle[title=More information about the Duration format]] |`PT5M` |=== @@ -199,5 +198,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-container-image-podman.adoc b/_generated-doc/latest/config/quarkus-container-image-podman.adoc index a94ff2c51c0..824e46e8fec 100644 --- a/_generated-doc/latest/config/quarkus-container-image-podman.adoc +++ b/_generated-doc/latest/config/quarkus-container-image-podman.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-container-image-podman_quarkus-podman [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -130,7 +129,22 @@ endif::add-copy-button-to-env-var[] |list of string | -|=== +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-tls-verify]] [.property-path]##link:#quarkus-container-image-podman_quarkus-podman-tls-verify[`quarkus.podman.tls-verify`]## + +[.description] +-- +Require HTTPS and verify certificates when contacting registries + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_TLS_VERIFY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_TLS_VERIFY+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` +|=== -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-container-image-podman_quarkus.podman.adoc b/_generated-doc/latest/config/quarkus-container-image-podman_quarkus.podman.adoc index a94ff2c51c0..824e46e8fec 100644 --- a/_generated-doc/latest/config/quarkus-container-image-podman_quarkus.podman.adoc +++ b/_generated-doc/latest/config/quarkus-container-image-podman_quarkus.podman.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-container-image-podman_quarkus-podman [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -130,7 +129,22 @@ endif::add-copy-button-to-env-var[] |list of string | -|=== +a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-podman-tls-verify]] [.property-path]##link:#quarkus-container-image-podman_quarkus-podman-tls-verify[`quarkus.podman.tls-verify`]## + +[.description] +-- +Require HTTPS and verify certificates when contacting registries + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_TLS_VERIFY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PODMAN_TLS_VERIFY+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` +|=== -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-container-image.adoc b/_generated-doc/latest/config/quarkus-container-image.adoc index 442cb8e68b9..45457884f9b 100644 --- a/_generated-doc/latest/config/quarkus-container-image.adoc +++ b/_generated-doc/latest/config/quarkus-container-image.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-container-image_quarkus-container-image [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -231,5 +230,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-container-image_quarkus.container-image.adoc b/_generated-doc/latest/config/quarkus-container-image_quarkus.container-image.adoc index 442cb8e68b9..45457884f9b 100644 --- a/_generated-doc/latest/config/quarkus-container-image_quarkus.container-image.adoc +++ b/_generated-doc/latest/config/quarkus-container-image_quarkus.container-image.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-container-image_quarkus-container-image [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -231,5 +230,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.analytics.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.analytics.adoc index 02262512fc0..d17da1e5559 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.analytics.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.analytics.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-analytics [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -61,5 +60,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.application.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.application.adoc index 3c72c247af6..ec4d49ffc96 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.application.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.application.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-application [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -61,5 +60,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.banner.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.banner.adoc index 80f6de672ba..37498e46f5a 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.banner.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.banner.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-banner [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.bootstrap.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.bootstrap.adoc index cbd96117ad6..dcf96fa1126 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.bootstrap.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.bootstrap.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-bootstrap [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -112,5 +111,3 @@ a|`error`, `warn`, `ignore` |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.builder.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.builder.adoc index 27cc4e63f35..be4686a6f76 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.builder.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.builder.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-builder [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.class-loading.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.class-loading.adoc index 41014560901..9dd2c67eb62 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.class-loading.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.class-loading.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-class-loading [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -98,5 +97,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.command-line.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.command-line.adoc new file mode 100644 index 00000000000..de2a86bb86a --- /dev/null +++ b/_generated-doc/latest/config/quarkus-core_quarkus.command-line.adoc @@ -0,0 +1,30 @@ +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a| [[quarkus-core_quarkus-args]] [.property-path]##link:#quarkus-core_quarkus-args[`quarkus.args`]## + +[.description] +-- +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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ARGS+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +|=== + diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.config-tracking.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.config-tracking.adoc index 021e75045ba..6f2eaaceea2 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.config-tracking.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.config-tracking.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-config-tracking [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -146,5 +145,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.config.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.config.adoc index d6a63aefb7e..00fa3a9886b 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.config.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.config.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-config [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -8,6 +7,23 @@ h|[.header-title]##Configuration property## h|Type h|Default +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-sources-system-only]] [.property-path]##link:#quarkus-core_quarkus-config-sources-system-only[`quarkus.config.sources.system-only`]## + +[.description] +-- +Set this to `true` to read configuration from system properties and environment variables only. This only applies to runtime. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_SOURCES_SYSTEM_ONLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CONFIG_SOURCES_SYSTEM_ONLY+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a| [[quarkus-core_quarkus-profile]] [.property-path]##link:#quarkus-core_quarkus-profile[`quarkus.profile`]## [.description] @@ -114,5 +130,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.configuration.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.configuration.adoc index 2b10797bf25..a25e186e43a 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.configuration.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.configuration.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-configuration [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -33,5 +32,3 @@ a|`warn`, `fail` |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.console.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.console.adoc index e554b246d58..2deb6fd4b15 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.console.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.console.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-console [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -82,5 +81,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.debug.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.debug.adoc index 90d79001663..84677352c25 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.debug.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.debug.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-debug [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -114,5 +113,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.deploy.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.deploy.adoc index d608cbba903..b87e79013ae 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.deploy.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.deploy.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-deploy [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.devservices.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.devservices.adoc index b8c92060c96..41af9dc7105 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -56,7 +55,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DEVSERVICES_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-core_quarkus-devservices[icon:question-circle[title=More information about the Duration format]] | |=== @@ -80,5 +79,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.execution-model-annotations.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.execution-model-annotations.adoc index 0e6f947c80d..215e2ed61f7 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.execution-model-annotations.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.execution-model-annotations.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-execution-model-annotations [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -29,5 +28,3 @@ a|tooltip:fail[Invalid usage of execution model annotations causes build failure |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.ide.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.ide.adoc index f819e511f4c..ca192750940 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.ide.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.ide.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-ide [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ a|`auto`, `idea`, `vscode`, `eclipse`, `netbeans` |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.index-dependency.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.index-dependency.adoc index d82c775664a..61bcd2eb902 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.index-dependency.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.index-dependency.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-index-dependency [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -66,5 +65,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.init.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.init.adoc new file mode 100644 index 00000000000..513d40d7d53 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-core_quarkus.init.adoc @@ -0,0 +1,28 @@ +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a| [[quarkus-core_quarkus-init-and-exit]] [.property-path]##link:#quarkus-core_quarkus-init-and-exit[`quarkus.init-and-exit`]## + +[.description] +-- +true to quit exit right after the initialization. The option is not meant be used directly by users. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INIT_AND_EXIT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +|=== + diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.jni.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.jni.adoc index 20b183cfab4..20cf2fed4cd 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.jni.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.jni.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-jni [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.launch.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.launch.adoc index 6cf53d8a96e..e133c0fea24 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.launch.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.launch.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-launch [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.live-reload.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.live-reload.adoc index d298afbaba6..78442e06857 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.live-reload.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.live-reload.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-live-reload [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -107,7 +106,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LIVE_RELOAD_CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-core_quarkus-live-reload[icon:question-circle[title=More information about the Duration format]] |`30S` a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-live-reload-retry-interval]] [.property-path]##link:#quarkus-core_quarkus-live-reload-retry-interval[`quarkus.live-reload.retry-interval`]## @@ -124,7 +123,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LIVE_RELOAD_RETRY_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-core_quarkus-live-reload[icon:question-circle[title=More information about the Duration format]] |`2S` a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-live-reload-retry-max-attempts]] [.property-path]##link:#quarkus-core_quarkus-live-reload-retry-max-attempts[`quarkus.live-reload.retry-max-attempts`]## @@ -165,5 +164,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.locales.adoc similarity index 55% rename from _generated-doc/latest/config/quarkus-core_quarkus.adoc rename to _generated-doc/latest/config/quarkus-core_quarkus.locales.adoc index 445a7cf1557..ed23ebffa52 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.locales.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -8,23 +7,6 @@ h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-config-sources-system-only]] [.property-path]##link:#quarkus-core_quarkus-config-sources-system-only[`quarkus.config.sources.system-only`]## - -[.description] --- -Set this to `true` to read configuration from system properties and environment variables only. This only applies to runtime. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_SOURCES_SYSTEM_ONLY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CONFIG_SOURCES_SYSTEM_ONLY+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-locales]] [.property-path]##link:#quarkus-core_quarkus-locales[`quarkus.locales`]## [.description] @@ -73,43 +55,5 @@ endif::add-copy-button-to-env-var[] |link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html[Locale] |`Build system locale` -a| [[quarkus-core_quarkus-args]] [.property-path]##link:#quarkus-core_quarkus-args[`quarkus.args`]## - -[.description] --- -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. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_ARGS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-core_quarkus-init-and-exit]] [.property-path]##link:#quarkus-core_quarkus-init-and-exit[`quarkus.init-and-exit`]## - -[.description] --- -true to quit exit right after the initialization. The option is not meant be used directly by users. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_INIT_AND_EXIT+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.log.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.log.adoc index 4177bd73e2e..3668ffe3771 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.log.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.log.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-log [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -512,7 +511,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LOG_FILE_ROTATION_MAX_FILE_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-core_quarkus-log[icon:question-circle[title=More information about the MemorySize format]] |`10M` a| [[quarkus-core_quarkus-log-file-rotation-max-backup-index]] [.property-path]##link:#quarkus-core_quarkus-log-file-rotation-max-backup-index[`quarkus.log.file.rotation.max-backup-index`]## @@ -817,7 +816,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LOG_SYSLOG_MAX_LENGTH+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-core_quarkus-log[icon:question-circle[title=More information about the MemorySize format]] | a| [[quarkus-core_quarkus-log-syslog-async]] [.property-path]##link:#quarkus-core_quarkus-log-syslog-async[`quarkus.log.syslog.async`]## @@ -1201,7 +1200,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_FILE_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-core_quarkus-log[icon:question-circle[title=More information about the MemorySize format]] |`10M` a| [[quarkus-core_quarkus-log-handler-file-file-handlers-rotation-max-backup-index]] [.property-path]##link:#quarkus-core_quarkus-log-handler-file-file-handlers-rotation-max-backup-index[`quarkus.log.handler.file."file-handlers".rotation.max-backup-index`]## @@ -1506,7 +1505,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__MAX_LENGTH+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-core_quarkus-log[icon:question-circle[title=More information about the MemorySize format]] | a| [[quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async]] [.property-path]##link:#quarkus-core_quarkus-log-handler-syslog-syslog-handlers-async[`quarkus.log.handler.syslog."syslog-handlers".async`]## @@ -1612,5 +1611,3 @@ A size configuration option recognizes strings in this format (shown as a regula If no suffix is given, assume bytes. ==== ifndef::no-memory-size-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.naming.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.naming.adoc index 5e26c714dd2..d7dadb07e87 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.naming.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.naming.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-naming [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.native.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.native.adoc index ec3e4a822b6..b8d58704086 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.native.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.native.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-native [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -714,5 +713,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.package.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.package.adoc index 4bd6e6a4104..df70dcfeaac 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.package.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.package.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-package [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -291,7 +290,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-decomp [.description] -- -Enable decompilation of generated and transformed bytecode into the `decompiled` directory. +Enable decompilation of generated and transformed bytecode into a filesystem. ifdef::add-copy-button-to-env-var[] @@ -304,6 +303,25 @@ endif::add-copy-button-to-env-var[] |boolean |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-decompiler-output-directory]] [.property-path]##link:#quarkus-core_quarkus-package-jar-decompiler-output-directory[`quarkus.package.jar.decompiler.output-directory`]## + +[.description] +-- +The directory into which to save the decompilation output. + +A relative path is understood as relative to the build directory. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_PACKAGE_JAR_DECOMPILER_OUTPUT_DIRECTORY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_PACKAGE_JAR_DECOMPILER_OUTPUT_DIRECTORY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`decompiler` + a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-package-jar-decompiler-jar-directory]] [.property-path]##link:#quarkus-core_quarkus-package-jar-decompiler-jar-directory[`quarkus.package.jar.decompiler.jar-directory`]## [.description] @@ -414,5 +432,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.platform.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.platform.adoc index 96e7d235220..385d3e6aef7 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.platform.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.platform.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-platform [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -61,5 +60,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.shutdown.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.shutdown.adoc index f55b43ed794..41eadf0995d 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.shutdown.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.shutdown.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-shutdown [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -39,7 +38,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SHUTDOWN_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-core_quarkus-shutdown[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-core_quarkus-shutdown-delay]] [.property-path]##link:#quarkus-core_quarkus-shutdown-delay[`quarkus.shutdown.delay`]## @@ -56,7 +55,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SHUTDOWN_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-core_quarkus-shutdown[icon:question-circle[title=More information about the Duration format]] | |=== @@ -80,5 +79,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.snapstart.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.snapstart.adoc index 7005ecdbff1..e2dfd4d9725 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.snapstart.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.snapstart.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-snapstart [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -97,5 +96,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.ssl.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.ssl.adoc index 40c70592700..9dbce587f95 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.ssl.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.ssl.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-ssl [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.test.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.test.adoc index 306b4bb6f91..71e6507d7aa 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.test.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.test.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-test [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -345,7 +344,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TEST_WAIT_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-core_quarkus-test[icon:question-circle[title=More information about the Duration format]] |`PT1M` a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-hang-detection-timeout]] [.property-path]##link:#quarkus-core_quarkus-test-hang-detection-timeout[`quarkus.test.hang-detection-timeout`]## @@ -362,7 +361,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TEST_HANG_DETECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-core_quarkus-test[icon:question-circle[title=More information about the Duration format]] |`10M` a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-test-type]] [.property-path]##link:#quarkus-core_quarkus-test-type[`quarkus.test.type`]## @@ -471,5 +470,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-core_quarkus.thread-pool.adoc b/_generated-doc/latest/config/quarkus-core_quarkus.thread-pool.adoc index 559308cfa12..15740262dd3 100644 --- a/_generated-doc/latest/config/quarkus-core_quarkus.thread-pool.adoc +++ b/_generated-doc/latest/config/quarkus-core_quarkus.thread-pool.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-core_quarkus-thread-pool [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -107,7 +106,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_THREAD_POOL_SHUTDOWN_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-core_quarkus-thread-pool[icon:question-circle[title=More information about the Duration format]] |`1M` a| [[quarkus-core_quarkus-thread-pool-shutdown-interrupt]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-shutdown-interrupt[`quarkus.thread-pool.shutdown-interrupt`]## @@ -124,7 +123,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_THREAD_POOL_SHUTDOWN_INTERRUPT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-core_quarkus-thread-pool[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-core_quarkus-thread-pool-shutdown-check-interval]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-shutdown-check-interval[`quarkus.thread-pool.shutdown-check-interval`]## @@ -141,7 +140,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_THREAD_POOL_SHUTDOWN_CHECK_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-core_quarkus-thread-pool[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-core_quarkus-thread-pool-keep-alive-time]] [.property-path]##link:#quarkus-core_quarkus-thread-pool-keep-alive-time[`quarkus.thread-pool.keep-alive-time`]## @@ -158,7 +157,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_THREAD_POOL_KEEP_ALIVE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-core_quarkus-thread-pool[icon:question-circle[title=More information about the Duration format]] |`30S` |=== @@ -182,5 +181,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-cyclonedx.adoc b/_generated-doc/latest/config/quarkus-cyclonedx.adoc index cd9d9b9dbbc..bfa52553b53 100644 --- a/_generated-doc/latest/config/quarkus-cyclonedx.adoc +++ b/_generated-doc/latest/config/quarkus-cyclonedx.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-cyclonedx_quarkus-cyclonedx [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-cyclonedx_quarkus.cyclonedx.adoc b/_generated-doc/latest/config/quarkus-cyclonedx_quarkus.cyclonedx.adoc index cd9d9b9dbbc..bfa52553b53 100644 --- a/_generated-doc/latest/config/quarkus-cyclonedx_quarkus.cyclonedx.adoc +++ b/_generated-doc/latest/config/quarkus-cyclonedx_quarkus.cyclonedx.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-cyclonedx_quarkus-cyclonedx [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-datasource.adoc b/_generated-doc/latest/config/quarkus-datasource.adoc index a20f0016d34..d23202f9384 100644 --- a/_generated-doc/latest/config/quarkus-datasource.adoc +++ b/_generated-doc/latest/config/quarkus-datasource.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-datasource_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -527,5 +526,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-datasource_quarkus.datasource.adoc b/_generated-doc/latest/config/quarkus-datasource_quarkus.datasource.adoc index a20f0016d34..d23202f9384 100644 --- a/_generated-doc/latest/config/quarkus-datasource_quarkus.datasource.adoc +++ b/_generated-doc/latest/config/quarkus-datasource_quarkus.datasource.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-datasource_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -527,5 +526,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-datasource_quarkus.datasource.devservices.adoc b/_generated-doc/latest/config/quarkus-datasource_quarkus.datasource.devservices.adoc index 03f36979a1d..d87e5cf70e8 100644 --- a/_generated-doc/latest/config/quarkus-datasource_quarkus.datasource.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-datasource_quarkus.datasource.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-datasource_quarkus-datasource-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -293,5 +292,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-oidc_quarkus.keycloak.devservices.adoc b/_generated-doc/latest/config/quarkus-devservices-keycloak.adoc similarity index 50% rename from _generated-doc/latest/config/quarkus-oidc_quarkus.keycloak.devservices.adoc rename to _generated-doc/latest/config/quarkus-devservices-keycloak.adoc index c21a9627f93..1cdac68228f 100644 --- a/_generated-doc/latest/config/quarkus-oidc_quarkus.keycloak.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-devservices-keycloak.adoc @@ -1,14 +1,13 @@ -:summaryTableId: quarkus-oidc_quarkus-keycloak-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference, cols="80,.^10,.^10"] +[.configuration-reference.searchable, cols="80,.^10,.^10"] |=== h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-enabled[`quarkus.keycloak.devservices.enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-enabled]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-enabled[`quarkus.keycloak.devservices.enabled`]## [.description] -- @@ -25,7 +24,7 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-image-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-image-name[`quarkus.keycloak.devservices.image-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-image-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-image-name[`quarkus.keycloak.devservices.image-name`]## [.description] -- @@ -42,7 +41,7 @@ endif::add-copy-button-to-env-var[] |string |`quay.io/keycloak/keycloak:25.0.6` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]## [.description] -- @@ -59,7 +58,7 @@ endif::add-copy-button-to-env-var[] |boolean | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-shared]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-shared[`quarkus.keycloak.devservices.shared`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-shared]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-shared[`quarkus.keycloak.devservices.shared`]## [.description] -- @@ -76,7 +75,7 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-service-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-service-name[`quarkus.keycloak.devservices.service-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-service-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-service-name[`quarkus.keycloak.devservices.service-name`]## [.description] -- @@ -93,12 +92,14 @@ endif::add-copy-button-to-env-var[] |string |`quarkus` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-realm-path]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-realm-path[`quarkus.keycloak.devservices.realm-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-realm-path]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-realm-path[`quarkus.keycloak.devservices.realm-path`]## [.description] -- A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties. +To learn more about Keycloak realm files, consult the link:https://www.keycloak.org/server/importExport[Importing and Exporting Keycloak Realms documentation]. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH+++[] @@ -110,7 +111,7 @@ endif::add-copy-button-to-env-var[] |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-resource-aliases-alias-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-resource-aliases-alias-name[`quarkus.keycloak.devservices.resource-aliases."alias-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-resource-aliases-alias-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-resource-aliases-alias-name[`quarkus.keycloak.devservices.resource-aliases."alias-name"`]## [.description] -- @@ -127,7 +128,7 @@ endif::add-copy-button-to-env-var[] |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-resource-mappings-resource-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-resource-mappings-resource-name[`quarkus.keycloak.devservices.resource-mappings."resource-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-resource-mappings-resource-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-resource-mappings-resource-name[`quarkus.keycloak.devservices.resource-mappings."resource-name"`]## [.description] -- @@ -144,7 +145,7 @@ endif::add-copy-button-to-env-var[] |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-java-opts]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-java-opts[`quarkus.keycloak.devservices.java-opts`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-java-opts]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-java-opts[`quarkus.keycloak.devservices.java-opts`]## [.description] -- @@ -161,7 +162,7 @@ endif::add-copy-button-to-env-var[] |string | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-show-logs]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-show-logs[`quarkus.keycloak.devservices.show-logs`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-show-logs]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-show-logs[`quarkus.keycloak.devservices.show-logs`]## [.description] -- @@ -178,7 +179,7 @@ endif::add-copy-button-to-env-var[] |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-start-command]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-start-command[`quarkus.keycloak.devservices.start-command`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-start-command]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-start-command[`quarkus.keycloak.devservices.start-command`]## [.description] -- @@ -195,7 +196,7 @@ endif::add-copy-button-to-env-var[] |string | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-realm-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-realm-name[`quarkus.keycloak.devservices.realm-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-realm-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-realm-name[`quarkus.keycloak.devservices.realm-name`]## [.description] -- @@ -212,7 +213,7 @@ endif::add-copy-button-to-env-var[] |string | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-create-realm]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-create-realm[`quarkus.keycloak.devservices.create-realm`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-create-realm]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-create-realm[`quarkus.keycloak.devservices.create-realm`]## [.description] -- @@ -229,7 +230,41 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-users-users]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-users-users[`quarkus.keycloak.devservices.users."users"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-create-client]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-create-client[`quarkus.keycloak.devservices.create-client`]## + +[.description] +-- +Specifies whether to create the default client id `quarkus-app` with a secret `secret`and register them if the `create-realm` property is set to true. For OIDC extension configuration properties `quarkus.oidc.client.id` and `quarkus.oidc.credentials.secret` will be configured. For OIDC Client extension configuration properties `quarkus.oidc-client.client.id` and `quarkus.oidc-client.credentials.secret` will be configured. Set to `false` if clients have to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by `io.quarkus.test.common.QuarkusTestResourceLifecycleManager` or registered dynamically. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_CLIENT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_CLIENT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-start-with-disabled-tenant]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-start-with-disabled-tenant[`quarkus.keycloak.devservices.start-with-disabled-tenant`]## + +[.description] +-- +Specifies whether to start the container even if the default OIDC tenant is disabled. Setting this property to true may be necessary in a multi-tenant OIDC setup, especially when OIDC tenants are created dynamically. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_START_WITH_DISABLED_TENANT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_START_WITH_DISABLED_TENANT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-users-users]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-users-users[`quarkus.keycloak.devservices.users."users"`]## [.description] -- @@ -246,7 +281,7 @@ endif::add-copy-button-to-env-var[] |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-roles-role-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-roles-role-name[`quarkus.keycloak.devservices.roles."role-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-roles-role-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-roles-role-name[`quarkus.keycloak.devservices.roles."role-name"`]## [.description] -- @@ -263,7 +298,7 @@ endif::add-copy-button-to-env-var[] |Map> | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-port]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-port[`quarkus.keycloak.devservices.port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-port]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-port[`quarkus.keycloak.devservices.port`]## [.description] -- @@ -282,7 +317,7 @@ endif::add-copy-button-to-env-var[] |int | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices_quarkus-keycloak-devservices-container-env-environment-variable-name[`quarkus.keycloak.devservices.container-env."environment-variable-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-container-env-environment-variable-name[`quarkus.keycloak.devservices.container-env."environment-variable-name"`]## [.description] -- @@ -299,7 +334,70 @@ endif::add-copy-button-to-env-var[] |Map | -|=== +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-container-memory-limit]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-container-memory-limit[`quarkus.keycloak.devservices.container-memory-limit`]## + +[.description] +-- +Memory limit for Keycloak container + +If not specified, 750MiB is the default memory limit. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_MEMORY_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_MEMORY_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-quarkus-devservices-keycloak_quarkus-keycloak[icon:question-circle[title=More information about the MemorySize format]] +|`750M` +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-web-client-timeout]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-web-client-timeout[`quarkus.keycloak.devservices.web-client-timeout`]## + +[.description] +-- +The WebClient timeout. Use this property to configure how long an HTTP client used by OIDC dev service admin client will wait for a response from OpenId Connect Provider when acquiring admin token and creating realm. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_WEB_CLIENT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_WEB_CLIENT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-devservices-keycloak_quarkus-keycloak[icon:question-circle[title=More information about the Duration format]] +|`4S` + +|=== -:!summaryTableId: \ No newline at end of file +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-devservices-keycloak_quarkus-keycloak] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-devservices-keycloak_quarkus-keycloak] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] diff --git a/_generated-doc/latest/config/quarkus-oidc_quarkus.keycloak.adoc b/_generated-doc/latest/config/quarkus-devservices-keycloak_quarkus.keycloak.adoc similarity index 50% rename from _generated-doc/latest/config/quarkus-oidc_quarkus.keycloak.adoc rename to _generated-doc/latest/config/quarkus-devservices-keycloak_quarkus.keycloak.adoc index ff816b55a28..1cdac68228f 100644 --- a/_generated-doc/latest/config/quarkus-oidc_quarkus.keycloak.adoc +++ b/_generated-doc/latest/config/quarkus-devservices-keycloak_quarkus.keycloak.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-oidc_quarkus-keycloak [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -8,11 +7,7 @@ h|[.header-title]##Configuration property## h|Type h|Default -h|[[quarkus-oidc_section_quarkus-keycloak-devservices]] [.section-name.section-level0]##link:#quarkus-oidc_section_quarkus-keycloak-devservices[Dev Services]## -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-enabled[`quarkus.keycloak.devservices.enabled`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-enabled]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-enabled[`quarkus.keycloak.devservices.enabled`]## [.description] -- @@ -29,7 +24,7 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-image-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-image-name[`quarkus.keycloak.devservices.image-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-image-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-image-name[`quarkus.keycloak.devservices.image-name`]## [.description] -- @@ -46,7 +41,7 @@ endif::add-copy-button-to-env-var[] |string |`quay.io/keycloak/keycloak:25.0.6` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]## [.description] -- @@ -63,7 +58,7 @@ endif::add-copy-button-to-env-var[] |boolean | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-shared]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-shared[`quarkus.keycloak.devservices.shared`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-shared]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-shared[`quarkus.keycloak.devservices.shared`]## [.description] -- @@ -80,7 +75,7 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-service-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-service-name[`quarkus.keycloak.devservices.service-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-service-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-service-name[`quarkus.keycloak.devservices.service-name`]## [.description] -- @@ -97,12 +92,14 @@ endif::add-copy-button-to-env-var[] |string |`quarkus` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-realm-path]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-realm-path[`quarkus.keycloak.devservices.realm-path`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-realm-path]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-realm-path[`quarkus.keycloak.devservices.realm-path`]## [.description] -- A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties. +To learn more about Keycloak realm files, consult the link:https://www.keycloak.org/server/importExport[Importing and Exporting Keycloak Realms documentation]. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH+++[] @@ -114,7 +111,7 @@ endif::add-copy-button-to-env-var[] |list of string | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-resource-aliases-alias-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-resource-aliases-alias-name[`quarkus.keycloak.devservices.resource-aliases."alias-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-resource-aliases-alias-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-resource-aliases-alias-name[`quarkus.keycloak.devservices.resource-aliases."alias-name"`]## [.description] -- @@ -131,7 +128,7 @@ endif::add-copy-button-to-env-var[] |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-resource-mappings-resource-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-resource-mappings-resource-name[`quarkus.keycloak.devservices.resource-mappings."resource-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-resource-mappings-resource-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-resource-mappings-resource-name[`quarkus.keycloak.devservices.resource-mappings."resource-name"`]## [.description] -- @@ -148,7 +145,7 @@ endif::add-copy-button-to-env-var[] |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-java-opts]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-java-opts[`quarkus.keycloak.devservices.java-opts`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-java-opts]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-java-opts[`quarkus.keycloak.devservices.java-opts`]## [.description] -- @@ -165,7 +162,7 @@ endif::add-copy-button-to-env-var[] |string | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-show-logs]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-show-logs[`quarkus.keycloak.devservices.show-logs`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-show-logs]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-show-logs[`quarkus.keycloak.devservices.show-logs`]## [.description] -- @@ -182,7 +179,7 @@ endif::add-copy-button-to-env-var[] |boolean |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-start-command]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-start-command[`quarkus.keycloak.devservices.start-command`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-start-command]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-start-command[`quarkus.keycloak.devservices.start-command`]## [.description] -- @@ -199,7 +196,7 @@ endif::add-copy-button-to-env-var[] |string | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-realm-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-realm-name[`quarkus.keycloak.devservices.realm-name`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-realm-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-realm-name[`quarkus.keycloak.devservices.realm-name`]## [.description] -- @@ -216,7 +213,7 @@ endif::add-copy-button-to-env-var[] |string | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-create-realm]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-create-realm[`quarkus.keycloak.devservices.create-realm`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-create-realm]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-create-realm[`quarkus.keycloak.devservices.create-realm`]## [.description] -- @@ -233,7 +230,41 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-users-users]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-users-users[`quarkus.keycloak.devservices.users."users"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-create-client]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-create-client[`quarkus.keycloak.devservices.create-client`]## + +[.description] +-- +Specifies whether to create the default client id `quarkus-app` with a secret `secret`and register them if the `create-realm` property is set to true. For OIDC extension configuration properties `quarkus.oidc.client.id` and `quarkus.oidc.credentials.secret` will be configured. For OIDC Client extension configuration properties `quarkus.oidc-client.client.id` and `quarkus.oidc-client.credentials.secret` will be configured. Set to `false` if clients have to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by `io.quarkus.test.common.QuarkusTestResourceLifecycleManager` or registered dynamically. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_CLIENT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_CLIENT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-start-with-disabled-tenant]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-start-with-disabled-tenant[`quarkus.keycloak.devservices.start-with-disabled-tenant`]## + +[.description] +-- +Specifies whether to start the container even if the default OIDC tenant is disabled. Setting this property to true may be necessary in a multi-tenant OIDC setup, especially when OIDC tenants are created dynamically. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_START_WITH_DISABLED_TENANT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_START_WITH_DISABLED_TENANT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-users-users]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-users-users[`quarkus.keycloak.devservices.users."users"`]## [.description] -- @@ -250,7 +281,7 @@ endif::add-copy-button-to-env-var[] |Map | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-roles-role-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-roles-role-name[`quarkus.keycloak.devservices.roles."role-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-roles-role-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-roles-role-name[`quarkus.keycloak.devservices.roles."role-name"`]## [.description] -- @@ -267,7 +298,7 @@ endif::add-copy-button-to-env-var[] |Map> | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-port]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-port[`quarkus.keycloak.devservices.port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-port]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-port[`quarkus.keycloak.devservices.port`]## [.description] -- @@ -286,7 +317,7 @@ endif::add-copy-button-to-env-var[] |int | -a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-oidc_quarkus-keycloak-devservices-container-env-environment-variable-name[`quarkus.keycloak.devservices.container-env."environment-variable-name"`]## +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-container-env-environment-variable-name[`quarkus.keycloak.devservices.container-env."environment-variable-name"`]## [.description] -- @@ -303,8 +334,70 @@ endif::add-copy-button-to-env-var[] |Map | +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-container-memory-limit]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-container-memory-limit[`quarkus.keycloak.devservices.container-memory-limit`]## -|=== +[.description] +-- +Memory limit for Keycloak container + +If not specified, 750MiB is the default memory limit. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_MEMORY_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_MEMORY_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-quarkus-devservices-keycloak_quarkus-keycloak[icon:question-circle[title=More information about the MemorySize format]] +|`750M` + +a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-web-client-timeout]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-web-client-timeout[`quarkus.keycloak.devservices.web-client-timeout`]## +[.description] +-- +The WebClient timeout. Use this property to configure how long an HTTP client used by OIDC dev service admin client will wait for a response from OpenId Connect Provider when acquiring admin token and creating realm. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_WEB_CLIENT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_WEB_CLIENT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-devservices-keycloak_quarkus-keycloak[icon:question-circle[title=More information about the Duration format]] +|`4S` + +|=== -:!summaryTableId: \ No newline at end of file +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-devservices-keycloak_quarkus-keycloak] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-devservices-keycloak_quarkus-keycloak] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] diff --git a/_generated-doc/latest/config/quarkus-elasticsearch-rest-client.adoc b/_generated-doc/latest/config/quarkus-elasticsearch-rest-client.adoc index c772b732acc..26fd628f0fa 100644 --- a/_generated-doc/latest/config/quarkus-elasticsearch-rest-client.adoc +++ b/_generated-doc/latest/config/quarkus-elasticsearch-rest-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-elasticsearch-rest-client_quarkus-elasticsearch [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -107,7 +106,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ELASTICSEARCH_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elasticsearch-rest-client_quarkus-elasticsearch[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-elasticsearch-rest-client_quarkus-elasticsearch-socket-timeout]] [.property-path]##link:#quarkus-elasticsearch-rest-client_quarkus-elasticsearch-socket-timeout[`quarkus.elasticsearch.socket-timeout`]## @@ -124,7 +123,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ELASTICSEARCH_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elasticsearch-rest-client_quarkus-elasticsearch[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-elasticsearch-rest-client_quarkus-elasticsearch-max-connections]] [.property-path]##link:#quarkus-elasticsearch-rest-client_quarkus-elasticsearch-max-connections[`quarkus.elasticsearch.max-connections`]## @@ -211,7 +210,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elasticsearch-rest-client_quarkus-elasticsearch[icon:question-circle[title=More information about the Duration format]] |`5M` h|[[quarkus-elasticsearch-rest-client_section_quarkus-elasticsearch-devservices]] [.section-name.section-level0]##link:#quarkus-elasticsearch-rest-client_section_quarkus-elasticsearch-devservices[Dev Services]## @@ -434,5 +433,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-elasticsearch-rest-client_quarkus.elasticsearch.adoc b/_generated-doc/latest/config/quarkus-elasticsearch-rest-client_quarkus.elasticsearch.adoc index c772b732acc..26fd628f0fa 100644 --- a/_generated-doc/latest/config/quarkus-elasticsearch-rest-client_quarkus.elasticsearch.adoc +++ b/_generated-doc/latest/config/quarkus-elasticsearch-rest-client_quarkus.elasticsearch.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-elasticsearch-rest-client_quarkus-elasticsearch [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -107,7 +106,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ELASTICSEARCH_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elasticsearch-rest-client_quarkus-elasticsearch[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-elasticsearch-rest-client_quarkus-elasticsearch-socket-timeout]] [.property-path]##link:#quarkus-elasticsearch-rest-client_quarkus-elasticsearch-socket-timeout[`quarkus.elasticsearch.socket-timeout`]## @@ -124,7 +123,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ELASTICSEARCH_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elasticsearch-rest-client_quarkus-elasticsearch[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-elasticsearch-rest-client_quarkus-elasticsearch-max-connections]] [.property-path]##link:#quarkus-elasticsearch-rest-client_quarkus-elasticsearch-max-connections[`quarkus.elasticsearch.max-connections`]## @@ -211,7 +210,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elasticsearch-rest-client_quarkus-elasticsearch[icon:question-circle[title=More information about the Duration format]] |`5M` h|[[quarkus-elasticsearch-rest-client_section_quarkus-elasticsearch-devservices]] [.section-name.section-level0]##link:#quarkus-elasticsearch-rest-client_section_quarkus-elasticsearch-devservices[Dev Services]## @@ -434,5 +433,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-elasticsearch-rest-client_quarkus.elasticsearch.devservices.adoc b/_generated-doc/latest/config/quarkus-elasticsearch-rest-client_quarkus.elasticsearch.devservices.adoc index 6ee832eeba0..9e41909f80e 100644 --- a/_generated-doc/latest/config/quarkus-elasticsearch-rest-client_quarkus.elasticsearch.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-elasticsearch-rest-client_quarkus.elasticsearch.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-elasticsearch-rest-client_quarkus-elasticsearch-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -204,5 +203,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-elytron-security-jdbc.adoc b/_generated-doc/latest/config/quarkus-elytron-security-jdbc.adoc index 146ef05e435..7dc75bbc3a6 100644 --- a/_generated-doc/latest/config/quarkus-elytron-security-jdbc.adoc +++ b/_generated-doc/latest/config/quarkus-elytron-security-jdbc.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-elytron-security-jdbc_quarkus-security [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -457,5 +456,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-elytron-security-jdbc_quarkus.security.adoc b/_generated-doc/latest/config/quarkus-elytron-security-jdbc_quarkus.security.adoc index 146ef05e435..7dc75bbc3a6 100644 --- a/_generated-doc/latest/config/quarkus-elytron-security-jdbc_quarkus.security.adoc +++ b/_generated-doc/latest/config/quarkus-elytron-security-jdbc_quarkus.security.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-elytron-security-jdbc_quarkus-security [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -457,5 +456,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-elytron-security-ldap.adoc b/_generated-doc/latest/config/quarkus-elytron-security-ldap.adoc index 3e27e2f51ee..bffa9802ba0 100644 --- a/_generated-doc/latest/config/quarkus-elytron-security-ldap.adoc +++ b/_generated-doc/latest/config/quarkus-elytron-security-ldap.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-elytron-security-ldap_quarkus-security [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -141,7 +140,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECURITY_LDAP_DIR_CONTEXT_CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elytron-security-ldap_quarkus-security[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-elytron-security-ldap_quarkus-security-ldap-dir-context-read-timeout]] [.property-path]##link:#quarkus-elytron-security-ldap_quarkus-security-ldap-dir-context-read-timeout[`quarkus.security.ldap.dir-context.read-timeout`]## @@ -158,7 +157,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECURITY_LDAP_DIR_CONTEXT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elytron-security-ldap_quarkus-security[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-elytron-security-ldap_quarkus-security-ldap-cache-enabled]] [.property-path]##link:#quarkus-elytron-security-ldap_quarkus-security-ldap-cache-enabled[`quarkus.security.ldap.cache.enabled`]## @@ -192,7 +191,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECURITY_LDAP_CACHE_MAX_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elytron-security-ldap_quarkus-security[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-elytron-security-ldap_quarkus-security-ldap-cache-size]] [.property-path]##link:#quarkus-elytron-security-ldap_quarkus-security-ldap-cache-size[`quarkus.security.ldap.cache.size`]## @@ -352,5 +351,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-elytron-security-ldap_quarkus.security.adoc b/_generated-doc/latest/config/quarkus-elytron-security-ldap_quarkus.security.adoc index 3e27e2f51ee..bffa9802ba0 100644 --- a/_generated-doc/latest/config/quarkus-elytron-security-ldap_quarkus.security.adoc +++ b/_generated-doc/latest/config/quarkus-elytron-security-ldap_quarkus.security.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-elytron-security-ldap_quarkus-security [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -141,7 +140,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECURITY_LDAP_DIR_CONTEXT_CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elytron-security-ldap_quarkus-security[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-elytron-security-ldap_quarkus-security-ldap-dir-context-read-timeout]] [.property-path]##link:#quarkus-elytron-security-ldap_quarkus-security-ldap-dir-context-read-timeout[`quarkus.security.ldap.dir-context.read-timeout`]## @@ -158,7 +157,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECURITY_LDAP_DIR_CONTEXT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elytron-security-ldap_quarkus-security[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-elytron-security-ldap_quarkus-security-ldap-cache-enabled]] [.property-path]##link:#quarkus-elytron-security-ldap_quarkus-security-ldap-cache-enabled[`quarkus.security.ldap.cache.enabled`]## @@ -192,7 +191,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECURITY_LDAP_CACHE_MAX_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-elytron-security-ldap_quarkus-security[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-elytron-security-ldap_quarkus-security-ldap-cache-size]] [.property-path]##link:#quarkus-elytron-security-ldap_quarkus-security-ldap-cache-size[`quarkus.security.ldap.cache.size`]## @@ -352,5 +351,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-elytron-security-oauth2.adoc b/_generated-doc/latest/config/quarkus-elytron-security-oauth2.adoc index e79fe24c202..e53e8ed50c1 100644 --- a/_generated-doc/latest/config/quarkus-elytron-security-oauth2.adoc +++ b/_generated-doc/latest/config/quarkus-elytron-security-oauth2.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-elytron-security-oauth2_quarkus-oauth2 [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -112,5 +111,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-elytron-security-oauth2_quarkus.oauth2.adoc b/_generated-doc/latest/config/quarkus-elytron-security-oauth2_quarkus.oauth2.adoc index e79fe24c202..e53e8ed50c1 100644 --- a/_generated-doc/latest/config/quarkus-elytron-security-oauth2_quarkus.oauth2.adoc +++ b/_generated-doc/latest/config/quarkus-elytron-security-oauth2_quarkus.oauth2.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-elytron-security-oauth2_quarkus-oauth2 [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -112,5 +111,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-elytron-security-properties-file.adoc b/_generated-doc/latest/config/quarkus-elytron-security-properties-file.adoc index ee59554eba2..31b1eb7d29e 100644 --- a/_generated-doc/latest/config/quarkus-elytron-security-properties-file.adoc +++ b/_generated-doc/latest/config/quarkus-elytron-security-properties-file.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-elytron-security-properties-file_quarkus-security [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -209,5 +208,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-elytron-security-properties-file_quarkus.security.adoc b/_generated-doc/latest/config/quarkus-elytron-security-properties-file_quarkus.security.adoc index ee59554eba2..31b1eb7d29e 100644 --- a/_generated-doc/latest/config/quarkus-elytron-security-properties-file_quarkus.security.adoc +++ b/_generated-doc/latest/config/quarkus-elytron-security-properties-file_quarkus.security.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-elytron-security-properties-file_quarkus-security [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -209,5 +208,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-flyway.adoc b/_generated-doc/latest/config/quarkus-flyway.adoc index 9c56161b8f4..e946a9ac071 100644 --- a/_generated-doc/latest/config/quarkus-flyway.adoc +++ b/_generated-doc/latest/config/quarkus-flyway.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-flyway_quarkus-flyway [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -117,7 +116,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_FLYWAY_CONNECT_RETRIES_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-flyway_quarkus-flyway[icon:question-circle[title=More information about the Duration format]] |`120 seconds` a| [[quarkus-flyway_quarkus-flyway-default-schema]] [.property-path]##link:#quarkus-flyway_quarkus-flyway-default-schema[`quarkus.flyway.default-schema`]## @@ -712,7 +711,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_FLYWAY__DATASOURCE_NAME__CONNECT_RETRIES_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-flyway_quarkus-flyway[icon:question-circle[title=More information about the Duration format]] |`120 seconds` a| [[quarkus-flyway_quarkus-flyway-datasource-name-default-schema]] [.property-path]##link:#quarkus-flyway_quarkus-flyway-datasource-name-default-schema[`quarkus.flyway."datasource-name".default-schema`]## @@ -1235,5 +1234,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-flyway_quarkus.flyway.adoc b/_generated-doc/latest/config/quarkus-flyway_quarkus.flyway.adoc index 9c56161b8f4..e946a9ac071 100644 --- a/_generated-doc/latest/config/quarkus-flyway_quarkus.flyway.adoc +++ b/_generated-doc/latest/config/quarkus-flyway_quarkus.flyway.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-flyway_quarkus-flyway [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -117,7 +116,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_FLYWAY_CONNECT_RETRIES_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-flyway_quarkus-flyway[icon:question-circle[title=More information about the Duration format]] |`120 seconds` a| [[quarkus-flyway_quarkus-flyway-default-schema]] [.property-path]##link:#quarkus-flyway_quarkus-flyway-default-schema[`quarkus.flyway.default-schema`]## @@ -712,7 +711,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_FLYWAY__DATASOURCE_NAME__CONNECT_RETRIES_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-flyway_quarkus-flyway[icon:question-circle[title=More information about the Duration format]] |`120 seconds` a| [[quarkus-flyway_quarkus-flyway-datasource-name-default-schema]] [.property-path]##link:#quarkus-flyway_quarkus-flyway-datasource-name-default-schema[`quarkus.flyway."datasource-name".default-schema`]## @@ -1235,5 +1234,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-funqy-amazon-lambda.adoc b/_generated-doc/latest/config/quarkus-funqy-amazon-lambda.adoc index a6d0f0d625a..9575150abde 100644 --- a/_generated-doc/latest/config/quarkus-funqy-amazon-lambda.adoc +++ b/_generated-doc/latest/config/quarkus-funqy-amazon-lambda.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-funqy-amazon-lambda_quarkus-funqy [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-funqy-amazon-lambda_quarkus.funqy.adoc b/_generated-doc/latest/config/quarkus-funqy-amazon-lambda_quarkus.funqy.adoc index a6d0f0d625a..9575150abde 100644 --- a/_generated-doc/latest/config/quarkus-funqy-amazon-lambda_quarkus.funqy.adoc +++ b/_generated-doc/latest/config/quarkus-funqy-amazon-lambda_quarkus.funqy.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-funqy-amazon-lambda_quarkus-funqy [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-funqy-knative-events.adoc b/_generated-doc/latest/config/quarkus-funqy-knative-events.adoc index f8af9c82aa7..a278f2d6636 100644 --- a/_generated-doc/latest/config/quarkus-funqy-knative-events.adoc +++ b/_generated-doc/latest/config/quarkus-funqy-knative-events.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-funqy-knative-events_quarkus-funqy [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -61,5 +60,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-funqy-knative-events_quarkus.funqy.adoc b/_generated-doc/latest/config/quarkus-funqy-knative-events_quarkus.funqy.adoc index f8af9c82aa7..a278f2d6636 100644 --- a/_generated-doc/latest/config/quarkus-funqy-knative-events_quarkus.funqy.adoc +++ b/_generated-doc/latest/config/quarkus-funqy-knative-events_quarkus.funqy.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-funqy-knative-events_quarkus-funqy [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -61,5 +60,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-funqy-server.adoc b/_generated-doc/latest/config/quarkus-funqy-server.adoc index 8db05b0e2d6..a2ada1509dd 100644 --- a/_generated-doc/latest/config/quarkus-funqy-server.adoc +++ b/_generated-doc/latest/config/quarkus-funqy-server.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-funqy-server_quarkus-funqy [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-funqy-server_quarkus.funqy.adoc b/_generated-doc/latest/config/quarkus-funqy-server_quarkus.funqy.adoc index 8db05b0e2d6..a2ada1509dd 100644 --- a/_generated-doc/latest/config/quarkus-funqy-server_quarkus.funqy.adoc +++ b/_generated-doc/latest/config/quarkus-funqy-server_quarkus.funqy.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-funqy-server_quarkus-funqy [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-google-cloud-functions.adoc b/_generated-doc/latest/config/quarkus-google-cloud-functions.adoc index 6a23921e75d..2a3b9040798 100644 --- a/_generated-doc/latest/config/quarkus-google-cloud-functions.adoc +++ b/_generated-doc/latest/config/quarkus-google-cloud-functions.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-google-cloud-functions_quarkus-google-cloud-functions [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-google-cloud-functions_quarkus.google-cloud-functions.adoc b/_generated-doc/latest/config/quarkus-google-cloud-functions_quarkus.google-cloud-functions.adoc index 6a23921e75d..2a3b9040798 100644 --- a/_generated-doc/latest/config/quarkus-google-cloud-functions_quarkus.google-cloud-functions.adoc +++ b/_generated-doc/latest/config/quarkus-google-cloud-functions_quarkus.google-cloud-functions.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-google-cloud-functions_quarkus-google-cloud-functions [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-grpc_quarkus.generate-code.adoc b/_generated-doc/latest/config/quarkus-grpc_quarkus.generate-code.adoc index 238297092d8..68a1f3b53ba 100644 --- a/_generated-doc/latest/config/quarkus-grpc_quarkus.generate-code.adoc +++ b/_generated-doc/latest/config/quarkus-grpc_quarkus.generate-code.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-grpc_quarkus-generate-code [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -52,5 +51,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc-client.adoc b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc-client.adoc index c9d3c1f5821..3b4267df2fa 100644 --- a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc-client.adoc +++ b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-grpc_quarkus-grpc-client [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.adoc b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.adoc index 6f2e79a8fd9..943570792de 100644 --- a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.adoc +++ b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-grpc_quarkus-grpc [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -671,7 +670,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-clients-client-name-flow-control-window]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-clients-client-name-flow-control-window[`quarkus.grpc.clients."client-name".flow-control-window`]## @@ -705,7 +704,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-clients-client-name-keep-alive-timeout]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-clients-client-name-keep-alive-timeout[`quarkus.grpc.clients."client-name".keep-alive-timeout`]## @@ -722,7 +721,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-clients-client-name-keep-alive-without-calls]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-clients-client-name-keep-alive-without-calls[`quarkus.grpc.clients."client-name".keep-alive-without-calls`]## @@ -977,7 +976,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__DEADLINE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc[icon:question-circle[title=More information about the Duration format]] | @@ -1140,7 +1139,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_SERVER_HANDSHAKE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-server-max-inbound-message-size]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-server-max-inbound-message-size[`quarkus.grpc.server.max-inbound-message-size`]## @@ -1149,6 +1148,8 @@ a| [[quarkus-grpc_quarkus-grpc-server-max-inbound-message-size]] [.property-path -- The max inbound message size in bytes. +When using a single server (using `quarkus.grpc.server.use-separate-server=false`), the default value is 256KB. When using a separate server (using `quarkus.grpc.server.use-separate-server=true`), the default value is 4MB. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_SERVER_MAX_INBOUND_MESSAGE_SIZE+++[] @@ -1520,7 +1521,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_SERVER_NETTY_KEEP_ALIVE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-server-netty-permit-keep-alive-time]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-server-netty-permit-keep-alive-time[`quarkus.grpc.server.netty.permit-keep-alive-time`]## @@ -1537,7 +1538,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_SERVER_NETTY_PERMIT_KEEP_ALIVE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-server-netty-permit-keep-alive-without-calls]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-server-netty-permit-keep-alive-without-calls[`quarkus.grpc.server.netty.permit-keep-alive-without-calls`]## @@ -1596,5 +1597,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.clients.-client-name-.xds.adoc b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.clients.-client-name-.xds.adoc index 2b776d79b72..d75a9ebceba 100644 --- a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.clients.-client-name-.xds.adoc +++ b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.clients.-client-name-.xds.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-grpc_quarkus-grpc-clients-client-name-xds [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -61,5 +60,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.clients.adoc b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.clients.adoc index f25d2eb7b3a..861108b9996 100644 --- a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.clients.adoc +++ b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.clients.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-grpc_quarkus-grpc-clients [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -611,7 +610,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc-clients[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-clients_quarkus-grpc-clients-client-name-flow-control-window]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-clients_quarkus-grpc-clients-client-name-flow-control-window[`quarkus.grpc.clients."client-name".flow-control-window`]## @@ -645,7 +644,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc-clients[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-clients_quarkus-grpc-clients-client-name-keep-alive-timeout]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-clients_quarkus-grpc-clients-client-name-keep-alive-timeout[`quarkus.grpc.clients."client-name".keep-alive-timeout`]## @@ -662,7 +661,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc-clients[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-clients_quarkus-grpc-clients-client-name-keep-alive-without-calls]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-clients_quarkus-grpc-clients-client-name-keep-alive-without-calls[`quarkus.grpc.clients."client-name".keep-alive-without-calls`]## @@ -917,7 +916,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_CLIENTS__CLIENT_NAME__DEADLINE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc-clients[icon:question-circle[title=More information about the Duration format]] | |=== @@ -941,5 +940,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.dev-mode.adoc b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.dev-mode.adoc index 36bcbc3641b..b0ee52a9bc1 100644 --- a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.dev-mode.adoc +++ b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.dev-mode.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-grpc_quarkus-grpc-dev-mode [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.server.adoc b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.server.adoc index a35e955524e..14b6095b93d 100644 --- a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.server.adoc +++ b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.server.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-grpc_quarkus-grpc-server [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -163,7 +162,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_SERVER_HANDSHAKE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc-server[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-server_quarkus-grpc-server-max-inbound-message-size]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-server_quarkus-grpc-server-max-inbound-message-size[`quarkus.grpc.server.max-inbound-message-size`]## @@ -172,6 +171,8 @@ a| [[quarkus-grpc_quarkus-grpc-server_quarkus-grpc-server-max-inbound-message-si -- The max inbound message size in bytes. +When using a single server (using `quarkus.grpc.server.use-separate-server=false`), the default value is 256KB. When using a separate server (using `quarkus.grpc.server.use-separate-server=true`), the default value is 4MB. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_GRPC_SERVER_MAX_INBOUND_MESSAGE_SIZE+++[] @@ -543,7 +544,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_SERVER_NETTY_KEEP_ALIVE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc-server[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-server_quarkus-grpc-server-netty-permit-keep-alive-time]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-server_quarkus-grpc-server-netty-permit-keep-alive-time[`quarkus.grpc.server.netty.permit-keep-alive-time`]## @@ -560,7 +561,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_GRPC_SERVER_NETTY_PERMIT_KEEP_ALIVE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-grpc_quarkus-grpc-server[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-grpc_quarkus-grpc-server_quarkus-grpc-server-netty-permit-keep-alive-without-calls]] [.property-path]##link:#quarkus-grpc_quarkus-grpc-server_quarkus-grpc-server-netty-permit-keep-alive-without-calls[`quarkus.grpc.server.netty.permit-keep-alive-without-calls`]## @@ -618,5 +619,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.server.xds.adoc b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.server.xds.adoc index f0f95c51a75..a81e4b86ecc 100644 --- a/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.server.xds.adoc +++ b/_generated-doc/latest/config/quarkus-grpc_quarkus.grpc.server.xds.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-grpc_quarkus-grpc-server-xds [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-hibernate-envers.adoc b/_generated-doc/latest/config/quarkus-hibernate-envers.adoc index 337daa33f2e..07306f2a774 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-envers.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-envers.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-hibernate-envers_quarkus-hibernate-envers [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -481,5 +480,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-hibernate-envers_quarkus.hibernate-envers.adoc b/_generated-doc/latest/config/quarkus-hibernate-envers_quarkus.hibernate-envers.adoc index 337daa33f2e..07306f2a774 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-envers_quarkus.hibernate-envers.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-envers_quarkus.hibernate-envers.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-hibernate-envers_quarkus-hibernate-envers [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -481,5 +480,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-hibernate-orm.adoc b/_generated-doc/latest/config/quarkus-hibernate-orm.adoc index 131bda0df99..729ce707846 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-orm.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-orm.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-hibernate-orm_quarkus-hibernate-orm [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -596,6 +595,29 @@ endif::add-copy-button-to-env-var[] |string | +a| [[quarkus-hibernate-orm_quarkus-hibernate-orm-database-version-check-enabled]] [.property-path]##link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-version-check-enabled[`quarkus.hibernate-orm.database.version-check.enabled`]## + +`quarkus.hibernate-orm."persistence-unit-name".database.version-check.enabled` + +[.description] +-- +Whether Hibernate ORM should check on startup +that the version of the database matches the version configured on the dialect +(either the default version, or the one set through `quarkus.datasource.db-version`). + +This should be set to `false` if the database is not available on startup. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_VERSION_CHECK_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_VERSION_CHECK_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|``true` if the dialect was set automatically by Quarkus, `false` if it was set explicitly` + h|[[quarkus-hibernate-orm_section_quarkus-hibernate-orm-dialect]] [.section-name.section-level0]##link:#quarkus-hibernate-orm_section_quarkus-hibernate-orm-dialect[Dialect related configuration]## h|Type @@ -940,7 +962,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_ORM_CACHE__CACHE__EXPIRATION_MAX_IDLE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-orm_quarkus-hibernate-orm[icon:question-circle[title=More information about the Duration format]] | a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-memory-object-count]] [.property-path]##link:#quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-memory-object-count[`quarkus.hibernate-orm.cache."cache".memory.object-count`]## @@ -1221,5 +1243,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-hibernate-orm_quarkus.hibernate-orm.adoc b/_generated-doc/latest/config/quarkus-hibernate-orm_quarkus.hibernate-orm.adoc index 131bda0df99..729ce707846 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-orm_quarkus.hibernate-orm.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-orm_quarkus.hibernate-orm.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-hibernate-orm_quarkus-hibernate-orm [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -596,6 +595,29 @@ endif::add-copy-button-to-env-var[] |string | +a| [[quarkus-hibernate-orm_quarkus-hibernate-orm-database-version-check-enabled]] [.property-path]##link:#quarkus-hibernate-orm_quarkus-hibernate-orm-database-version-check-enabled[`quarkus.hibernate-orm.database.version-check.enabled`]## + +`quarkus.hibernate-orm."persistence-unit-name".database.version-check.enabled` + +[.description] +-- +Whether Hibernate ORM should check on startup +that the version of the database matches the version configured on the dialect +(either the default version, or the one set through `quarkus.datasource.db-version`). + +This should be set to `false` if the database is not available on startup. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_ORM_DATABASE_VERSION_CHECK_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_ORM_DATABASE_VERSION_CHECK_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|``true` if the dialect was set automatically by Quarkus, `false` if it was set explicitly` + h|[[quarkus-hibernate-orm_section_quarkus-hibernate-orm-dialect]] [.section-name.section-level0]##link:#quarkus-hibernate-orm_section_quarkus-hibernate-orm-dialect[Dialect related configuration]## h|Type @@ -940,7 +962,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_ORM_CACHE__CACHE__EXPIRATION_MAX_IDLE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-orm_quarkus-hibernate-orm[icon:question-circle[title=More information about the Duration format]] | a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-memory-object-count]] [.property-path]##link:#quarkus-hibernate-orm_quarkus-hibernate-orm-cache-cache-memory-object-count[`quarkus.hibernate-orm.cache."cache".memory.object-count`]## @@ -1221,5 +1243,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-hibernate-search-orm-elasticsearch.adoc b/_generated-doc/latest/config/quarkus-hibernate-search-orm-elasticsearch.adoc index 8ccc354eba3..76b895a0fed 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-search-orm-elasticsearch.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-search-orm-elasticsearch.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -409,58 +408,6 @@ endif::add-copy-button-to-env-var[] |ElasticsearchVersion | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[`quarkus.hibernate-search-orm.elasticsearch.layout.strategy`]## - -`quarkus.hibernate-search-orm.elasticsearch."backend-name".layout.strategy` - -`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.layout.strategy` - -`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".layout.strategy` - -[.description] --- -A xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component -used to configure the Elasticsearch layout: index names, index aliases, ... - -The referenced bean must implement `IndexLayoutStrategy`. - -Available built-in implementations: - -`simple`:: -The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, -and an alias for read operations named `myindex-read`. -`no-alias`:: -A strategy without index aliases, mostly useful on legacy clusters: -if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex`, and will not use any alias. - -See -link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] -for more information. - -[NOTE] -==== -Instead of setting this configuration property, -you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension` -and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. -See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section] -for more information. - -If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. -==== - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file[`quarkus.hibernate-search-orm.elasticsearch.schema-management.settings-file`]## `quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.settings-file` @@ -674,7 +621,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-read-timeout]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-read-timeout[`quarkus.hibernate-search-orm.elasticsearch.read-timeout`]## @@ -697,7 +644,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-request-timeout]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-request-timeout[`quarkus.hibernate-search-orm.elasticsearch.request-timeout`]## @@ -723,7 +670,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_REQUEST_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-max-connections]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-max-connections[`quarkus.hibernate-search-orm.elasticsearch.max-connections`]## @@ -815,7 +762,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size[`quarkus.hibernate-search-orm.elasticsearch.thread-pool.size`]## @@ -946,7 +893,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count[`quarkus.hibernate-search-orm.elasticsearch.indexing.queue-count`]## @@ -1040,6 +987,58 @@ endif::add-copy-button-to-env-var[] |int |`100` +a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[`quarkus.hibernate-search-orm.elasticsearch.layout.strategy`]## + +`quarkus.hibernate-search-orm.elasticsearch."backend-name".layout.strategy` + +`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.layout.strategy` + +`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".layout.strategy` + +[.description] +-- +A xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component +used to configure the Elasticsearch layout: index names, index aliases, ... + +The referenced bean must implement `IndexLayoutStrategy`. + +Available built-in implementations: + +`simple`:: +The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, +this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, +and an alias for read operations named `myindex-read`. +`no-alias`:: +A strategy without index aliases, mostly useful on legacy clusters: +if the index name in Hibernate Search is `myIndex`, +this strategy will create an index named `myindex`, and will not use any alias. + +See +link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] +for more information. + +[NOTE] +==== +Instead of setting this configuration property, +you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension` +and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. +See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section] +for more information. + +If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. +==== + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + h|[[quarkus-hibernate-search-orm-elasticsearch_section_quarkus-hibernate-search-orm-elasticsearch-indexes]] [.section-name.section-level1]##link:#quarkus-hibernate-search-orm-elasticsearch_section_quarkus-hibernate-search-orm-elasticsearch-indexes[Per-index configuration overrides]## h|Type h|Default @@ -1189,7 +1188,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[`quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.queue-count`]## @@ -1347,5 +1346,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-hibernate-search-orm-elasticsearch_quarkus.hibernate-search-orm.adoc b/_generated-doc/latest/config/quarkus-hibernate-search-orm-elasticsearch_quarkus.hibernate-search-orm.adoc index 8ccc354eba3..76b895a0fed 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-search-orm-elasticsearch_quarkus.hibernate-search-orm.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-search-orm-elasticsearch_quarkus.hibernate-search-orm.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -409,58 +408,6 @@ endif::add-copy-button-to-env-var[] |ElasticsearchVersion | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[`quarkus.hibernate-search-orm.elasticsearch.layout.strategy`]## - -`quarkus.hibernate-search-orm.elasticsearch."backend-name".layout.strategy` - -`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.layout.strategy` - -`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".layout.strategy` - -[.description] --- -A xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component -used to configure the Elasticsearch layout: index names, index aliases, ... - -The referenced bean must implement `IndexLayoutStrategy`. - -Available built-in implementations: - -`simple`:: -The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, -and an alias for read operations named `myindex-read`. -`no-alias`:: -A strategy without index aliases, mostly useful on legacy clusters: -if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex`, and will not use any alias. - -See -link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] -for more information. - -[NOTE] -==== -Instead of setting this configuration property, -you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension` -and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. -See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section] -for more information. - -If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. -==== - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-schema-management-settings-file[`quarkus.hibernate-search-orm.elasticsearch.schema-management.settings-file`]## `quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.settings-file` @@ -674,7 +621,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-read-timeout]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-read-timeout[`quarkus.hibernate-search-orm.elasticsearch.read-timeout`]## @@ -697,7 +644,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-request-timeout]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-request-timeout[`quarkus.hibernate-search-orm.elasticsearch.request-timeout`]## @@ -723,7 +670,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_REQUEST_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-max-connections]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-max-connections[`quarkus.hibernate-search-orm.elasticsearch.max-connections`]## @@ -815,7 +762,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-thread-pool-size[`quarkus.hibernate-search-orm.elasticsearch.thread-pool.size`]## @@ -946,7 +893,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-indexing-queue-count[`quarkus.hibernate-search-orm.elasticsearch.indexing.queue-count`]## @@ -1040,6 +987,58 @@ endif::add-copy-button-to-env-var[] |int |`100` +a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-layout-strategy[`quarkus.hibernate-search-orm.elasticsearch.layout.strategy`]## + +`quarkus.hibernate-search-orm.elasticsearch."backend-name".layout.strategy` + +`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.layout.strategy` + +`quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".layout.strategy` + +[.description] +-- +A xref:hibernate-search-orm-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component +used to configure the Elasticsearch layout: index names, index aliases, ... + +The referenced bean must implement `IndexLayoutStrategy`. + +Available built-in implementations: + +`simple`:: +The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, +this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, +and an alias for read operations named `myindex-read`. +`no-alias`:: +A strategy without index aliases, mostly useful on legacy clusters: +if the index name in Hibernate Search is `myIndex`, +this strategy will create an index named `myindex`, and will not use any alias. + +See +link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] +for more information. + +[NOTE] +==== +Instead of setting this configuration property, +you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension` +and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. +See xref:hibernate-search-orm-elasticsearch.adoc#plugging-in-custom-components[this section] +for more information. + +If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. +==== + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + h|[[quarkus-hibernate-search-orm-elasticsearch_section_quarkus-hibernate-search-orm-elasticsearch-indexes]] [.section-name.section-level1]##link:#quarkus-hibernate-search-orm-elasticsearch_section_quarkus-hibernate-search-orm-elasticsearch-indexes[Per-index configuration overrides]## h|Type h|Default @@ -1189,7 +1188,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-elasticsearch-indexes-index-name-indexing-queue-count[`quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.queue-count`]## @@ -1347,5 +1346,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-hibernate-search-orm-outbox-polling.adoc b/_generated-doc/latest/config/quarkus-hibernate-search-orm-outbox-polling.adoc index 432b9dbacea..da6a7f66519 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-search-orm-outbox-polling.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-search-orm-outbox-polling.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -121,7 +120,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_POLLING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`0.100S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-pulse-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-pulse-interval[`quarkus.hibernate-search-orm.coordination.event-processor.pulse-interval`]## @@ -160,7 +159,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_PULSE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-pulse-expiration]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-pulse-expiration[`quarkus.hibernate-search-orm.coordination.event-processor.pulse-expiration`]## @@ -196,7 +195,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_PULSE_EXPIRATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-batch-size]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-batch-size[`quarkus.hibernate-search-orm.coordination.event-processor.batch-size`]## @@ -251,7 +250,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_TRANSACTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-retry-delay]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-retry-delay[`quarkus.hibernate-search-orm.coordination.event-processor.retry-delay`]## @@ -276,7 +275,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_RETRY_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-polling-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-polling-interval[`quarkus.hibernate-search-orm.coordination.mass-indexer.polling-interval`]## @@ -308,7 +307,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_POLLING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`0.100S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-pulse-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-pulse-interval[`quarkus.hibernate-search-orm.coordination.mass-indexer.pulse-interval`]## @@ -345,7 +344,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_PULSE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-pulse-expiration]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-pulse-expiration[`quarkus.hibernate-search-orm.coordination.mass-indexer.pulse-expiration`]## @@ -381,7 +380,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_PULSE_EXPIRATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` h|[[quarkus-hibernate-search-orm-outbox-polling_section_quarkus-hibernate-search-orm]] [.section-name.section-level0]##link:#quarkus-hibernate-search-orm-outbox-polling_section_quarkus-hibernate-search-orm[Configuration for persistence units]## @@ -725,7 +724,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_POLLING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`0.100S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-pulse-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-pulse-interval[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.pulse-interval`]## @@ -764,7 +763,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_PULSE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-pulse-expiration]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-pulse-expiration[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.pulse-expiration`]## @@ -800,7 +799,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_PULSE_EXPIRATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-batch-size]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-batch-size[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.batch-size`]## @@ -855,7 +854,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_TRANSACTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-retry-delay]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-retry-delay[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.retry-delay`]## @@ -880,7 +879,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_RETRY_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-polling-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-polling-interval[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".mass-indexer.polling-interval`]## @@ -912,7 +911,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_POLLING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`0.100S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-pulse-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-pulse-interval[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".mass-indexer.pulse-interval`]## @@ -949,7 +948,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_PULSE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-pulse-expiration]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-pulse-expiration[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".mass-indexer.pulse-expiration`]## @@ -985,7 +984,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_PULSE_EXPIRATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` @@ -1010,5 +1009,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-hibernate-search-orm-outbox-polling_quarkus.hibernate-search-orm.adoc b/_generated-doc/latest/config/quarkus-hibernate-search-orm-outbox-polling_quarkus.hibernate-search-orm.adoc index 432b9dbacea..da6a7f66519 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-search-orm-outbox-polling_quarkus.hibernate-search-orm.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-search-orm-outbox-polling_quarkus.hibernate-search-orm.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -121,7 +120,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_POLLING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`0.100S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-pulse-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-pulse-interval[`quarkus.hibernate-search-orm.coordination.event-processor.pulse-interval`]## @@ -160,7 +159,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_PULSE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-pulse-expiration]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-pulse-expiration[`quarkus.hibernate-search-orm.coordination.event-processor.pulse-expiration`]## @@ -196,7 +195,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_PULSE_EXPIRATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-batch-size]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-batch-size[`quarkus.hibernate-search-orm.coordination.event-processor.batch-size`]## @@ -251,7 +250,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_TRANSACTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-retry-delay]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-event-processor-retry-delay[`quarkus.hibernate-search-orm.coordination.event-processor.retry-delay`]## @@ -276,7 +275,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_RETRY_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-polling-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-polling-interval[`quarkus.hibernate-search-orm.coordination.mass-indexer.polling-interval`]## @@ -308,7 +307,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_POLLING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`0.100S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-pulse-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-pulse-interval[`quarkus.hibernate-search-orm.coordination.mass-indexer.pulse-interval`]## @@ -345,7 +344,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_PULSE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-pulse-expiration]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-mass-indexer-pulse-expiration[`quarkus.hibernate-search-orm.coordination.mass-indexer.pulse-expiration`]## @@ -381,7 +380,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_PULSE_EXPIRATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` h|[[quarkus-hibernate-search-orm-outbox-polling_section_quarkus-hibernate-search-orm]] [.section-name.section-level0]##link:#quarkus-hibernate-search-orm-outbox-polling_section_quarkus-hibernate-search-orm[Configuration for persistence units]## @@ -725,7 +724,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_POLLING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`0.100S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-pulse-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-pulse-interval[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.pulse-interval`]## @@ -764,7 +763,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_PULSE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-pulse-expiration]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-pulse-expiration[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.pulse-expiration`]## @@ -800,7 +799,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_PULSE_EXPIRATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-batch-size]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-batch-size[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.batch-size`]## @@ -855,7 +854,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_TRANSACTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-retry-delay]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-event-processor-retry-delay[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.retry-delay`]## @@ -880,7 +879,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_RETRY_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-polling-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-polling-interval[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".mass-indexer.polling-interval`]## @@ -912,7 +911,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_POLLING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`0.100S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-pulse-interval]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-pulse-interval[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".mass-indexer.pulse-interval`]## @@ -949,7 +948,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_PULSE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-pulse-expiration]] [.property-path]##link:#quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm-coordination-tenants-tenant-id-mass-indexer-pulse-expiration[`quarkus.hibernate-search-orm.coordination.tenants."tenant-id".mass-indexer.pulse-expiration`]## @@ -985,7 +984,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_PULSE_EXPIRATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-orm-outbox-polling_quarkus-hibernate-search-orm[icon:question-circle[title=More information about the Duration format]] |`30S` @@ -1010,5 +1009,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-hibernate-search-standalone-elasticsearch.adoc b/_generated-doc/latest/config/quarkus-hibernate-search-standalone-elasticsearch.adoc index e77703eec4c..77063573dc4 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-search-standalone-elasticsearch.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-search-standalone-elasticsearch.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -339,54 +338,6 @@ endif::add-copy-button-to-env-var[] |ElasticsearchVersion | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy[`quarkus.hibernate-search-standalone.elasticsearch.layout.strategy`]## - -`quarkus.hibernate-search-standalone.elasticsearch."backend-name".layout.strategy` - -[.description] --- -A xref:hibernate-search-standalone-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component -used to configure the Elasticsearch layout: index names, index aliases, ... - -The referenced bean must implement `IndexLayoutStrategy`. - -Available built-in implementations: - -`simple`:: -The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, -and an alias for read operations named `myindex-read`. -`no-alias`:: -A strategy without index aliases, mostly useful on legacy clusters: -if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex`, and will not use any alias. - -See -link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] -for more information. - -[NOTE] -==== -Instead of setting this configuration property, -you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension` -and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. -See xref:hibernate-search-standalone-elasticsearch.adoc#plugging-in-custom-components[this section] -for more information. - -If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. -==== - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-schema-management-settings-file]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-schema-management-settings-file[`quarkus.hibernate-search-standalone.elasticsearch.schema-management.settings-file`]## `quarkus.hibernate-search-standalone.elasticsearch."backend-name".schema-management.settings-file` @@ -568,7 +519,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-read-timeout]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-read-timeout[`quarkus.hibernate-search-standalone.elasticsearch.read-timeout`]## @@ -587,7 +538,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-request-timeout]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-request-timeout[`quarkus.hibernate-search-standalone.elasticsearch.request-timeout`]## @@ -609,7 +560,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_REQUEST_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-max-connections]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-max-connections[`quarkus.hibernate-search-standalone.elasticsearch.max-connections`]## @@ -685,7 +636,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-thread-pool-size]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-thread-pool-size[`quarkus.hibernate-search-standalone.elasticsearch.thread-pool.size`]## @@ -796,7 +747,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-indexing-queue-count]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-indexing-queue-count[`quarkus.hibernate-search-standalone.elasticsearch.indexing.queue-count`]## @@ -878,6 +829,54 @@ endif::add-copy-button-to-env-var[] |int |`100` +a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy[`quarkus.hibernate-search-standalone.elasticsearch.layout.strategy`]## + +`quarkus.hibernate-search-standalone.elasticsearch."backend-name".layout.strategy` + +[.description] +-- +A xref:hibernate-search-standalone-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component +used to configure the Elasticsearch layout: index names, index aliases, ... + +The referenced bean must implement `IndexLayoutStrategy`. + +Available built-in implementations: + +`simple`:: +The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, +this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, +and an alias for read operations named `myindex-read`. +`no-alias`:: +A strategy without index aliases, mostly useful on legacy clusters: +if the index name in Hibernate Search is `myIndex`, +this strategy will create an index named `myindex`, and will not use any alias. + +See +link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] +for more information. + +[NOTE] +==== +Instead of setting this configuration property, +you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension` +and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. +See xref:hibernate-search-standalone-elasticsearch.adoc#plugging-in-custom-components[this section] +for more information. + +If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. +==== + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + h|[[quarkus-hibernate-search-standalone-elasticsearch_section_quarkus-hibernate-search-standalone-elasticsearch-indexes]] [.section-name.section-level1]##link:#quarkus-hibernate-search-standalone-elasticsearch_section_quarkus-hibernate-search-standalone-elasticsearch-indexes[Per-index configuration overrides]## h|Type h|Default @@ -1007,7 +1006,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-indexes-index-name-indexing-queue-count]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-indexes-index-name-indexing-queue-count[`quarkus.hibernate-search-standalone.elasticsearch.indexes."index-name".indexing.queue-count`]## @@ -1153,5 +1152,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-hibernate-search-standalone-elasticsearch_quarkus.hibernate-search-standalone.adoc b/_generated-doc/latest/config/quarkus-hibernate-search-standalone-elasticsearch_quarkus.hibernate-search-standalone.adoc index e77703eec4c..77063573dc4 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-search-standalone-elasticsearch_quarkus.hibernate-search-standalone.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-search-standalone-elasticsearch_quarkus.hibernate-search-standalone.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -339,54 +338,6 @@ endif::add-copy-button-to-env-var[] |ElasticsearchVersion | -a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy[`quarkus.hibernate-search-standalone.elasticsearch.layout.strategy`]## - -`quarkus.hibernate-search-standalone.elasticsearch."backend-name".layout.strategy` - -[.description] --- -A xref:hibernate-search-standalone-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component -used to configure the Elasticsearch layout: index names, index aliases, ... - -The referenced bean must implement `IndexLayoutStrategy`. - -Available built-in implementations: - -`simple`:: -The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, -and an alias for read operations named `myindex-read`. -`no-alias`:: -A strategy without index aliases, mostly useful on legacy clusters: -if the index name in Hibernate Search is `myIndex`, -this strategy will create an index named `myindex`, and will not use any alias. - -See -link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] -for more information. - -[NOTE] -==== -Instead of setting this configuration property, -you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension` -and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. -See xref:hibernate-search-standalone-elasticsearch.adoc#plugging-in-custom-components[this section] -for more information. - -If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. -==== - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a|icon:lock[title=Fixed at build time] [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-schema-management-settings-file]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-schema-management-settings-file[`quarkus.hibernate-search-standalone.elasticsearch.schema-management.settings-file`]## `quarkus.hibernate-search-standalone.elasticsearch."backend-name".schema-management.settings-file` @@ -568,7 +519,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-read-timeout]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-read-timeout[`quarkus.hibernate-search-standalone.elasticsearch.read-timeout`]## @@ -587,7 +538,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-request-timeout]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-request-timeout[`quarkus.hibernate-search-standalone.elasticsearch.request-timeout`]## @@ -609,7 +560,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_REQUEST_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-max-connections]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-max-connections[`quarkus.hibernate-search-standalone.elasticsearch.max-connections`]## @@ -685,7 +636,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-thread-pool-size]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-thread-pool-size[`quarkus.hibernate-search-standalone.elasticsearch.thread-pool.size`]## @@ -796,7 +747,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-indexing-queue-count]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-indexing-queue-count[`quarkus.hibernate-search-standalone.elasticsearch.indexing.queue-count`]## @@ -878,6 +829,54 @@ endif::add-copy-button-to-env-var[] |int |`100` +a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-layout-strategy[`quarkus.hibernate-search-standalone.elasticsearch.layout.strategy`]## + +`quarkus.hibernate-search-standalone.elasticsearch."backend-name".layout.strategy` + +[.description] +-- +A xref:hibernate-search-standalone-elasticsearch.adoc#bean-reference-note-anchor[bean reference] to the component +used to configure the Elasticsearch layout: index names, index aliases, ... + +The referenced bean must implement `IndexLayoutStrategy`. + +Available built-in implementations: + +`simple`:: +The default, future-proof strategy: if the index name in Hibernate Search is `myIndex`, +this strategy will create an index named `myindex-000001`, an alias for write operations named `myindex-write`, +and an alias for read operations named `myindex-read`. +`no-alias`:: +A strategy without index aliases, mostly useful on legacy clusters: +if the index name in Hibernate Search is `myIndex`, +this strategy will create an index named `myindex`, and will not use any alias. + +See +link:{hibernate-search-docs-url}#backend-elasticsearch-indexlayout[this section of the reference documentation] +for more information. + +[NOTE] +==== +Instead of setting this configuration property, +you can simply annotate your custom `IndexLayoutStrategy` implementation with `@SearchExtension` +and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically. +See xref:hibernate-search-standalone-elasticsearch.adoc#plugging-in-custom-components[this section] +for more information. + +If this configuration property is set, it takes precedence over any `@SearchExtension` annotation. +==== + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + h|[[quarkus-hibernate-search-standalone-elasticsearch_section_quarkus-hibernate-search-standalone-elasticsearch-indexes]] [.section-name.section-level1]##link:#quarkus-hibernate-search-standalone-elasticsearch_section_quarkus-hibernate-search-standalone-elasticsearch-indexes[Per-index configuration overrides]## h|Type h|Default @@ -1007,7 +1006,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-indexes-index-name-indexing-queue-count]] [.property-path]##link:#quarkus-hibernate-search-standalone-elasticsearch_quarkus-hibernate-search-standalone-elasticsearch-indexes-index-name-indexing-queue-count[`quarkus.hibernate-search-standalone.elasticsearch.indexes."index-name".indexing.queue-count`]## @@ -1153,5 +1152,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-hibernate-validator.adoc b/_generated-doc/latest/config/quarkus-hibernate-validator.adoc index 98dfe669dcf..c9458c41912 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-validator.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-validator.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-hibernate-validator_quarkus-hibernate-validator [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -130,5 +129,3 @@ a|`default`, `none`, `variables`, `bean-properties`, `bean-methods` |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-hibernate-validator_quarkus.hibernate-validator.adoc b/_generated-doc/latest/config/quarkus-hibernate-validator_quarkus.hibernate-validator.adoc index 98dfe669dcf..c9458c41912 100644 --- a/_generated-doc/latest/config/quarkus-hibernate-validator_quarkus.hibernate-validator.adoc +++ b/_generated-doc/latest/config/quarkus-hibernate-validator_quarkus.hibernate-validator.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-hibernate-validator_quarkus-hibernate-validator [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -130,5 +129,3 @@ a|`default`, `none`, `variables`, `bean-properties`, `bean-methods` |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-infinispan-cache.adoc b/_generated-doc/latest/config/quarkus-infinispan-cache.adoc index e5e46e0697c..4f00b9d52db 100644 --- a/_generated-doc/latest/config/quarkus-infinispan-cache.adoc +++ b/_generated-doc/latest/config/quarkus-infinispan-cache.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-infinispan-cache_quarkus-cache [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -39,7 +38,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_INFINISPAN_LIFESPAN+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-infinispan-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-infinispan-cache_quarkus-cache-infinispan-max-idle]] [.property-path]##link:#quarkus-infinispan-cache_quarkus-cache-infinispan-max-idle[`quarkus.cache.infinispan.max-idle`]## @@ -56,7 +55,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_INFINISPAN_MAX_IDLE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-infinispan-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | h|[[quarkus-infinispan-cache_section_quarkus-cache-infinispan]] [.section-name.section-level0]##link:#quarkus-infinispan-cache_section_quarkus-cache-infinispan[Additional configuration applied to a specific Infinispan cache (highest precedence)]## @@ -77,7 +76,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_INFINISPAN__CACHE_NAME__LIFESPAN+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-infinispan-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-infinispan-cache_quarkus-cache-infinispan-cache-name-max-idle]] [.property-path]##link:#quarkus-infinispan-cache_quarkus-cache-infinispan-cache-name-max-idle[`quarkus.cache.infinispan."cache-name".max-idle`]## @@ -94,7 +93,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_INFINISPAN__CACHE_NAME__MAX_IDLE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-infinispan-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | @@ -119,5 +118,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-infinispan-cache_quarkus.cache.adoc b/_generated-doc/latest/config/quarkus-infinispan-cache_quarkus.cache.adoc index e5e46e0697c..4f00b9d52db 100644 --- a/_generated-doc/latest/config/quarkus-infinispan-cache_quarkus.cache.adoc +++ b/_generated-doc/latest/config/quarkus-infinispan-cache_quarkus.cache.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-infinispan-cache_quarkus-cache [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -39,7 +38,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_INFINISPAN_LIFESPAN+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-infinispan-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-infinispan-cache_quarkus-cache-infinispan-max-idle]] [.property-path]##link:#quarkus-infinispan-cache_quarkus-cache-infinispan-max-idle[`quarkus.cache.infinispan.max-idle`]## @@ -56,7 +55,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_INFINISPAN_MAX_IDLE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-infinispan-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | h|[[quarkus-infinispan-cache_section_quarkus-cache-infinispan]] [.section-name.section-level0]##link:#quarkus-infinispan-cache_section_quarkus-cache-infinispan[Additional configuration applied to a specific Infinispan cache (highest precedence)]## @@ -77,7 +76,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_INFINISPAN__CACHE_NAME__LIFESPAN+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-infinispan-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-infinispan-cache_quarkus-cache-infinispan-cache-name-max-idle]] [.property-path]##link:#quarkus-infinispan-cache_quarkus-cache-infinispan-cache-name-max-idle[`quarkus.cache.infinispan."cache-name".max-idle`]## @@ -94,7 +93,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_INFINISPAN__CACHE_NAME__MAX_IDLE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-infinispan-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | @@ -119,5 +118,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-infinispan-client.adoc b/_generated-doc/latest/config/quarkus-infinispan-client.adoc index 92903247f12..e37baf34ca2 100644 --- a/_generated-doc/latest/config/quarkus-infinispan-client.adoc +++ b/_generated-doc/latest/config/quarkus-infinispan-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-infinispan-client_quarkus-infinispan-client [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -1602,5 +1601,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-infinispan-client_quarkus.infinispan-client.-client-name-.devservices.adoc b/_generated-doc/latest/config/quarkus-infinispan-client_quarkus.infinispan-client.-client-name-.devservices.adoc index 59e2ce72b12..c220216e8f2 100644 --- a/_generated-doc/latest/config/quarkus-infinispan-client_quarkus.infinispan-client.-client-name-.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-infinispan-client_quarkus.infinispan-client.-client-name-.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-infinispan-client_quarkus-infinispan-client-client-name-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -211,5 +210,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-infinispan-client_quarkus.infinispan-client.adoc b/_generated-doc/latest/config/quarkus-infinispan-client_quarkus.infinispan-client.adoc index 92903247f12..e37baf34ca2 100644 --- a/_generated-doc/latest/config/quarkus-infinispan-client_quarkus.infinispan-client.adoc +++ b/_generated-doc/latest/config/quarkus-infinispan-client_quarkus.infinispan-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-infinispan-client_quarkus-infinispan-client [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -1602,5 +1601,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-infinispan-client_quarkus.infinispan-client.devservices.adoc b/_generated-doc/latest/config/quarkus-infinispan-client_quarkus.infinispan-client.devservices.adoc index 6a61bdd7c06..2a5bcd9355a 100644 --- a/_generated-doc/latest/config/quarkus-infinispan-client_quarkus.infinispan-client.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-infinispan-client_quarkus.infinispan-client.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-infinispan-client_quarkus-infinispan-client-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -211,5 +210,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-info.adoc b/_generated-doc/latest/config/quarkus-info.adoc index 7ddcf0f3f59..541eba83f15 100644 --- a/_generated-doc/latest/config/quarkus-info.adoc +++ b/_generated-doc/latest/config/quarkus-info.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-info_quarkus-info [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -146,5 +145,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-info_quarkus.info.adoc b/_generated-doc/latest/config/quarkus-info_quarkus.info.adoc index 7ddcf0f3f59..541eba83f15 100644 --- a/_generated-doc/latest/config/quarkus-info_quarkus.info.adoc +++ b/_generated-doc/latest/config/quarkus-info_quarkus.info.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-info_quarkus-info [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -146,5 +145,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-jackson.adoc b/_generated-doc/latest/config/quarkus-jackson.adoc index 787bb223224..e9f78f18a3f 100644 --- a/_generated-doc/latest/config/quarkus-jackson.adoc +++ b/_generated-doc/latest/config/quarkus-jackson.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-jackson_quarkus-jackson [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -148,5 +147,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-jackson_quarkus.jackson.adoc b/_generated-doc/latest/config/quarkus-jackson_quarkus.jackson.adoc index 787bb223224..e9f78f18a3f 100644 --- a/_generated-doc/latest/config/quarkus-jackson_quarkus.jackson.adoc +++ b/_generated-doc/latest/config/quarkus-jackson_quarkus.jackson.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-jackson_quarkus-jackson [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -148,5 +147,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-jacoco.adoc b/_generated-doc/latest/config/quarkus-jacoco.adoc index 046c03ef190..123f726c891 100644 --- a/_generated-doc/latest/config/quarkus-jacoco.adoc +++ b/_generated-doc/latest/config/quarkus-jacoco.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-jacoco_quarkus-jacoco [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -209,5 +208,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-jacoco_quarkus.jacoco.adoc b/_generated-doc/latest/config/quarkus-jacoco_quarkus.jacoco.adoc index 046c03ef190..123f726c891 100644 --- a/_generated-doc/latest/config/quarkus-jacoco_quarkus.jacoco.adoc +++ b/_generated-doc/latest/config/quarkus-jacoco_quarkus.jacoco.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-jacoco_quarkus-jacoco [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -209,5 +208,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-jaxb.adoc b/_generated-doc/latest/config/quarkus-jaxb.adoc index 0ad69fbe7a4..c74e0dafc14 100644 --- a/_generated-doc/latest/config/quarkus-jaxb.adoc +++ b/_generated-doc/latest/config/quarkus-jaxb.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-jaxb_quarkus-jaxb [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-jaxb_quarkus.jaxb.adoc b/_generated-doc/latest/config/quarkus-jaxb_quarkus.jaxb.adoc index 0ad69fbe7a4..c74e0dafc14 100644 --- a/_generated-doc/latest/config/quarkus-jaxb_quarkus.jaxb.adoc +++ b/_generated-doc/latest/config/quarkus-jaxb_quarkus.jaxb.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-jaxb_quarkus-jaxb [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-jfr.adoc b/_generated-doc/latest/config/quarkus-jfr.adoc index 52ea89b224d..7f263d1afc4 100644 --- a/_generated-doc/latest/config/quarkus-jfr.adoc +++ b/_generated-doc/latest/config/quarkus-jfr.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-jfr_quarkus-jfr [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-jfr_quarkus.jfr.adoc b/_generated-doc/latest/config/quarkus-jfr_quarkus.jfr.adoc index 52ea89b224d..7f263d1afc4 100644 --- a/_generated-doc/latest/config/quarkus-jfr_quarkus.jfr.adoc +++ b/_generated-doc/latest/config/quarkus-jfr_quarkus.jfr.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-jfr_quarkus-jfr [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kafka-client.adoc b/_generated-doc/latest/config/quarkus-kafka-client.adoc index c6bae89f89f..2d55e7a66b7 100644 --- a/_generated-doc/latest/config/quarkus-kafka-client.adoc +++ b/_generated-doc/latest/config/quarkus-kafka-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kafka-client_quarkus-kafka [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -224,7 +223,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KAFKA_DEVSERVICES_TOPIC_PARTITIONS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kafka-client_quarkus-kafka[icon:question-circle[title=More information about the Duration format]] |`2S` a|icon:lock[title=Fixed at build time] [[quarkus-kafka-client_quarkus-kafka-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-kafka-client_quarkus-kafka-devservices-container-env-environment-variable-name[`quarkus.kafka.devservices.container-env."environment-variable-name"`]## @@ -302,5 +301,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kafka-client_quarkus.kafka.adoc b/_generated-doc/latest/config/quarkus-kafka-client_quarkus.kafka.adoc index c6bae89f89f..2d55e7a66b7 100644 --- a/_generated-doc/latest/config/quarkus-kafka-client_quarkus.kafka.adoc +++ b/_generated-doc/latest/config/quarkus-kafka-client_quarkus.kafka.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kafka-client_quarkus-kafka [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -224,7 +223,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KAFKA_DEVSERVICES_TOPIC_PARTITIONS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kafka-client_quarkus-kafka[icon:question-circle[title=More information about the Duration format]] |`2S` a|icon:lock[title=Fixed at build time] [[quarkus-kafka-client_quarkus-kafka-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-kafka-client_quarkus-kafka-devservices-container-env-environment-variable-name[`quarkus.kafka.devservices.container-env."environment-variable-name"`]## @@ -302,5 +301,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kafka-client_quarkus.kafka.devservices.adoc b/_generated-doc/latest/config/quarkus-kafka-client_quarkus.kafka.devservices.adoc index 16aa232a93d..47c631e343d 100644 --- a/_generated-doc/latest/config/quarkus-kafka-client_quarkus.kafka.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-kafka-client_quarkus.kafka.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kafka-client_quarkus-kafka-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -165,7 +164,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KAFKA_DEVSERVICES_TOPIC_PARTITIONS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kafka-client_quarkus-kafka-devservices[icon:question-circle[title=More information about the Duration format]] |`2S` a|icon:lock[title=Fixed at build time] [[quarkus-kafka-client_quarkus-kafka-devservices_quarkus-kafka-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-kafka-client_quarkus-kafka-devservices_quarkus-kafka-devservices-container-env-environment-variable-name[`quarkus.kafka.devservices.container-env."environment-variable-name"`]## @@ -242,5 +241,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kafka-streams.adoc b/_generated-doc/latest/config/quarkus-kafka-streams.adoc index 1209175d3fe..45c582bfdbb 100644 --- a/_generated-doc/latest/config/quarkus-kafka-streams.adoc +++ b/_generated-doc/latest/config/quarkus-kafka-streams.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kafka-streams_quarkus-kafka-streams [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -107,7 +106,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KAFKA_STREAMS_TOPICS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kafka-streams_quarkus-kafka-streams[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-kafka-streams_quarkus-kafka-streams-schema-registry-key]] [.property-path]##link:#quarkus-kafka-streams_quarkus-kafka-streams-schema-registry-key[`quarkus.kafka-streams.schema-registry-key`]## @@ -379,7 +378,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_MIN_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kafka-streams_quarkus-kafka-streams[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-kafka-streams_quarkus-kafka-streams-sasl-login-refresh-buffer]] [.property-path]##link:#quarkus-kafka-streams_quarkus-kafka-streams-sasl-login-refresh-buffer[`quarkus.kafka-streams.sasl.login-refresh-buffer`]## @@ -396,7 +395,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_BUFFER+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kafka-streams_quarkus-kafka-streams[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-kafka-streams_quarkus-kafka-streams-ssl-protocol]] [.property-path]##link:#quarkus-kafka-streams_quarkus-kafka-streams-ssl-protocol[`quarkus.kafka-streams.ssl.protocol`]## @@ -726,5 +725,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kafka-streams_quarkus.kafka-streams.adoc b/_generated-doc/latest/config/quarkus-kafka-streams_quarkus.kafka-streams.adoc index 1209175d3fe..45c582bfdbb 100644 --- a/_generated-doc/latest/config/quarkus-kafka-streams_quarkus.kafka-streams.adoc +++ b/_generated-doc/latest/config/quarkus-kafka-streams_quarkus.kafka-streams.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kafka-streams_quarkus-kafka-streams [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -107,7 +106,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KAFKA_STREAMS_TOPICS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kafka-streams_quarkus-kafka-streams[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-kafka-streams_quarkus-kafka-streams-schema-registry-key]] [.property-path]##link:#quarkus-kafka-streams_quarkus-kafka-streams-schema-registry-key[`quarkus.kafka-streams.schema-registry-key`]## @@ -379,7 +378,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_MIN_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kafka-streams_quarkus-kafka-streams[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-kafka-streams_quarkus-kafka-streams-sasl-login-refresh-buffer]] [.property-path]##link:#quarkus-kafka-streams_quarkus-kafka-streams-sasl-login-refresh-buffer[`quarkus.kafka-streams.sasl.login-refresh-buffer`]## @@ -396,7 +395,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_BUFFER+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kafka-streams_quarkus-kafka-streams[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-kafka-streams_quarkus-kafka-streams-ssl-protocol]] [.property-path]##link:#quarkus-kafka-streams_quarkus-kafka-streams-ssl-protocol[`quarkus.kafka-streams.ssl.protocol`]## @@ -726,5 +725,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-keycloak-admin-client.adoc b/_generated-doc/latest/config/quarkus-keycloak-admin-client.adoc index 0875c9445f7..29fcd3d9dd3 100644 --- a/_generated-doc/latest/config/quarkus-keycloak-admin-client.adoc +++ b/_generated-doc/latest/config/quarkus-keycloak-admin-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-keycloak-admin-client_quarkus-keycloak [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -161,7 +160,26 @@ endif::add-copy-button-to-env-var[] a|`password`, `client-credentials` |`password` -|=== +a| [[quarkus-keycloak-admin-client_quarkus-keycloak-admin-client-tls-configuration-name]] [.property-path]##link:#quarkus-keycloak-admin-client_quarkus-keycloak-admin-client-tls-configuration-name[`quarkus.keycloak.admin-client.tls-configuration-name`]## + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_ADMIN_CLIENT_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KEYCLOAK_ADMIN_CLIENT_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| +|=== -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-keycloak-admin-client_quarkus.keycloak.adoc b/_generated-doc/latest/config/quarkus-keycloak-admin-client_quarkus.keycloak.adoc index 0875c9445f7..29fcd3d9dd3 100644 --- a/_generated-doc/latest/config/quarkus-keycloak-admin-client_quarkus.keycloak.adoc +++ b/_generated-doc/latest/config/quarkus-keycloak-admin-client_quarkus.keycloak.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-keycloak-admin-client_quarkus-keycloak [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -161,7 +160,26 @@ endif::add-copy-button-to-env-var[] a|`password`, `client-credentials` |`password` -|=== +a| [[quarkus-keycloak-admin-client_quarkus-keycloak-admin-client-tls-configuration-name]] [.property-path]##link:#quarkus-keycloak-admin-client_quarkus-keycloak-admin-client-tls-configuration-name[`quarkus.keycloak.admin-client.tls-configuration-name`]## + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_ADMIN_CLIENT_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KEYCLOAK_ADMIN_CLIENT_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| +|=== -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-keycloak-authorization.adoc b/_generated-doc/latest/config/quarkus-keycloak-authorization.adoc index 67cc4b6f517..0e65ed46bf9 100644 --- a/_generated-doc/latest/config/quarkus-keycloak-authorization.adoc +++ b/_generated-doc/latest/config/quarkus-keycloak-authorization.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-keycloak-authorization_quarkus-keycloak [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -576,5 +575,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-keycloak-authorization_quarkus.keycloak.adoc b/_generated-doc/latest/config/quarkus-keycloak-authorization_quarkus.keycloak.adoc index 67cc4b6f517..0e65ed46bf9 100644 --- a/_generated-doc/latest/config/quarkus-keycloak-authorization_quarkus.keycloak.adoc +++ b/_generated-doc/latest/config/quarkus-keycloak-authorization_quarkus.keycloak.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-keycloak-authorization_quarkus-keycloak [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -576,5 +575,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kubernetes-client.adoc b/_generated-doc/latest/config/quarkus-kubernetes-client.adoc index 6f24c9e8636..c13b8091deb 100644 --- a/_generated-doc/latest/config/quarkus-kubernetes-client.adoc +++ b/_generated-doc/latest/config/quarkus-kubernetes-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kubernetes-client_quarkus-kubernetes-client [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -260,8 +259,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT1S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes-client_quarkus-kubernetes-client[icon:question-circle[title=More information about the Duration format]] +| a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-watch-reconnect-limit]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-watch-reconnect-limit[`quarkus.kubernetes-client.watch-reconnect-limit`]## @@ -278,7 +277,7 @@ Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_LIMIT+++` endif::add-copy-button-to-env-var[] -- |int -|`-1` +| a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-connection-timeout]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-connection-timeout[`quarkus.kubernetes-client.connection-timeout`]## @@ -294,8 +293,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT10S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes-client_quarkus-kubernetes-client[icon:question-circle[title=More information about the Duration format]] +| a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-request-timeout]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-request-timeout[`quarkus.kubernetes-client.request-timeout`]## @@ -311,8 +310,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_REQUEST_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT10S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes-client_quarkus-kubernetes-client[icon:question-circle[title=More information about the Duration format]] +| a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-limit]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-limit[`quarkus.kubernetes-client.request-retry-backoff-limit`]## @@ -329,7 +328,7 @@ Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_LIMIT+ endif::add-copy-button-to-env-var[] -- |int -|`0` +| a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-interval]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-interval[`quarkus.kubernetes-client.request-retry-backoff-interval`]## @@ -345,8 +344,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT1S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes-client_quarkus-kubernetes-client[icon:question-circle[title=More information about the Duration format]] +| a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-http-proxy]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-http-proxy[`quarkus.kubernetes-client.http-proxy`]## @@ -601,5 +600,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kubernetes-client_quarkus.kubernetes-client.adoc b/_generated-doc/latest/config/quarkus-kubernetes-client_quarkus.kubernetes-client.adoc index 6f24c9e8636..c13b8091deb 100644 --- a/_generated-doc/latest/config/quarkus-kubernetes-client_quarkus.kubernetes-client.adoc +++ b/_generated-doc/latest/config/quarkus-kubernetes-client_quarkus.kubernetes-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kubernetes-client_quarkus-kubernetes-client [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -260,8 +259,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT1S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes-client_quarkus-kubernetes-client[icon:question-circle[title=More information about the Duration format]] +| a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-watch-reconnect-limit]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-watch-reconnect-limit[`quarkus.kubernetes-client.watch-reconnect-limit`]## @@ -278,7 +277,7 @@ Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_LIMIT+++` endif::add-copy-button-to-env-var[] -- |int -|`-1` +| a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-connection-timeout]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-connection-timeout[`quarkus.kubernetes-client.connection-timeout`]## @@ -294,8 +293,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT10S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes-client_quarkus-kubernetes-client[icon:question-circle[title=More information about the Duration format]] +| a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-request-timeout]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-request-timeout[`quarkus.kubernetes-client.request-timeout`]## @@ -311,8 +310,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_REQUEST_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT10S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes-client_quarkus-kubernetes-client[icon:question-circle[title=More information about the Duration format]] +| a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-limit]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-limit[`quarkus.kubernetes-client.request-retry-backoff-limit`]## @@ -329,7 +328,7 @@ Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_LIMIT+ endif::add-copy-button-to-env-var[] -- |int -|`0` +| a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-interval]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-request-retry-backoff-interval[`quarkus.kubernetes-client.request-retry-backoff-interval`]## @@ -345,8 +344,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT1S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes-client_quarkus-kubernetes-client[icon:question-circle[title=More information about the Duration format]] +| a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-client_quarkus-kubernetes-client-http-proxy]] [.property-path]##link:#quarkus-kubernetes-client_quarkus-kubernetes-client-http-proxy[`quarkus.kubernetes-client.http-proxy`]## @@ -601,5 +600,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kubernetes-client_quarkus.kubernetes-client.devservices.adoc b/_generated-doc/latest/config/quarkus-kubernetes-client_quarkus.kubernetes-client.devservices.adoc index 1041647e286..70643b2a46d 100644 --- a/_generated-doc/latest/config/quarkus-kubernetes-client_quarkus.kubernetes-client.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-kubernetes-client_quarkus.kubernetes-client.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kubernetes-client_quarkus-kubernetes-client-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -135,5 +134,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kubernetes-config.adoc b/_generated-doc/latest/config/quarkus-kubernetes-config.adoc index 021b6cbe920..80058b78d1d 100644 --- a/_generated-doc/latest/config/quarkus-kubernetes-config.adoc +++ b/_generated-doc/latest/config/quarkus-kubernetes-config.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kubernetes-config_quarkus-kubernetes-config [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -180,5 +179,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kubernetes-config_quarkus.kubernetes-config.adoc b/_generated-doc/latest/config/quarkus-kubernetes-config_quarkus.kubernetes-config.adoc index 021b6cbe920..80058b78d1d 100644 --- a/_generated-doc/latest/config/quarkus-kubernetes-config_quarkus.kubernetes-config.adoc +++ b/_generated-doc/latest/config/quarkus-kubernetes-config_quarkus.kubernetes-config.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kubernetes-config_quarkus-kubernetes-config [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -180,5 +179,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kubernetes-service-binding.adoc b/_generated-doc/latest/config/quarkus-kubernetes-service-binding.adoc index b2b6d65a3e5..e3ae13b2af4 100644 --- a/_generated-doc/latest/config/quarkus-kubernetes-service-binding.adoc +++ b/_generated-doc/latest/config/quarkus-kubernetes-service-binding.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kubernetes-service-binding_quarkus-kubernetes-service-binding [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -180,5 +179,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kubernetes-service-binding_quarkus.kubernetes-service-binding.adoc b/_generated-doc/latest/config/quarkus-kubernetes-service-binding_quarkus.kubernetes-service-binding.adoc index b2b6d65a3e5..e3ae13b2af4 100644 --- a/_generated-doc/latest/config/quarkus-kubernetes-service-binding_quarkus.kubernetes-service-binding.adoc +++ b/_generated-doc/latest/config/quarkus-kubernetes-service-binding_quarkus.kubernetes-service-binding.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kubernetes-service-binding_quarkus-kubernetes-service-binding [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -180,5 +179,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kubernetes_quarkus.knative.adoc b/_generated-doc/latest/config/quarkus-kubernetes_quarkus.knative.adoc index 94d5faa4a1b..901473efb34 100644 --- a/_generated-doc/latest/config/quarkus-kubernetes_quarkus.knative.adoc +++ b/_generated-doc/latest/config/quarkus-kubernetes_quarkus.knative.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kubernetes_quarkus-knative [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -515,7 +514,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-period[`quarkus.knative.liveness-probe.period`]## @@ -532,7 +531,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-timeout[`quarkus.knative.liveness-probe.timeout`]## @@ -549,7 +548,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-liveness-probe-success-threshold[`quarkus.knative.liveness-probe.success-threshold`]## @@ -736,7 +735,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-period[`quarkus.knative.readiness-probe.period`]## @@ -753,7 +752,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-timeout[`quarkus.knative.readiness-probe.timeout`]## @@ -770,7 +769,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-readiness-probe-success-threshold[`quarkus.knative.readiness-probe.success-threshold`]## @@ -957,7 +956,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-period[`quarkus.knative.startup-probe.period`]## @@ -974,7 +973,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-timeout[`quarkus.knative.startup-probe.timeout`]## @@ -991,7 +990,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_STARTUP_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-startup-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-startup-probe-success-threshold[`quarkus.knative.startup-probe.success-threshold`]## @@ -2130,7 +2129,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-period[`quarkus.knative.init-containers."init-containers".liveness-probe.period`]## @@ -2147,7 +2146,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-timeout[`quarkus.knative.init-containers."init-containers".liveness-probe.timeout`]## @@ -2164,7 +2163,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-liveness-probe-success-threshold[`quarkus.knative.init-containers."init-containers".liveness-probe.success-threshold`]## @@ -2351,7 +2350,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-period[`quarkus.knative.init-containers."init-containers".readiness-probe.period`]## @@ -2368,7 +2367,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-timeout[`quarkus.knative.init-containers."init-containers".readiness-probe.timeout`]## @@ -2385,7 +2384,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-init-containers-init-containers-readiness-probe-success-threshold[`quarkus.knative.init-containers."init-containers".readiness-probe.success-threshold`]## @@ -3099,7 +3098,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-period[`quarkus.knative.containers."containers".liveness-probe.period`]## @@ -3116,7 +3115,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-timeout[`quarkus.knative.containers."containers".liveness-probe.timeout`]## @@ -3133,7 +3132,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-liveness-probe-success-threshold[`quarkus.knative.containers."containers".liveness-probe.success-threshold`]## @@ -3320,7 +3319,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-period[`quarkus.knative.containers."containers".readiness-probe.period`]## @@ -3337,7 +3336,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-timeout[`quarkus.knative.containers."containers".readiness-probe.timeout`]## @@ -3354,7 +3353,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-knative[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-knative-containers-containers-readiness-probe-success-threshold[`quarkus.knative.containers."containers".readiness-probe.success-threshold`]## @@ -5248,5 +5247,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kubernetes_quarkus.kubernetes.adoc b/_generated-doc/latest/config/quarkus-kubernetes_quarkus.kubernetes.adoc index 44b8500aa67..9d57112b86c 100644 --- a/_generated-doc/latest/config/quarkus-kubernetes_quarkus.kubernetes.adoc +++ b/_generated-doc/latest/config/quarkus-kubernetes_quarkus.kubernetes.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kubernetes_quarkus-kubernetes [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -617,7 +616,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-liveness-probe-period[`quarkus.kubernetes.liveness-probe.period`]## @@ -634,7 +633,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-liveness-probe-timeout[`quarkus.kubernetes.liveness-probe.timeout`]## @@ -651,7 +650,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-liveness-probe-success-threshold[`quarkus.kubernetes.liveness-probe.success-threshold`]## @@ -838,7 +837,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-readiness-probe-period[`quarkus.kubernetes.readiness-probe.period`]## @@ -855,7 +854,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-readiness-probe-timeout[`quarkus.kubernetes.readiness-probe.timeout`]## @@ -872,7 +871,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-readiness-probe-success-threshold[`quarkus.kubernetes.readiness-probe.success-threshold`]## @@ -1059,7 +1058,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_STARTUP_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-startup-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-startup-probe-period[`quarkus.kubernetes.startup-probe.period`]## @@ -1076,7 +1075,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_STARTUP_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-startup-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-startup-probe-timeout[`quarkus.kubernetes.startup-probe.timeout`]## @@ -1093,7 +1092,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_STARTUP_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-startup-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-startup-probe-success-threshold[`quarkus.kubernetes.startup-probe.success-threshold`]## @@ -2215,7 +2214,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-liveness-probe-period[`quarkus.kubernetes.init-containers."init-containers".liveness-probe.period`]## @@ -2232,7 +2231,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-liveness-probe-timeout[`quarkus.kubernetes.init-containers."init-containers".liveness-probe.timeout`]## @@ -2249,7 +2248,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-liveness-probe-success-threshold[`quarkus.kubernetes.init-containers."init-containers".liveness-probe.success-threshold`]## @@ -2436,7 +2435,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-readiness-probe-period[`quarkus.kubernetes.init-containers."init-containers".readiness-probe.period`]## @@ -2453,7 +2452,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-readiness-probe-timeout[`quarkus.kubernetes.init-containers."init-containers".readiness-probe.timeout`]## @@ -2470,7 +2469,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-containers-init-containers-readiness-probe-success-threshold[`quarkus.kubernetes.init-containers."init-containers".readiness-probe.success-threshold`]## @@ -3184,7 +3183,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-liveness-probe-period[`quarkus.kubernetes.sidecars."sidecars".liveness-probe.period`]## @@ -3201,7 +3200,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-liveness-probe-timeout[`quarkus.kubernetes.sidecars."sidecars".liveness-probe.timeout`]## @@ -3218,7 +3217,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-liveness-probe-success-threshold[`quarkus.kubernetes.sidecars."sidecars".liveness-probe.success-threshold`]## @@ -3405,7 +3404,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-readiness-probe-period[`quarkus.kubernetes.sidecars."sidecars".readiness-probe.period`]## @@ -3422,7 +3421,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-readiness-probe-timeout[`quarkus.kubernetes.sidecars."sidecars".readiness-probe.timeout`]## @@ -3439,7 +3438,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-kubernetes[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-sidecars-sidecars-readiness-probe-success-threshold[`quarkus.kubernetes.sidecars."sidecars".readiness-probe.success-threshold`]## @@ -5792,5 +5791,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-kubernetes_quarkus.openshift.adoc b/_generated-doc/latest/config/quarkus-kubernetes_quarkus.openshift.adoc index a438aae0b02..73054b089fe 100644 --- a/_generated-doc/latest/config/quarkus-kubernetes_quarkus.openshift.adoc +++ b/_generated-doc/latest/config/quarkus-kubernetes_quarkus.openshift.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-kubernetes_quarkus-openshift [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -583,7 +582,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-period[`quarkus.openshift.liveness-probe.period`]## @@ -600,7 +599,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-timeout[`quarkus.openshift.liveness-probe.timeout`]## @@ -617,7 +616,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-liveness-probe-success-threshold[`quarkus.openshift.liveness-probe.success-threshold`]## @@ -804,7 +803,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-period[`quarkus.openshift.readiness-probe.period`]## @@ -821,7 +820,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-timeout[`quarkus.openshift.readiness-probe.timeout`]## @@ -838,7 +837,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-readiness-probe-success-threshold[`quarkus.openshift.readiness-probe.success-threshold`]## @@ -1025,7 +1024,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-period[`quarkus.openshift.startup-probe.period`]## @@ -1042,7 +1041,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-timeout[`quarkus.openshift.startup-probe.timeout`]## @@ -1059,7 +1058,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_STARTUP_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-startup-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-startup-probe-success-threshold[`quarkus.openshift.startup-probe.success-threshold`]## @@ -2181,7 +2180,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-period[`quarkus.openshift.init-containers."init-containers".liveness-probe.period`]## @@ -2198,7 +2197,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-timeout[`quarkus.openshift.init-containers."init-containers".liveness-probe.timeout`]## @@ -2215,7 +2214,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-liveness-probe-success-threshold[`quarkus.openshift.init-containers."init-containers".liveness-probe.success-threshold`]## @@ -2402,7 +2401,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-period[`quarkus.openshift.init-containers."init-containers".readiness-probe.period`]## @@ -2419,7 +2418,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-timeout[`quarkus.openshift.init-containers."init-containers".readiness-probe.timeout`]## @@ -2436,7 +2435,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-init-containers-init-containers-readiness-probe-success-threshold[`quarkus.openshift.init-containers."init-containers".readiness-probe.success-threshold`]## @@ -3150,7 +3149,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-period[`quarkus.openshift.sidecars."sidecars".liveness-probe.period`]## @@ -3167,7 +3166,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-timeout[`quarkus.openshift.sidecars."sidecars".liveness-probe.timeout`]## @@ -3184,7 +3183,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-liveness-probe-success-threshold[`quarkus.openshift.sidecars."sidecars".liveness-probe.success-threshold`]## @@ -3371,7 +3370,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-period]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-period[`quarkus.openshift.sidecars."sidecars".readiness-probe.period`]## @@ -3388,7 +3387,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-timeout]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-timeout[`quarkus.openshift.sidecars."sidecars".readiness-probe.timeout`]## @@ -3405,7 +3404,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-kubernetes_quarkus-openshift[icon:question-circle[title=More information about the Duration format]] |`10S` a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-success-threshold]] [.property-path]##link:#quarkus-kubernetes_quarkus-openshift-sidecars-sidecars-readiness-probe-success-threshold[`quarkus.openshift.sidecars."sidecars".readiness-probe.success-threshold`]## @@ -5690,5 +5689,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-liquibase-mongodb.adoc b/_generated-doc/latest/config/quarkus-liquibase-mongodb.adoc index e29e1cd54c4..82f56edfa37 100644 --- a/_generated-doc/latest/config/quarkus-liquibase-mongodb.adoc +++ b/_generated-doc/latest/config/quarkus-liquibase-mongodb.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-liquibase-mongodb_quarkus-liquibase-mongodb [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -248,5 +247,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-liquibase-mongodb_quarkus.liquibase-mongodb.adoc b/_generated-doc/latest/config/quarkus-liquibase-mongodb_quarkus.liquibase-mongodb.adoc index e29e1cd54c4..82f56edfa37 100644 --- a/_generated-doc/latest/config/quarkus-liquibase-mongodb_quarkus.liquibase-mongodb.adoc +++ b/_generated-doc/latest/config/quarkus-liquibase-mongodb_quarkus.liquibase-mongodb.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-liquibase-mongodb_quarkus-liquibase-mongodb [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -248,5 +247,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-liquibase.adoc b/_generated-doc/latest/config/quarkus-liquibase.adoc index ac5bd4d611b..bde2d9cede1 100644 --- a/_generated-doc/latest/config/quarkus-liquibase.adoc +++ b/_generated-doc/latest/config/quarkus-liquibase.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-liquibase_quarkus-liquibase [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -644,5 +643,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-liquibase_quarkus.liquibase.adoc b/_generated-doc/latest/config/quarkus-liquibase_quarkus.liquibase.adoc index ac5bd4d611b..bde2d9cede1 100644 --- a/_generated-doc/latest/config/quarkus-liquibase_quarkus.liquibase.adoc +++ b/_generated-doc/latest/config/quarkus-liquibase_quarkus.liquibase.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-liquibase_quarkus-liquibase [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -644,5 +643,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-load-shedding.adoc b/_generated-doc/latest/config/quarkus-load-shedding.adoc index bd939dfcfcd..c4b757b7fca 100644 --- a/_generated-doc/latest/config/quarkus-load-shedding.adoc +++ b/_generated-doc/latest/config/quarkus-load-shedding.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-load-shedding_quarkus-load-shedding [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -129,5 +128,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-load-shedding_quarkus.load-shedding.adoc b/_generated-doc/latest/config/quarkus-load-shedding_quarkus.load-shedding.adoc index bd939dfcfcd..c4b757b7fca 100644 --- a/_generated-doc/latest/config/quarkus-load-shedding_quarkus.load-shedding.adoc +++ b/_generated-doc/latest/config/quarkus-load-shedding_quarkus.load-shedding.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-load-shedding_quarkus-load-shedding [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -129,5 +128,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-logging-gelf.adoc b/_generated-doc/latest/config/quarkus-logging-gelf.adoc index b83c4d568bf..05a195ded40 100644 --- a/_generated-doc/latest/config/quarkus-logging-gelf.adoc +++ b/_generated-doc/latest/config/quarkus-logging-gelf.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-logging-gelf_quarkus-log [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -372,5 +371,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-logging-gelf_quarkus.log.adoc b/_generated-doc/latest/config/quarkus-logging-gelf_quarkus.log.adoc index b83c4d568bf..05a195ded40 100644 --- a/_generated-doc/latest/config/quarkus-logging-gelf_quarkus.log.adoc +++ b/_generated-doc/latest/config/quarkus-logging-gelf_quarkus.log.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-logging-gelf_quarkus-log [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -372,5 +371,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-logging-json.adoc b/_generated-doc/latest/config/quarkus-logging-json.adoc index 8d5b754fc5b..9fb5e476408 100644 --- a/_generated-doc/latest/config/quarkus-logging-json.adoc +++ b/_generated-doc/latest/config/quarkus-logging-json.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-logging-json_quarkus-log [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -592,5 +591,3 @@ a|`string`, `int`, `long` |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-logging-json_quarkus.log.adoc b/_generated-doc/latest/config/quarkus-logging-json_quarkus.log.adoc index 8d5b754fc5b..9fb5e476408 100644 --- a/_generated-doc/latest/config/quarkus-logging-json_quarkus.log.adoc +++ b/_generated-doc/latest/config/quarkus-logging-json_quarkus.log.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-logging-json_quarkus-log [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -592,5 +591,3 @@ a|`string`, `int`, `long` |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-mailer.adoc b/_generated-doc/latest/config/quarkus-mailer.adoc index c2d33739632..04841fdadcf 100644 --- a/_generated-doc/latest/config/quarkus-mailer.adoc +++ b/_generated-doc/latest/config/quarkus-mailer.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-mailer_quarkus-mailer [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -587,7 +586,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MAILER_POOL_CLEANER_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mailer_quarkus-mailer[icon:question-circle[title=More information about the Duration format]] |`PT1S` a| [[quarkus-mailer_quarkus-mailer-keep-alive-timeout]] [.property-path]##link:#quarkus-mailer_quarkus-mailer-keep-alive-timeout[`quarkus.mailer.keep-alive-timeout`]## @@ -604,7 +603,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MAILER_KEEP_ALIVE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mailer_quarkus-mailer[icon:question-circle[title=More information about the Duration format]] |`PT300S` a| [[quarkus-mailer_quarkus-mailer-ntlm-workstation]] [.property-path]##link:#quarkus-mailer_quarkus-mailer-ntlm-workstation[`quarkus.mailer.ntlm.workstation`]## @@ -1245,7 +1244,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__POOL_CLEANER_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mailer_quarkus-mailer[icon:question-circle[title=More information about the Duration format]] |`PT1S` a| [[quarkus-mailer_quarkus-mailer-mailer-name-keep-alive-timeout]] [.property-path]##link:#quarkus-mailer_quarkus-mailer-mailer-name-keep-alive-timeout[`quarkus.mailer."mailer-name".keep-alive-timeout`]## @@ -1262,7 +1261,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__KEEP_ALIVE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mailer_quarkus-mailer[icon:question-circle[title=More information about the Duration format]] |`PT300S` a| [[quarkus-mailer_quarkus-mailer-mailer-name-ntlm-workstation]] [.property-path]##link:#quarkus-mailer_quarkus-mailer-mailer-name-ntlm-workstation[`quarkus.mailer."mailer-name".ntlm.workstation`]## @@ -1359,5 +1358,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-mailer_quarkus.mailer.adoc b/_generated-doc/latest/config/quarkus-mailer_quarkus.mailer.adoc index c2d33739632..04841fdadcf 100644 --- a/_generated-doc/latest/config/quarkus-mailer_quarkus.mailer.adoc +++ b/_generated-doc/latest/config/quarkus-mailer_quarkus.mailer.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-mailer_quarkus-mailer [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -587,7 +586,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MAILER_POOL_CLEANER_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mailer_quarkus-mailer[icon:question-circle[title=More information about the Duration format]] |`PT1S` a| [[quarkus-mailer_quarkus-mailer-keep-alive-timeout]] [.property-path]##link:#quarkus-mailer_quarkus-mailer-keep-alive-timeout[`quarkus.mailer.keep-alive-timeout`]## @@ -604,7 +603,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MAILER_KEEP_ALIVE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mailer_quarkus-mailer[icon:question-circle[title=More information about the Duration format]] |`PT300S` a| [[quarkus-mailer_quarkus-mailer-ntlm-workstation]] [.property-path]##link:#quarkus-mailer_quarkus-mailer-ntlm-workstation[`quarkus.mailer.ntlm.workstation`]## @@ -1245,7 +1244,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__POOL_CLEANER_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mailer_quarkus-mailer[icon:question-circle[title=More information about the Duration format]] |`PT1S` a| [[quarkus-mailer_quarkus-mailer-mailer-name-keep-alive-timeout]] [.property-path]##link:#quarkus-mailer_quarkus-mailer-mailer-name-keep-alive-timeout[`quarkus.mailer."mailer-name".keep-alive-timeout`]## @@ -1262,7 +1261,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MAILER__MAILER_NAME__KEEP_ALIVE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mailer_quarkus-mailer[icon:question-circle[title=More information about the Duration format]] |`PT300S` a| [[quarkus-mailer_quarkus-mailer-mailer-name-ntlm-workstation]] [.property-path]##link:#quarkus-mailer_quarkus-mailer-mailer-name-ntlm-workstation[`quarkus.mailer."mailer-name".ntlm.workstation`]## @@ -1359,5 +1358,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging-amqp.adoc b/_generated-doc/latest/config/quarkus-messaging-amqp.adoc index 410f586aa93..a28bb670215 100644 --- a/_generated-doc/latest/config/quarkus-messaging-amqp.adoc +++ b/_generated-doc/latest/config/quarkus-messaging-amqp.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging-amqp_quarkus-amqp [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -144,5 +143,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging-amqp_quarkus.amqp.adoc b/_generated-doc/latest/config/quarkus-messaging-amqp_quarkus.amqp.adoc index 410f586aa93..a28bb670215 100644 --- a/_generated-doc/latest/config/quarkus-messaging-amqp_quarkus.amqp.adoc +++ b/_generated-doc/latest/config/quarkus-messaging-amqp_quarkus.amqp.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging-amqp_quarkus-amqp [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -144,5 +143,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging-amqp_quarkus.amqp.devservices.adoc b/_generated-doc/latest/config/quarkus-messaging-amqp_quarkus.amqp.devservices.adoc index 96d1dfa9b39..491981fb0b1 100644 --- a/_generated-doc/latest/config/quarkus-messaging-amqp_quarkus.amqp.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-messaging-amqp_quarkus.amqp.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging-amqp_quarkus-amqp-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -139,5 +138,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging-kafka.adoc b/_generated-doc/latest/config/quarkus-messaging-kafka.adoc index 80dab1c490e..633f5b223a8 100644 --- a/_generated-doc/latest/config/quarkus-messaging-kafka.adoc +++ b/_generated-doc/latest/config/quarkus-messaging-kafka.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging-kafka_quarkus-messaging [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -61,5 +60,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging-kafka_quarkus.messaging.adoc b/_generated-doc/latest/config/quarkus-messaging-kafka_quarkus.messaging.adoc index 80dab1c490e..633f5b223a8 100644 --- a/_generated-doc/latest/config/quarkus-messaging-kafka_quarkus.messaging.adoc +++ b/_generated-doc/latest/config/quarkus-messaging-kafka_quarkus.messaging.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging-kafka_quarkus-messaging [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -61,5 +60,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging-mqtt.adoc b/_generated-doc/latest/config/quarkus-messaging-mqtt.adoc index 44a995ce015..4eff24e2211 100644 --- a/_generated-doc/latest/config/quarkus-messaging-mqtt.adoc +++ b/_generated-doc/latest/config/quarkus-messaging-mqtt.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging-mqtt_quarkus-mqtt [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -120,5 +119,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging-mqtt_quarkus.mqtt.adoc b/_generated-doc/latest/config/quarkus-messaging-mqtt_quarkus.mqtt.adoc index 44a995ce015..4eff24e2211 100644 --- a/_generated-doc/latest/config/quarkus-messaging-mqtt_quarkus.mqtt.adoc +++ b/_generated-doc/latest/config/quarkus-messaging-mqtt_quarkus.mqtt.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging-mqtt_quarkus-mqtt [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -120,5 +119,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging-pulsar_quarkus.messaging.adoc b/_generated-doc/latest/config/quarkus-messaging-pulsar_quarkus.messaging.adoc index e2cbf04f94c..1358bba1132 100644 --- a/_generated-doc/latest/config/quarkus-messaging-pulsar_quarkus.messaging.adoc +++ b/_generated-doc/latest/config/quarkus-messaging-pulsar_quarkus.messaging.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging-pulsar_quarkus-messaging [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging-pulsar_quarkus.pulsar.adoc b/_generated-doc/latest/config/quarkus-messaging-pulsar_quarkus.pulsar.adoc index 2cc490c1249..3bd88fe934a 100644 --- a/_generated-doc/latest/config/quarkus-messaging-pulsar_quarkus.pulsar.adoc +++ b/_generated-doc/latest/config/quarkus-messaging-pulsar_quarkus.pulsar.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging-pulsar_quarkus-pulsar [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -125,5 +124,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging-pulsar_quarkus.pulsar.devservices.adoc b/_generated-doc/latest/config/quarkus-messaging-pulsar_quarkus.pulsar.devservices.adoc index 7134398c2b8..203ca7a0cb0 100644 --- a/_generated-doc/latest/config/quarkus-messaging-pulsar_quarkus.pulsar.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-messaging-pulsar_quarkus.pulsar.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging-pulsar_quarkus-pulsar-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -120,5 +119,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging-rabbitmq.adoc b/_generated-doc/latest/config/quarkus-messaging-rabbitmq.adoc index aa0c94cc83d..a1e9d8d75f9 100644 --- a/_generated-doc/latest/config/quarkus-messaging-rabbitmq.adoc +++ b/_generated-doc/latest/config/quarkus-messaging-rabbitmq.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging-rabbitmq_quarkus-rabbitmq [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -175,6 +174,23 @@ endif::add-copy-button-to-env-var[] |boolean |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-exchanges-exchange-name-vhost]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-exchanges-exchange-name-vhost[`quarkus.rabbitmq.devservices.exchanges."exchange-name".vhost`]## + +[.description] +-- +What virtual host should the exchange be associated with? + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_EXCHANGES__EXCHANGE_NAME__VHOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_EXCHANGES__EXCHANGE_NAME__VHOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-exchanges-exchange-name-arguments-argument-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-exchanges-exchange-name-arguments-argument-name[`quarkus.rabbitmq.devservices.exchanges."exchange-name".arguments."argument-name"`]## [.description] @@ -226,6 +242,23 @@ endif::add-copy-button-to-env-var[] |boolean |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-queues-queue-name-vhost]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-queues-queue-name-vhost[`quarkus.rabbitmq.devservices.queues."queue-name".vhost`]## + +[.description] +-- +What virtual host should the queue be associated with? + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_QUEUES__QUEUE_NAME__VHOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_QUEUES__QUEUE_NAME__VHOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-queues-queue-name-arguments-argument-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-queues-queue-name-arguments-argument-name[`quarkus.rabbitmq.devservices.queues."queue-name".arguments."argument-name"`]## [.description] @@ -311,6 +344,23 @@ endif::add-copy-button-to-env-var[] |string |`queue` +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-bindings-binding-name-vhost]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-bindings-binding-name-vhost[`quarkus.rabbitmq.devservices.bindings."binding-name".vhost`]## + +[.description] +-- +What virtual host should the binding be associated with? + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_BINDINGS__BINDING_NAME__VHOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_BINDINGS__BINDING_NAME__VHOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-bindings-binding-name-arguments-argument-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-bindings-binding-name-arguments-argument-name[`quarkus.rabbitmq.devservices.bindings."binding-name".arguments."argument-name"`]## [.description] @@ -328,6 +378,23 @@ endif::add-copy-button-to-env-var[] |Map | +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-vhosts]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-vhosts[`quarkus.rabbitmq.devservices.vhosts`]## + +[.description] +-- +Virtual hosts that should be predefined after starting the RabbitMQ broker. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_VHOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_VHOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-container-env-environment-variable-name[`quarkus.rabbitmq.devservices.container-env."environment-variable-name"`]## [.description] @@ -386,5 +453,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging-rabbitmq_quarkus.rabbitmq.adoc b/_generated-doc/latest/config/quarkus-messaging-rabbitmq_quarkus.rabbitmq.adoc index aa0c94cc83d..a1e9d8d75f9 100644 --- a/_generated-doc/latest/config/quarkus-messaging-rabbitmq_quarkus.rabbitmq.adoc +++ b/_generated-doc/latest/config/quarkus-messaging-rabbitmq_quarkus.rabbitmq.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging-rabbitmq_quarkus-rabbitmq [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -175,6 +174,23 @@ endif::add-copy-button-to-env-var[] |boolean |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-exchanges-exchange-name-vhost]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-exchanges-exchange-name-vhost[`quarkus.rabbitmq.devservices.exchanges."exchange-name".vhost`]## + +[.description] +-- +What virtual host should the exchange be associated with? + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_EXCHANGES__EXCHANGE_NAME__VHOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_EXCHANGES__EXCHANGE_NAME__VHOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-exchanges-exchange-name-arguments-argument-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-exchanges-exchange-name-arguments-argument-name[`quarkus.rabbitmq.devservices.exchanges."exchange-name".arguments."argument-name"`]## [.description] @@ -226,6 +242,23 @@ endif::add-copy-button-to-env-var[] |boolean |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-queues-queue-name-vhost]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-queues-queue-name-vhost[`quarkus.rabbitmq.devservices.queues."queue-name".vhost`]## + +[.description] +-- +What virtual host should the queue be associated with? + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_QUEUES__QUEUE_NAME__VHOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_QUEUES__QUEUE_NAME__VHOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-queues-queue-name-arguments-argument-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-queues-queue-name-arguments-argument-name[`quarkus.rabbitmq.devservices.queues."queue-name".arguments."argument-name"`]## [.description] @@ -311,6 +344,23 @@ endif::add-copy-button-to-env-var[] |string |`queue` +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-bindings-binding-name-vhost]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-bindings-binding-name-vhost[`quarkus.rabbitmq.devservices.bindings."binding-name".vhost`]## + +[.description] +-- +What virtual host should the binding be associated with? + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_BINDINGS__BINDING_NAME__VHOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_BINDINGS__BINDING_NAME__VHOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-bindings-binding-name-arguments-argument-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-bindings-binding-name-arguments-argument-name[`quarkus.rabbitmq.devservices.bindings."binding-name".arguments."argument-name"`]## [.description] @@ -328,6 +378,23 @@ endif::add-copy-button-to-env-var[] |Map | +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-vhosts]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-vhosts[`quarkus.rabbitmq.devservices.vhosts`]## + +[.description] +-- +Virtual hosts that should be predefined after starting the RabbitMQ broker. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_VHOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_VHOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices-container-env-environment-variable-name[`quarkus.rabbitmq.devservices.container-env."environment-variable-name"`]## [.description] @@ -386,5 +453,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging-rabbitmq_quarkus.rabbitmq.devservices.adoc b/_generated-doc/latest/config/quarkus-messaging-rabbitmq_quarkus.rabbitmq.devservices.adoc index 4905c76360c..c5feceb5ceb 100644 --- a/_generated-doc/latest/config/quarkus-messaging-rabbitmq_quarkus.rabbitmq.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-messaging-rabbitmq_quarkus.rabbitmq.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -171,6 +170,23 @@ endif::add-copy-button-to-env-var[] |boolean |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-exchanges-exchange-name-vhost]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-exchanges-exchange-name-vhost[`quarkus.rabbitmq.devservices.exchanges."exchange-name".vhost`]## + +[.description] +-- +What virtual host should the exchange be associated with? + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_EXCHANGES__EXCHANGE_NAME__VHOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_EXCHANGES__EXCHANGE_NAME__VHOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-exchanges-exchange-name-arguments-argument-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-exchanges-exchange-name-arguments-argument-name[`quarkus.rabbitmq.devservices.exchanges."exchange-name".arguments."argument-name"`]## [.description] @@ -222,6 +238,23 @@ endif::add-copy-button-to-env-var[] |boolean |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-queues-queue-name-vhost]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-queues-queue-name-vhost[`quarkus.rabbitmq.devservices.queues."queue-name".vhost`]## + +[.description] +-- +What virtual host should the queue be associated with? + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_QUEUES__QUEUE_NAME__VHOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_QUEUES__QUEUE_NAME__VHOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-queues-queue-name-arguments-argument-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-queues-queue-name-arguments-argument-name[`quarkus.rabbitmq.devservices.queues."queue-name".arguments."argument-name"`]## [.description] @@ -307,6 +340,23 @@ endif::add-copy-button-to-env-var[] |string |`queue` +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-bindings-binding-name-vhost]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-bindings-binding-name-vhost[`quarkus.rabbitmq.devservices.bindings."binding-name".vhost`]## + +[.description] +-- +What virtual host should the binding be associated with? + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_BINDINGS__BINDING_NAME__VHOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_BINDINGS__BINDING_NAME__VHOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-bindings-binding-name-arguments-argument-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-bindings-binding-name-arguments-argument-name[`quarkus.rabbitmq.devservices.bindings."binding-name".arguments."argument-name"`]## [.description] @@ -324,6 +374,23 @@ endif::add-copy-button-to-env-var[] |Map | +a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-vhosts]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-vhosts[`quarkus.rabbitmq.devservices.vhosts`]## + +[.description] +-- +Virtual hosts that should be predefined after starting the RabbitMQ broker. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_RABBITMQ_DEVSERVICES_VHOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_RABBITMQ_DEVSERVICES_VHOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + a|icon:lock[title=Fixed at build time] [[quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-container-env-environment-variable-name]] [.property-path]##link:#quarkus-messaging-rabbitmq_quarkus-rabbitmq-devservices_quarkus-rabbitmq-devservices-container-env-environment-variable-name[`quarkus.rabbitmq.devservices.container-env."environment-variable-name"`]## [.description] @@ -343,5 +410,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging.adoc b/_generated-doc/latest/config/quarkus-messaging.adoc index 527f545fc24..fb4c8404a78 100644 --- a/_generated-doc/latest/config/quarkus-messaging.adoc +++ b/_generated-doc/latest/config/quarkus-messaging.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging_quarkus-messaging [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -168,5 +167,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-messaging_quarkus.messaging.adoc b/_generated-doc/latest/config/quarkus-messaging_quarkus.messaging.adoc index 527f545fc24..fb4c8404a78 100644 --- a/_generated-doc/latest/config/quarkus-messaging_quarkus.messaging.adoc +++ b/_generated-doc/latest/config/quarkus-messaging_quarkus.messaging.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-messaging_quarkus-messaging [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -168,5 +167,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-micrometer.adoc b/_generated-doc/latest/config/quarkus-micrometer.adoc index 7314caf5f29..30d8a1d11b4 100644 --- a/_generated-doc/latest/config/quarkus-micrometer.adoc +++ b/_generated-doc/latest/config/quarkus-micrometer.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-micrometer_quarkus-micrometer [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -390,7 +389,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MICROMETER_EXPORT_JSON_EXPIRY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-micrometer_quarkus-micrometer[icon:question-circle[title=More information about the Duration format]] |`P3D` a|icon:lock[title=Fixed at build time] [[quarkus-micrometer_quarkus-micrometer-export-prometheus-enabled]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-export-prometheus-enabled[`quarkus.micrometer.export.prometheus.enabled`]## @@ -650,5 +649,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-micrometer_quarkus.micrometer.adoc b/_generated-doc/latest/config/quarkus-micrometer_quarkus.micrometer.adoc index 7314caf5f29..30d8a1d11b4 100644 --- a/_generated-doc/latest/config/quarkus-micrometer_quarkus.micrometer.adoc +++ b/_generated-doc/latest/config/quarkus-micrometer_quarkus.micrometer.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-micrometer_quarkus-micrometer [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -390,7 +389,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MICROMETER_EXPORT_JSON_EXPIRY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-micrometer_quarkus-micrometer[icon:question-circle[title=More information about the Duration format]] |`P3D` a|icon:lock[title=Fixed at build time] [[quarkus-micrometer_quarkus-micrometer-export-prometheus-enabled]] [.property-path]##link:#quarkus-micrometer_quarkus-micrometer-export-prometheus-enabled[`quarkus.micrometer.export.prometheus.enabled`]## @@ -650,5 +649,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-mongodb-client.adoc b/_generated-doc/latest/config/quarkus-mongodb-client.adoc index 8b23f72c99c..b01ef9da25e 100644 --- a/_generated-doc/latest/config/quarkus-mongodb-client.adoc +++ b/_generated-doc/latest/config/quarkus-mongodb-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-mongodb-client_quarkus-mongodb [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -218,7 +217,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_MAX_CONNECTION_IDLE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-max-connection-life-time]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-max-connection-life-time[`quarkus.mongodb.max-connection-life-time`]## @@ -235,7 +234,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_MAX_CONNECTION_LIFE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-maintenance-frequency]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-maintenance-frequency[`quarkus.mongodb.maintenance-frequency`]## @@ -252,7 +251,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_MAINTENANCE_FREQUENCY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-maintenance-initial-delay]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-maintenance-initial-delay[`quarkus.mongodb.maintenance-initial-delay`]## @@ -269,7 +268,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_MAINTENANCE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-connect-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-connect-timeout[`quarkus.mongodb.connect-timeout`]## @@ -286,7 +285,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-read-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-read-timeout[`quarkus.mongodb.read-timeout`]## @@ -303,7 +302,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-tls-insecure]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-tls-insecure[`quarkus.mongodb.tls-insecure`]## @@ -371,7 +370,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_SERVER_SELECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-local-threshold]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-local-threshold[`quarkus.mongodb.local-threshold`]## @@ -388,7 +387,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_LOCAL_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-heartbeat-frequency]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-heartbeat-frequency[`quarkus.mongodb.heartbeat-frequency`]## @@ -405,7 +404,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_HEARTBEAT_FREQUENCY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-read-concern]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-read-concern[`quarkus.mongodb.read-concern`]## @@ -524,7 +523,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_DNS_LOOKUP_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-mongodb-client_quarkus-mongodb-dns-log-activity]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-dns-log-activity[`quarkus.mongodb.dns.log-activity`]## @@ -686,7 +685,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAX_CONNECTION_IDLE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-max-connection-life-time]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-max-connection-life-time[`quarkus.mongodb."mongo-client-configs".max-connection-life-time`]## @@ -703,7 +702,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAX_CONNECTION_LIFE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-maintenance-frequency]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-maintenance-frequency[`quarkus.mongodb."mongo-client-configs".maintenance-frequency`]## @@ -720,7 +719,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAINTENANCE_FREQUENCY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-maintenance-initial-delay]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-maintenance-initial-delay[`quarkus.mongodb."mongo-client-configs".maintenance-initial-delay`]## @@ -737,7 +736,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAINTENANCE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-connect-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-connect-timeout[`quarkus.mongodb."mongo-client-configs".connect-timeout`]## @@ -754,7 +753,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-read-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-read-timeout[`quarkus.mongodb."mongo-client-configs".read-timeout`]## @@ -771,7 +770,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-tls-insecure]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-tls-insecure[`quarkus.mongodb."mongo-client-configs".tls-insecure`]## @@ -839,7 +838,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__SERVER_SELECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-local-threshold]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-local-threshold[`quarkus.mongodb."mongo-client-configs".local-threshold`]## @@ -856,7 +855,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__LOCAL_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-heartbeat-frequency]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-heartbeat-frequency[`quarkus.mongodb."mongo-client-configs".heartbeat-frequency`]## @@ -873,7 +872,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__HEARTBEAT_FREQUENCY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-read-concern]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-read-concern[`quarkus.mongodb."mongo-client-configs".read-concern`]## @@ -1163,7 +1162,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_WRITE_CONCERN_W_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | @@ -1382,7 +1381,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__WRITE_CONCERN_W_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | @@ -1535,5 +1534,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-mongodb-client_quarkus.mongodb.adoc b/_generated-doc/latest/config/quarkus-mongodb-client_quarkus.mongodb.adoc index 8b23f72c99c..b01ef9da25e 100644 --- a/_generated-doc/latest/config/quarkus-mongodb-client_quarkus.mongodb.adoc +++ b/_generated-doc/latest/config/quarkus-mongodb-client_quarkus.mongodb.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-mongodb-client_quarkus-mongodb [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -218,7 +217,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_MAX_CONNECTION_IDLE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-max-connection-life-time]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-max-connection-life-time[`quarkus.mongodb.max-connection-life-time`]## @@ -235,7 +234,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_MAX_CONNECTION_LIFE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-maintenance-frequency]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-maintenance-frequency[`quarkus.mongodb.maintenance-frequency`]## @@ -252,7 +251,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_MAINTENANCE_FREQUENCY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-maintenance-initial-delay]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-maintenance-initial-delay[`quarkus.mongodb.maintenance-initial-delay`]## @@ -269,7 +268,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_MAINTENANCE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-connect-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-connect-timeout[`quarkus.mongodb.connect-timeout`]## @@ -286,7 +285,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-read-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-read-timeout[`quarkus.mongodb.read-timeout`]## @@ -303,7 +302,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-tls-insecure]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-tls-insecure[`quarkus.mongodb.tls-insecure`]## @@ -371,7 +370,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_SERVER_SELECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-local-threshold]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-local-threshold[`quarkus.mongodb.local-threshold`]## @@ -388,7 +387,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_LOCAL_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-heartbeat-frequency]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-heartbeat-frequency[`quarkus.mongodb.heartbeat-frequency`]## @@ -405,7 +404,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_HEARTBEAT_FREQUENCY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-read-concern]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-read-concern[`quarkus.mongodb.read-concern`]## @@ -524,7 +523,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_DNS_LOOKUP_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-mongodb-client_quarkus-mongodb-dns-log-activity]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-dns-log-activity[`quarkus.mongodb.dns.log-activity`]## @@ -686,7 +685,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAX_CONNECTION_IDLE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-max-connection-life-time]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-max-connection-life-time[`quarkus.mongodb."mongo-client-configs".max-connection-life-time`]## @@ -703,7 +702,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAX_CONNECTION_LIFE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-maintenance-frequency]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-maintenance-frequency[`quarkus.mongodb."mongo-client-configs".maintenance-frequency`]## @@ -720,7 +719,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAINTENANCE_FREQUENCY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-maintenance-initial-delay]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-maintenance-initial-delay[`quarkus.mongodb."mongo-client-configs".maintenance-initial-delay`]## @@ -737,7 +736,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAINTENANCE_INITIAL_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-connect-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-connect-timeout[`quarkus.mongodb."mongo-client-configs".connect-timeout`]## @@ -754,7 +753,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-read-timeout]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-read-timeout[`quarkus.mongodb."mongo-client-configs".read-timeout`]## @@ -771,7 +770,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-tls-insecure]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-tls-insecure[`quarkus.mongodb."mongo-client-configs".tls-insecure`]## @@ -839,7 +838,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__SERVER_SELECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-local-threshold]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-local-threshold[`quarkus.mongodb."mongo-client-configs".local-threshold`]## @@ -856,7 +855,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__LOCAL_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-heartbeat-frequency]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-heartbeat-frequency[`quarkus.mongodb."mongo-client-configs".heartbeat-frequency`]## @@ -873,7 +872,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__HEARTBEAT_FREQUENCY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-read-concern]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-read-concern[`quarkus.mongodb."mongo-client-configs".read-concern`]## @@ -1163,7 +1162,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB_WRITE_CONCERN_W_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | @@ -1382,7 +1381,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__WRITE_CONCERN_W_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-mongodb-client_quarkus-mongodb[icon:question-circle[title=More information about the Duration format]] | @@ -1535,5 +1534,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-mongodb-client_quarkus.mongodb.devservices.adoc b/_generated-doc/latest/config/quarkus-mongodb-client_quarkus.mongodb.devservices.adoc index 4e82e7f61f1..4f2e4b37290 100644 --- a/_generated-doc/latest/config/quarkus-mongodb-client_quarkus.mongodb.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-mongodb-client_quarkus.mongodb.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-mongodb-client_quarkus-mongodb-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -137,5 +136,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-narayana-jta.adoc b/_generated-doc/latest/config/quarkus-narayana-jta.adoc index 4b601bf7809..61af7e8e2f6 100644 --- a/_generated-doc/latest/config/quarkus-narayana-jta.adoc +++ b/_generated-doc/latest/config/quarkus-narayana-jta.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-narayana-jta_quarkus-transaction-manager [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -56,7 +55,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TRANSACTION_MANAGER_DEFAULT_TRANSACTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-narayana-jta_quarkus-transaction-manager[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-narayana-jta_quarkus-transaction-manager-enable-recovery]] [.property-path]##link:#quarkus-narayana-jta_quarkus-transaction-manager-enable-recovery[`quarkus.transaction-manager.enable-recovery`]## @@ -238,5 +237,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-narayana-jta_quarkus.transaction-manager.adoc b/_generated-doc/latest/config/quarkus-narayana-jta_quarkus.transaction-manager.adoc index 4b601bf7809..61af7e8e2f6 100644 --- a/_generated-doc/latest/config/quarkus-narayana-jta_quarkus.transaction-manager.adoc +++ b/_generated-doc/latest/config/quarkus-narayana-jta_quarkus.transaction-manager.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-narayana-jta_quarkus-transaction-manager [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -56,7 +55,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TRANSACTION_MANAGER_DEFAULT_TRANSACTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-narayana-jta_quarkus-transaction-manager[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-narayana-jta_quarkus-transaction-manager-enable-recovery]] [.property-path]##link:#quarkus-narayana-jta_quarkus-transaction-manager-enable-recovery[`quarkus.transaction-manager.enable-recovery`]## @@ -238,5 +237,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-narayana-lra.adoc b/_generated-doc/latest/config/quarkus-narayana-lra.adoc index 13a48e6ec3a..fa551e33421 100644 --- a/_generated-doc/latest/config/quarkus-narayana-lra.adoc +++ b/_generated-doc/latest/config/quarkus-narayana-lra.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-narayana-lra_quarkus-lra [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-narayana-lra_quarkus.lra.adoc b/_generated-doc/latest/config/quarkus-narayana-lra_quarkus.lra.adoc index 13a48e6ec3a..fa551e33421 100644 --- a/_generated-doc/latest/config/quarkus-narayana-lra_quarkus.lra.adoc +++ b/_generated-doc/latest/config/quarkus-narayana-lra_quarkus.lra.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-narayana-lra_quarkus-lra [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-netty.adoc b/_generated-doc/latest/config/quarkus-netty.adoc index 60fdc5e46bb..8db9fdbd119 100644 --- a/_generated-doc/latest/config/quarkus-netty.adoc +++ b/_generated-doc/latest/config/quarkus-netty.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-netty_quarkus-netty [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-netty_quarkus.netty.adoc b/_generated-doc/latest/config/quarkus-netty_quarkus.netty.adoc index 60fdc5e46bb..8db9fdbd119 100644 --- a/_generated-doc/latest/config/quarkus-netty_quarkus.netty.adoc +++ b/_generated-doc/latest/config/quarkus-netty_quarkus.netty.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-netty_quarkus-netty [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-observability-devservices.adoc b/_generated-doc/latest/config/quarkus-observability-devservices.adoc index 27833fd488a..8e73682a451 100644 --- a/_generated-doc/latest/config/quarkus-observability-devservices.adoc +++ b/_generated-doc/latest/config/quarkus-observability-devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-observability-devservices_quarkus-observability [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -136,7 +135,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-observability-devservices_quarkus-observability[icon:question-circle[title=More information about the Duration format]] |`PT1M` a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-image-name]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-image-name[`quarkus.observability.lgtm.image-name`]## @@ -154,7 +153,7 @@ Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] -- |string -|`docker.io/grafana/otel-lgtm:0.4.0` +|`docker.io/grafana/otel-lgtm:0.7.5` a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-network-aliases]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-network-aliases[`quarkus.observability.lgtm.network-aliases`]## @@ -190,22 +189,22 @@ endif::add-copy-button-to-env-var[] |string |`quarkus-dev-service-lgtm` -a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-otlp-port]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-otlp-port[`quarkus.observability.lgtm.otlp-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-otlp-protocol]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-otlp-protocol[`quarkus.observability.lgtm.otlp-protocol`]## [.description] -- -The port on which LGTM's OTLP port will be exposed. +The LGTM's OTLP protocol. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_LGTM_OTLP_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_LGTM_OTLP_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_OTLP_PORT+++` +Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_OTLP_PROTOCOL+++` endif::add-copy-button-to-env-var[] -- -|int -|`4318` +|string +|`http/protobuf` a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-enabled]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-enabled[`quarkus.observability.enabled`]## @@ -282,5 +281,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-observability-devservices_quarkus.observability.adoc b/_generated-doc/latest/config/quarkus-observability-devservices_quarkus.observability.adoc index 27833fd488a..8e73682a451 100644 --- a/_generated-doc/latest/config/quarkus-observability-devservices_quarkus.observability.adoc +++ b/_generated-doc/latest/config/quarkus-observability-devservices_quarkus.observability.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-observability-devservices_quarkus-observability [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -136,7 +135,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-observability-devservices_quarkus-observability[icon:question-circle[title=More information about the Duration format]] |`PT1M` a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-image-name]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-image-name[`quarkus.observability.lgtm.image-name`]## @@ -154,7 +153,7 @@ Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] -- |string -|`docker.io/grafana/otel-lgtm:0.4.0` +|`docker.io/grafana/otel-lgtm:0.7.5` a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-network-aliases]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-network-aliases[`quarkus.observability.lgtm.network-aliases`]## @@ -190,22 +189,22 @@ endif::add-copy-button-to-env-var[] |string |`quarkus-dev-service-lgtm` -a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-otlp-port]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-otlp-port[`quarkus.observability.lgtm.otlp-port`]## +a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-lgtm-otlp-protocol]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-lgtm-otlp-protocol[`quarkus.observability.lgtm.otlp-protocol`]## [.description] -- -The port on which LGTM's OTLP port will be exposed. +The LGTM's OTLP protocol. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_LGTM_OTLP_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OBSERVABILITY_LGTM_OTLP_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_OTLP_PORT+++` +Environment variable: `+++QUARKUS_OBSERVABILITY_LGTM_OTLP_PROTOCOL+++` endif::add-copy-button-to-env-var[] -- -|int -|`4318` +|string +|`http/protobuf` a|icon:lock[title=Fixed at build time] [[quarkus-observability-devservices_quarkus-observability-enabled]] [.property-path]##link:#quarkus-observability-devservices_quarkus-observability-enabled[`quarkus.observability.enabled`]## @@ -282,5 +281,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-oidc-client-graphql.adoc b/_generated-doc/latest/config/quarkus-oidc-client-graphql.adoc index dcba6ac0c97..dacb4935e5a 100644 --- a/_generated-doc/latest/config/quarkus-oidc-client-graphql.adoc +++ b/_generated-doc/latest/config/quarkus-oidc-client-graphql.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-oidc-client-graphql_quarkus-oidc-client-graphql [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-oidc-client-graphql_quarkus.oidc-client-graphql.adoc b/_generated-doc/latest/config/quarkus-oidc-client-graphql_quarkus.oidc-client-graphql.adoc index dcba6ac0c97..dacb4935e5a 100644 --- a/_generated-doc/latest/config/quarkus-oidc-client-graphql_quarkus.oidc-client-graphql.adoc +++ b/_generated-doc/latest/config/quarkus-oidc-client-graphql_quarkus.oidc-client-graphql.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-oidc-client-graphql_quarkus-oidc-client-graphql [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-oidc-client-registration.adoc b/_generated-doc/latest/config/quarkus-oidc-client-registration.adoc new file mode 100644 index 00000000000..57bbe0c8813 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-oidc-client-registration.adoc @@ -0,0 +1,776 @@ +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-enabled[`quarkus.oidc-client-registration.enabled`]## + +[.description] +-- +If the OIDC client registration extension is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-auth-server-url]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-auth-server-url[`quarkus.oidc-client-registration.auth-server-url`]## + +[.description] +-- +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_AUTH_SERVER_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_AUTH_SERVER_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-discovery-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-discovery-enabled[`quarkus.oidc-client-registration.discovery-enabled`]## + +[.description] +-- +Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_DISCOVERY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_DISCOVERY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-registration-path]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-registration-path[`quarkus.oidc-client-registration.registration-path`]## + +[.description] +-- +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTRATION_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTRATION_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-delay]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-delay[`quarkus.oidc-client-registration.connection-delay`]## + +[.description] +-- +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client-registration_quarkus-oidc-client-registration[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-retry-count[`quarkus.oidc-client-registration.connection-retry-count`]## + +[.description] +-- +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-timeout]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-timeout[`quarkus.oidc-client-registration.connection-timeout`]## + +[.description] +-- +The number of seconds after which the current OIDC connection request times out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client-registration_quarkus-oidc-client-registration[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-use-blocking-dns-lookup[`quarkus.oidc-client-registration.use-blocking-dns-lookup`]## + +[.description] +-- +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_USE_BLOCKING_DNS_LOOKUP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_USE_BLOCKING_DNS_LOOKUP+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-max-pool-size]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-max-pool-size[`quarkus.oidc-client-registration.max-pool-size`]## + +[.description] +-- +The maximum size of the connection pool used by the WebClient. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_MAX_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_MAX_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-host]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-host[`quarkus.oidc-client-registration.proxy.host`]## + +[.description] +-- +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-port]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-port[`quarkus.oidc-client-registration.proxy.port`]## + +[.description] +-- +The port number of the Proxy. The default value is `80`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`80` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-username]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-username[`quarkus.oidc-client-registration.proxy.username`]## + +[.description] +-- +The username, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-password]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-password[`quarkus.oidc-client-registration.proxy.password`]## + +[.description] +-- +The password, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-tls-tls-configuration-name[`quarkus.oidc-client-registration.tls.tls-configuration-name`]## + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_TLS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_TLS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id[`quarkus.oidc-client-registration.id`]## + +[.description] +-- +OIDC Client Registration id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-registration-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-registration-enabled[`quarkus.oidc-client-registration.registration-enabled`]## + +[.description] +-- +If this client registration configuration is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTRATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTRATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-register-early]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-register-early[`quarkus.oidc-client-registration.register-early`]## + +[.description] +-- +If the client configured with `metadata` must be registered at startup. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTER_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTER_EARLY+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-initial-token]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-initial-token[`quarkus.oidc-client-registration.initial-token`]## + +[.description] +-- +Initial access token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_INITIAL_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_INITIAL_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-client-name]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-client-name[`quarkus.oidc-client-registration.metadata.client-name`]## + +[.description] +-- +Client name + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-redirect-uri]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-redirect-uri[`quarkus.oidc-client-registration.metadata.redirect-uri`]## + +[.description] +-- +Redirect URI + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_REDIRECT_URI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_REDIRECT_URI+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-post-logout-uri]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-post-logout-uri[`quarkus.oidc-client-registration.metadata.post-logout-uri`]## + +[.description] +-- +Post Logout URI + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_POST_LOGOUT_URI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_POST_LOGOUT_URI+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-extra-props-extra-props]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-extra-props-extra-props[`quarkus.oidc-client-registration.metadata.extra-props."extra-props"`]## + +[.description] +-- +Additional metadata properties + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_EXTRA_PROPS__EXTRA_PROPS_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_EXTRA_PROPS__EXTRA_PROPS_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-oidc-client-registration_section_quarkus-oidc-client-registration]] [.section-name.section-level0]##link:#quarkus-oidc-client-registration_section_quarkus-oidc-client-registration[Additional named client registrations]## +h|Type +h|Default + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-auth-server-url]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-auth-server-url[`quarkus.oidc-client-registration."id".auth-server-url`]## + +[.description] +-- +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__AUTH_SERVER_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__AUTH_SERVER_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-discovery-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-discovery-enabled[`quarkus.oidc-client-registration."id".discovery-enabled`]## + +[.description] +-- +Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__DISCOVERY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__DISCOVERY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-registration-path]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-registration-path[`quarkus.oidc-client-registration."id".registration-path`]## + +[.description] +-- +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTRATION_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTRATION_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-delay]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-delay[`quarkus.oidc-client-registration."id".connection-delay`]## + +[.description] +-- +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client-registration_quarkus-oidc-client-registration[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-retry-count[`quarkus.oidc-client-registration."id".connection-retry-count`]## + +[.description] +-- +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-timeout]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-timeout[`quarkus.oidc-client-registration."id".connection-timeout`]## + +[.description] +-- +The number of seconds after which the current OIDC connection request times out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client-registration_quarkus-oidc-client-registration[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-use-blocking-dns-lookup[`quarkus.oidc-client-registration."id".use-blocking-dns-lookup`]## + +[.description] +-- +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__USE_BLOCKING_DNS_LOOKUP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__USE_BLOCKING_DNS_LOOKUP+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-max-pool-size]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-max-pool-size[`quarkus.oidc-client-registration."id".max-pool-size`]## + +[.description] +-- +The maximum size of the connection pool used by the WebClient. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__MAX_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__MAX_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-host]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-host[`quarkus.oidc-client-registration."id".proxy.host`]## + +[.description] +-- +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-port]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-port[`quarkus.oidc-client-registration."id".proxy.port`]## + +[.description] +-- +The port number of the Proxy. The default value is `80`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`80` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-username]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-username[`quarkus.oidc-client-registration."id".proxy.username`]## + +[.description] +-- +The username, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-password]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-password[`quarkus.oidc-client-registration."id".proxy.password`]## + +[.description] +-- +The password, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-tls-tls-configuration-name[`quarkus.oidc-client-registration."id".tls.tls-configuration-name`]## + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__TLS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__TLS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-id]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-id[`quarkus.oidc-client-registration."id".id`]## + +[.description] +-- +OIDC Client Registration id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-registration-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-registration-enabled[`quarkus.oidc-client-registration."id".registration-enabled`]## + +[.description] +-- +If this client registration configuration is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTRATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTRATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-register-early]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-register-early[`quarkus.oidc-client-registration."id".register-early`]## + +[.description] +-- +If the client configured with `metadata` must be registered at startup. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTER_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTER_EARLY+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-initial-token]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-initial-token[`quarkus.oidc-client-registration."id".initial-token`]## + +[.description] +-- +Initial access token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__INITIAL_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__INITIAL_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-client-name]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-client-name[`quarkus.oidc-client-registration."id".metadata.client-name`]## + +[.description] +-- +Client name + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-redirect-uri]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-redirect-uri[`quarkus.oidc-client-registration."id".metadata.redirect-uri`]## + +[.description] +-- +Redirect URI + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_REDIRECT_URI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_REDIRECT_URI+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-post-logout-uri]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-post-logout-uri[`quarkus.oidc-client-registration."id".metadata.post-logout-uri`]## + +[.description] +-- +Post Logout URI + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_POST_LOGOUT_URI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_POST_LOGOUT_URI+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-extra-props-extra-props]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-extra-props-extra-props[`quarkus.oidc-client-registration."id".metadata.extra-props."extra-props"`]## + +[.description] +-- +Additional metadata properties + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_EXTRA_PROPS__EXTRA_PROPS_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_EXTRA_PROPS__EXTRA_PROPS_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-oidc-client-registration_quarkus-oidc-client-registration] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] diff --git a/_generated-doc/latest/config/quarkus-oidc-client-registration_quarkus.oidc-client-registration.adoc b/_generated-doc/latest/config/quarkus-oidc-client-registration_quarkus.oidc-client-registration.adoc new file mode 100644 index 00000000000..57bbe0c8813 --- /dev/null +++ b/_generated-doc/latest/config/quarkus-oidc-client-registration_quarkus.oidc-client-registration.adoc @@ -0,0 +1,776 @@ +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-enabled[`quarkus.oidc-client-registration.enabled`]## + +[.description] +-- +If the OIDC client registration extension is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-auth-server-url]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-auth-server-url[`quarkus.oidc-client-registration.auth-server-url`]## + +[.description] +-- +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_AUTH_SERVER_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_AUTH_SERVER_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-discovery-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-discovery-enabled[`quarkus.oidc-client-registration.discovery-enabled`]## + +[.description] +-- +Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_DISCOVERY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_DISCOVERY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-registration-path]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-registration-path[`quarkus.oidc-client-registration.registration-path`]## + +[.description] +-- +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTRATION_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTRATION_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-delay]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-delay[`quarkus.oidc-client-registration.connection-delay`]## + +[.description] +-- +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client-registration_quarkus-oidc-client-registration[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-retry-count[`quarkus.oidc-client-registration.connection-retry-count`]## + +[.description] +-- +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-timeout]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-connection-timeout[`quarkus.oidc-client-registration.connection-timeout`]## + +[.description] +-- +The number of seconds after which the current OIDC connection request times out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client-registration_quarkus-oidc-client-registration[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-use-blocking-dns-lookup[`quarkus.oidc-client-registration.use-blocking-dns-lookup`]## + +[.description] +-- +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_USE_BLOCKING_DNS_LOOKUP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_USE_BLOCKING_DNS_LOOKUP+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-max-pool-size]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-max-pool-size[`quarkus.oidc-client-registration.max-pool-size`]## + +[.description] +-- +The maximum size of the connection pool used by the WebClient. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_MAX_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_MAX_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-host]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-host[`quarkus.oidc-client-registration.proxy.host`]## + +[.description] +-- +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-port]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-port[`quarkus.oidc-client-registration.proxy.port`]## + +[.description] +-- +The port number of the Proxy. The default value is `80`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`80` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-username]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-username[`quarkus.oidc-client-registration.proxy.username`]## + +[.description] +-- +The username, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-password]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-password[`quarkus.oidc-client-registration.proxy.password`]## + +[.description] +-- +The password, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-tls-tls-configuration-name[`quarkus.oidc-client-registration.tls.tls-configuration-name`]## + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_TLS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_TLS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id[`quarkus.oidc-client-registration.id`]## + +[.description] +-- +OIDC Client Registration id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-registration-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-registration-enabled[`quarkus.oidc-client-registration.registration-enabled`]## + +[.description] +-- +If this client registration configuration is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTRATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTRATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-register-early]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-register-early[`quarkus.oidc-client-registration.register-early`]## + +[.description] +-- +If the client configured with `metadata` must be registered at startup. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTER_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_REGISTER_EARLY+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-initial-token]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-initial-token[`quarkus.oidc-client-registration.initial-token`]## + +[.description] +-- +Initial access token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_INITIAL_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_INITIAL_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-client-name]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-client-name[`quarkus.oidc-client-registration.metadata.client-name`]## + +[.description] +-- +Client name + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-redirect-uri]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-redirect-uri[`quarkus.oidc-client-registration.metadata.redirect-uri`]## + +[.description] +-- +Redirect URI + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_REDIRECT_URI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_REDIRECT_URI+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-post-logout-uri]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-post-logout-uri[`quarkus.oidc-client-registration.metadata.post-logout-uri`]## + +[.description] +-- +Post Logout URI + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_POST_LOGOUT_URI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_POST_LOGOUT_URI+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-extra-props-extra-props]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-metadata-extra-props-extra-props[`quarkus.oidc-client-registration.metadata.extra-props."extra-props"`]## + +[.description] +-- +Additional metadata properties + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_EXTRA_PROPS__EXTRA_PROPS_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_METADATA_EXTRA_PROPS__EXTRA_PROPS_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-oidc-client-registration_section_quarkus-oidc-client-registration]] [.section-name.section-level0]##link:#quarkus-oidc-client-registration_section_quarkus-oidc-client-registration[Additional named client registrations]## +h|Type +h|Default + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-auth-server-url]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-auth-server-url[`quarkus.oidc-client-registration."id".auth-server-url`]## + +[.description] +-- +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__AUTH_SERVER_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__AUTH_SERVER_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-discovery-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-discovery-enabled[`quarkus.oidc-client-registration."id".discovery-enabled`]## + +[.description] +-- +Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__DISCOVERY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__DISCOVERY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-registration-path]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-registration-path[`quarkus.oidc-client-registration."id".registration-path`]## + +[.description] +-- +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTRATION_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTRATION_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-delay]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-delay[`quarkus.oidc-client-registration."id".connection-delay`]## + +[.description] +-- +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client-registration_quarkus-oidc-client-registration[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-retry-count[`quarkus.oidc-client-registration."id".connection-retry-count`]## + +[.description] +-- +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-timeout]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connection-timeout[`quarkus.oidc-client-registration."id".connection-timeout`]## + +[.description] +-- +The number of seconds after which the current OIDC connection request times out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client-registration_quarkus-oidc-client-registration[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-use-blocking-dns-lookup[`quarkus.oidc-client-registration."id".use-blocking-dns-lookup`]## + +[.description] +-- +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__USE_BLOCKING_DNS_LOOKUP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__USE_BLOCKING_DNS_LOOKUP+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-max-pool-size]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-max-pool-size[`quarkus.oidc-client-registration."id".max-pool-size`]## + +[.description] +-- +The maximum size of the connection pool used by the WebClient. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__MAX_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__MAX_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-host]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-host[`quarkus.oidc-client-registration."id".proxy.host`]## + +[.description] +-- +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-port]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-port[`quarkus.oidc-client-registration."id".proxy.port`]## + +[.description] +-- +The port number of the Proxy. The default value is `80`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`80` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-username]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-username[`quarkus.oidc-client-registration."id".proxy.username`]## + +[.description] +-- +The username, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-password]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-password[`quarkus.oidc-client-registration."id".proxy.password`]## + +[.description] +-- +The password, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-tls-tls-configuration-name[`quarkus.oidc-client-registration."id".tls.tls-configuration-name`]## + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__TLS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__TLS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-id]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-id[`quarkus.oidc-client-registration."id".id`]## + +[.description] +-- +OIDC Client Registration id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-registration-enabled]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-registration-enabled[`quarkus.oidc-client-registration."id".registration-enabled`]## + +[.description] +-- +If this client registration configuration is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTRATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTRATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-register-early]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-register-early[`quarkus.oidc-client-registration."id".register-early`]## + +[.description] +-- +If the client configured with `metadata` must be registered at startup. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTER_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__REGISTER_EARLY+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-initial-token]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-initial-token[`quarkus.oidc-client-registration."id".initial-token`]## + +[.description] +-- +Initial access token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__INITIAL_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__INITIAL_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-client-name]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-client-name[`quarkus.oidc-client-registration."id".metadata.client-name`]## + +[.description] +-- +Client name + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-redirect-uri]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-redirect-uri[`quarkus.oidc-client-registration."id".metadata.redirect-uri`]## + +[.description] +-- +Redirect URI + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_REDIRECT_URI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_REDIRECT_URI+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-post-logout-uri]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-post-logout-uri[`quarkus.oidc-client-registration."id".metadata.post-logout-uri`]## + +[.description] +-- +Post Logout URI + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_POST_LOGOUT_URI+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_POST_LOGOUT_URI+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-extra-props-extra-props]] [.property-path]##link:#quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-metadata-extra-props-extra-props[`quarkus.oidc-client-registration."id".metadata.extra-props."extra-props"`]## + +[.description] +-- +Additional metadata properties + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_EXTRA_PROPS__EXTRA_PROPS_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__METADATA_EXTRA_PROPS__EXTRA_PROPS_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-oidc-client-registration_quarkus-oidc-client-registration] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] diff --git a/_generated-doc/latest/config/quarkus-oidc-client.adoc b/_generated-doc/latest/config/quarkus-oidc-client.adoc index 9892e826c41..7c657a0dafb 100644 --- a/_generated-doc/latest/config/quarkus-oidc-client.adoc +++ b/_generated-doc/latest/config/quarkus-oidc-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-oidc-client_quarkus-oidc-client [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -29,7 +28,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-auth-server-url]] [.property-path]# [.description] -- -The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. ifdef::add-copy-button-to-env-var[] @@ -59,157 +58,264 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a| [[quarkus-oidc-client_quarkus-oidc-client-token-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-token-path[`quarkus.oidc-client.token-path`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-registration-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-registration-path[`quarkus.oidc-client.registration-path`]## [.description] -- -The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TOKEN_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TOKEN_PATH+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-revoke-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-revoke-path[`quarkus.oidc-client.revoke-path`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-connection-delay]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-delay[`quarkus.oidc-client.connection-delay`]## [.description] -- -The relative path or absolute URL of the OIDC token revocation endpoint. +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REVOKE_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_REVOKE_PATH+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc-client_quarkus-oidc-client-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-retry-count[`quarkus.oidc-client.connection-retry-count`]## + +[.description] +-- +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +a| [[quarkus-oidc-client_quarkus-oidc-client-connection-timeout]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-timeout[`quarkus.oidc-client.connection-timeout`]## + +[.description] +-- +The number of seconds after which the current OIDC connection request times out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-oidc-client_quarkus-oidc-client-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-use-blocking-dns-lookup[`quarkus.oidc-client.use-blocking-dns-lookup`]## + +[.description] +-- +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc-client_quarkus-oidc-client-max-pool-size]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-max-pool-size[`quarkus.oidc-client.max-pool-size`]## + +[.description] +-- +The maximum size of the connection pool used by the WebClient. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-host]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-host[`quarkus.oidc-client.proxy.host`]## + +[.description] +-- +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_HOST+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-id[`quarkus.oidc-client.client-id`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-port]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-port[`quarkus.oidc-client.proxy.port`]## [.description] -- -The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. +The port number of the Proxy. The default value is `80`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_ID+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`80` + +a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-username]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-username[`quarkus.oidc-client.proxy.username`]## + +[.description] +-- +The username, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-client-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-name[`quarkus.oidc-client.client-name`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-password[`quarkus.oidc-client.proxy.password`]## [.description] -- -The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. +The password, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_NAME+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-connection-delay]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-delay[`quarkus.oidc-client.connection-delay`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-tls-configuration-name[`quarkus.oidc-client.tls.tls-configuration-name`]## [.description] -- -The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_DELAY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|string | -a| [[quarkus-oidc-client_quarkus-oidc-client-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-retry-count[`quarkus.oidc-client.connection-retry-count`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-token-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-token-path[`quarkus.oidc-client.token-path`]## [.description] -- -The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. +The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TOKEN_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_TOKEN_PATH+++` endif::add-copy-button-to-env-var[] -- -|int -|`3` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-connection-timeout]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-timeout[`quarkus.oidc-client.connection-timeout`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-revoke-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-revoke-path[`quarkus.oidc-client.revoke-path`]## [.description] -- -The number of seconds after which the current OIDC connection request times out. +The relative path or absolute URL of the OIDC token revocation endpoint. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REVOKE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REVOKE_PATH+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-use-blocking-dns-lookup[`quarkus.oidc-client.use-blocking-dns-lookup`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-id[`quarkus.oidc-client.client-id`]## [.description] -- -Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. +The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_ID+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-max-pool-size]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-max-pool-size[`quarkus.oidc-client.max-pool-size`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-client-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-name[`quarkus.oidc-client.client-name`]## [.description] -- -The maximum size of the connection pool used by the WebClient. +The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-secret]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-credentials-secret[`quarkus.oidc-client.credentials.secret`]## @@ -335,7 +441,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-jwt-secret]] [.property [.description] -- -If provided, indicates that JWT is signed using a secret key. +If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. ifdef::add-copy-button-to-env-var[] @@ -403,7 +509,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-jwt-key]] [.property-pa [.description] -- -String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -420,7 +526,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-jwt-key-file]] [.proper [.description] -- -If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -437,7 +543,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-jwt-key-store-file]] [. [.description] -- -If provided, indicates that JWT is signed using a private key from a keystore. +If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. ifdef::add-copy-button-to-env-var[] @@ -637,538 +743,474 @@ endif::add-copy-button-to-env-var[] |boolean |`false` -a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-host]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-host[`quarkus.oidc-client.proxy.host`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id[`quarkus.oidc-client.id`]## [.description] -- -The host name or IP address of the Proxy. + -Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. +A unique OIDC client identifier. It must be set when OIDC clients are created dynamically and is optional in all other cases. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_HOST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_HOST+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_ID+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-port]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-port[`quarkus.oidc-client.proxy.port`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-client-enabled]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-enabled[`quarkus.oidc-client.client-enabled`]## [.description] -- -The port number of the Proxy. The default value is `80`. +If this client configuration is enabled. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_PORT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|int -|`80` +|boolean +|`true` -a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-username]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-username[`quarkus.oidc-client.proxy.username`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-scopes]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-scopes[`quarkus.oidc-client.scopes`]## [.description] -- -The username, if the Proxy needs authentication. +List of access token scopes ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_USERNAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_SCOPES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_USERNAME+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_SCOPES+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-password[`quarkus.oidc-client.proxy.password`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-refresh-token-time-skew]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-refresh-token-time-skew[`quarkus.oidc-client.refresh-token-time-skew`]## [.description] -- -The password, if the Proxy needs authentication. +Refresh token time skew. If this property is enabled then the configured duration is converted to seconds and is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REFRESH_TOKEN_TIME_SKEW+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REFRESH_TOKEN_TIME_SKEW+++` endif::add-copy-button-to-env-var[] -- -|string +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] | -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-verification]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-verification[`quarkus.oidc-client.tls.verification`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-access-token-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-access-token-expires-in[`quarkus.oidc-client.access-token-expires-in`]## [.description] -- -Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is `required`. +Access token expiration period relative to the current time. This property is only checked when an access token grant response does not include an access token expiration property. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_VERIFICATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ACCESS_TOKEN_EXPIRES_IN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_VERIFICATION+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_ACCESS_TOKEN_EXPIRES_IN+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.], tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.], tooltip:none[All certificates are trusted and hostname verification is disabled.] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] | -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-file]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-file[`quarkus.oidc-client.tls.key-store-file`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-absolute-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-absolute-expires-in[`quarkus.oidc-client.absolute-expires-in`]## [.description] -- -An optional keystore that holds the certificate information instead of specifying separate files. +If the access token 'expires_in' property should be checked as an absolute time value as opposed to a duration relative to the current time. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_FILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ABSOLUTE_EXPIRES_IN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_FILE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_ABSOLUTE_EXPIRES_IN+++` endif::add-copy-button-to-env-var[] -- -|path -| +|boolean +|`false` -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-file-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-file-type[`quarkus.oidc-client.tls.key-store-file-type`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-grant-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-type[`quarkus.oidc-client.grant.type`]## [.description] -- -The type of the keystore file. If not given, the type is automatically detected based on the file name. +Grant type ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_FILE_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_FILE_TYPE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_TYPE+++` endif::add-copy-button-to-env-var[] -- -|string -| +a|tooltip:client['client_credentials' grant requiring an OIDC client authentication only], tooltip:password['password' grant requiring both OIDC client and user ('username' and 'password') authentications], tooltip:code['authorization_code' grant requiring an OIDC client authentication as well as at least 'code' and 'redirect_uri' parameters which must be passed to OidcClient at the token request time.], tooltip:exchange['urn\:ietf\:params\:oauth\:grant-type\:token-exchange' grant requiring an OIDC client authentication as well as at least 'subject_token' parameter which must be passed to OidcClient at the token request time.], tooltip:jwt['urn\:ietf\:params\:oauth\:grant-type\:jwt-bearer' grant requiring an OIDC client authentication as well as at least an 'assertion' parameter which must be passed to OidcClient at the token request time.], tooltip:refresh['refresh_token' grant requiring an OIDC client authentication and a refresh token. Note, OidcClient supports this grant by default if an access token acquisition response contained a refresh token. However, in some cases, the refresh token is provided out of band, for example, it can be shared between several of the confidential client's services, etc. If 'quarkus.oidc-client.grant-type' is set to 'refresh' then `OidcClient` will only support refreshing the tokens.], tooltip:ciba['urn\:openid\:params\:grant-type\:ciba' grant requiring an OIDC client authentication as well as 'auth_req_id' parameter which must be passed to OidcClient at the token request time.], tooltip:device['urn\:ietf\:params\:oauth\:grant-type\:device_code' grant requiring an OIDC client authentication as well as 'device_code' parameter which must be passed to OidcClient at the token request time.] +|tooltip:client['client_credentials' grant requiring an OIDC client authentication only] -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-provider]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-provider[`quarkus.oidc-client.tls.key-store-provider`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-grant-access-token-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-access-token-property[`quarkus.oidc-client.grant.access-token-property`]## [.description] -- -The provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type. +Access token property name in a token grant response ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_PROVIDER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_ACCESS_TOKEN_PROPERTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_PROVIDER+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_ACCESS_TOKEN_PROPERTY+++` endif::add-copy-button-to-env-var[] -- |string -| +|`access_token` -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-password[`quarkus.oidc-client.tls.key-store-password`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-grant-refresh-token-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-refresh-token-property[`quarkus.oidc-client.grant.refresh-token-property`]## [.description] -- -The password of the keystore file. If not given, the default value, `password`, is used. +Refresh token property name in a token grant response ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_TOKEN_PROPERTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_TOKEN_PROPERTY+++` endif::add-copy-button-to-env-var[] -- |string -| +|`refresh_token` -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-key-alias]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-key-alias[`quarkus.oidc-client.tls.key-store-key-alias`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-grant-expires-in-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-expires-in-property[`quarkus.oidc-client.grant.expires-in-property`]## [.description] -- -The alias of a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined. +Access token expiry property name in a token grant response ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_KEY_ALIAS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_EXPIRES_IN_PROPERTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_KEY_ALIAS+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_EXPIRES_IN_PROPERTY+++` endif::add-copy-button-to-env-var[] -- |string -| +|`expires_in` -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-key-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-key-password[`quarkus.oidc-client.tls.key-store-key-password`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-grant-refresh-expires-in-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-refresh-expires-in-property[`quarkus.oidc-client.grant.refresh-expires-in-property`]## [.description] -- -The password of the key, if it is different from the `key-store-password`. +Refresh token expiry property name in a token grant response ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_KEY_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_EXPIRES_IN_PROPERTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_KEY_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_EXPIRES_IN_PROPERTY+++` endif::add-copy-button-to-env-var[] -- |string -| +|`refresh_expires_in` -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-file]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-file[`quarkus.oidc-client.tls.trust-store-file`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-grant-options-grant-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-options-grant-name[`quarkus.oidc-client.grant-options."grant-name"`]## [.description] -- -The truststore that holds the certificate information of the certificates to trust. +Grant options ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_FILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_OPTIONS__GRANT_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_FILE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_OPTIONS__GRANT_NAME_+++` endif::add-copy-button-to-env-var[] -- -|path +|Map> | -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-password[`quarkus.oidc-client.tls.trust-store-password`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-early-tokens-acquisition]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-early-tokens-acquisition[`quarkus.oidc-client.early-tokens-acquisition`]## [.description] -- -The password of the truststore file. +Requires that all filters which use 'OidcClient' acquire the tokens at the post-construct initialization time, possibly long before these tokens are used. This property should be disabled if the access token may expire before it is used for the first time and no refresh token is available. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_EARLY_TOKENS_ACQUISITION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_EARLY_TOKENS_ACQUISITION+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`true` -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-cert-alias]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-cert-alias[`quarkus.oidc-client.tls.trust-store-cert-alias`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-headers-headers]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-headers-headers[`quarkus.oidc-client.headers."headers"`]## [.description] -- -The alias of the truststore certificate. +Custom HTTP headers which have to be sent to the token endpoint ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_CERT_ALIAS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_HEADERS__HEADERS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_CERT_ALIAS+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_HEADERS__HEADERS_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-file-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-file-type[`quarkus.oidc-client.tls.trust-store-file-type`]## +h|[[quarkus-oidc-client_section_quarkus-oidc-client]] [.section-name.section-level0]##link:#quarkus-oidc-client_section_quarkus-oidc-client[Additional named clients]## +h|Type +h|Default + +a| [[quarkus-oidc-client_quarkus-oidc-client-id-auth-server-url]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-auth-server-url[`quarkus.oidc-client."id".auth-server-url`]## [.description] -- -The type of the truststore file. If not given, the type is automatically detected based on the file name. +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_FILE_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__AUTH_SERVER_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_FILE_TYPE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__AUTH_SERVER_URL+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-provider]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-provider[`quarkus.oidc-client.tls.trust-store-provider`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-discovery-enabled]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-discovery-enabled[`quarkus.oidc-client."id".discovery-enabled`]## [.description] -- -The provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type. +Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_PROVIDER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__DISCOVERY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_PROVIDER+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__DISCOVERY_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`true` -a| [[quarkus-oidc-client_quarkus-oidc-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id[`quarkus.oidc-client.id`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-registration-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-registration-path[`quarkus.oidc-client."id".registration-path`]## [.description] -- -A unique OIDC client identifier. It must be set when OIDC clients are created dynamically and is optional in all other cases. +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__REGISTRATION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_ID+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__REGISTRATION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-client-enabled]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-enabled[`quarkus.oidc-client.client-enabled`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-delay]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-delay[`quarkus.oidc-client."id".connection-delay`]## [.description] -- -If this client configuration is enabled. +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_ENABLED+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_DELAY+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] +| -a| [[quarkus-oidc-client_quarkus-oidc-client-scopes]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-scopes[`quarkus.oidc-client.scopes`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-retry-count[`quarkus.oidc-client."id".connection-retry-count`]## [.description] -- -List of access token scopes +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_SCOPES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_RETRY_COUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_SCOPES+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_RETRY_COUNT+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|int +|`3` -a| [[quarkus-oidc-client_quarkus-oidc-client-refresh-token-time-skew]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-refresh-token-time-skew[`quarkus.oidc-client.refresh-token-time-skew`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-timeout]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-timeout[`quarkus.oidc-client."id".connection-timeout`]## [.description] -- -Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen. +The number of seconds after which the current OIDC connection request times out. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REFRESH_TOKEN_TIME_SKEW+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_REFRESH_TOKEN_TIME_SKEW+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] +|`10S` -a| [[quarkus-oidc-client_quarkus-oidc-client-absolute-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-absolute-expires-in[`quarkus.oidc-client.absolute-expires-in`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-use-blocking-dns-lookup[`quarkus.oidc-client."id".use-blocking-dns-lookup`]## [.description] -- -If the access token 'expires_in' property should be checked as an absolute time value as opposed to a duration relative to the current time. +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ABSOLUTE_EXPIRES_IN+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__USE_BLOCKING_DNS_LOOKUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_ABSOLUTE_EXPIRES_IN+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__USE_BLOCKING_DNS_LOOKUP+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-oidc-client_quarkus-oidc-client-grant-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-type[`quarkus.oidc-client.grant.type`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-max-pool-size]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-max-pool-size[`quarkus.oidc-client."id".max-pool-size`]## [.description] -- -Grant type +The maximum size of the connection pool used by the WebClient. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__MAX_POOL_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_TYPE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__MAX_POOL_SIZE+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:client['client_credentials' grant requiring an OIDC client authentication only], tooltip:password['password' grant requiring both OIDC client and user ('username' and 'password') authentications], tooltip:code['authorization_code' grant requiring an OIDC client authentication as well as at least 'code' and 'redirect_uri' parameters which must be passed to OidcClient at the token request time.], tooltip:exchange['urn\:ietf\:params\:oauth\:grant-type\:token-exchange' grant requiring an OIDC client authentication as well as at least 'subject_token' parameter which must be passed to OidcClient at the token request time.], tooltip:jwt['urn\:ietf\:params\:oauth\:grant-type\:jwt-bearer' grant requiring an OIDC client authentication as well as at least an 'assertion' parameter which must be passed to OidcClient at the token request time.], tooltip:refresh['refresh_token' grant requiring an OIDC client authentication and a refresh token. Note, OidcClient supports this grant by default if an access token acquisition response contained a refresh token. However, in some cases, the refresh token is provided out of band, for example, it can be shared between several of the confidential client's services, etc. If 'quarkus.oidc-client.grant-type' is set to 'refresh' then `OidcClient` will only support refreshing the tokens.], tooltip:ciba['urn\:openid\:params\:grant-type\:ciba' grant requiring an OIDC client authentication as well as 'auth_req_id' parameter which must be passed to OidcClient at the token request time.], tooltip:device['urn\:ietf\:params\:oauth\:grant-type\:device_code' grant requiring an OIDC client authentication as well as 'device_code' parameter which must be passed to OidcClient at the token request time.] -|tooltip:client['client_credentials' grant requiring an OIDC client authentication only] +|int +| -a| [[quarkus-oidc-client_quarkus-oidc-client-grant-access-token-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-access-token-property[`quarkus.oidc-client.grant.access-token-property`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-host]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-host[`quarkus.oidc-client."id".proxy.host`]## [.description] -- -Access token property name in a token grant response +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_ACCESS_TOKEN_PROPERTY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_ACCESS_TOKEN_PROPERTY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_HOST+++` endif::add-copy-button-to-env-var[] -- |string -|`access_token` +| -a| [[quarkus-oidc-client_quarkus-oidc-client-grant-refresh-token-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-refresh-token-property[`quarkus.oidc-client.grant.refresh-token-property`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-port]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-port[`quarkus.oidc-client."id".proxy.port`]## [.description] -- -Refresh token property name in a token grant response +The port number of the Proxy. The default value is `80`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_TOKEN_PROPERTY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_TOKEN_PROPERTY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_PORT+++` endif::add-copy-button-to-env-var[] -- -|string -|`refresh_token` +|int +|`80` -a| [[quarkus-oidc-client_quarkus-oidc-client-grant-expires-in-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-expires-in-property[`quarkus.oidc-client.grant.expires-in-property`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-username]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-username[`quarkus.oidc-client."id".proxy.username`]## [.description] -- -Access token expiry property name in a token grant response +The username, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_EXPIRES_IN_PROPERTY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_EXPIRES_IN_PROPERTY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] -- |string -|`expires_in` +| -a| [[quarkus-oidc-client_quarkus-oidc-client-grant-refresh-expires-in-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-refresh-expires-in-property[`quarkus.oidc-client.grant.refresh-expires-in-property`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-password[`quarkus.oidc-client."id".proxy.password`]## [.description] -- -Refresh token expiry property name in a token grant response +The password, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_EXPIRES_IN_PROPERTY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_EXPIRES_IN_PROPERTY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string -|`refresh_expires_in` - -a| [[quarkus-oidc-client_quarkus-oidc-client-grant-options-grant-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-options-grant-name[`quarkus.oidc-client.grant-options."grant-name"`]## - -[.description] --- -Grant options - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_OPTIONS__GRANT_NAME_+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_OPTIONS__GRANT_NAME_+++` -endif::add-copy-button-to-env-var[] --- -|Map> | -a| [[quarkus-oidc-client_quarkus-oidc-client-early-tokens-acquisition]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-early-tokens-acquisition[`quarkus.oidc-client.early-tokens-acquisition`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-tls-configuration-name[`quarkus.oidc-client."id".tls.tls-configuration-name`]## [.description] -- -Requires that all filters which use 'OidcClient' acquire the tokens at the post-construct initialization time, possibly long before these tokens are used. This property should be disabled if the access token may expire before it is used for the first time and no refresh token is available. +The name of the TLS configuration to use. +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_EARLY_TOKENS_ACQUISITION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_EARLY_TOKENS_ACQUISITION+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` - -a| [[quarkus-oidc-client_quarkus-oidc-client-headers-headers]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-headers-headers[`quarkus.oidc-client.headers."headers"`]## - -[.description] --- -Custom HTTP headers which have to be sent to the token endpoint +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_HEADERS__HEADERS_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_HEADERS__HEADERS_+++` -endif::add-copy-button-to-env-var[] --- -|Map -| - -h|[[quarkus-oidc-client_section_quarkus-oidc-client]] [.section-name.section-level0]##link:#quarkus-oidc-client_section_quarkus-oidc-client[Additional named clients]## -h|Type -h|Default - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-auth-server-url]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-auth-server-url[`quarkus.oidc-client."id".auth-server-url`]## - -[.description] --- -The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__AUTH_SERVER_URL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__AUTH_SERVER_URL+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-id-discovery-enabled]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-discovery-enabled[`quarkus.oidc-client."id".discovery-enabled`]## - -[.description] --- -Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__DISCOVERY_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__DISCOVERY_ENABLED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` - a| [[quarkus-oidc-client_quarkus-oidc-client-id-token-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-token-path[`quarkus.oidc-client."id".token-path`]## [.description] @@ -1203,123 +1245,38 @@ endif::add-copy-button-to-env-var[] |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-id-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-client-id[`quarkus.oidc-client."id".client-id`]## - -[.description] --- -The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CLIENT_ID+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CLIENT_ID+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-client-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-client-name[`quarkus.oidc-client."id".client-name`]## - -[.description] --- -The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CLIENT_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CLIENT_NAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-delay]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-delay[`quarkus.oidc-client."id".connection-delay`]## - -[.description] --- -The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_DELAY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_DELAY+++` -endif::add-copy-button-to-env-var[] --- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-retry-count[`quarkus.oidc-client."id".connection-retry-count`]## - -[.description] --- -The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_RETRY_COUNT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_RETRY_COUNT+++` -endif::add-copy-button-to-env-var[] --- -|int -|`3` - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-timeout]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-timeout[`quarkus.oidc-client."id".connection-timeout`]## - -[.description] --- -The number of seconds after which the current OIDC connection request times out. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_TIMEOUT+++` -endif::add-copy-button-to-env-var[] --- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-use-blocking-dns-lookup[`quarkus.oidc-client."id".use-blocking-dns-lookup`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-client-id[`quarkus.oidc-client."id".client-id`]## [.description] -- -Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. +The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__USE_BLOCKING_DNS_LOOKUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CLIENT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__USE_BLOCKING_DNS_LOOKUP+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CLIENT_ID+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-id-max-pool-size]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-max-pool-size[`quarkus.oidc-client."id".max-pool-size`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-client-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-client-name[`quarkus.oidc-client."id".client-name`]## [.description] -- -The maximum size of the connection pool used by the WebClient. +The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__MAX_POOL_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CLIENT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__MAX_POOL_SIZE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CLIENT_NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-secret]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-credentials-secret[`quarkus.oidc-client."id".credentials.secret`]## @@ -1445,7 +1402,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-jwt-secret]] [.prope [.description] -- -If provided, indicates that JWT is signed using a secret key. +If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. ifdef::add-copy-button-to-env-var[] @@ -1513,7 +1470,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-jwt-key]] [.property [.description] -- -String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -1530,7 +1487,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-jwt-key-file]] [.pro [.description] -- -If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -1547,7 +1504,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-jwt-key-store-file]] [.description] -- -If provided, indicates that JWT is signed using a private key from a keystore. +If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. ifdef::add-copy-button-to-env-var[] @@ -1747,279 +1704,6 @@ endif::add-copy-button-to-env-var[] |boolean |`false` -a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-host]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-host[`quarkus.oidc-client."id".proxy.host`]## - -[.description] --- -The host name or IP address of the Proxy. + -Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_HOST+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_HOST+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-port]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-port[`quarkus.oidc-client."id".proxy.port`]## - -[.description] --- -The port number of the Proxy. The default value is `80`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_PORT+++` -endif::add-copy-button-to-env-var[] --- -|int -|`80` - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-username]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-username[`quarkus.oidc-client."id".proxy.username`]## - -[.description] --- -The username, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_USERNAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-password[`quarkus.oidc-client."id".proxy.password`]## - -[.description] --- -The password, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-verification]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-verification[`quarkus.oidc-client."id".tls.verification`]## - -[.description] --- -Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is `required`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_VERIFICATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_VERIFICATION+++` -endif::add-copy-button-to-env-var[] --- -a|tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.], tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.], tooltip:none[All certificates are trusted and hostname verification is disabled.] -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-file]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-file[`quarkus.oidc-client."id".tls.key-store-file`]## - -[.description] --- -An optional keystore that holds the certificate information instead of specifying separate files. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-file-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-file-type[`quarkus.oidc-client."id".tls.key-store-file-type`]## - -[.description] --- -The type of the keystore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-provider]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-provider[`quarkus.oidc-client."id".tls.key-store-provider`]## - -[.description] --- -The provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-password[`quarkus.oidc-client."id".tls.key-store-password`]## - -[.description] --- -The password of the keystore file. If not given, the default value, `password`, is used. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-key-alias]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-key-alias[`quarkus.oidc-client."id".tls.key-store-key-alias`]## - -[.description] --- -The alias of a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_KEY_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_KEY_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-key-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-key-password[`quarkus.oidc-client."id".tls.key-store-key-password`]## - -[.description] --- -The password of the key, if it is different from the `key-store-password`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_KEY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_KEY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-file]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-file[`quarkus.oidc-client."id".tls.trust-store-file`]## - -[.description] --- -The truststore that holds the certificate information of the certificates to trust. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-password[`quarkus.oidc-client."id".tls.trust-store-password`]## - -[.description] --- -The password of the truststore file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-cert-alias]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-cert-alias[`quarkus.oidc-client."id".tls.trust-store-cert-alias`]## - -[.description] --- -The alias of the truststore certificate. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_CERT_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_CERT_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-file-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-file-type[`quarkus.oidc-client."id".tls.trust-store-file-type`]## - -[.description] --- -The type of the truststore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-provider]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-provider[`quarkus.oidc-client."id".tls.trust-store-provider`]## - -[.description] --- -The provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a| [[quarkus-oidc-client_quarkus-oidc-client-id-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-id[`quarkus.oidc-client."id".id`]## [.description] @@ -2075,7 +1759,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-refresh-token-time-skew]] [.prop [.description] -- -Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen. +Refresh token time skew. If this property is enabled then the configured duration is converted to seconds and is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen. ifdef::add-copy-button-to-env-var[] @@ -2085,7 +1769,24 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__REFRESH_TOKEN_TIME_SKEW+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc-client_quarkus-oidc-client-id-access-token-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-access-token-expires-in[`quarkus.oidc-client."id".access-token-expires-in`]## + +[.description] +-- +Access token expiration period relative to the current time. This property is only checked when an access token grant response does not include an access token expiration property. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__ACCESS_TOKEN_EXPIRES_IN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__ACCESS_TOKEN_EXPIRES_IN+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc-client_quarkus-oidc-client-id-absolute-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-absolute-expires-in[`quarkus.oidc-client."id".absolute-expires-in`]## @@ -2263,5 +1964,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-oidc-client_quarkus.oidc-client.adoc b/_generated-doc/latest/config/quarkus-oidc-client_quarkus.oidc-client.adoc index 9892e826c41..7c657a0dafb 100644 --- a/_generated-doc/latest/config/quarkus-oidc-client_quarkus.oidc-client.adoc +++ b/_generated-doc/latest/config/quarkus-oidc-client_quarkus.oidc-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-oidc-client_quarkus-oidc-client [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -29,7 +28,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-auth-server-url]] [.property-path]# [.description] -- -The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. ifdef::add-copy-button-to-env-var[] @@ -59,157 +58,264 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a| [[quarkus-oidc-client_quarkus-oidc-client-token-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-token-path[`quarkus.oidc-client.token-path`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-registration-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-registration-path[`quarkus.oidc-client.registration-path`]## [.description] -- -The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TOKEN_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TOKEN_PATH+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REGISTRATION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-revoke-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-revoke-path[`quarkus.oidc-client.revoke-path`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-connection-delay]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-delay[`quarkus.oidc-client.connection-delay`]## [.description] -- -The relative path or absolute URL of the OIDC token revocation endpoint. +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REVOKE_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_REVOKE_PATH+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc-client_quarkus-oidc-client-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-retry-count[`quarkus.oidc-client.connection-retry-count`]## + +[.description] +-- +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +a| [[quarkus-oidc-client_quarkus-oidc-client-connection-timeout]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-timeout[`quarkus.oidc-client.connection-timeout`]## + +[.description] +-- +The number of seconds after which the current OIDC connection request times out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-oidc-client_quarkus-oidc-client-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-use-blocking-dns-lookup[`quarkus.oidc-client.use-blocking-dns-lookup`]## + +[.description] +-- +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc-client_quarkus-oidc-client-max-pool-size]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-max-pool-size[`quarkus.oidc-client.max-pool-size`]## + +[.description] +-- +The maximum size of the connection pool used by the WebClient. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-host]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-host[`quarkus.oidc-client.proxy.host`]## + +[.description] +-- +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_HOST+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-id[`quarkus.oidc-client.client-id`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-port]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-port[`quarkus.oidc-client.proxy.port`]## [.description] -- -The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. +The port number of the Proxy. The default value is `80`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_ID+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`80` + +a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-username]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-username[`quarkus.oidc-client.proxy.username`]## + +[.description] +-- +The username, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-client-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-name[`quarkus.oidc-client.client-name`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-password[`quarkus.oidc-client.proxy.password`]## [.description] -- -The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. +The password, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_NAME+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-connection-delay]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-delay[`quarkus.oidc-client.connection-delay`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-tls-configuration-name[`quarkus.oidc-client.tls.tls-configuration-name`]## [.description] -- -The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_DELAY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|string | -a| [[quarkus-oidc-client_quarkus-oidc-client-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-retry-count[`quarkus.oidc-client.connection-retry-count`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-token-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-token-path[`quarkus.oidc-client.token-path`]## [.description] -- -The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. +The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TOKEN_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_TOKEN_PATH+++` endif::add-copy-button-to-env-var[] -- -|int -|`3` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-connection-timeout]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-connection-timeout[`quarkus.oidc-client.connection-timeout`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-revoke-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-revoke-path[`quarkus.oidc-client.revoke-path`]## [.description] -- -The number of seconds after which the current OIDC connection request times out. +The relative path or absolute URL of the OIDC token revocation endpoint. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REVOKE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REVOKE_PATH+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-use-blocking-dns-lookup[`quarkus.oidc-client.use-blocking-dns-lookup`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-id[`quarkus.oidc-client.client-id`]## [.description] -- -Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. +The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_ID+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-max-pool-size]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-max-pool-size[`quarkus.oidc-client.max-pool-size`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-client-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-name[`quarkus.oidc-client.client-name`]## [.description] -- -The maximum size of the connection pool used by the WebClient. +The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-secret]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-credentials-secret[`quarkus.oidc-client.credentials.secret`]## @@ -335,7 +441,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-jwt-secret]] [.property [.description] -- -If provided, indicates that JWT is signed using a secret key. +If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. ifdef::add-copy-button-to-env-var[] @@ -403,7 +509,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-jwt-key]] [.property-pa [.description] -- -String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -420,7 +526,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-jwt-key-file]] [.proper [.description] -- -If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -437,7 +543,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-credentials-jwt-key-store-file]] [. [.description] -- -If provided, indicates that JWT is signed using a private key from a keystore. +If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. ifdef::add-copy-button-to-env-var[] @@ -637,538 +743,474 @@ endif::add-copy-button-to-env-var[] |boolean |`false` -a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-host]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-host[`quarkus.oidc-client.proxy.host`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id[`quarkus.oidc-client.id`]## [.description] -- -The host name or IP address of the Proxy. + -Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. +A unique OIDC client identifier. It must be set when OIDC clients are created dynamically and is optional in all other cases. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_HOST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_HOST+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_ID+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-port]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-port[`quarkus.oidc-client.proxy.port`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-client-enabled]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-enabled[`quarkus.oidc-client.client-enabled`]## [.description] -- -The port number of the Proxy. The default value is `80`. +If this client configuration is enabled. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_PORT+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|int -|`80` +|boolean +|`true` -a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-username]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-username[`quarkus.oidc-client.proxy.username`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-scopes]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-scopes[`quarkus.oidc-client.scopes`]## [.description] -- -The username, if the Proxy needs authentication. +List of access token scopes ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_USERNAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_SCOPES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_USERNAME+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_SCOPES+++` endif::add-copy-button-to-env-var[] -- -|string +|list of string | -a| [[quarkus-oidc-client_quarkus-oidc-client-proxy-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-proxy-password[`quarkus.oidc-client.proxy.password`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-refresh-token-time-skew]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-refresh-token-time-skew[`quarkus.oidc-client.refresh-token-time-skew`]## [.description] -- -The password, if the Proxy needs authentication. +Refresh token time skew. If this property is enabled then the configured duration is converted to seconds and is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_PROXY_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REFRESH_TOKEN_TIME_SKEW+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_PROXY_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_REFRESH_TOKEN_TIME_SKEW+++` endif::add-copy-button-to-env-var[] -- -|string +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] | -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-verification]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-verification[`quarkus.oidc-client.tls.verification`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-access-token-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-access-token-expires-in[`quarkus.oidc-client.access-token-expires-in`]## [.description] -- -Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is `required`. +Access token expiration period relative to the current time. This property is only checked when an access token grant response does not include an access token expiration property. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_VERIFICATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ACCESS_TOKEN_EXPIRES_IN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_VERIFICATION+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_ACCESS_TOKEN_EXPIRES_IN+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.], tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.], tooltip:none[All certificates are trusted and hostname verification is disabled.] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] | -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-file]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-file[`quarkus.oidc-client.tls.key-store-file`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-absolute-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-absolute-expires-in[`quarkus.oidc-client.absolute-expires-in`]## [.description] -- -An optional keystore that holds the certificate information instead of specifying separate files. +If the access token 'expires_in' property should be checked as an absolute time value as opposed to a duration relative to the current time. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_FILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ABSOLUTE_EXPIRES_IN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_FILE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_ABSOLUTE_EXPIRES_IN+++` endif::add-copy-button-to-env-var[] -- -|path -| +|boolean +|`false` -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-file-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-file-type[`quarkus.oidc-client.tls.key-store-file-type`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-grant-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-type[`quarkus.oidc-client.grant.type`]## [.description] -- -The type of the keystore file. If not given, the type is automatically detected based on the file name. +Grant type ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_FILE_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_FILE_TYPE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_TYPE+++` endif::add-copy-button-to-env-var[] -- -|string -| +a|tooltip:client['client_credentials' grant requiring an OIDC client authentication only], tooltip:password['password' grant requiring both OIDC client and user ('username' and 'password') authentications], tooltip:code['authorization_code' grant requiring an OIDC client authentication as well as at least 'code' and 'redirect_uri' parameters which must be passed to OidcClient at the token request time.], tooltip:exchange['urn\:ietf\:params\:oauth\:grant-type\:token-exchange' grant requiring an OIDC client authentication as well as at least 'subject_token' parameter which must be passed to OidcClient at the token request time.], tooltip:jwt['urn\:ietf\:params\:oauth\:grant-type\:jwt-bearer' grant requiring an OIDC client authentication as well as at least an 'assertion' parameter which must be passed to OidcClient at the token request time.], tooltip:refresh['refresh_token' grant requiring an OIDC client authentication and a refresh token. Note, OidcClient supports this grant by default if an access token acquisition response contained a refresh token. However, in some cases, the refresh token is provided out of band, for example, it can be shared between several of the confidential client's services, etc. If 'quarkus.oidc-client.grant-type' is set to 'refresh' then `OidcClient` will only support refreshing the tokens.], tooltip:ciba['urn\:openid\:params\:grant-type\:ciba' grant requiring an OIDC client authentication as well as 'auth_req_id' parameter which must be passed to OidcClient at the token request time.], tooltip:device['urn\:ietf\:params\:oauth\:grant-type\:device_code' grant requiring an OIDC client authentication as well as 'device_code' parameter which must be passed to OidcClient at the token request time.] +|tooltip:client['client_credentials' grant requiring an OIDC client authentication only] -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-provider]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-provider[`quarkus.oidc-client.tls.key-store-provider`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-grant-access-token-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-access-token-property[`quarkus.oidc-client.grant.access-token-property`]## [.description] -- -The provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type. +Access token property name in a token grant response ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_PROVIDER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_ACCESS_TOKEN_PROPERTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_PROVIDER+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_ACCESS_TOKEN_PROPERTY+++` endif::add-copy-button-to-env-var[] -- |string -| +|`access_token` -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-password[`quarkus.oidc-client.tls.key-store-password`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-grant-refresh-token-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-refresh-token-property[`quarkus.oidc-client.grant.refresh-token-property`]## [.description] -- -The password of the keystore file. If not given, the default value, `password`, is used. +Refresh token property name in a token grant response ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_TOKEN_PROPERTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_TOKEN_PROPERTY+++` endif::add-copy-button-to-env-var[] -- |string -| +|`refresh_token` -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-key-alias]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-key-alias[`quarkus.oidc-client.tls.key-store-key-alias`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-grant-expires-in-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-expires-in-property[`quarkus.oidc-client.grant.expires-in-property`]## [.description] -- -The alias of a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined. +Access token expiry property name in a token grant response ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_KEY_ALIAS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_EXPIRES_IN_PROPERTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_KEY_ALIAS+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_EXPIRES_IN_PROPERTY+++` endif::add-copy-button-to-env-var[] -- |string -| +|`expires_in` -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-key-store-key-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-key-store-key-password[`quarkus.oidc-client.tls.key-store-key-password`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-grant-refresh-expires-in-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-refresh-expires-in-property[`quarkus.oidc-client.grant.refresh-expires-in-property`]## [.description] -- -The password of the key, if it is different from the `key-store-password`. +Refresh token expiry property name in a token grant response ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_KEY_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_EXPIRES_IN_PROPERTY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_KEY_STORE_KEY_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_EXPIRES_IN_PROPERTY+++` endif::add-copy-button-to-env-var[] -- |string -| +|`refresh_expires_in` -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-file]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-file[`quarkus.oidc-client.tls.trust-store-file`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-grant-options-grant-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-options-grant-name[`quarkus.oidc-client.grant-options."grant-name"`]## [.description] -- -The truststore that holds the certificate information of the certificates to trust. +Grant options ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_FILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_OPTIONS__GRANT_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_FILE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_OPTIONS__GRANT_NAME_+++` endif::add-copy-button-to-env-var[] -- -|path +|Map> | -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-password[`quarkus.oidc-client.tls.trust-store-password`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-early-tokens-acquisition]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-early-tokens-acquisition[`quarkus.oidc-client.early-tokens-acquisition`]## [.description] -- -The password of the truststore file. +Requires that all filters which use 'OidcClient' acquire the tokens at the post-construct initialization time, possibly long before these tokens are used. This property should be disabled if the access token may expire before it is used for the first time and no refresh token is available. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_EARLY_TOKENS_ACQUISITION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_EARLY_TOKENS_ACQUISITION+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`true` -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-cert-alias]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-cert-alias[`quarkus.oidc-client.tls.trust-store-cert-alias`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-headers-headers]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-headers-headers[`quarkus.oidc-client.headers."headers"`]## [.description] -- -The alias of the truststore certificate. +Custom HTTP headers which have to be sent to the token endpoint ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_CERT_ALIAS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_HEADERS__HEADERS_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_CERT_ALIAS+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_HEADERS__HEADERS_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-file-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-file-type[`quarkus.oidc-client.tls.trust-store-file-type`]## +h|[[quarkus-oidc-client_section_quarkus-oidc-client]] [.section-name.section-level0]##link:#quarkus-oidc-client_section_quarkus-oidc-client[Additional named clients]## +h|Type +h|Default + +a| [[quarkus-oidc-client_quarkus-oidc-client-id-auth-server-url]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-auth-server-url[`quarkus.oidc-client."id".auth-server-url`]## [.description] -- -The type of the truststore file. If not given, the type is automatically detected based on the file name. +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_FILE_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__AUTH_SERVER_URL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_FILE_TYPE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__AUTH_SERVER_URL+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-provider]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-tls-trust-store-provider[`quarkus.oidc-client.tls.trust-store-provider`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-discovery-enabled]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-discovery-enabled[`quarkus.oidc-client."id".discovery-enabled`]## [.description] -- -The provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type. +Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_PROVIDER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__DISCOVERY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_TLS_TRUST_STORE_PROVIDER+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__DISCOVERY_ENABLED+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`true` -a| [[quarkus-oidc-client_quarkus-oidc-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id[`quarkus.oidc-client.id`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-registration-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-registration-path[`quarkus.oidc-client."id".registration-path`]## [.description] -- -A unique OIDC client identifier. It must be set when OIDC clients are created dynamically and is optional in all other cases. +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__REGISTRATION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_ID+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__REGISTRATION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-client-enabled]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-client-enabled[`quarkus.oidc-client.client-enabled`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-delay]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-delay[`quarkus.oidc-client."id".connection-delay`]## [.description] -- -If this client configuration is enabled. +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_CLIENT_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_CLIENT_ENABLED+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_DELAY+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`true` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] +| -a| [[quarkus-oidc-client_quarkus-oidc-client-scopes]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-scopes[`quarkus.oidc-client.scopes`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-retry-count[`quarkus.oidc-client."id".connection-retry-count`]## [.description] -- -List of access token scopes +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_SCOPES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_RETRY_COUNT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_SCOPES+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_RETRY_COUNT+++` endif::add-copy-button-to-env-var[] -- -|list of string -| +|int +|`3` -a| [[quarkus-oidc-client_quarkus-oidc-client-refresh-token-time-skew]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-refresh-token-time-skew[`quarkus.oidc-client.refresh-token-time-skew`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-timeout]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-timeout[`quarkus.oidc-client."id".connection-timeout`]## [.description] -- -Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen. +The number of seconds after which the current OIDC connection request times out. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REFRESH_TOKEN_TIME_SKEW+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_REFRESH_TOKEN_TIME_SKEW+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] +|`10S` -a| [[quarkus-oidc-client_quarkus-oidc-client-absolute-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-absolute-expires-in[`quarkus.oidc-client.absolute-expires-in`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-use-blocking-dns-lookup[`quarkus.oidc-client."id".use-blocking-dns-lookup`]## [.description] -- -If the access token 'expires_in' property should be checked as an absolute time value as opposed to a duration relative to the current time. +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ABSOLUTE_EXPIRES_IN+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__USE_BLOCKING_DNS_LOOKUP+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_ABSOLUTE_EXPIRES_IN+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__USE_BLOCKING_DNS_LOOKUP+++` endif::add-copy-button-to-env-var[] -- |boolean |`false` -a| [[quarkus-oidc-client_quarkus-oidc-client-grant-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-type[`quarkus.oidc-client.grant.type`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-max-pool-size]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-max-pool-size[`quarkus.oidc-client."id".max-pool-size`]## [.description] -- -Grant type +The maximum size of the connection pool used by the WebClient. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__MAX_POOL_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_TYPE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__MAX_POOL_SIZE+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:client['client_credentials' grant requiring an OIDC client authentication only], tooltip:password['password' grant requiring both OIDC client and user ('username' and 'password') authentications], tooltip:code['authorization_code' grant requiring an OIDC client authentication as well as at least 'code' and 'redirect_uri' parameters which must be passed to OidcClient at the token request time.], tooltip:exchange['urn\:ietf\:params\:oauth\:grant-type\:token-exchange' grant requiring an OIDC client authentication as well as at least 'subject_token' parameter which must be passed to OidcClient at the token request time.], tooltip:jwt['urn\:ietf\:params\:oauth\:grant-type\:jwt-bearer' grant requiring an OIDC client authentication as well as at least an 'assertion' parameter which must be passed to OidcClient at the token request time.], tooltip:refresh['refresh_token' grant requiring an OIDC client authentication and a refresh token. Note, OidcClient supports this grant by default if an access token acquisition response contained a refresh token. However, in some cases, the refresh token is provided out of band, for example, it can be shared between several of the confidential client's services, etc. If 'quarkus.oidc-client.grant-type' is set to 'refresh' then `OidcClient` will only support refreshing the tokens.], tooltip:ciba['urn\:openid\:params\:grant-type\:ciba' grant requiring an OIDC client authentication as well as 'auth_req_id' parameter which must be passed to OidcClient at the token request time.], tooltip:device['urn\:ietf\:params\:oauth\:grant-type\:device_code' grant requiring an OIDC client authentication as well as 'device_code' parameter which must be passed to OidcClient at the token request time.] -|tooltip:client['client_credentials' grant requiring an OIDC client authentication only] +|int +| -a| [[quarkus-oidc-client_quarkus-oidc-client-grant-access-token-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-access-token-property[`quarkus.oidc-client.grant.access-token-property`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-host]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-host[`quarkus.oidc-client."id".proxy.host`]## [.description] -- -Access token property name in a token grant response +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_ACCESS_TOKEN_PROPERTY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_ACCESS_TOKEN_PROPERTY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_HOST+++` endif::add-copy-button-to-env-var[] -- |string -|`access_token` +| -a| [[quarkus-oidc-client_quarkus-oidc-client-grant-refresh-token-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-refresh-token-property[`quarkus.oidc-client.grant.refresh-token-property`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-port]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-port[`quarkus.oidc-client."id".proxy.port`]## [.description] -- -Refresh token property name in a token grant response +The port number of the Proxy. The default value is `80`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_TOKEN_PROPERTY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_TOKEN_PROPERTY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_PORT+++` endif::add-copy-button-to-env-var[] -- -|string -|`refresh_token` +|int +|`80` -a| [[quarkus-oidc-client_quarkus-oidc-client-grant-expires-in-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-expires-in-property[`quarkus.oidc-client.grant.expires-in-property`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-username]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-username[`quarkus.oidc-client."id".proxy.username`]## [.description] -- -Access token expiry property name in a token grant response +The username, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_EXPIRES_IN_PROPERTY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_EXPIRES_IN_PROPERTY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] -- |string -|`expires_in` +| -a| [[quarkus-oidc-client_quarkus-oidc-client-grant-refresh-expires-in-property]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-refresh-expires-in-property[`quarkus.oidc-client.grant.refresh-expires-in-property`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-password[`quarkus.oidc-client."id".proxy.password`]## [.description] -- -Refresh token expiry property name in a token grant response +The password, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_EXPIRES_IN_PROPERTY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_REFRESH_EXPIRES_IN_PROPERTY+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string -|`refresh_expires_in` - -a| [[quarkus-oidc-client_quarkus-oidc-client-grant-options-grant-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-grant-options-grant-name[`quarkus.oidc-client.grant-options."grant-name"`]## - -[.description] --- -Grant options - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_GRANT_OPTIONS__GRANT_NAME_+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_GRANT_OPTIONS__GRANT_NAME_+++` -endif::add-copy-button-to-env-var[] --- -|Map> | -a| [[quarkus-oidc-client_quarkus-oidc-client-early-tokens-acquisition]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-early-tokens-acquisition[`quarkus.oidc-client.early-tokens-acquisition`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-tls-configuration-name[`quarkus.oidc-client."id".tls.tls-configuration-name`]## [.description] -- -Requires that all filters which use 'OidcClient' acquire the tokens at the post-construct initialization time, possibly long before these tokens are used. This property should be disabled if the access token may expire before it is used for the first time and no refresh token is available. +The name of the TLS configuration to use. +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_EARLY_TOKENS_ACQUISITION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_EARLY_TOKENS_ACQUISITION+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` - -a| [[quarkus-oidc-client_quarkus-oidc-client-headers-headers]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-headers-headers[`quarkus.oidc-client.headers."headers"`]## - -[.description] --- -Custom HTTP headers which have to be sent to the token endpoint +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_HEADERS__HEADERS_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_HEADERS__HEADERS_+++` -endif::add-copy-button-to-env-var[] --- -|Map -| - -h|[[quarkus-oidc-client_section_quarkus-oidc-client]] [.section-name.section-level0]##link:#quarkus-oidc-client_section_quarkus-oidc-client[Additional named clients]## -h|Type -h|Default - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-auth-server-url]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-auth-server-url[`quarkus.oidc-client."id".auth-server-url`]## - -[.description] --- -The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__AUTH_SERVER_URL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__AUTH_SERVER_URL+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-id-discovery-enabled]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-discovery-enabled[`quarkus.oidc-client."id".discovery-enabled`]## - -[.description] --- -Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__DISCOVERY_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__DISCOVERY_ENABLED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` - a| [[quarkus-oidc-client_quarkus-oidc-client-id-token-path]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-token-path[`quarkus.oidc-client."id".token-path`]## [.description] @@ -1203,123 +1245,38 @@ endif::add-copy-button-to-env-var[] |string | -a| [[quarkus-oidc-client_quarkus-oidc-client-id-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-client-id[`quarkus.oidc-client."id".client-id`]## - -[.description] --- -The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CLIENT_ID+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CLIENT_ID+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-client-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-client-name[`quarkus.oidc-client."id".client-name`]## - -[.description] --- -The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CLIENT_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CLIENT_NAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-delay]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-delay[`quarkus.oidc-client."id".connection-delay`]## - -[.description] --- -The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_DELAY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_DELAY+++` -endif::add-copy-button-to-env-var[] --- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-retry-count]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-retry-count[`quarkus.oidc-client."id".connection-retry-count`]## - -[.description] --- -The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_RETRY_COUNT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_RETRY_COUNT+++` -endif::add-copy-button-to-env-var[] --- -|int -|`3` - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-connection-timeout]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-connection-timeout[`quarkus.oidc-client."id".connection-timeout`]## - -[.description] --- -The number of seconds after which the current OIDC connection request times out. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CONNECTION_TIMEOUT+++` -endif::add-copy-button-to-env-var[] --- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-use-blocking-dns-lookup[`quarkus.oidc-client."id".use-blocking-dns-lookup`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-client-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-client-id[`quarkus.oidc-client."id".client-id`]## [.description] -- -Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. +The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__USE_BLOCKING_DNS_LOOKUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CLIENT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__USE_BLOCKING_DNS_LOOKUP+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CLIENT_ID+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-oidc-client_quarkus-oidc-client-id-max-pool-size]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-max-pool-size[`quarkus.oidc-client."id".max-pool-size`]## +a| [[quarkus-oidc-client_quarkus-oidc-client-id-client-name]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-client-name[`quarkus.oidc-client."id".client-name`]## [.description] -- -The maximum size of the connection pool used by the WebClient. +The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__MAX_POOL_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__CLIENT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__MAX_POOL_SIZE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__CLIENT_NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-secret]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-credentials-secret[`quarkus.oidc-client."id".credentials.secret`]## @@ -1445,7 +1402,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-jwt-secret]] [.prope [.description] -- -If provided, indicates that JWT is signed using a secret key. +If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. ifdef::add-copy-button-to-env-var[] @@ -1513,7 +1470,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-jwt-key]] [.property [.description] -- -String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -1530,7 +1487,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-jwt-key-file]] [.pro [.description] -- -If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -1547,7 +1504,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-credentials-jwt-key-store-file]] [.description] -- -If provided, indicates that JWT is signed using a private key from a keystore. +If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. ifdef::add-copy-button-to-env-var[] @@ -1747,279 +1704,6 @@ endif::add-copy-button-to-env-var[] |boolean |`false` -a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-host]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-host[`quarkus.oidc-client."id".proxy.host`]## - -[.description] --- -The host name or IP address of the Proxy. + -Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_HOST+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_HOST+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-port]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-port[`quarkus.oidc-client."id".proxy.port`]## - -[.description] --- -The port number of the Proxy. The default value is `80`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_PORT+++` -endif::add-copy-button-to-env-var[] --- -|int -|`80` - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-username]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-username[`quarkus.oidc-client."id".proxy.username`]## - -[.description] --- -The username, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_USERNAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-proxy-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-proxy-password[`quarkus.oidc-client."id".proxy.password`]## - -[.description] --- -The password, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__PROXY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__PROXY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-verification]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-verification[`quarkus.oidc-client."id".tls.verification`]## - -[.description] --- -Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is `required`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_VERIFICATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_VERIFICATION+++` -endif::add-copy-button-to-env-var[] --- -a|tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.], tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.], tooltip:none[All certificates are trusted and hostname verification is disabled.] -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-file]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-file[`quarkus.oidc-client."id".tls.key-store-file`]## - -[.description] --- -An optional keystore that holds the certificate information instead of specifying separate files. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-file-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-file-type[`quarkus.oidc-client."id".tls.key-store-file-type`]## - -[.description] --- -The type of the keystore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-provider]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-provider[`quarkus.oidc-client."id".tls.key-store-provider`]## - -[.description] --- -The provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-password[`quarkus.oidc-client."id".tls.key-store-password`]## - -[.description] --- -The password of the keystore file. If not given, the default value, `password`, is used. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-key-alias]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-key-alias[`quarkus.oidc-client."id".tls.key-store-key-alias`]## - -[.description] --- -The alias of a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_KEY_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_KEY_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-key-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-key-store-key-password[`quarkus.oidc-client."id".tls.key-store-key-password`]## - -[.description] --- -The password of the key, if it is different from the `key-store-password`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_KEY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_KEY_STORE_KEY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-file]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-file[`quarkus.oidc-client."id".tls.trust-store-file`]## - -[.description] --- -The truststore that holds the certificate information of the certificates to trust. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-password]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-password[`quarkus.oidc-client."id".tls.trust-store-password`]## - -[.description] --- -The password of the truststore file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-cert-alias]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-cert-alias[`quarkus.oidc-client."id".tls.trust-store-cert-alias`]## - -[.description] --- -The alias of the truststore certificate. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_CERT_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_CERT_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-file-type]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-file-type[`quarkus.oidc-client."id".tls.trust-store-file-type`]## - -[.description] --- -The type of the truststore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-provider]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-tls-trust-store-provider[`quarkus.oidc-client."id".tls.trust-store-provider`]## - -[.description] --- -The provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__TLS_TRUST_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a| [[quarkus-oidc-client_quarkus-oidc-client-id-id]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-id[`quarkus.oidc-client."id".id`]## [.description] @@ -2075,7 +1759,7 @@ a| [[quarkus-oidc-client_quarkus-oidc-client-id-refresh-token-time-skew]] [.prop [.description] -- -Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen. +Refresh token time skew. If this property is enabled then the configured duration is converted to seconds and is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen. ifdef::add-copy-button-to-env-var[] @@ -2085,7 +1769,24 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__REFRESH_TOKEN_TIME_SKEW+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc-client_quarkus-oidc-client-id-access-token-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-access-token-expires-in[`quarkus.oidc-client."id".access-token-expires-in`]## + +[.description] +-- +Access token expiration period relative to the current time. This property is only checked when an access token grant response does not include an access token expiration property. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT__ID__ACCESS_TOKEN_EXPIRES_IN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT__ID__ACCESS_TOKEN_EXPIRES_IN+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-client_quarkus-oidc-client[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc-client_quarkus-oidc-client-id-absolute-expires-in]] [.property-path]##link:#quarkus-oidc-client_quarkus-oidc-client-id-absolute-expires-in[`quarkus.oidc-client."id".absolute-expires-in`]## @@ -2263,5 +1964,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-oidc-db-token-state-manager.adoc b/_generated-doc/latest/config/quarkus-oidc-db-token-state-manager.adoc index ae73f1a236f..5c64d6956e7 100644 --- a/_generated-doc/latest/config/quarkus-oidc-db-token-state-manager.adoc +++ b/_generated-doc/latest/config/quarkus-oidc-db-token-state-manager.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-oidc-db-token-state-manager_quarkus-oidc [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -39,7 +38,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_DB_TOKEN_STATE_MANAGER_DELETE_EXPIRED_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-db-token-state-manager_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`8H` a| [[quarkus-oidc-db-token-state-manager_quarkus-oidc-db-token-state-manager-create-database-table-if-not-exists]] [.property-path]##link:#quarkus-oidc-db-token-state-manager_quarkus-oidc-db-token-state-manager-create-database-table-if-not-exists[`quarkus.oidc.db-token-state-manager.create-database-table-if-not-exists`]## @@ -80,5 +79,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-oidc-db-token-state-manager_quarkus.oidc.adoc b/_generated-doc/latest/config/quarkus-oidc-db-token-state-manager_quarkus.oidc.adoc index ae73f1a236f..5c64d6956e7 100644 --- a/_generated-doc/latest/config/quarkus-oidc-db-token-state-manager_quarkus.oidc.adoc +++ b/_generated-doc/latest/config/quarkus-oidc-db-token-state-manager_quarkus.oidc.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-oidc-db-token-state-manager_quarkus-oidc [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -39,7 +38,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_DB_TOKEN_STATE_MANAGER_DELETE_EXPIRED_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc-db-token-state-manager_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`8H` a| [[quarkus-oidc-db-token-state-manager_quarkus-oidc-db-token-state-manager-create-database-table-if-not-exists]] [.property-path]##link:#quarkus-oidc-db-token-state-manager_quarkus-oidc-db-token-state-manager-create-database-table-if-not-exists[`quarkus.oidc.db-token-state-manager.create-database-table-if-not-exists`]## @@ -80,5 +79,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-oidc.adoc b/_generated-doc/latest/config/quarkus-oidc.adoc new file mode 100644 index 00000000000..38cc9c06e6a --- /dev/null +++ b/_generated-doc/latest/config/quarkus-oidc.adoc @@ -0,0 +1,5038 @@ +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-enabled[`quarkus.oidc.enabled`]## + +[.description] +-- +If the OIDC extension is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-devui-grant-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-devui-grant-type[`quarkus.oidc.devui.grant.type`]## + +[.description] +-- +Grant type which will be used to acquire a token to test the OIDC 'service' applications + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVUI_GRANT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_DEVUI_GRANT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|tooltip:client['client_credentials' grant], tooltip:password['password' grant], tooltip:code['authorization_code' grant], tooltip:implicit['implicit' grant] +| + +a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-devui-grant-options-option-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-devui-grant-options-option-name[`quarkus.oidc.devui.grant-options."option-name"`]## + +[.description] +-- +Grant options + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVUI_GRANT_OPTIONS__OPTION_NAME_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_DEVUI_GRANT_OPTIONS__OPTION_NAME_+++` +endif::add-copy-button-to-env-var[] +-- +|Map> +| + +a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-devui-web-client-timeout]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-devui-web-client-timeout[`quarkus.oidc.devui.web-client-timeout`]## + +[.description] +-- +The WebClient timeout. Use this property to configure how long an HTTP client used by Dev UI handlers will wait for a response when requesting tokens from OpenId Connect Provider and sending them to the service endpoint. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVUI_WEB_CLIENT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_DEVUI_WEB_CLIENT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`4S` + +a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-default-token-cache-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-default-token-cache-enabled[`quarkus.oidc.default-token-cache-enabled`]## + +[.description] +-- +Enable the registration of the Default TokenIntrospection and UserInfo Cache implementation bean. Note: This only enables the default implementation. It requires configuration to be activated. See `OidcConfig++#++tokenCache`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEFAULT_TOKEN_CACHE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_DEFAULT_TOKEN_CACHE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-auth-server-url]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-auth-server-url[`quarkus.oidc.auth-server-url`]## + +[.description] +-- +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTH_SERVER_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTH_SERVER_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-discovery-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-discovery-enabled[`quarkus.oidc.discovery-enabled`]## + +[.description] +-- +Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DISCOVERY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_DISCOVERY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-registration-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-registration-path[`quarkus.oidc.registration-path`]## + +[.description] +-- +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_REGISTRATION_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_REGISTRATION_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-connection-delay]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-connection-delay[`quarkus.oidc.connection-delay`]## + +[.description] +-- +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CONNECTION_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CONNECTION_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc_quarkus-oidc-connection-retry-count]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-connection-retry-count[`quarkus.oidc.connection-retry-count`]## + +[.description] +-- +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CONNECTION_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CONNECTION_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +a| [[quarkus-oidc_quarkus-oidc-connection-timeout]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-connection-timeout[`quarkus.oidc.connection-timeout`]## + +[.description] +-- +The number of seconds after which the current OIDC connection request times out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-oidc_quarkus-oidc-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-use-blocking-dns-lookup[`quarkus.oidc.use-blocking-dns-lookup`]## + +[.description] +-- +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_USE_BLOCKING_DNS_LOOKUP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_USE_BLOCKING_DNS_LOOKUP+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-max-pool-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-max-pool-size[`quarkus.oidc.max-pool-size`]## + +[.description] +-- +The maximum size of the connection pool used by the WebClient. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_MAX_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_MAX_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc_quarkus-oidc-proxy-host]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-host[`quarkus.oidc.proxy.host`]## + +[.description] +-- +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_PROXY_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-proxy-port]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-port[`quarkus.oidc.proxy.port`]## + +[.description] +-- +The port number of the Proxy. The default value is `80`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`80` + +a| [[quarkus-oidc_quarkus-oidc-proxy-username]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-username[`quarkus.oidc.proxy.username`]## + +[.description] +-- +The username, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-proxy-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-password[`quarkus.oidc.proxy.password`]## + +[.description] +-- +The password, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-tls-configuration-name[`quarkus.oidc.tls.tls-configuration-name`]## + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TLS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-token-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-path[`quarkus.oidc.token-path`]## + +[.description] +-- +The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-revoke-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-revoke-path[`quarkus.oidc.revoke-path`]## + +[.description] +-- +The relative path or absolute URL of the OIDC token revocation endpoint. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_REVOKE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_REVOKE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-client-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-client-id[`quarkus.oidc.client-id`]## + +[.description] +-- +The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-client-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-client-name[`quarkus.oidc.client-name`]## + +[.description] +-- +The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-secret[`quarkus.oidc.credentials.secret`]## + +[.description] +-- +The client secret used by the `client_secret_basic` authentication method. Must be set unless a secret is set in `client-secret` or `jwt` client authentication is required. You can use `client-secret.value` instead, but both properties are mutually exclusive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_SECRET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_SECRET+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-value]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-value[`quarkus.oidc.credentials.client-secret.value`]## + +[.description] +-- +The client secret value. This value is ignored if `credentials.secret` is set. Must be set unless a secret is set in `client-secret` or `jwt` client authentication is required. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_VALUE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_VALUE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-name[`quarkus.oidc.credentials.client-secret.provider.name`]## + +[.description] +-- +The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-keyring-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-keyring-name[`quarkus.oidc.credentials.client-secret.provider.keyring-name`]## + +[.description] +-- +The CredentialsProvider keyring name. The keyring name is only required when the CredentialsProvider being used requires the keyring name to look up the secret, which is often the case when a CredentialsProvider is shared by multiple extensions to retrieve credentials from a more dynamic source like a vault instance or secret manager + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEYRING_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEYRING_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-key[`quarkus.oidc.credentials.client-secret.provider.key`]## + +[.description] +-- +The CredentialsProvider client secret key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-method]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-method[`quarkus.oidc.credentials.client-secret.method`]## + +[.description] +-- +The authentication method. If the `clientSecret.value` secret is set, this method is `basic` by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_METHOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_METHOD+++` +endif::add-copy-button-to-env-var[] +-- +a|tooltip:basic[`client_secret_basic` (default)\: The client id and secret are submitted with the HTTP Authorization Basic scheme.], tooltip:post[`client_secret_post`\: The client id and secret are submitted as the `client_id` and `client_secret` form parameters.], tooltip:post-jwt[`client_secret_jwt`\: The client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters.], tooltip:query[client id and secret are submitted as HTTP query parameters. This option is only supported by the OIDC extension.] +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-source]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-source[`quarkus.oidc.credentials.jwt.source`]## + +[.description] +-- +JWT token source: OIDC provider client or an existing JWT bearer token. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SOURCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SOURCE+++` +endif::add-copy-button-to-env-var[] +-- +a|`client`, `bearer` +|`client` + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-secret[`quarkus.oidc.credentials.jwt.secret`]## + +[.description] +-- +If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-name[`quarkus.oidc.credentials.jwt.secret-provider.name`]## + +[.description] +-- +The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-keyring-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-keyring-name[`quarkus.oidc.credentials.jwt.secret-provider.keyring-name`]## + +[.description] +-- +The CredentialsProvider keyring name. The keyring name is only required when the CredentialsProvider being used requires the keyring name to look up the secret, which is often the case when a CredentialsProvider is shared by multiple extensions to retrieve credentials from a more dynamic source like a vault instance or secret manager + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEYRING_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEYRING_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-key[`quarkus.oidc.credentials.jwt.secret-provider.key`]## + +[.description] +-- +The CredentialsProvider client secret key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key[`quarkus.oidc.credentials.jwt.key`]## + +[.description] +-- +String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-file[`quarkus.oidc.credentials.jwt.key-file`]## + +[.description] +-- +If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_FILE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_FILE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-store-file[`quarkus.oidc.credentials.jwt.key-store-file`]## + +[.description] +-- +If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_FILE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_FILE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-store-password[`quarkus.oidc.credentials.jwt.key-store-password`]## + +[.description] +-- +A parameter to specify the password of the keystore file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-id[`quarkus.oidc.credentials.jwt.key-id`]## + +[.description] +-- +The private key id or alias. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-password[`quarkus.oidc.credentials.jwt.key-password`]## + +[.description] +-- +The private key password. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-audience]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-audience[`quarkus.oidc.credentials.jwt.audience`]## + +[.description] +-- +The JWT audience (`aud`) claim value. By default, the audience is set to the address of the OpenId Connect Provider's token endpoint. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_AUDIENCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_AUDIENCE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-token-key-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-token-key-id[`quarkus.oidc.credentials.jwt.token-key-id`]## + +[.description] +-- +The key identifier of the signing key added as a JWT `kid` header. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_TOKEN_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_TOKEN_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-issuer]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-issuer[`quarkus.oidc.credentials.jwt.issuer`]## + +[.description] +-- +The issuer of the signing key added as a JWT `iss` claim. The default value is the client id. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_ISSUER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_ISSUER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-subject]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-subject[`quarkus.oidc.credentials.jwt.subject`]## + +[.description] +-- +Subject of the signing key added as a JWT `sub` claim The default value is the client id. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SUBJECT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SUBJECT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-claims-claim-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-claims-claim-name[`quarkus.oidc.credentials.jwt.claims."claim-name"`]## + +[.description] +-- +Additional claims. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_CLAIMS__CLAIM_NAME_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_CLAIMS__CLAIM_NAME_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-signature-algorithm]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-signature-algorithm[`quarkus.oidc.credentials.jwt.signature-algorithm`]## + +[.description] +-- +The signature algorithm used for the `key-file` property. Supported values: `RS256` (default), `RS384`, `RS512`, `PS256`, `PS384`, `PS512`, `ES256`, `ES384`, `ES512`, `HS256`, `HS384`, `HS512`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SIGNATURE_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SIGNATURE_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-lifespan]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-lifespan[`quarkus.oidc.credentials.jwt.lifespan`]## + +[.description] +-- +The JWT lifespan in seconds. This value is added to the time at which the JWT was issued to calculate the expiration time. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_LIFESPAN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_LIFESPAN+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10` + +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-assertion]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-assertion[`quarkus.oidc.credentials.jwt.assertion`]## + +[.description] +-- +If true then the client authentication token is a JWT bearer grant assertion. Instead of producing 'client_assertion' and 'client_assertion_type' form properties, only 'assertion' is produced. This option is only supported by the OIDC client extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_ASSERTION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_ASSERTION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-id[`quarkus.oidc.tenant-id`]## + +[.description] +-- +A unique tenant identifier. It can be set by `TenantConfigResolver` providers, which resolve the tenant configuration dynamically. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TENANT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TENANT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-enabled[`quarkus.oidc.tenant-enabled`]## + +[.description] +-- +If this tenant configuration is enabled. The default tenant is disabled if it is not configured but a `TenantConfigResolver` that resolves tenant configurations is registered, or named tenants are configured. In this case, you do not need to disable the default tenant. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TENANT_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TENANT_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-application-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-application-type[`quarkus.oidc.application-type`]## + +[.description] +-- +The application type, which can be one of the following `ApplicationType` values. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_APPLICATION_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_APPLICATION_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|tooltip:web-app[A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users.], tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.], tooltip:hybrid[A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method is used if the Authorization header is set and Authorization Code Flow - if not.] +|tooltip:service[A {@code SERVICE} is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.] + +a| [[quarkus-oidc_quarkus-oidc-authorization-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authorization-path[`quarkus.oidc.authorization-path`]## + +[.description] +-- +The relative path or absolute URL of the OpenID Connect (OIDC) authorization endpoint, which authenticates users. You must set this property for `web-app` applications if OIDC discovery is disabled. This property is ignored if OIDC discovery is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHORIZATION_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHORIZATION_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-user-info-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-user-info-path[`quarkus.oidc.user-info-path`]## + +[.description] +-- +The relative path or absolute URL of the OIDC UserInfo endpoint. You must set this property for `web-app` applications if OIDC discovery is disabled and the `authentication.user-info-required` property is enabled. This property is ignored if OIDC discovery is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_USER_INFO_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_USER_INFO_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-introspection-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-introspection-path[`quarkus.oidc.introspection-path`]## + +[.description] +-- +Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JSON Web Token (JWT) tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens must be verified or 2) JWT tokens must be verified while the cached JWK verification set with no matching JWK is being refreshed. This property is ignored if the discovery is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_INTROSPECTION_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_INTROSPECTION_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-jwks-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-jwks-path[`quarkus.oidc.jwks-path`]## + +[.description] +-- +Relative path or absolute URL of the OIDC JSON Web Key Set (JWKS) endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property is ignored if the discovery is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-end-session-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-end-session-path[`quarkus.oidc.end-session-path`]## + +[.description] +-- +Relative path or absolute URL of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the `web-app` applications is required. This property is ignored if the discovery is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_END_SESSION_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_END_SESSION_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-paths]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-paths[`quarkus.oidc.tenant-paths`]## + +[.description] +-- +The paths which must be secured by this tenant. Tenant with the most specific path wins. +Please see the xref:security-openid-connect-multitenancy.adoc#configure-tenant-paths[Configure tenant paths] +section of the OIDC multitenancy guide for explanation of allowed path patterns. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TENANT_PATHS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TENANT_PATHS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-oidc_quarkus-oidc-public-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-public-key[`quarkus.oidc.public-key`]## + +[.description] +-- +The public key for the local JWT token verification. OIDC server connection is not created when this property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PUBLIC_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_PUBLIC_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-introspection-credentials-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-introspection-credentials-name[`quarkus.oidc.introspection-credentials.name`]## + +[.description] +-- +Name + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-introspection-credentials-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-introspection-credentials-secret[`quarkus.oidc.introspection-credentials.secret`]## + +[.description] +-- +Secret + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_SECRET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_SECRET+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-introspection-credentials-include-client-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-introspection-credentials-include-client-id[`quarkus.oidc.introspection-credentials.include-client-id`]## + +[.description] +-- +Include OpenId Connect Client ID configured with `quarkus.oidc.client-id`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_INCLUDE_CLIENT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_INCLUDE_CLIENT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-roles-role-claim-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-roles-role-claim-path[`quarkus.oidc.roles.role-claim-path`]## + +[.description] +-- +A list of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments. Each segment represents a JSON object name only; for example: "realm/groups". Use double quotes with the namespace-qualified claim names. This property can be used if a token has no `groups` claim but has the groups set in one or more different claims. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_ROLES_ROLE_CLAIM_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_ROLES_ROLE_CLAIM_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-oidc_quarkus-oidc-roles-role-claim-separator]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-roles-role-claim-separator[`quarkus.oidc.roles.role-claim-separator`]## + +[.description] +-- +The separator for splitting strings that contain multiple group values. It is only used if the "role-claim-path" property points to one or more custom claims whose values are strings. A single space is used by default because the standard `scope` claim can contain a space-separated sequence. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_ROLES_ROLE_CLAIM_SEPARATOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_ROLES_ROLE_CLAIM_SEPARATOR+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-roles-source]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-roles-source[`quarkus.oidc.roles.source`]## + +[.description] +-- +Source of the principal roles. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_ROLES_SOURCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_ROLES_SOURCE+++` +endif::add-copy-button-to-env-var[] +-- +a|tooltip:idtoken[ID Token - the default value for the `web-app` applications.], tooltip:accesstoken[Access Token - the default value for the `service` applications; can also be used as the source of roles for the `web-app` applications.], tooltip:userinfo[User Info] +| + +a| [[quarkus-oidc_quarkus-oidc-token-issuer]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-issuer[`quarkus.oidc.token.issuer`]## + +[.description] +-- +The expected issuer `iss` claim value. This property overrides the `issuer` property, which might be set in OpenId Connect provider's well-known configuration. If the `iss` claim value varies depending on the host, IP address, or tenant id of the provider, you can skip the issuer verification by setting this property to `any`, but it should be done only when other options (such as configuring the provider to use the fixed `iss` claim value) are not possible. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_ISSUER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_ISSUER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-token-audience]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-audience[`quarkus.oidc.token.audience`]## + +[.description] +-- +The expected audience `aud` claim value, which can be a string or an array of strings. Note the audience claim is verified for ID tokens by default. ID token audience must be equal to the value of `quarkus.oidc.client-id` property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to `any` if your provider does not set ID token audience` claim. Audience verification for access tokens is only done if this property is configured. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_AUDIENCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_AUDIENCE+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-oidc_quarkus-oidc-token-subject-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-subject-required[`quarkus.oidc.token.subject-required`]## + +[.description] +-- +Require that the token includes a `sub` (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required, both the token and UserInfo `sub` claims must be present and match each other. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_SUBJECT_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_SUBJECT_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-token-required-claims-claim-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-required-claims-claim-name[`quarkus.oidc.token.required-claims."claim-name"`]## + +[.description] +-- +A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_REQUIRED_CLAIMS__CLAIM_NAME_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_REQUIRED_CLAIMS__CLAIM_NAME_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-oidc_quarkus-oidc-token-token-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-token-type[`quarkus.oidc.token.token-type`]## + +[.description] +-- +Expected token type + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_TOKEN_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_TOKEN_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-token-lifespan-grace]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-lifespan-grace[`quarkus.oidc.token.lifespan-grace`]## + +[.description] +-- +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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_LIFESPAN_GRACE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_LIFESPAN_GRACE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc_quarkus-oidc-token-age]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-age[`quarkus.oidc.token.age`]## + +[.description] +-- +Token age. It allows for the number of seconds to be specified that must not elapse since the `iat` (issued at) time. A small leeway to account for clock skew which can be configured with `quarkus.oidc.token.lifespan-grace` to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid (`exp`) expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an `exp` claim. However, even if the current logout token is allowed to have no `exp` claim, the `exp` claim is still verified if the logout token contains it. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_AGE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_AGE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc_quarkus-oidc-token-issued-at-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-issued-at-required[`quarkus.oidc.token.issued-at-required`]## + +[.description] +-- +Require that the token includes a `iat` (issued at) claim Set this property to `false` if your JWT token does not contain an `iat` (issued at) claim. Note that ID token is always required to have an `iat` claim and therefore this property has no impact on the ID token verification process. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_ISSUED_AT_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_ISSUED_AT_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-token-principal-claim]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-principal-claim[`quarkus.oidc.token.principal-claim`]## + +[.description] +-- +Name of the claim which contains a principal name. By default, the `upn`, `preferred_username` and `sub` claims are checked. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_PRINCIPAL_CLAIM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_PRINCIPAL_CLAIM+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-token-refresh-expired]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-refresh-expired[`quarkus.oidc.token.refresh-expired`]## + +[.description] +-- +Refresh expired authorization code flow ID or access tokens. If this property is enabled, a refresh token request is performed if the authorization code ID or access token has expired and, if successful, the local session is updated with the new set of tokens. Otherwise, the local session is invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case, the user might not be challenged again if the OIDC provider session is still active. For this option be effective the `authentication.session-age-extension` property should also be set to a nonzero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type `ApplicationType++#++WEB_APP`++}++. This property is enabled if `quarkus.oidc.token.refresh-token-time-skew` is configured, you do not need to enable this property manually in this case. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_REFRESH_EXPIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_REFRESH_EXPIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-token-refresh-token-time-skew]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-refresh-token-time-skew[`quarkus.oidc.token.refresh-token-time-skew`]## + +[.description] +-- +The refresh token time skew, in seconds. If this property is enabled, the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token's expiration time, a refresh is going to happen. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_REFRESH_TOKEN_TIME_SKEW+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_REFRESH_TOKEN_TIME_SKEW+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc_quarkus-oidc-token-forced-jwk-refresh-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-forced-jwk-refresh-interval[`quarkus.oidc.token.forced-jwk-refresh-interval`]## + +[.description] +-- +The forced JWK set refresh interval in minutes. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_FORCED_JWK_REFRESH_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_FORCED_JWK_REFRESH_INTERVAL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`10M` + +a| [[quarkus-oidc_quarkus-oidc-token-header]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-header[`quarkus.oidc.token.header`]## + +[.description] +-- +Custom HTTP header that contains a bearer token. This option is valid only when the application is of type `ApplicationType++#++SERVICE`++}++. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_HEADER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_HEADER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-token-authorization-scheme]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-authorization-scheme[`quarkus.oidc.token.authorization-scheme`]## + +[.description] +-- +HTTP Authorization header scheme. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_AUTHORIZATION_SCHEME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_AUTHORIZATION_SCHEME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`Bearer` + +a| [[quarkus-oidc_quarkus-oidc-token-signature-algorithm]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-signature-algorithm[`quarkus.oidc.token.signature-algorithm`]## + +[.description] +-- +Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_SIGNATURE_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_SIGNATURE_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +-- +a|`rs256`, `rs384`, `rs512`, `ps256`, `ps384`, `ps512`, `es256`, `es384`, `es512`, `eddsa` +| + +a| [[quarkus-oidc_quarkus-oidc-token-decryption-key-location]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-decryption-key-location[`quarkus.oidc.token.decryption-key-location`]## + +[.description] +-- +Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers might not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. If this property is not set and the `private_key_jwt` client authentication method is used, the private key used to sign the client authentication JWT tokens are also used to decrypt the encrypted ID tokens. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_DECRYPTION_KEY_LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_DECRYPTION_KEY_LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-token-allow-jwt-introspection]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-allow-jwt-introspection[`quarkus.oidc.token.allow-jwt-introspection`]## + +[.description] +-- +Allow the remote introspection of JWT tokens when no matching JWK key is available. This property is set to `true` by default for backward-compatibility reasons. It is planned that this default value will be changed to `false` in an upcoming release. Also note this property is ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_ALLOW_JWT_INTROSPECTION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_ALLOW_JWT_INTROSPECTION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-token-require-jwt-introspection-only]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-require-jwt-introspection-only[`quarkus.oidc.token.require-jwt-introspection-only`]## + +[.description] +-- +Require that JWT tokens are only introspected remotely. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_REQUIRE_JWT_INTROSPECTION_ONLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_REQUIRE_JWT_INTROSPECTION_ONLY+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-token-allow-opaque-token-introspection]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-allow-opaque-token-introspection[`quarkus.oidc.token.allow-opaque-token-introspection`]## + +[.description] +-- +Allow the remote introspection of the opaque tokens. Set this property to `false` if only JWT tokens are expected. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_ALLOW_OPAQUE_TOKEN_INTROSPECTION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_ALLOW_OPAQUE_TOKEN_INTROSPECTION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-token-customizer-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-customizer-name[`quarkus.oidc.token.customizer-name`]## + +[.description] +-- +Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using `TenantFeature` qualifier when registering custom `TokenCustomizer`. Use this property only to refer to `TokenCustomizer` implementations provided by this extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_CUSTOMIZER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_CUSTOMIZER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-token-verify-access-token-with-user-info]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-verify-access-token-with-user-info[`quarkus.oidc.token.verify-access-token-with-user-info`]## + +[.description] +-- +Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens must be accepted but OpenId Connect provider does not have a token introspection endpoint. This property has no effect when JWT tokens must be verified. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_VERIFY_ACCESS_TOKEN_WITH_USER_INFO+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_VERIFY_ACCESS_TOKEN_WITH_USER_INFO+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-logout-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-path[`quarkus.oidc.logout.path`]## + +[.description] +-- +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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_LOGOUT_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_LOGOUT_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-logout-post-logout-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-post-logout-path[`quarkus.oidc.logout.post-logout-path`]## + +[.description] +-- +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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_LOGOUT_POST_LOGOUT_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_LOGOUT_POST_LOGOUT_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-logout-post-logout-uri-param]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-post-logout-uri-param[`quarkus.oidc.logout.post-logout-uri-param`]## + +[.description] +-- +Name of the post logout URI parameter which is added as a query parameter to the logout redirect URI. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_LOGOUT_POST_LOGOUT_URI_PARAM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_LOGOUT_POST_LOGOUT_URI_PARAM+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`post_logout_redirect_uri` + +a| [[quarkus-oidc_quarkus-oidc-logout-extra-params-query-parameter-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-extra-params-query-parameter-name[`quarkus.oidc.logout.extra-params."query-parameter-name"`]## + +[.description] +-- +Additional properties which is added as the query parameters to the logout redirect URI. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_LOGOUT_EXTRA_PARAMS__QUERY_PARAMETER_NAME_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_LOGOUT_EXTRA_PARAMS__QUERY_PARAMETER_NAME_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-oidc_quarkus-oidc-logout-backchannel-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-backchannel-path[`quarkus.oidc.logout.backchannel.path`]## + +[.description] +-- +The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-logout-backchannel-token-cache-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-backchannel-token-cache-size[`quarkus.oidc.logout.backchannel.token-cache-size`]## + +[.description] +-- +Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_TOKEN_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_TOKEN_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10` + +a| [[quarkus-oidc_quarkus-oidc-logout-backchannel-token-cache-time-to-live]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-backchannel-token-cache-time-to-live[`quarkus.oidc.logout.backchannel.token-cache-time-to-live`]## + +[.description] +-- +Number of minutes a logout token can be cached for. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`10M` + +a| [[quarkus-oidc_quarkus-oidc-logout-backchannel-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-backchannel-clean-up-timer-interval[`quarkus.oidc.logout.backchannel.clean-up-timer-interval`]## + +[.description] +-- +Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc_quarkus-oidc-logout-backchannel-logout-token-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-backchannel-logout-token-key[`quarkus.oidc.logout.backchannel.logout-token-key`]## + +[.description] +-- +Logout token claim whose value is used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_LOGOUT_TOKEN_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_LOGOUT_TOKEN_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`sub` + +a| [[quarkus-oidc_quarkus-oidc-logout-frontchannel-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-frontchannel-path[`quarkus.oidc.logout.frontchannel.path`]## + +[.description] +-- +The relative path of the Front-Channel Logout endpoint at the application. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_LOGOUT_FRONTCHANNEL_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_LOGOUT_FRONTCHANNEL_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-certificate-chain-leaf-certificate-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-certificate-chain-leaf-certificate-name[`quarkus.oidc.certificate-chain.leaf-certificate-name`]## + +[.description] +-- +Common name of the leaf certificate. It must be set if the `trust-store-file` does not have this certificate imported. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CERTIFICATE_CHAIN_LEAF_CERTIFICATE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CERTIFICATE_CHAIN_LEAF_CERTIFICATE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-certificate-chain-trust-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-certificate-chain-trust-store-file[`quarkus.oidc.certificate-chain.trust-store-file`]## + +[.description] +-- +Truststore file which keeps thumbprints of the trusted certificates. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_FILE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_FILE+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-oidc_quarkus-oidc-certificate-chain-trust-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-certificate-chain-trust-store-password[`quarkus.oidc.certificate-chain.trust-store-password`]## + +[.description] +-- +A parameter to specify the password of the truststore file if it is configured with `trust-store-file`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-certificate-chain-trust-store-cert-alias]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-certificate-chain-trust-store-cert-alias[`quarkus.oidc.certificate-chain.trust-store-cert-alias`]## + +[.description] +-- +A parameter to specify the alias of the truststore certificate. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_CERT_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_CERT_ALIAS+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-certificate-chain-trust-store-file-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-certificate-chain-trust-store-file-type[`quarkus.oidc.certificate-chain.trust-store-file-type`]## + +[.description] +-- +An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_FILE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_FILE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-authentication-response-mode]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-response-mode[`quarkus.oidc.authentication.response-mode`]## + +[.description] +-- +Authorization code flow response mode. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_RESPONSE_MODE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_RESPONSE_MODE+++` +endif::add-copy-button-to-env-var[] +-- +a|tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`], tooltip:form-post[Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted by the HTTP POST method using the application/x-www-form-urlencoded content type] +|tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`] + +a| [[quarkus-oidc_quarkus-oidc-authentication-redirect-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-redirect-path[`quarkus.oidc.authentication.redirect-path`]## + +[.description] +-- +The relative path for calculating a `redirect_uri` query parameter. It has to start from a forward slash and is appended to the request URI's host and port. For example, if the current request URI is `https://localhost:8080/service`, a `redirect_uri` parameter is set to `https://localhost:8080/` if this property is set to `/` and be the same as the request URI if this property has not been configured. Note the original request URI is restored after the user has authenticated if `restorePathAfterRedirect` is set to `true`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_REDIRECT_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_REDIRECT_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-authentication-restore-path-after-redirect]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-restore-path-after-redirect[`quarkus.oidc.authentication.restore-path-after-redirect`]## + +[.description] +-- +If this property is set to `true`, the original request URI which was used before the authentication is restored after the user has been redirected back to the application. Note if `redirectPath` property is not set, the original request URI is restored even if this property is disabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_RESTORE_PATH_AFTER_REDIRECT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_RESTORE_PATH_AFTER_REDIRECT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-authentication-remove-redirect-parameters]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-remove-redirect-parameters[`quarkus.oidc.authentication.remove-redirect-parameters`]## + +[.description] +-- +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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_REMOVE_REDIRECT_PARAMETERS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_REMOVE_REDIRECT_PARAMETERS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-authentication-error-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-error-path[`quarkus.oidc.authentication.error-path`]## + +[.description] +-- +Relative path to the public endpoint which processes the error response from the OIDC authorization endpoint. If the user authentication has failed, the OIDC provider returns an `error` and an optional `error_description` parameters, instead of the expected authorization `code`. If this property is set, the user is redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and is appended to the request URI's host and port. For example, if it is set as `/error` and the current request URI is `https://localhost:8080/callback?error=invalid_scope`, a redirect is made to `https://localhost:8080/error?error=invalid_scope`. If this property is not set, HTTP 401 status is returned in case of the user authentication failure. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_ERROR_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_ERROR_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-authentication-session-expired-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-session-expired-path[`quarkus.oidc.authentication.session-expired-path`]## + +[.description] +-- +Relative path to the public endpoint which an authenticated user is redirected to when the session has expired. + +When the OIDC session has expired and the session can not be refreshed, a user is redirected to the OIDC provider to re-authenticate. The user experience may not be ideal in this case as it may not be obvious to the authenticated user why an authentication challenge is returned. + +Set this property if you would like the user whose session has expired be redirected to a public application specific page instead, which can inform that the session has expired and advise the user to re-authenticated by following a link to the secured initial entry page. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_SESSION_EXPIRED_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_SESSION_EXPIRED_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-authentication-verify-access-token]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-verify-access-token[`quarkus.oidc.authentication.verify-access-token`]## + +[.description] +-- +Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow. + +ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles. + +Authorization code flow access token is meant to be propagated to downstream services and is not verified by default unless `quarkus.oidc.roles.source` property is set to `accesstoken` which means the authorization decision is based on the roles extracted from the access token. + +Authorization code flow access token verification is also enabled if this token is injected as JsonWebToken. Set this property to `false` if it is not required. + +Bearer access token is always verified. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_VERIFY_ACCESS_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_VERIFY_ACCESS_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true when access token is injected as the JsonWebToken bean, false otherwise` + +a| [[quarkus-oidc_quarkus-oidc-authentication-force-redirect-https-scheme]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-force-redirect-https-scheme[`quarkus.oidc.authentication.force-redirect-https-scheme`]## + +[.description] +-- +Force `https` as the `redirect_uri` parameter scheme when running behind an SSL/TLS terminating reverse proxy. This property, if enabled, also affects the logout `post_logout_redirect_uri` and the local redirect requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_FORCE_REDIRECT_HTTPS_SCHEME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_FORCE_REDIRECT_HTTPS_SCHEME+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-authentication-scopes]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-scopes[`quarkus.oidc.authentication.scopes`]## + +[.description] +-- +List of scopes + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_SCOPES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_SCOPES+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-oidc_quarkus-oidc-authentication-scope-separator]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-scope-separator[`quarkus.oidc.authentication.scope-separator`]## + +[.description] +-- +The separator which is used when more than one scope is configured. A single space is used by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_SCOPE_SEPARATOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_SCOPE_SEPARATOR+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-authentication-nonce-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-nonce-required[`quarkus.oidc.authentication.nonce-required`]## + +[.description] +-- +Require that ID token includes a `nonce` claim which must match `nonce` authentication request query parameter. Enabling this property can help mitigate replay attacks. Do not enable this property if your OpenId Connect provider does not support setting `nonce` in ID token or if you work with OAuth2 provider such as `GitHub` which does not issue ID tokens. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_NONCE_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_NONCE_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-authentication-add-openid-scope]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-add-openid-scope[`quarkus.oidc.authentication.add-openid-scope`]## + +[.description] +-- +Add the `openid` scope automatically to the list of scopes. This is required for OpenId Connect providers, but does not work for OAuth2 providers such as Twitter OAuth2, which do not accept this scope and throw errors. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_ADD_OPENID_SCOPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_ADD_OPENID_SCOPE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-authentication-extra-params-parameter-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-extra-params-parameter-name[`quarkus.oidc.authentication.extra-params."parameter-name"`]## + +[.description] +-- +Additional properties added as query parameters to the authentication redirect URI. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_EXTRA_PARAMS__PARAMETER_NAME_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_EXTRA_PARAMS__PARAMETER_NAME_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-oidc_quarkus-oidc-authentication-forward-params]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-forward-params[`quarkus.oidc.authentication.forward-params`]## + +[.description] +-- +Request URL query parameters which, if present, are added to the authentication redirect URI. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_FORWARD_PARAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_FORWARD_PARAMS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-oidc_quarkus-oidc-authentication-cookie-force-secure]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-cookie-force-secure[`quarkus.oidc.authentication.cookie-force-secure`]## + +[.description] +-- +If enabled the state, session, and post logout cookies have their `secure` parameter set to `true` when HTTP is used. It might be necessary when running behind an SSL/TLS terminating reverse proxy. The cookies are always secure if HTTPS is used, even if this property is set to false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_COOKIE_FORCE_SECURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_COOKIE_FORCE_SECURE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-authentication-cookie-suffix]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-cookie-suffix[`quarkus.oidc.authentication.cookie-suffix`]## + +[.description] +-- +Cookie name suffix. For example, a session cookie name for the default OIDC tenant is `q_session` but can be changed to `q_session_test` if this property is set to `test`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_COOKIE_SUFFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_COOKIE_SUFFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-authentication-cookie-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-cookie-path[`quarkus.oidc.authentication.cookie-path`]## + +[.description] +-- +Cookie path parameter value which, if set, is used to set a path parameter for the session, state and post logout cookies. The `cookie-path-header` property, if set, is checked first. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_COOKIE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_COOKIE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + +a| [[quarkus-oidc_quarkus-oidc-authentication-cookie-path-header]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-cookie-path-header[`quarkus.oidc.authentication.cookie-path-header`]## + +[.description] +-- +Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value is used to set a path parameter for the session, state and post logout cookies. If the header is missing, the `cookie-path` property is checked. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_COOKIE_PATH_HEADER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_COOKIE_PATH_HEADER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-authentication-cookie-domain]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-cookie-domain[`quarkus.oidc.authentication.cookie-domain`]## + +[.description] +-- +Cookie domain parameter value which, if set, is used for the session, state and post logout cookies. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_COOKIE_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_COOKIE_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-authentication-cookie-same-site]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-cookie-same-site[`quarkus.oidc.authentication.cookie-same-site`]## + +[.description] +-- +SameSite attribute for the session cookie. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_COOKIE_SAME_SITE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_COOKIE_SAME_SITE+++` +endif::add-copy-button-to-env-var[] +-- +a|`strict`, `lax`, `none` +|`lax` + +a| [[quarkus-oidc_quarkus-oidc-authentication-allow-multiple-code-flows]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-allow-multiple-code-flows[`quarkus.oidc.authentication.allow-multiple-code-flows`]## + +[.description] +-- +If a state cookie is present, a `state` query parameter must also be present and both the state cookie name suffix and state cookie value must match the value of the `state` query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie might represent the authentication flow initiated from another tab and not related to the current request. Disable this property to permit only a single authorization code flow in the same browser. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_ALLOW_MULTIPLE_CODE_FLOWS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_ALLOW_MULTIPLE_CODE_FLOWS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-authentication-fail-on-missing-state-param]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-fail-on-missing-state-param[`quarkus.oidc.authentication.fail-on-missing-state-param`]## + +[.description] +-- +Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present. + +When either multiple authentications are disabled or the redirect URL matches the original request URL, the stale state cookie might remain in the browser cache from the earlier failed redirect to an OpenId Connect provider and be visible during the current request. For example, if Single-page application (SPA) uses XHR to handle redirects to the provider which does not support CORS for its authorization endpoint, the browser blocks it and the state cookie created by Quarkus remains in the browser cache. Quarkus reports an authentication failure when it detects such an old state cookie but find no matching state query parameter. + +Reporting HTTP 401 error is usually the right thing to do in such cases, it minimizes a risk of the browser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects. For example, enabling `java-script-auto-redirect` or having the provider redirect to URL configured with `redirect-path` might be needed to avoid such errors. + +However, setting this property to `false` might help if the above options are not suitable. It causes a new authentication redirect to OpenId Connect provider. Doing so might increase the risk of browser redirect loops. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_FAIL_ON_MISSING_STATE_PARAM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_FAIL_ON_MISSING_STATE_PARAM+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-authentication-user-info-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-user-info-required[`quarkus.oidc.authentication.user-info-required`]## + +[.description] +-- +If this property is set to `true`, an OIDC UserInfo endpoint is called. + +This property is enabled automatically if `quarkus.oidc.roles.source` is set to `userinfo` or `quarkus.oidc.token.verify-access-token-with-user-info` is set to `true` or `quarkus.oidc.authentication.id-token-required` is set to `false`, the current OIDC tenant must support a UserInfo endpoint in these cases. + +It is also enabled automatically if `io.quarkus.oidc.UserInfo` injection point is detected but only if the current OIDC tenant supports a UserInfo endpoint. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_USER_INFO_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_USER_INFO_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true when UserInfo bean is injected, false otherwise` + +a| [[quarkus-oidc_quarkus-oidc-authentication-session-age-extension]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-session-age-extension[`quarkus.oidc.authentication.session-age-extension`]## + +[.description] +-- +Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user is redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a nonzero value, then the expired ID token can be refreshed before the session has expired. This property is ignored if the `token.refresh-expired` property has not been enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_SESSION_AGE_EXTENSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_SESSION_AGE_EXTENSION+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`5M` + +a| [[quarkus-oidc_quarkus-oidc-authentication-state-cookie-age]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-state-cookie-age[`quarkus.oidc.authentication.state-cookie-age`]## + +[.description] +-- +State cookie age in minutes. State cookie is created every time a new authorization code flow redirect starts and removed when this flow is completed. State cookie name is unique by default, see `allow-multiple-code-flows`. Keep its age to the reasonable minimum value such as 5 minutes or less. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_STATE_COOKIE_AGE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_STATE_COOKIE_AGE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`5M` + +a| [[quarkus-oidc_quarkus-oidc-authentication-java-script-auto-redirect]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-java-script-auto-redirect[`quarkus.oidc.authentication.java-script-auto-redirect`]## + +[.description] +-- +If this property is set to `true`, a normal 302 redirect response is returned if the request was initiated by a JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated, which might not be desirable for Single-page applications (SPA) since it automatically following the redirect might not work given that OIDC authorization endpoints typically do not support CORS. + +If this property is set to `false`, a status code of `499` is returned to allow SPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found. `X-Requested-With` request header with its value set to either `JavaScript` or `XMLHttpRequest` is expected by default if this property is enabled. You can register a custom `JavaScriptRequestChecker` to do a custom JavaScript request check instead. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_JAVA_SCRIPT_AUTO_REDIRECT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_JAVA_SCRIPT_AUTO_REDIRECT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-authentication-id-token-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-id-token-required[`quarkus.oidc.authentication.id-token-required`]## + +[.description] +-- +Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken is generated in such cases. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_ID_TOKEN_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_ID_TOKEN_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-authentication-internal-id-token-lifespan]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-internal-id-token-lifespan[`quarkus.oidc.authentication.internal-id-token-lifespan`]## + +[.description] +-- +Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`5M` + +a| [[quarkus-oidc_quarkus-oidc-authentication-pkce-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-pkce-required[`quarkus.oidc.authentication.pkce-required`]## + +[.description] +-- +Requires that a Proof Key for Code Exchange (PKCE) is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_PKCE_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_PKCE_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-authentication-state-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-state-secret[`quarkus.oidc.authentication.state-secret`]## + +[.description] +-- +Secret used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long. + +If this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` is checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication is checked. A client secret is not be used as a state encryption secret if it is less than 32 characters long. + +The secret is auto-generated if it remains uninitialized after checking all of these properties. + +Error is reported if the secret length is less than 16 characters. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_STATE_SECRET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_STATE_SECRET+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-code-grant-extra-params-parameter-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-code-grant-extra-params-parameter-name[`quarkus.oidc.code-grant.extra-params."parameter-name"`]## + +[.description] +-- +Additional parameters, in addition to the required `code` and `redirect-uri` parameters, which must be included to complete the authorization code grant request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CODE_GRANT_EXTRA_PARAMS__PARAMETER_NAME_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CODE_GRANT_EXTRA_PARAMS__PARAMETER_NAME_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-oidc_quarkus-oidc-code-grant-headers-header-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-code-grant-headers-header-name[`quarkus.oidc.code-grant.headers."header-name"`]## + +[.description] +-- +Custom HTTP headers which must be sent to complete the authorization code grant request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CODE_GRANT_HEADERS__HEADER_NAME_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CODE_GRANT_HEADERS__HEADER_NAME_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-oidc_quarkus-oidc-token-state-manager-strategy]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-state-manager-strategy[`quarkus.oidc.token-state-manager.strategy`]## + +[.description] +-- +Default TokenStateManager strategy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_STATE_MANAGER_STRATEGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_STATE_MANAGER_STRATEGY+++` +endif::add-copy-button-to-env-var[] +-- +a|tooltip:keep-all-tokens[Keep ID, access and refresh tokens.], tooltip:id-token[Keep ID token only], tooltip:id-refresh-tokens[Keep ID and refresh tokens only] +|tooltip:keep-all-tokens[Keep ID, access and refresh tokens.] + +a| [[quarkus-oidc_quarkus-oidc-token-state-manager-split-tokens]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-state-manager-split-tokens[`quarkus.oidc.token-state-manager.split-tokens`]## + +[.description] +-- +Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_STATE_MANAGER_SPLIT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_STATE_MANAGER_SPLIT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-token-state-manager-encryption-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-state-manager-encryption-required[`quarkus.oidc.token-state-manager.encryption-required`]## + +[.description] +-- +Mandates that the Default TokenStateManager encrypt the session cookie that stores the tokens. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-token-state-manager-encryption-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-state-manager-encryption-secret[`quarkus.oidc.token-state-manager.encryption-secret`]## + +[.description] +-- +The secret used by the Default TokenStateManager to encrypt the session cookie storing the tokens when `encryption-required` property is enabled. + +If this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` is checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication is checked. The secret is auto-generated every time an application starts if it remains uninitialized after checking all of these properties. Generated secret can not decrypt the session cookie encrypted before the restart, therefore a user re-authentication will be required. + +The length of the secret used to encrypt the tokens should be at least 32 characters long. A warning is logged if the secret length is less than 16 characters. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_SECRET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_SECRET+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-token-state-manager-encryption-algorithm]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-state-manager-encryption-algorithm[`quarkus.oidc.token-state-manager.encryption-algorithm`]## + +[.description] +-- +Session cookie key encryption algorithm + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +-- +a|tooltip:a256-gcmkw[Content encryption key will be generated and encrypted using the A256GCMKW algorithm and the configured encryption secret. The generated content encryption key will be used to encrypt the session cookie content.], tooltip:dir[The configured key encryption secret will be used as the content encryption key to encrypt the session cookie content. Using the direct encryption avoids a content encryption key generation step and will make the encrypted session cookie sequence slightly shorter. Avoid using the direct encryption if the encryption secret is less than 32 characters long.] +|tooltip:a256-gcmkw[Content encryption key will be generated and encrypted using the A256GCMKW algorithm and the configured encryption secret. The generated content encryption key will be used to encrypt the session cookie content.] + +a| [[quarkus-oidc_quarkus-oidc-allow-token-introspection-cache]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-allow-token-introspection-cache[`quarkus.oidc.allow-token-introspection-cache`]## + +[.description] +-- +Allow caching the token introspection data. Note enabling this property does not enable the cache itself but only permits to cache the token introspection for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_ALLOW_TOKEN_INTROSPECTION_CACHE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_ALLOW_TOKEN_INTROSPECTION_CACHE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-allow-user-info-cache]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-allow-user-info-cache[`quarkus.oidc.allow-user-info-cache`]## + +[.description] +-- +Allow caching the user info data. Note enabling this property does not enable the cache itself but only permits to cache the user info data for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_ALLOW_USER_INFO_CACHE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_ALLOW_USER_INFO_CACHE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-cache-user-info-in-idtoken]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-cache-user-info-in-idtoken[`quarkus.oidc.cache-user-info-in-idtoken`]## + +[.description] +-- +Allow inlining UserInfo in IdToken instead of caching it in the token cache. This property is only checked when an internal IdToken is generated when OAuth2 providers do not return IdToken. Inlining UserInfo in the generated IdToken allows to store it in the session cookie and avoids introducing a cached state. + +Inlining UserInfo in the generated IdToken is enabled if the session cookie is encrypted and the UserInfo cache is not enabled or caching UserInfo is disabled for the current tenant with the `allow-user-info-cache` property set to `false`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CACHE_USER_INFO_IN_IDTOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_CACHE_USER_INFO_IN_IDTOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-oidc_quarkus-oidc-jwks-resolve-early]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-jwks-resolve-early[`quarkus.oidc.jwks.resolve-early`]## + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property delays the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-jwks-cache-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-jwks-cache-size[`quarkus.oidc.jwks.cache-size`]## + +[.description] +-- +Maximum number of JWK keys that can be cached. This property is ignored if the `resolve-early` property is set to true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10` + +a| [[quarkus-oidc_quarkus-oidc-jwks-cache-time-to-live]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-jwks-cache-time-to-live[`quarkus.oidc.jwks.cache-time-to-live`]## + +[.description] +-- +Number of minutes a JWK key can be cached for. This property is ignored if the `resolve-early` property is set to true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`10M` + +a| [[quarkus-oidc_quarkus-oidc-jwks-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-jwks-clean-up-timer-interval[`quarkus.oidc.jwks.clean-up-timer-interval`]## + +[.description] +-- +Cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. This property is ignored if the `resolve-early` property is set to true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc_quarkus-oidc-jwks-try-all]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-jwks-try-all[`quarkus.oidc.jwks.try-all`]## + +[.description] +-- +In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t++#++S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_TRY_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_TRY_ALL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-provider]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-provider[`quarkus.oidc.provider`]## + +[.description] +-- +Well known OpenId Connect provider identifier + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `spotify`, `strava`, `twitch`, `twitter`, `x` +| + +a| [[quarkus-oidc_quarkus-oidc-token-cache-max-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-cache-max-size[`quarkus.oidc.token-cache.max-size`]## + +[.description] +-- +Maximum number of cache entries. Set it to a positive value if the cache has to be enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_CACHE_MAX_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_CACHE_MAX_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`0` + +a| [[quarkus-oidc_quarkus-oidc-token-cache-time-to-live]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-cache-time-to-live[`quarkus.oidc.token-cache.time-to-live`]## + +[.description] +-- +Maximum amount of time a given cache entry is valid for. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`3M` + +a| [[quarkus-oidc_quarkus-oidc-token-cache-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-cache-clean-up-timer-interval[`quarkus.oidc.token-cache.clean-up-timer-interval`]## + +[.description] +-- +Clean up timer interval. If this property is set then a timer will check and remove the stale entries periodically. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_CACHE_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_TOKEN_CACHE_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc_quarkus-oidc-resolve-tenants-with-issuer]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-resolve-tenants-with-issuer[`quarkus.oidc.resolve-tenants-with-issuer`]## + +[.description] +-- +If OIDC tenants should be resolved using the bearer access token's issuer (`iss`) claim value. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_RESOLVE_TENANTS_WITH_ISSUER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_RESOLVE_TENANTS_WITH_ISSUER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-oidc_section_quarkus-oidc]] [.section-name.section-level0]##link:#quarkus-oidc_section_quarkus-oidc[Additional named tenants]## +h|Type +h|Default + +a| [[quarkus-oidc_quarkus-oidc-tenant-auth-server-url]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-auth-server-url[`quarkus.oidc."tenant".auth-server-url`]## + +[.description] +-- +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTH_SERVER_URL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTH_SERVER_URL+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-discovery-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-discovery-enabled[`quarkus.oidc."tenant".discovery-enabled`]## + +[.description] +-- +Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__DISCOVERY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__DISCOVERY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-registration-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-registration-path[`quarkus.oidc."tenant".registration-path`]## + +[.description] +-- +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__REGISTRATION_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__REGISTRATION_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-connection-delay]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-delay[`quarkus.oidc."tenant".connection-delay`]## + +[.description] +-- +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-connection-retry-count]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-retry-count[`quarkus.oidc."tenant".connection-retry-count`]## + +[.description] +-- +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +a| [[quarkus-oidc_quarkus-oidc-tenant-connection-timeout]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-timeout[`quarkus.oidc."tenant".connection-timeout`]## + +[.description] +-- +The number of seconds after which the current OIDC connection request times out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-oidc_quarkus-oidc-tenant-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-use-blocking-dns-lookup[`quarkus.oidc."tenant".use-blocking-dns-lookup`]## + +[.description] +-- +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__USE_BLOCKING_DNS_LOOKUP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__USE_BLOCKING_DNS_LOOKUP+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-max-pool-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-max-pool-size[`quarkus.oidc."tenant".max-pool-size`]## + +[.description] +-- +The maximum size of the connection pool used by the WebClient. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__MAX_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__MAX_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-host]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-host[`quarkus.oidc."tenant".proxy.host`]## + +[.description] +-- +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-port]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-port[`quarkus.oidc."tenant".proxy.port`]## + +[.description] +-- +The port number of the Proxy. The default value is `80`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`80` + +a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-username]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-username[`quarkus.oidc."tenant".proxy.username`]## + +[.description] +-- +The username, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-password[`quarkus.oidc."tenant".proxy.password`]## + +[.description] +-- +The password, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-tls-configuration-name[`quarkus.oidc."tenant".tls.tls-configuration-name`]## + +[.description] +-- +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-path[`quarkus.oidc."tenant".token-path`]## + +[.description] +-- +The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-revoke-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-revoke-path[`quarkus.oidc."tenant".revoke-path`]## + +[.description] +-- +The relative path or absolute URL of the OIDC token revocation endpoint. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__REVOKE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__REVOKE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-client-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-client-id[`quarkus.oidc."tenant".client-id`]## + +[.description] +-- +The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CLIENT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CLIENT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-client-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-client-name[`quarkus.oidc."tenant".client-name`]## + +[.description] +-- +The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-secret[`quarkus.oidc."tenant".credentials.secret`]## + +[.description] +-- +The client secret used by the `client_secret_basic` authentication method. Must be set unless a secret is set in `client-secret` or `jwt` client authentication is required. You can use `client-secret.value` instead, but both properties are mutually exclusive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_SECRET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_SECRET+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-client-secret-value]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-client-secret-value[`quarkus.oidc."tenant".credentials.client-secret.value`]## + +[.description] +-- +The client secret value. This value is ignored if `credentials.secret` is set. Must be set unless a secret is set in `client-secret` or `jwt` client authentication is required. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_VALUE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_VALUE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-client-secret-provider-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-client-secret-provider-name[`quarkus.oidc."tenant".credentials.client-secret.provider.name`]## + +[.description] +-- +The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-client-secret-provider-keyring-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-client-secret-provider-keyring-name[`quarkus.oidc."tenant".credentials.client-secret.provider.keyring-name`]## + +[.description] +-- +The CredentialsProvider keyring name. The keyring name is only required when the CredentialsProvider being used requires the keyring name to look up the secret, which is often the case when a CredentialsProvider is shared by multiple extensions to retrieve credentials from a more dynamic source like a vault instance or secret manager + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_PROVIDER_KEYRING_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_PROVIDER_KEYRING_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-client-secret-provider-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-client-secret-provider-key[`quarkus.oidc."tenant".credentials.client-secret.provider.key`]## + +[.description] +-- +The CredentialsProvider client secret key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_PROVIDER_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_PROVIDER_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-client-secret-method]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-client-secret-method[`quarkus.oidc."tenant".credentials.client-secret.method`]## + +[.description] +-- +The authentication method. If the `clientSecret.value` secret is set, this method is `basic` by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_METHOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_CLIENT_SECRET_METHOD+++` +endif::add-copy-button-to-env-var[] +-- +a|tooltip:basic[`client_secret_basic` (default)\: The client id and secret are submitted with the HTTP Authorization Basic scheme.], tooltip:post[`client_secret_post`\: The client id and secret are submitted as the `client_id` and `client_secret` form parameters.], tooltip:post-jwt[`client_secret_jwt`\: The client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters.], tooltip:query[client id and secret are submitted as HTTP query parameters. This option is only supported by the OIDC extension.] +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-source]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-source[`quarkus.oidc."tenant".credentials.jwt.source`]## + +[.description] +-- +JWT token source: OIDC provider client or an existing JWT bearer token. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SOURCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SOURCE+++` +endif::add-copy-button-to-env-var[] +-- +a|`client`, `bearer` +|`client` + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-secret[`quarkus.oidc."tenant".credentials.jwt.secret`]## + +[.description] +-- +If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-secret-provider-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-secret-provider-name[`quarkus.oidc."tenant".credentials.jwt.secret-provider.name`]## + +[.description] +-- +The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-secret-provider-keyring-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-secret-provider-keyring-name[`quarkus.oidc."tenant".credentials.jwt.secret-provider.keyring-name`]## + +[.description] +-- +The CredentialsProvider keyring name. The keyring name is only required when the CredentialsProvider being used requires the keyring name to look up the secret, which is often the case when a CredentialsProvider is shared by multiple extensions to retrieve credentials from a more dynamic source like a vault instance or secret manager + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET_PROVIDER_KEYRING_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET_PROVIDER_KEYRING_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-secret-provider-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-secret-provider-key[`quarkus.oidc."tenant".credentials.jwt.secret-provider.key`]## + +[.description] +-- +The CredentialsProvider client secret key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET_PROVIDER_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SECRET_PROVIDER_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key[`quarkus.oidc."tenant".credentials.jwt.key`]## + +[.description] +-- +String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-file[`quarkus.oidc."tenant".credentials.jwt.key-file`]## + +[.description] +-- +If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_FILE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_FILE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-store-file[`quarkus.oidc."tenant".credentials.jwt.key-store-file`]## + +[.description] +-- +If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_STORE_FILE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_STORE_FILE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-store-password[`quarkus.oidc."tenant".credentials.jwt.key-store-password`]## + +[.description] +-- +A parameter to specify the password of the keystore file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-id[`quarkus.oidc."tenant".credentials.jwt.key-id`]## + +[.description] +-- +The private key id or alias. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-password[`quarkus.oidc."tenant".credentials.jwt.key-password`]## + +[.description] +-- +The private key password. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_KEY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-audience]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-audience[`quarkus.oidc."tenant".credentials.jwt.audience`]## + +[.description] +-- +The JWT audience (`aud`) claim value. By default, the audience is set to the address of the OpenId Connect Provider's token endpoint. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_AUDIENCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_AUDIENCE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-token-key-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-token-key-id[`quarkus.oidc."tenant".credentials.jwt.token-key-id`]## + +[.description] +-- +The key identifier of the signing key added as a JWT `kid` header. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_TOKEN_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_TOKEN_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-issuer]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-issuer[`quarkus.oidc."tenant".credentials.jwt.issuer`]## + +[.description] +-- +The issuer of the signing key added as a JWT `iss` claim. The default value is the client id. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_ISSUER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_ISSUER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-subject]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-subject[`quarkus.oidc."tenant".credentials.jwt.subject`]## + +[.description] +-- +Subject of the signing key added as a JWT `sub` claim The default value is the client id. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SUBJECT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SUBJECT+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-claims-claim-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-claims-claim-name[`quarkus.oidc."tenant".credentials.jwt.claims."claim-name"`]## + +[.description] +-- +Additional claims. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_CLAIMS__CLAIM_NAME_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_CLAIMS__CLAIM_NAME_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-signature-algorithm]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-signature-algorithm[`quarkus.oidc."tenant".credentials.jwt.signature-algorithm`]## + +[.description] +-- +The signature algorithm used for the `key-file` property. Supported values: `RS256` (default), `RS384`, `RS512`, `PS256`, `PS384`, `PS512`, `ES256`, `ES384`, `ES512`, `HS256`, `HS384`, `HS512`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SIGNATURE_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_SIGNATURE_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-lifespan]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-lifespan[`quarkus.oidc."tenant".credentials.jwt.lifespan`]## + +[.description] +-- +The JWT lifespan in seconds. This value is added to the time at which the JWT was issued to calculate the expiration time. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_LIFESPAN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_LIFESPAN+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10` + +a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-assertion]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-assertion[`quarkus.oidc."tenant".credentials.jwt.assertion`]## + +[.description] +-- +If true then the client authentication token is a JWT bearer grant assertion. Instead of producing 'client_assertion' and 'client_assertion_type' form properties, only 'assertion' is produced. This option is only supported by the OIDC client extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_ASSERTION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CREDENTIALS_JWT_ASSERTION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-tenant-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tenant-id[`quarkus.oidc."tenant".tenant-id`]## + +[.description] +-- +A unique tenant identifier. It can be set by `TenantConfigResolver` providers, which resolve the tenant configuration dynamically. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TENANT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TENANT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-tenant-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tenant-enabled[`quarkus.oidc."tenant".tenant-enabled`]## + +[.description] +-- +If this tenant configuration is enabled. The default tenant is disabled if it is not configured but a `TenantConfigResolver` that resolves tenant configurations is registered, or named tenants are configured. In this case, you do not need to disable the default tenant. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TENANT_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TENANT_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-application-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-application-type[`quarkus.oidc."tenant".application-type`]## + +[.description] +-- +The application type, which can be one of the following `ApplicationType` values. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__APPLICATION_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__APPLICATION_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|tooltip:web-app[A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users.], tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.], tooltip:hybrid[A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method is used if the Authorization header is set and Authorization Code Flow - if not.] +|tooltip:service[A {@code SERVICE} is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.] + +a| [[quarkus-oidc_quarkus-oidc-tenant-authorization-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authorization-path[`quarkus.oidc."tenant".authorization-path`]## + +[.description] +-- +The relative path or absolute URL of the OpenID Connect (OIDC) authorization endpoint, which authenticates users. You must set this property for `web-app` applications if OIDC discovery is disabled. This property is ignored if OIDC discovery is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHORIZATION_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHORIZATION_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-user-info-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-user-info-path[`quarkus.oidc."tenant".user-info-path`]## + +[.description] +-- +The relative path or absolute URL of the OIDC UserInfo endpoint. You must set this property for `web-app` applications if OIDC discovery is disabled and the `authentication.user-info-required` property is enabled. This property is ignored if OIDC discovery is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__USER_INFO_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__USER_INFO_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-introspection-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-introspection-path[`quarkus.oidc."tenant".introspection-path`]## + +[.description] +-- +Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JSON Web Token (JWT) tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens must be verified or 2) JWT tokens must be verified while the cached JWK verification set with no matching JWK is being refreshed. This property is ignored if the discovery is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__INTROSPECTION_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__INTROSPECTION_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-jwks-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-jwks-path[`quarkus.oidc."tenant".jwks-path`]## + +[.description] +-- +Relative path or absolute URL of the OIDC JSON Web Key Set (JWKS) endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property is ignored if the discovery is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-end-session-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-end-session-path[`quarkus.oidc."tenant".end-session-path`]## + +[.description] +-- +Relative path or absolute URL of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the `web-app` applications is required. This property is ignored if the discovery is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__END_SESSION_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__END_SESSION_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-tenant-paths]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tenant-paths[`quarkus.oidc."tenant".tenant-paths`]## + +[.description] +-- +The paths which must be secured by this tenant. Tenant with the most specific path wins. +Please see the xref:security-openid-connect-multitenancy.adoc#configure-tenant-paths[Configure tenant paths] +section of the OIDC multitenancy guide for explanation of allowed path patterns. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TENANT_PATHS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TENANT_PATHS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-public-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-public-key[`quarkus.oidc."tenant".public-key`]## + +[.description] +-- +The public key for the local JWT token verification. OIDC server connection is not created when this property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PUBLIC_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__PUBLIC_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-introspection-credentials-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-introspection-credentials-name[`quarkus.oidc."tenant".introspection-credentials.name`]## + +[.description] +-- +Name + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-introspection-credentials-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-introspection-credentials-secret[`quarkus.oidc."tenant".introspection-credentials.secret`]## + +[.description] +-- +Secret + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_SECRET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_SECRET+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-introspection-credentials-include-client-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-introspection-credentials-include-client-id[`quarkus.oidc."tenant".introspection-credentials.include-client-id`]## + +[.description] +-- +Include OpenId Connect Client ID configured with `quarkus.oidc.client-id`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_INCLUDE_CLIENT_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_INCLUDE_CLIENT_ID+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-roles-role-claim-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-roles-role-claim-path[`quarkus.oidc."tenant".roles.role-claim-path`]## + +[.description] +-- +A list of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments. Each segment represents a JSON object name only; for example: "realm/groups". Use double quotes with the namespace-qualified claim names. This property can be used if a token has no `groups` claim but has the groups set in one or more different claims. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__ROLES_ROLE_CLAIM_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__ROLES_ROLE_CLAIM_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-roles-role-claim-separator]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-roles-role-claim-separator[`quarkus.oidc."tenant".roles.role-claim-separator`]## + +[.description] +-- +The separator for splitting strings that contain multiple group values. It is only used if the "role-claim-path" property points to one or more custom claims whose values are strings. A single space is used by default because the standard `scope` claim can contain a space-separated sequence. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__ROLES_ROLE_CLAIM_SEPARATOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__ROLES_ROLE_CLAIM_SEPARATOR+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-roles-source]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-roles-source[`quarkus.oidc."tenant".roles.source`]## + +[.description] +-- +Source of the principal roles. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__ROLES_SOURCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__ROLES_SOURCE+++` +endif::add-copy-button-to-env-var[] +-- +a|tooltip:idtoken[ID Token - the default value for the `web-app` applications.], tooltip:accesstoken[Access Token - the default value for the `service` applications; can also be used as the source of roles for the `web-app` applications.], tooltip:userinfo[User Info] +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-issuer]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-issuer[`quarkus.oidc."tenant".token.issuer`]## + +[.description] +-- +The expected issuer `iss` claim value. This property overrides the `issuer` property, which might be set in OpenId Connect provider's well-known configuration. If the `iss` claim value varies depending on the host, IP address, or tenant id of the provider, you can skip the issuer verification by setting this property to `any`, but it should be done only when other options (such as configuring the provider to use the fixed `iss` claim value) are not possible. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_ISSUER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_ISSUER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-audience]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-audience[`quarkus.oidc."tenant".token.audience`]## + +[.description] +-- +The expected audience `aud` claim value, which can be a string or an array of strings. Note the audience claim is verified for ID tokens by default. ID token audience must be equal to the value of `quarkus.oidc.client-id` property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to `any` if your provider does not set ID token audience` claim. Audience verification for access tokens is only done if this property is configured. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_AUDIENCE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_AUDIENCE+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-subject-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-subject-required[`quarkus.oidc."tenant".token.subject-required`]## + +[.description] +-- +Require that the token includes a `sub` (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required, both the token and UserInfo `sub` claims must be present and match each other. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_SUBJECT_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_SUBJECT_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-required-claims-claim-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-required-claims-claim-name[`quarkus.oidc."tenant".token.required-claims."claim-name"`]## + +[.description] +-- +A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_REQUIRED_CLAIMS__CLAIM_NAME_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_REQUIRED_CLAIMS__CLAIM_NAME_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-token-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-token-type[`quarkus.oidc."tenant".token.token-type`]## + +[.description] +-- +Expected token type + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_TOKEN_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_TOKEN_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-lifespan-grace]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-lifespan-grace[`quarkus.oidc."tenant".token.lifespan-grace`]## + +[.description] +-- +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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_LIFESPAN_GRACE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_LIFESPAN_GRACE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-age]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-age[`quarkus.oidc."tenant".token.age`]## + +[.description] +-- +Token age. It allows for the number of seconds to be specified that must not elapse since the `iat` (issued at) time. A small leeway to account for clock skew which can be configured with `quarkus.oidc.token.lifespan-grace` to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid (`exp`) expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an `exp` claim. However, even if the current logout token is allowed to have no `exp` claim, the `exp` claim is still verified if the logout token contains it. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_AGE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_AGE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-issued-at-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-issued-at-required[`quarkus.oidc."tenant".token.issued-at-required`]## + +[.description] +-- +Require that the token includes a `iat` (issued at) claim Set this property to `false` if your JWT token does not contain an `iat` (issued at) claim. Note that ID token is always required to have an `iat` claim and therefore this property has no impact on the ID token verification process. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_ISSUED_AT_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_ISSUED_AT_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-principal-claim]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-principal-claim[`quarkus.oidc."tenant".token.principal-claim`]## + +[.description] +-- +Name of the claim which contains a principal name. By default, the `upn`, `preferred_username` and `sub` claims are checked. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_PRINCIPAL_CLAIM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_PRINCIPAL_CLAIM+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-refresh-expired]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-refresh-expired[`quarkus.oidc."tenant".token.refresh-expired`]## + +[.description] +-- +Refresh expired authorization code flow ID or access tokens. If this property is enabled, a refresh token request is performed if the authorization code ID or access token has expired and, if successful, the local session is updated with the new set of tokens. Otherwise, the local session is invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case, the user might not be challenged again if the OIDC provider session is still active. For this option be effective the `authentication.session-age-extension` property should also be set to a nonzero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type `ApplicationType++#++WEB_APP`++}++. This property is enabled if `quarkus.oidc.token.refresh-token-time-skew` is configured, you do not need to enable this property manually in this case. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_REFRESH_EXPIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_REFRESH_EXPIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-refresh-token-time-skew]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-refresh-token-time-skew[`quarkus.oidc."tenant".token.refresh-token-time-skew`]## + +[.description] +-- +The refresh token time skew, in seconds. If this property is enabled, the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token's expiration time, a refresh is going to happen. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_REFRESH_TOKEN_TIME_SKEW+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_REFRESH_TOKEN_TIME_SKEW+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-forced-jwk-refresh-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-forced-jwk-refresh-interval[`quarkus.oidc."tenant".token.forced-jwk-refresh-interval`]## + +[.description] +-- +The forced JWK set refresh interval in minutes. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_FORCED_JWK_REFRESH_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_FORCED_JWK_REFRESH_INTERVAL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`10M` + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-header]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-header[`quarkus.oidc."tenant".token.header`]## + +[.description] +-- +Custom HTTP header that contains a bearer token. This option is valid only when the application is of type `ApplicationType++#++SERVICE`++}++. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_HEADER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_HEADER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-authorization-scheme]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-authorization-scheme[`quarkus.oidc."tenant".token.authorization-scheme`]## + +[.description] +-- +HTTP Authorization header scheme. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_AUTHORIZATION_SCHEME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_AUTHORIZATION_SCHEME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`Bearer` + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-signature-algorithm]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-signature-algorithm[`quarkus.oidc."tenant".token.signature-algorithm`]## + +[.description] +-- +Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_SIGNATURE_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_SIGNATURE_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +-- +a|`rs256`, `rs384`, `rs512`, `ps256`, `ps384`, `ps512`, `es256`, `es384`, `es512`, `eddsa` +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-decryption-key-location]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-decryption-key-location[`quarkus.oidc."tenant".token.decryption-key-location`]## + +[.description] +-- +Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers might not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. If this property is not set and the `private_key_jwt` client authentication method is used, the private key used to sign the client authentication JWT tokens are also used to decrypt the encrypted ID tokens. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_DECRYPTION_KEY_LOCATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_DECRYPTION_KEY_LOCATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-allow-jwt-introspection]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-allow-jwt-introspection[`quarkus.oidc."tenant".token.allow-jwt-introspection`]## + +[.description] +-- +Allow the remote introspection of JWT tokens when no matching JWK key is available. This property is set to `true` by default for backward-compatibility reasons. It is planned that this default value will be changed to `false` in an upcoming release. Also note this property is ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_ALLOW_JWT_INTROSPECTION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_ALLOW_JWT_INTROSPECTION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-require-jwt-introspection-only]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-require-jwt-introspection-only[`quarkus.oidc."tenant".token.require-jwt-introspection-only`]## + +[.description] +-- +Require that JWT tokens are only introspected remotely. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_REQUIRE_JWT_INTROSPECTION_ONLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_REQUIRE_JWT_INTROSPECTION_ONLY+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-allow-opaque-token-introspection]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-allow-opaque-token-introspection[`quarkus.oidc."tenant".token.allow-opaque-token-introspection`]## + +[.description] +-- +Allow the remote introspection of the opaque tokens. Set this property to `false` if only JWT tokens are expected. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_ALLOW_OPAQUE_TOKEN_INTROSPECTION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_ALLOW_OPAQUE_TOKEN_INTROSPECTION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-customizer-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-customizer-name[`quarkus.oidc."tenant".token.customizer-name`]## + +[.description] +-- +Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using `TenantFeature` qualifier when registering custom `TokenCustomizer`. Use this property only to refer to `TokenCustomizer` implementations provided by this extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_CUSTOMIZER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_CUSTOMIZER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-verify-access-token-with-user-info]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-verify-access-token-with-user-info[`quarkus.oidc."tenant".token.verify-access-token-with-user-info`]## + +[.description] +-- +Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens must be accepted but OpenId Connect provider does not have a token introspection endpoint. This property has no effect when JWT tokens must be verified. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_VERIFY_ACCESS_TOKEN_WITH_USER_INFO+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_VERIFY_ACCESS_TOKEN_WITH_USER_INFO+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-logout-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-path[`quarkus.oidc."tenant".logout.path`]## + +[.description] +-- +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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__LOGOUT_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-logout-post-logout-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-post-logout-path[`quarkus.oidc."tenant".logout.post-logout-path`]## + +[.description] +-- +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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__LOGOUT_POST_LOGOUT_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_POST_LOGOUT_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-logout-post-logout-uri-param]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-post-logout-uri-param[`quarkus.oidc."tenant".logout.post-logout-uri-param`]## + +[.description] +-- +Name of the post logout URI parameter which is added as a query parameter to the logout redirect URI. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__LOGOUT_POST_LOGOUT_URI_PARAM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_POST_LOGOUT_URI_PARAM+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`post_logout_redirect_uri` + +a| [[quarkus-oidc_quarkus-oidc-tenant-logout-extra-params-query-parameter-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-extra-params-query-parameter-name[`quarkus.oidc."tenant".logout.extra-params."query-parameter-name"`]## + +[.description] +-- +Additional properties which is added as the query parameters to the logout redirect URI. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__LOGOUT_EXTRA_PARAMS__QUERY_PARAMETER_NAME_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_EXTRA_PARAMS__QUERY_PARAMETER_NAME_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-path[`quarkus.oidc."tenant".logout.backchannel.path`]## + +[.description] +-- +The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-token-cache-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-token-cache-size[`quarkus.oidc."tenant".logout.backchannel.token-cache-size`]## + +[.description] +-- +Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_TOKEN_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_TOKEN_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10` + +a| [[quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-token-cache-time-to-live]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-token-cache-time-to-live[`quarkus.oidc."tenant".logout.backchannel.token-cache-time-to-live`]## + +[.description] +-- +Number of minutes a logout token can be cached for. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`10M` + +a| [[quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-clean-up-timer-interval[`quarkus.oidc."tenant".logout.backchannel.clean-up-timer-interval`]## + +[.description] +-- +Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-logout-token-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-logout-token-key[`quarkus.oidc."tenant".logout.backchannel.logout-token-key`]## + +[.description] +-- +Logout token claim whose value is used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_LOGOUT_TOKEN_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_LOGOUT_TOKEN_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`sub` + +a| [[quarkus-oidc_quarkus-oidc-tenant-logout-frontchannel-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-frontchannel-path[`quarkus.oidc."tenant".logout.frontchannel.path`]## + +[.description] +-- +The relative path of the Front-Channel Logout endpoint at the application. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__LOGOUT_FRONTCHANNEL_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_FRONTCHANNEL_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-certificate-chain-leaf-certificate-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-certificate-chain-leaf-certificate-name[`quarkus.oidc."tenant".certificate-chain.leaf-certificate-name`]## + +[.description] +-- +Common name of the leaf certificate. It must be set if the `trust-store-file` does not have this certificate imported. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_LEAF_CERTIFICATE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_LEAF_CERTIFICATE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-certificate-chain-trust-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-certificate-chain-trust-store-file[`quarkus.oidc."tenant".certificate-chain.trust-store-file`]## + +[.description] +-- +Truststore file which keeps thumbprints of the trusted certificates. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_FILE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_FILE+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-certificate-chain-trust-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-certificate-chain-trust-store-password[`quarkus.oidc."tenant".certificate-chain.trust-store-password`]## + +[.description] +-- +A parameter to specify the password of the truststore file if it is configured with `trust-store-file`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-certificate-chain-trust-store-cert-alias]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-certificate-chain-trust-store-cert-alias[`quarkus.oidc."tenant".certificate-chain.trust-store-cert-alias`]## + +[.description] +-- +A parameter to specify the alias of the truststore certificate. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_CERT_ALIAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_CERT_ALIAS+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-certificate-chain-trust-store-file-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-certificate-chain-trust-store-file-type[`quarkus.oidc."tenant".certificate-chain.trust-store-file-type`]## + +[.description] +-- +An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_FILE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_FILE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-response-mode]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-response-mode[`quarkus.oidc."tenant".authentication.response-mode`]## + +[.description] +-- +Authorization code flow response mode. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_RESPONSE_MODE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_RESPONSE_MODE+++` +endif::add-copy-button-to-env-var[] +-- +a|tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`], tooltip:form-post[Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted by the HTTP POST method using the application/x-www-form-urlencoded content type] +|tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`] + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-redirect-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-redirect-path[`quarkus.oidc."tenant".authentication.redirect-path`]## + +[.description] +-- +The relative path for calculating a `redirect_uri` query parameter. It has to start from a forward slash and is appended to the request URI's host and port. For example, if the current request URI is `https://localhost:8080/service`, a `redirect_uri` parameter is set to `https://localhost:8080/` if this property is set to `/` and be the same as the request URI if this property has not been configured. Note the original request URI is restored after the user has authenticated if `restorePathAfterRedirect` is set to `true`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_REDIRECT_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_REDIRECT_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-restore-path-after-redirect]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-restore-path-after-redirect[`quarkus.oidc."tenant".authentication.restore-path-after-redirect`]## + +[.description] +-- +If this property is set to `true`, the original request URI which was used before the authentication is restored after the user has been redirected back to the application. Note if `redirectPath` property is not set, the original request URI is restored even if this property is disabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_RESTORE_PATH_AFTER_REDIRECT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_RESTORE_PATH_AFTER_REDIRECT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-remove-redirect-parameters]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-remove-redirect-parameters[`quarkus.oidc."tenant".authentication.remove-redirect-parameters`]## + +[.description] +-- +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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_REMOVE_REDIRECT_PARAMETERS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_REMOVE_REDIRECT_PARAMETERS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-error-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-error-path[`quarkus.oidc."tenant".authentication.error-path`]## + +[.description] +-- +Relative path to the public endpoint which processes the error response from the OIDC authorization endpoint. If the user authentication has failed, the OIDC provider returns an `error` and an optional `error_description` parameters, instead of the expected authorization `code`. If this property is set, the user is redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and is appended to the request URI's host and port. For example, if it is set as `/error` and the current request URI is `https://localhost:8080/callback?error=invalid_scope`, a redirect is made to `https://localhost:8080/error?error=invalid_scope`. If this property is not set, HTTP 401 status is returned in case of the user authentication failure. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_ERROR_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_ERROR_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-session-expired-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-session-expired-path[`quarkus.oidc."tenant".authentication.session-expired-path`]## + +[.description] +-- +Relative path to the public endpoint which an authenticated user is redirected to when the session has expired. + +When the OIDC session has expired and the session can not be refreshed, a user is redirected to the OIDC provider to re-authenticate. The user experience may not be ideal in this case as it may not be obvious to the authenticated user why an authentication challenge is returned. + +Set this property if you would like the user whose session has expired be redirected to a public application specific page instead, which can inform that the session has expired and advise the user to re-authenticated by following a link to the secured initial entry page. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_EXPIRED_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_EXPIRED_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-verify-access-token]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-verify-access-token[`quarkus.oidc."tenant".authentication.verify-access-token`]## + +[.description] +-- +Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow. + +ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles. + +Authorization code flow access token is meant to be propagated to downstream services and is not verified by default unless `quarkus.oidc.roles.source` property is set to `accesstoken` which means the authorization decision is based on the roles extracted from the access token. + +Authorization code flow access token verification is also enabled if this token is injected as JsonWebToken. Set this property to `false` if it is not required. + +Bearer access token is always verified. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_VERIFY_ACCESS_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_VERIFY_ACCESS_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true when access token is injected as the JsonWebToken bean, false otherwise` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-force-redirect-https-scheme]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-force-redirect-https-scheme[`quarkus.oidc."tenant".authentication.force-redirect-https-scheme`]## + +[.description] +-- +Force `https` as the `redirect_uri` parameter scheme when running behind an SSL/TLS terminating reverse proxy. This property, if enabled, also affects the logout `post_logout_redirect_uri` and the local redirect requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_FORCE_REDIRECT_HTTPS_SCHEME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_FORCE_REDIRECT_HTTPS_SCHEME+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-scopes]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-scopes[`quarkus.oidc."tenant".authentication.scopes`]## + +[.description] +-- +List of scopes + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_SCOPES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_SCOPES+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-scope-separator]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-scope-separator[`quarkus.oidc."tenant".authentication.scope-separator`]## + +[.description] +-- +The separator which is used when more than one scope is configured. A single space is used by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_SCOPE_SEPARATOR+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_SCOPE_SEPARATOR+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-nonce-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-nonce-required[`quarkus.oidc."tenant".authentication.nonce-required`]## + +[.description] +-- +Require that ID token includes a `nonce` claim which must match `nonce` authentication request query parameter. Enabling this property can help mitigate replay attacks. Do not enable this property if your OpenId Connect provider does not support setting `nonce` in ID token or if you work with OAuth2 provider such as `GitHub` which does not issue ID tokens. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_NONCE_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_NONCE_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-add-openid-scope]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-add-openid-scope[`quarkus.oidc."tenant".authentication.add-openid-scope`]## + +[.description] +-- +Add the `openid` scope automatically to the list of scopes. This is required for OpenId Connect providers, but does not work for OAuth2 providers such as Twitter OAuth2, which do not accept this scope and throw errors. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_ADD_OPENID_SCOPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_ADD_OPENID_SCOPE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-extra-params-parameter-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-extra-params-parameter-name[`quarkus.oidc."tenant".authentication.extra-params."parameter-name"`]## + +[.description] +-- +Additional properties added as query parameters to the authentication redirect URI. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_EXTRA_PARAMS__PARAMETER_NAME_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_EXTRA_PARAMS__PARAMETER_NAME_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-forward-params]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-forward-params[`quarkus.oidc."tenant".authentication.forward-params`]## + +[.description] +-- +Request URL query parameters which, if present, are added to the authentication redirect URI. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_FORWARD_PARAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_FORWARD_PARAMS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-cookie-force-secure]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-cookie-force-secure[`quarkus.oidc."tenant".authentication.cookie-force-secure`]## + +[.description] +-- +If enabled the state, session, and post logout cookies have their `secure` parameter set to `true` when HTTP is used. It might be necessary when running behind an SSL/TLS terminating reverse proxy. The cookies are always secure if HTTPS is used, even if this property is set to false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_FORCE_SECURE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_FORCE_SECURE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-cookie-suffix]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-cookie-suffix[`quarkus.oidc."tenant".authentication.cookie-suffix`]## + +[.description] +-- +Cookie name suffix. For example, a session cookie name for the default OIDC tenant is `q_session` but can be changed to `q_session_test` if this property is set to `test`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_SUFFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_SUFFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-cookie-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-cookie-path[`quarkus.oidc."tenant".authentication.cookie-path`]## + +[.description] +-- +Cookie path parameter value which, if set, is used to set a path parameter for the session, state and post logout cookies. The `cookie-path-header` property, if set, is checked first. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`/` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-cookie-path-header]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-cookie-path-header[`quarkus.oidc."tenant".authentication.cookie-path-header`]## + +[.description] +-- +Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value is used to set a path parameter for the session, state and post logout cookies. If the header is missing, the `cookie-path` property is checked. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_PATH_HEADER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_PATH_HEADER+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-cookie-domain]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-cookie-domain[`quarkus.oidc."tenant".authentication.cookie-domain`]## + +[.description] +-- +Cookie domain parameter value which, if set, is used for the session, state and post logout cookies. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-cookie-same-site]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-cookie-same-site[`quarkus.oidc."tenant".authentication.cookie-same-site`]## + +[.description] +-- +SameSite attribute for the session cookie. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_SAME_SITE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_SAME_SITE+++` +endif::add-copy-button-to-env-var[] +-- +a|`strict`, `lax`, `none` +|`lax` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-allow-multiple-code-flows]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-allow-multiple-code-flows[`quarkus.oidc."tenant".authentication.allow-multiple-code-flows`]## + +[.description] +-- +If a state cookie is present, a `state` query parameter must also be present and both the state cookie name suffix and state cookie value must match the value of the `state` query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie might represent the authentication flow initiated from another tab and not related to the current request. Disable this property to permit only a single authorization code flow in the same browser. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_ALLOW_MULTIPLE_CODE_FLOWS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_ALLOW_MULTIPLE_CODE_FLOWS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-fail-on-missing-state-param]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-fail-on-missing-state-param[`quarkus.oidc."tenant".authentication.fail-on-missing-state-param`]## + +[.description] +-- +Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present. + +When either multiple authentications are disabled or the redirect URL matches the original request URL, the stale state cookie might remain in the browser cache from the earlier failed redirect to an OpenId Connect provider and be visible during the current request. For example, if Single-page application (SPA) uses XHR to handle redirects to the provider which does not support CORS for its authorization endpoint, the browser blocks it and the state cookie created by Quarkus remains in the browser cache. Quarkus reports an authentication failure when it detects such an old state cookie but find no matching state query parameter. + +Reporting HTTP 401 error is usually the right thing to do in such cases, it minimizes a risk of the browser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects. For example, enabling `java-script-auto-redirect` or having the provider redirect to URL configured with `redirect-path` might be needed to avoid such errors. + +However, setting this property to `false` might help if the above options are not suitable. It causes a new authentication redirect to OpenId Connect provider. Doing so might increase the risk of browser redirect loops. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_FAIL_ON_MISSING_STATE_PARAM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_FAIL_ON_MISSING_STATE_PARAM+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-user-info-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-user-info-required[`quarkus.oidc."tenant".authentication.user-info-required`]## + +[.description] +-- +If this property is set to `true`, an OIDC UserInfo endpoint is called. + +This property is enabled automatically if `quarkus.oidc.roles.source` is set to `userinfo` or `quarkus.oidc.token.verify-access-token-with-user-info` is set to `true` or `quarkus.oidc.authentication.id-token-required` is set to `false`, the current OIDC tenant must support a UserInfo endpoint in these cases. + +It is also enabled automatically if `io.quarkus.oidc.UserInfo` injection point is detected but only if the current OIDC tenant supports a UserInfo endpoint. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_USER_INFO_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_USER_INFO_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true when UserInfo bean is injected, false otherwise` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-session-age-extension]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-session-age-extension[`quarkus.oidc."tenant".authentication.session-age-extension`]## + +[.description] +-- +Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user is redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a nonzero value, then the expired ID token can be refreshed before the session has expired. This property is ignored if the `token.refresh-expired` property has not been enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_AGE_EXTENSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_AGE_EXTENSION+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`5M` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-state-cookie-age]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-state-cookie-age[`quarkus.oidc."tenant".authentication.state-cookie-age`]## + +[.description] +-- +State cookie age in minutes. State cookie is created every time a new authorization code flow redirect starts and removed when this flow is completed. State cookie name is unique by default, see `allow-multiple-code-flows`. Keep its age to the reasonable minimum value such as 5 minutes or less. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_STATE_COOKIE_AGE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_STATE_COOKIE_AGE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`5M` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-java-script-auto-redirect]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-java-script-auto-redirect[`quarkus.oidc."tenant".authentication.java-script-auto-redirect`]## + +[.description] +-- +If this property is set to `true`, a normal 302 redirect response is returned if the request was initiated by a JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated, which might not be desirable for Single-page applications (SPA) since it automatically following the redirect might not work given that OIDC authorization endpoints typically do not support CORS. + +If this property is set to `false`, a status code of `499` is returned to allow SPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found. `X-Requested-With` request header with its value set to either `JavaScript` or `XMLHttpRequest` is expected by default if this property is enabled. You can register a custom `JavaScriptRequestChecker` to do a custom JavaScript request check instead. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_JAVA_SCRIPT_AUTO_REDIRECT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_JAVA_SCRIPT_AUTO_REDIRECT+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-id-token-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-id-token-required[`quarkus.oidc."tenant".authentication.id-token-required`]## + +[.description] +-- +Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken is generated in such cases. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_ID_TOKEN_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_ID_TOKEN_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-internal-id-token-lifespan]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-internal-id-token-lifespan[`quarkus.oidc."tenant".authentication.internal-id-token-lifespan`]## + +[.description] +-- +Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`5M` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-pkce-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-pkce-required[`quarkus.oidc."tenant".authentication.pkce-required`]## + +[.description] +-- +Requires that a Proof Key for Code Exchange (PKCE) is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_PKCE_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_PKCE_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-state-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-state-secret[`quarkus.oidc."tenant".authentication.state-secret`]## + +[.description] +-- +Secret used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long. + +If this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` is checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication is checked. A client secret is not be used as a state encryption secret if it is less than 32 characters long. + +The secret is auto-generated if it remains uninitialized after checking all of these properties. + +Error is reported if the secret length is less than 16 characters. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_STATE_SECRET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_STATE_SECRET+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-code-grant-extra-params-parameter-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-code-grant-extra-params-parameter-name[`quarkus.oidc."tenant".code-grant.extra-params."parameter-name"`]## + +[.description] +-- +Additional parameters, in addition to the required `code` and `redirect-uri` parameters, which must be included to complete the authorization code grant request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CODE_GRANT_EXTRA_PARAMS__PARAMETER_NAME_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CODE_GRANT_EXTRA_PARAMS__PARAMETER_NAME_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-code-grant-headers-header-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-code-grant-headers-header-name[`quarkus.oidc."tenant".code-grant.headers."header-name"`]## + +[.description] +-- +Custom HTTP headers which must be sent to complete the authorization code grant request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CODE_GRANT_HEADERS__HEADER_NAME_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CODE_GRANT_HEADERS__HEADER_NAME_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-state-manager-strategy]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-state-manager-strategy[`quarkus.oidc."tenant".token-state-manager.strategy`]## + +[.description] +-- +Default TokenStateManager strategy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_STRATEGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_STRATEGY+++` +endif::add-copy-button-to-env-var[] +-- +a|tooltip:keep-all-tokens[Keep ID, access and refresh tokens.], tooltip:id-token[Keep ID token only], tooltip:id-refresh-tokens[Keep ID and refresh tokens only] +|tooltip:keep-all-tokens[Keep ID, access and refresh tokens.] + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-state-manager-split-tokens]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-state-manager-split-tokens[`quarkus.oidc."tenant".token-state-manager.split-tokens`]## + +[.description] +-- +Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_SPLIT_TOKENS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_SPLIT_TOKENS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-state-manager-encryption-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-state-manager-encryption-required[`quarkus.oidc."tenant".token-state-manager.encryption-required`]## + +[.description] +-- +Mandates that the Default TokenStateManager encrypt the session cookie that stores the tokens. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_REQUIRED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_REQUIRED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-state-manager-encryption-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-state-manager-encryption-secret[`quarkus.oidc."tenant".token-state-manager.encryption-secret`]## + +[.description] +-- +The secret used by the Default TokenStateManager to encrypt the session cookie storing the tokens when `encryption-required` property is enabled. + +If this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` is checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication is checked. The secret is auto-generated every time an application starts if it remains uninitialized after checking all of these properties. Generated secret can not decrypt the session cookie encrypted before the restart, therefore a user re-authentication will be required. + +The length of the secret used to encrypt the tokens should be at least 32 characters long. A warning is logged if the secret length is less than 16 characters. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_SECRET+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_SECRET+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-token-state-manager-encryption-algorithm]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-state-manager-encryption-algorithm[`quarkus.oidc."tenant".token-state-manager.encryption-algorithm`]## + +[.description] +-- +Session cookie key encryption algorithm + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_ALGORITHM+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_ALGORITHM+++` +endif::add-copy-button-to-env-var[] +-- +a|tooltip:a256-gcmkw[Content encryption key will be generated and encrypted using the A256GCMKW algorithm and the configured encryption secret. The generated content encryption key will be used to encrypt the session cookie content.], tooltip:dir[The configured key encryption secret will be used as the content encryption key to encrypt the session cookie content. Using the direct encryption avoids a content encryption key generation step and will make the encrypted session cookie sequence slightly shorter. Avoid using the direct encryption if the encryption secret is less than 32 characters long.] +|tooltip:a256-gcmkw[Content encryption key will be generated and encrypted using the A256GCMKW algorithm and the configured encryption secret. The generated content encryption key will be used to encrypt the session cookie content.] + +a| [[quarkus-oidc_quarkus-oidc-tenant-allow-token-introspection-cache]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-allow-token-introspection-cache[`quarkus.oidc."tenant".allow-token-introspection-cache`]## + +[.description] +-- +Allow caching the token introspection data. Note enabling this property does not enable the cache itself but only permits to cache the token introspection for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__ALLOW_TOKEN_INTROSPECTION_CACHE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__ALLOW_TOKEN_INTROSPECTION_CACHE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-allow-user-info-cache]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-allow-user-info-cache[`quarkus.oidc."tenant".allow-user-info-cache`]## + +[.description] +-- +Allow caching the user info data. Note enabling this property does not enable the cache itself but only permits to cache the user info data for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__ALLOW_USER_INFO_CACHE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__ALLOW_USER_INFO_CACHE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-cache-user-info-in-idtoken]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-cache-user-info-in-idtoken[`quarkus.oidc."tenant".cache-user-info-in-idtoken`]## + +[.description] +-- +Allow inlining UserInfo in IdToken instead of caching it in the token cache. This property is only checked when an internal IdToken is generated when OAuth2 providers do not return IdToken. Inlining UserInfo in the generated IdToken allows to store it in the session cookie and avoids introducing a cached state. + +Inlining UserInfo in the generated IdToken is enabled if the session cookie is encrypted and the UserInfo cache is not enabled or caching UserInfo is disabled for the current tenant with the `allow-user-info-cache` property set to `false`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CACHE_USER_INFO_IN_IDTOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CACHE_USER_INFO_IN_IDTOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-jwks-resolve-early]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-jwks-resolve-early[`quarkus.oidc."tenant".jwks.resolve-early`]## + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property delays the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-oidc_quarkus-oidc-tenant-jwks-cache-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-jwks-cache-size[`quarkus.oidc."tenant".jwks.cache-size`]## + +[.description] +-- +Maximum number of JWK keys that can be cached. This property is ignored if the `resolve-early` property is set to true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10` + +a| [[quarkus-oidc_quarkus-oidc-tenant-jwks-cache-time-to-live]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-jwks-cache-time-to-live[`quarkus.oidc."tenant".jwks.cache-time-to-live`]## + +[.description] +-- +Number of minutes a JWK key can be cached for. This property is ignored if the `resolve-early` property is set to true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`10M` + +a| [[quarkus-oidc_quarkus-oidc-tenant-jwks-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-jwks-clean-up-timer-interval[`quarkus.oidc."tenant".jwks.clean-up-timer-interval`]## + +[.description] +-- +Cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. This property is ignored if the `resolve-early` property is set to true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-jwks-try-all]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-jwks-try-all[`quarkus.oidc."tenant".jwks.try-all`]## + +[.description] +-- +In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t++#++S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_TRY_ALL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_TRY_ALL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-provider]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-provider[`quarkus.oidc."tenant".provider`]## + +[.description] +-- +Well known OpenId Connect provider identifier + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|`apple`, `discord`, `facebook`, `github`, `google`, `linkedin`, `mastodon`, `microsoft`, `spotify`, `strava`, `twitch`, `twitter`, `x` +| + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-oidc_quarkus-oidc] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] diff --git a/_generated-doc/latest/config/quarkus-oidc_quarkus.oidc.adoc b/_generated-doc/latest/config/quarkus-oidc_quarkus.oidc.adoc index 8d4956e6cba..38cc9c06e6a 100644 --- a/_generated-doc/latest/config/quarkus-oidc_quarkus.oidc.adoc +++ b/_generated-doc/latest/config/quarkus-oidc_quarkus.oidc.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-oidc_quarkus-oidc [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -63,7 +62,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-devui-web-cli [.description] -- -The WebClient timeout. Use this property to configure how long an HTTP client used by Dev UI handlers will wait for a response when requesting tokens from OpenId Connect Provider and sending them to the service endpoint. This timeout is also used by the OIDC dev service admin client. +The WebClient timeout. Use this property to configure how long an HTTP client used by Dev UI handlers will wait for a response when requesting tokens from OpenId Connect Provider and sending them to the service endpoint. ifdef::add-copy-button-to-env-var[] @@ -73,7 +72,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_DEVUI_WEB_CLIENT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`4S` a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-oidc-default-token-cache-enabled]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-default-token-cache-enabled[`quarkus.oidc.default-token-cache-enabled`]## @@ -97,7 +96,7 @@ a| [[quarkus-oidc_quarkus-oidc-auth-server-url]] [.property-path]##link:#quarkus [.description] -- -The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. ifdef::add-copy-button-to-env-var[] @@ -127,69 +126,18 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a| [[quarkus-oidc_quarkus-oidc-token-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-path[`quarkus.oidc.token-path`]## - -[.description] --- -The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TOKEN_PATH+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-revoke-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-revoke-path[`quarkus.oidc.revoke-path`]## - -[.description] --- -The relative path or absolute URL of the OIDC token revocation endpoint. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_REVOKE_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_REVOKE_PATH+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-client-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-client-id[`quarkus.oidc.client-id`]## +a| [[quarkus-oidc_quarkus-oidc-registration-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-registration-path[`quarkus.oidc.registration-path`]## [.description] -- -The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_REGISTRATION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_ID+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-client-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-client-name[`quarkus.oidc.client-name`]## - -[.description] --- -The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CLIENT_NAME+++` +Environment variable: `+++QUARKUS_OIDC_REGISTRATION_PATH+++` endif::add-copy-button-to-env-var[] -- |string @@ -209,7 +157,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_CONNECTION_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-connection-retry-count]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-connection-retry-count[`quarkus.oidc.connection-retry-count`]## @@ -243,7 +191,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-oidc_quarkus-oidc-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-use-blocking-dns-lookup[`quarkus.oidc.use-blocking-dns-lookup`]## @@ -280,703 +228,588 @@ endif::add-copy-button-to-env-var[] |int | -a| [[quarkus-oidc_quarkus-oidc-credentials-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-secret[`quarkus.oidc.credentials.secret`]## - -[.description] --- -The client secret used by the `client_secret_basic` authentication method. Must be set unless a secret is set in `client-secret` or `jwt` client authentication is required. You can use `client-secret.value` instead, but both properties are mutually exclusive. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_SECRET+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_SECRET+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-value]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-value[`quarkus.oidc.credentials.client-secret.value`]## - -[.description] --- -The client secret value. This value is ignored if `credentials.secret` is set. Must be set unless a secret is set in `client-secret` or `jwt` client authentication is required. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_VALUE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_VALUE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-name[`quarkus.oidc.credentials.client-secret.provider.name`]## - -[.description] --- -The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_NAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-keyring-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-keyring-name[`quarkus.oidc.credentials.client-secret.provider.keyring-name`]## - -[.description] --- -The CredentialsProvider keyring name. The keyring name is only required when the CredentialsProvider being used requires the keyring name to look up the secret, which is often the case when a CredentialsProvider is shared by multiple extensions to retrieve credentials from a more dynamic source like a vault instance or secret manager - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEYRING_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEYRING_NAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-key[`quarkus.oidc.credentials.client-secret.provider.key`]## +a| [[quarkus-oidc_quarkus-oidc-proxy-host]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-host[`quarkus.oidc.proxy.host`]## [.description] -- -The CredentialsProvider client secret key +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_HOST+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEY+++` +Environment variable: `+++QUARKUS_OIDC_PROXY_HOST+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-method]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-method[`quarkus.oidc.credentials.client-secret.method`]## - -[.description] --- -The authentication method. If the `clientSecret.value` secret is set, this method is `basic` by default. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_METHOD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_METHOD+++` -endif::add-copy-button-to-env-var[] --- -a|tooltip:basic[`client_secret_basic` (default)\: The client id and secret are submitted with the HTTP Authorization Basic scheme.], tooltip:post[`client_secret_post`\: The client id and secret are submitted as the `client_id` and `client_secret` form parameters.], tooltip:post-jwt[`client_secret_jwt`\: The client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters.], tooltip:query[client id and secret are submitted as HTTP query parameters. This option is only supported by the OIDC extension.] -| - -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-source]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-source[`quarkus.oidc.credentials.jwt.source`]## +a| [[quarkus-oidc_quarkus-oidc-proxy-port]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-port[`quarkus.oidc.proxy.port`]## [.description] -- -JWT token source: OIDC provider client or an existing JWT bearer token. +The port number of the Proxy. The default value is `80`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SOURCE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SOURCE+++` +Environment variable: `+++QUARKUS_OIDC_PROXY_PORT+++` endif::add-copy-button-to-env-var[] -- -a|`client`, `bearer` -|`client` +|int +|`80` -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-secret[`quarkus.oidc.credentials.jwt.secret`]## +a| [[quarkus-oidc_quarkus-oidc-proxy-username]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-username[`quarkus.oidc.proxy.username`]## [.description] -- -If provided, indicates that JWT is signed using a secret key. +The username, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET+++` +Environment variable: `+++QUARKUS_OIDC_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-name[`quarkus.oidc.credentials.jwt.secret-provider.name`]## +a| [[quarkus-oidc_quarkus-oidc-proxy-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-password[`quarkus.oidc.proxy.password`]## [.description] -- -The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered +The password, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_NAME+++` +Environment variable: `+++QUARKUS_OIDC_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-keyring-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-keyring-name[`quarkus.oidc.credentials.jwt.secret-provider.keyring-name`]## +a| [[quarkus-oidc_quarkus-oidc-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-tls-configuration-name[`quarkus.oidc.tls.tls-configuration-name`]## [.description] -- -The CredentialsProvider keyring name. The keyring name is only required when the CredentialsProvider being used requires the keyring name to look up the secret, which is often the case when a CredentialsProvider is shared by multiple extensions to retrieve credentials from a more dynamic source like a vault instance or secret manager +The name of the TLS configuration to use. +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEYRING_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEYRING_NAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-key[`quarkus.oidc.credentials.jwt.secret-provider.key`]## - -[.description] --- -The CredentialsProvider client secret key +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEY+++` +Environment variable: `+++QUARKUS_OIDC_TLS_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key[`quarkus.oidc.credentials.jwt.key`]## +a| [[quarkus-oidc_quarkus-oidc-token-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-path[`quarkus.oidc.token-path`]## [.description] -- -String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TOKEN_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY+++` +Environment variable: `+++QUARKUS_OIDC_TOKEN_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-file[`quarkus.oidc.credentials.jwt.key-file`]## +a| [[quarkus-oidc_quarkus-oidc-revoke-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-revoke-path[`quarkus.oidc.revoke-path`]## [.description] -- -If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +The relative path or absolute URL of the OIDC token revocation endpoint. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_FILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_REVOKE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_FILE+++` +Environment variable: `+++QUARKUS_OIDC_REVOKE_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-store-file[`quarkus.oidc.credentials.jwt.key-store-file`]## +a| [[quarkus-oidc_quarkus-oidc-client-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-client-id[`quarkus.oidc.client-id`]## [.description] -- -If provided, indicates that JWT is signed using a private key from a keystore. +The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_FILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_FILE+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_ID+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-store-password[`quarkus.oidc.credentials.jwt.key-store-password`]## +a| [[quarkus-oidc_quarkus-oidc-client-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-client-name[`quarkus.oidc.client-name`]## [.description] -- -A parameter to specify the password of the keystore file. +The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CLIENT_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-id[`quarkus.oidc.credentials.jwt.key-id`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-secret[`quarkus.oidc.credentials.secret`]## [.description] -- -The private key id or alias. +The client secret used by the `client_secret_basic` authentication method. Must be set unless a secret is set in `client-secret` or `jwt` client authentication is required. You can use `client-secret.value` instead, but both properties are mutually exclusive. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_ID+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_SECRET+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-password[`quarkus.oidc.credentials.jwt.key-password`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-value]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-value[`quarkus.oidc.credentials.client-secret.value`]## [.description] -- -The private key password. +The client secret value. This value is ignored if `credentials.secret` is set. Must be set unless a secret is set in `client-secret` or `jwt` client authentication is required. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_VALUE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_VALUE+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-audience]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-audience[`quarkus.oidc.credentials.jwt.audience`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-name[`quarkus.oidc.credentials.client-secret.provider.name`]## [.description] -- -The JWT audience (`aud`) claim value. By default, the audience is set to the address of the OpenId Connect Provider's token endpoint. +The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_AUDIENCE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_AUDIENCE+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-token-key-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-token-key-id[`quarkus.oidc.credentials.jwt.token-key-id`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-keyring-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-keyring-name[`quarkus.oidc.credentials.client-secret.provider.keyring-name`]## [.description] -- -The key identifier of the signing key added as a JWT `kid` header. +The CredentialsProvider keyring name. The keyring name is only required when the CredentialsProvider being used requires the keyring name to look up the secret, which is often the case when a CredentialsProvider is shared by multiple extensions to retrieve credentials from a more dynamic source like a vault instance or secret manager ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_TOKEN_KEY_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEYRING_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_TOKEN_KEY_ID+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEYRING_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-issuer]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-issuer[`quarkus.oidc.credentials.jwt.issuer`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-provider-key[`quarkus.oidc.credentials.client-secret.provider.key`]## [.description] -- -The issuer of the signing key added as a JWT `iss` claim. The default value is the client id. +The CredentialsProvider client secret key ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_ISSUER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_ISSUER+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_PROVIDER_KEY+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-subject]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-subject[`quarkus.oidc.credentials.jwt.subject`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-client-secret-method]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-client-secret-method[`quarkus.oidc.credentials.client-secret.method`]## [.description] -- -Subject of the signing key added as a JWT `sub` claim The default value is the client id. +The authentication method. If the `clientSecret.value` secret is set, this method is `basic` by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SUBJECT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_METHOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SUBJECT+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_CLIENT_SECRET_METHOD+++` endif::add-copy-button-to-env-var[] -- -|string +a|tooltip:basic[`client_secret_basic` (default)\: The client id and secret are submitted with the HTTP Authorization Basic scheme.], tooltip:post[`client_secret_post`\: The client id and secret are submitted as the `client_id` and `client_secret` form parameters.], tooltip:post-jwt[`client_secret_jwt`\: The client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters.], tooltip:query[client id and secret are submitted as HTTP query parameters. This option is only supported by the OIDC extension.] | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-claims-claim-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-claims-claim-name[`quarkus.oidc.credentials.jwt.claims."claim-name"`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-source]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-source[`quarkus.oidc.credentials.jwt.source`]## [.description] -- -Additional claims. +JWT token source: OIDC provider client or an existing JWT bearer token. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_CLAIMS__CLAIM_NAME_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SOURCE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_CLAIMS__CLAIM_NAME_+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SOURCE+++` endif::add-copy-button-to-env-var[] -- -|Map -| +a|`client`, `bearer` +|`client` -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-signature-algorithm]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-signature-algorithm[`quarkus.oidc.credentials.jwt.signature-algorithm`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-secret[`quarkus.oidc.credentials.jwt.secret`]## [.description] -- -The signature algorithm used for the `key-file` property. Supported values: `RS256` (default), `RS384`, `RS512`, `PS256`, `PS384`, `PS512`, `ES256`, `ES384`, `ES512`, `HS256`, `HS384`, `HS512`. +If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SIGNATURE_ALGORITHM+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SIGNATURE_ALGORITHM+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-lifespan]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-lifespan[`quarkus.oidc.credentials.jwt.lifespan`]## - -[.description] --- -The JWT lifespan in seconds. This value is added to the time at which the JWT was issued to calculate the expiration time. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_LIFESPAN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_LIFESPAN+++` -endif::add-copy-button-to-env-var[] --- -|int -|`10` - -a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-assertion]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-assertion[`quarkus.oidc.credentials.jwt.assertion`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-name[`quarkus.oidc.credentials.jwt.secret-provider.name`]## [.description] -- -If true then the client authentication token is a JWT bearer grant assertion. Instead of producing 'client_assertion' and 'client_assertion_type' form properties, only 'assertion' is produced. This option is only supported by the OIDC client extension. +The CredentialsProvider bean name, which should only be set if more than one CredentialsProvider is registered ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_ASSERTION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_ASSERTION+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-oidc_quarkus-oidc-proxy-host]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-host[`quarkus.oidc.proxy.host`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-keyring-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-keyring-name[`quarkus.oidc.credentials.jwt.secret-provider.keyring-name`]## [.description] -- -The host name or IP address of the Proxy. + -Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. +The CredentialsProvider keyring name. The keyring name is only required when the CredentialsProvider being used requires the keyring name to look up the secret, which is often the case when a CredentialsProvider is shared by multiple extensions to retrieve credentials from a more dynamic source like a vault instance or secret manager ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_HOST+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEYRING_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_PROXY_HOST+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEYRING_NAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-proxy-port]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-port[`quarkus.oidc.proxy.port`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-secret-provider-key[`quarkus.oidc.credentials.jwt.secret-provider.key`]## [.description] -- -The port number of the Proxy. The default value is `80`. +The CredentialsProvider client secret key ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_PORT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_PROXY_PORT+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SECRET_PROVIDER_KEY+++` endif::add-copy-button-to-env-var[] -- -|int -|`80` +|string +| -a| [[quarkus-oidc_quarkus-oidc-proxy-username]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-username[`quarkus.oidc.proxy.username`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key[`quarkus.oidc.credentials.jwt.key`]## [.description] -- -The username, if the Proxy needs authentication. +String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_USERNAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_PROXY_USERNAME+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-proxy-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-proxy-password[`quarkus.oidc.proxy.password`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-file[`quarkus.oidc.credentials.jwt.key-file`]## [.description] -- -The password, if the Proxy needs authentication. +If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_PROXY_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_FILE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_PROXY_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_FILE+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tls-verification]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-verification[`quarkus.oidc.tls.verification`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-store-file[`quarkus.oidc.credentials.jwt.key-store-file`]## [.description] -- -Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is `required`. +If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_VERIFICATION+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_FILE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_VERIFICATION+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_FILE+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.], tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.], tooltip:none[All certificates are trusted and hostname verification is disabled.] +|string | -a| [[quarkus-oidc_quarkus-oidc-tls-key-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-key-store-file[`quarkus.oidc.tls.key-store-file`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-store-password[`quarkus.oidc.credentials.jwt.key-store-password`]## [.description] -- -An optional keystore that holds the certificate information instead of specifying separate files. +A parameter to specify the password of the keystore file. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_KEY_STORE_FILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_KEY_STORE_FILE+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] -- -|path +|string | -a| [[quarkus-oidc_quarkus-oidc-tls-key-store-file-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-key-store-file-type[`quarkus.oidc.tls.key-store-file-type`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-id[`quarkus.oidc.credentials.jwt.key-id`]## [.description] -- -The type of the keystore file. If not given, the type is automatically detected based on the file name. +The private key id or alias. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_KEY_STORE_FILE_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_KEY_STORE_FILE_TYPE+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_ID+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tls-key-store-provider]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-key-store-provider[`quarkus.oidc.tls.key-store-provider`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-key-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-key-password[`quarkus.oidc.credentials.jwt.key-password`]## [.description] -- -The provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type. +The private key password. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_KEY_STORE_PROVIDER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_KEY_STORE_PROVIDER+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_KEY_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tls-key-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-key-store-password[`quarkus.oidc.tls.key-store-password`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-audience]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-audience[`quarkus.oidc.credentials.jwt.audience`]## [.description] -- -The password of the keystore file. If not given, the default value, `password`, is used. +The JWT audience (`aud`) claim value. By default, the audience is set to the address of the OpenId Connect Provider's token endpoint. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_KEY_STORE_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_AUDIENCE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_KEY_STORE_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_AUDIENCE+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tls-key-store-key-alias]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-key-store-key-alias[`quarkus.oidc.tls.key-store-key-alias`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-token-key-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-token-key-id[`quarkus.oidc.credentials.jwt.token-key-id`]## [.description] -- -The alias of a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined. +The key identifier of the signing key added as a JWT `kid` header. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_KEY_STORE_KEY_ALIAS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_TOKEN_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_KEY_STORE_KEY_ALIAS+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_TOKEN_KEY_ID+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tls-key-store-key-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-key-store-key-password[`quarkus.oidc.tls.key-store-key-password`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-issuer]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-issuer[`quarkus.oidc.credentials.jwt.issuer`]## [.description] -- -The password of the key, if it is different from the `key-store-password`. +The issuer of the signing key added as a JWT `iss` claim. The default value is the client id. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_KEY_STORE_KEY_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_ISSUER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_KEY_STORE_KEY_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_ISSUER+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tls-trust-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-trust-store-file[`quarkus.oidc.tls.trust-store-file`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-subject]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-subject[`quarkus.oidc.credentials.jwt.subject`]## [.description] -- -The truststore that holds the certificate information of the certificates to trust. +Subject of the signing key added as a JWT `sub` claim The default value is the client id. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_TRUST_STORE_FILE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SUBJECT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_TRUST_STORE_FILE+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SUBJECT+++` endif::add-copy-button-to-env-var[] -- -|path +|string | -a| [[quarkus-oidc_quarkus-oidc-tls-trust-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-trust-store-password[`quarkus.oidc.tls.trust-store-password`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-claims-claim-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-claims-claim-name[`quarkus.oidc.credentials.jwt.claims."claim-name"`]## [.description] -- -The password of the truststore file. +Additional claims. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_TRUST_STORE_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_CLAIMS__CLAIM_NAME_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_TRUST_STORE_PASSWORD+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_CLAIMS__CLAIM_NAME_+++` endif::add-copy-button-to-env-var[] -- -|string +|Map | -a| [[quarkus-oidc_quarkus-oidc-tls-trust-store-cert-alias]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-trust-store-cert-alias[`quarkus.oidc.tls.trust-store-cert-alias`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-signature-algorithm]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-signature-algorithm[`quarkus.oidc.credentials.jwt.signature-algorithm`]## [.description] -- -The alias of the truststore certificate. +The signature algorithm used for the `key-file` property. Supported values: `RS256` (default), `RS384`, `RS512`, `PS256`, `PS384`, `PS512`, `ES256`, `ES384`, `ES512`, `HS256`, `HS384`, `HS512`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_TRUST_STORE_CERT_ALIAS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_SIGNATURE_ALGORITHM+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_TRUST_STORE_CERT_ALIAS+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_SIGNATURE_ALGORITHM+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tls-trust-store-file-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-trust-store-file-type[`quarkus.oidc.tls.trust-store-file-type`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-lifespan]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-lifespan[`quarkus.oidc.credentials.jwt.lifespan`]## [.description] -- -The type of the truststore file. If not given, the type is automatically detected based on the file name. +The JWT lifespan in seconds. This value is added to the time at which the JWT was issued to calculate the expiration time. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_TRUST_STORE_FILE_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_LIFESPAN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_TRUST_STORE_FILE_TYPE+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_LIFESPAN+++` endif::add-copy-button-to-env-var[] -- -|string -| +|int +|`10` -a| [[quarkus-oidc_quarkus-oidc-tls-trust-store-provider]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tls-trust-store-provider[`quarkus.oidc.tls.trust-store-provider`]## +a| [[quarkus-oidc_quarkus-oidc-credentials-jwt-assertion]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-credentials-jwt-assertion[`quarkus.oidc.credentials.jwt.assertion`]## [.description] -- -The provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type. +If true then the client authentication token is a JWT bearer grant assertion. Instead of producing 'client_assertion' and 'client_assertion_type' form properties, only 'assertion' is produced. This option is only supported by the OIDC client extension. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_TLS_TRUST_STORE_PROVIDER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CREDENTIALS_JWT_ASSERTION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC_TLS_TRUST_STORE_PROVIDER+++` +Environment variable: `+++QUARKUS_OIDC_CREDENTIALS_JWT_ASSERTION+++` endif::add-copy-button-to-env-var[] -- -|string -| +|boolean +|`false` a| [[quarkus-oidc_quarkus-oidc-tenant-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-id[`quarkus.oidc.tenant-id`]## @@ -1027,7 +860,7 @@ Environment variable: `+++QUARKUS_OIDC_APPLICATION_TYPE+++` endif::add-copy-button-to-env-var[] -- a|tooltip:web-app[A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users.], tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.], tooltip:hybrid[A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method is used if the Authorization header is set and Authorization Code Flow - if not.] -|tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.] +|tooltip:service[A {@code SERVICE} is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.] a| [[quarkus-oidc_quarkus-oidc-authorization-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authorization-path[`quarkus.oidc.authorization-path`]## @@ -1368,7 +1201,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_TOKEN_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-token-issued-at-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-issued-at-required[`quarkus.oidc.token.issued-at-required`]## @@ -1436,7 +1269,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_TOKEN_REFRESH_TOKEN_TIME_SKEW+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-token-forced-jwk-refresh-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-forced-jwk-refresh-interval[`quarkus.oidc.token.forced-jwk-refresh-interval`]## @@ -1453,7 +1286,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_TOKEN_FORCED_JWK_REFRESH_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`10M` a| [[quarkus-oidc_quarkus-oidc-token-header]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-header[`quarkus.oidc.token.header`]## @@ -1725,7 +1558,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`10M` a| [[quarkus-oidc_quarkus-oidc-logout-backchannel-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-backchannel-clean-up-timer-interval[`quarkus.oidc.logout.backchannel.clean-up-timer-interval`]## @@ -1742,7 +1575,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-logout-backchannel-logout-token-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-backchannel-logout-token-key[`quarkus.oidc.logout.backchannel.logout-token-key`]## @@ -2291,7 +2124,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_SESSION_AGE_EXTENSION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-oidc_quarkus-oidc-authentication-state-cookie-age]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-state-cookie-age[`quarkus.oidc.authentication.state-cookie-age`]## @@ -2308,7 +2141,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_STATE_COOKIE_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-oidc_quarkus-oidc-authentication-java-script-auto-redirect]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-java-script-auto-redirect[`quarkus.oidc.authentication.java-script-auto-redirect`]## @@ -2361,7 +2194,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-oidc_quarkus-oidc-authentication-pkce-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-pkce-required[`quarkus.oidc.authentication.pkce-required`]## @@ -2630,7 +2463,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`10M` a| [[quarkus-oidc_quarkus-oidc-jwks-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-jwks-clean-up-timer-interval[`quarkus.oidc.jwks.clean-up-timer-interval`]## @@ -2647,7 +2480,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-jwks-try-all]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-jwks-try-all[`quarkus.oidc.jwks.try-all`]## @@ -2715,7 +2548,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_TOKEN_CACHE_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`3M` a| [[quarkus-oidc_quarkus-oidc-token-cache-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-token-cache-clean-up-timer-interval[`quarkus.oidc.token-cache.clean-up-timer-interval`]## @@ -2732,7 +2565,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC_TOKEN_CACHE_CLEAN_UP_TIMER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-resolve-tenants-with-issuer]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-resolve-tenants-with-issuer[`quarkus.oidc.resolve-tenants-with-issuer`]## @@ -2760,7 +2593,7 @@ a| [[quarkus-oidc_quarkus-oidc-tenant-auth-server-url]] [.property-path]##link:# [.description] -- -The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. +The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (`public-key`) or certificate chain verification only (`certificate-chain`) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/++{++realm++}++`, replacing `++{++realm++}++` with the Keycloak realm name. ifdef::add-copy-button-to-env-var[] @@ -2790,157 +2623,264 @@ endif::add-copy-button-to-env-var[] |boolean |`true` -a| [[quarkus-oidc_quarkus-oidc-tenant-token-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-path[`quarkus.oidc."tenant".token-path`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-registration-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-registration-path[`quarkus.oidc."tenant".registration-path`]## [.description] -- -The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. +The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__REGISTRATION_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_PATH+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__REGISTRATION_PATH+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tenant-revoke-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-revoke-path[`quarkus.oidc."tenant".revoke-path`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-connection-delay]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-delay[`quarkus.oidc."tenant".connection-delay`]## [.description] -- -The relative path or absolute URL of the OIDC token revocation endpoint. +The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__REVOKE_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_DELAY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__REVOKE_PATH+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-connection-retry-count]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-retry-count[`quarkus.oidc."tenant".connection-retry-count`]## + +[.description] +-- +The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_RETRY_COUNT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_RETRY_COUNT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`3` + +a| [[quarkus-oidc_quarkus-oidc-tenant-connection-timeout]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-timeout[`quarkus.oidc."tenant".connection-timeout`]## + +[.description] +-- +The number of seconds after which the current OIDC connection request times out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-oidc_quarkus-oidc-tenant-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-use-blocking-dns-lookup[`quarkus.oidc."tenant".use-blocking-dns-lookup`]## + +[.description] +-- +Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__USE_BLOCKING_DNS_LOOKUP+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__USE_BLOCKING_DNS_LOOKUP+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-oidc_quarkus-oidc-tenant-max-pool-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-max-pool-size[`quarkus.oidc."tenant".max-pool-size`]## + +[.description] +-- +The maximum size of the connection pool used by the WebClient. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__MAX_POOL_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__MAX_POOL_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-host]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-host[`quarkus.oidc."tenant".proxy.host`]## + +[.description] +-- +The host name or IP address of the Proxy. + +Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_HOST+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tenant-client-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-client-id[`quarkus.oidc."tenant".client-id`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-port]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-port[`quarkus.oidc."tenant".proxy.port`]## [.description] -- -The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. +The port number of the Proxy. The default value is `80`. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CLIENT_ID+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__CLIENT_ID+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`80` + +a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-username]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-username[`quarkus.oidc."tenant".proxy.username`]## + +[.description] +-- +The username, if the Proxy needs authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tenant-client-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-client-name[`quarkus.oidc."tenant".client-name`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-password[`quarkus.oidc."tenant".proxy.password`]## [.description] -- -The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. +The password, if the Proxy needs authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CLIENT_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__CLIENT_NAME+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] -- |string | -a| [[quarkus-oidc_quarkus-oidc-tenant-connection-delay]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-delay[`quarkus.oidc."tenant".connection-delay`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-tls-tls-configuration-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-tls-configuration-name[`quarkus.oidc."tenant".tls.tls-configuration-name`]## [.description] -- -The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead. +The name of the TLS configuration to use. + +If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +The default TLS configuration is *not* used by default. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_DELAY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_TLS_CONFIGURATION_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_DELAY+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_TLS_CONFIGURATION_NAME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|string | -a| [[quarkus-oidc_quarkus-oidc-tenant-connection-retry-count]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-retry-count[`quarkus.oidc."tenant".connection-retry-count`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-token-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-path[`quarkus.oidc."tenant".token-path`]## [.description] -- -The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting. +The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if `discovery-enabled` is `false` or a discovered token endpoint path must be customized. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_RETRY_COUNT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TOKEN_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_RETRY_COUNT+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_PATH+++` endif::add-copy-button-to-env-var[] -- -|int -|`3` +|string +| -a| [[quarkus-oidc_quarkus-oidc-tenant-connection-timeout]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-connection-timeout[`quarkus.oidc."tenant".connection-timeout`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-revoke-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-revoke-path[`quarkus.oidc."tenant".revoke-path`]## [.description] -- -The number of seconds after which the current OIDC connection request times out. +The relative path or absolute URL of the OIDC token revocation endpoint. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CONNECTION_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__REVOKE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__CONNECTION_TIMEOUT+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__REVOKE_PATH+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` +|string +| -a| [[quarkus-oidc_quarkus-oidc-tenant-use-blocking-dns-lookup]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-use-blocking-dns-lookup[`quarkus.oidc."tenant".use-blocking-dns-lookup`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-client-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-client-id[`quarkus.oidc."tenant".client-id`]## [.description] -- -Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server. +The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if `application-type` is `service` and no token introspection is required. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__USE_BLOCKING_DNS_LOOKUP+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CLIENT_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__USE_BLOCKING_DNS_LOOKUP+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__CLIENT_ID+++` endif::add-copy-button-to-env-var[] -- -|boolean -|`false` +|string +| -a| [[quarkus-oidc_quarkus-oidc-tenant-max-pool-size]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-max-pool-size[`quarkus.oidc."tenant".max-pool-size`]## +a| [[quarkus-oidc_quarkus-oidc-tenant-client-name]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-client-name[`quarkus.oidc."tenant".client-name`]## [.description] -- -The maximum size of the connection pool used by the WebClient. +The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__MAX_POOL_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__CLIENT_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__MAX_POOL_SIZE+++` +Environment variable: `+++QUARKUS_OIDC__TENANT__CLIENT_NAME+++` endif::add-copy-button-to-env-var[] -- -|int +|string | a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-secret]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-credentials-secret[`quarkus.oidc."tenant".credentials.secret`]## @@ -3066,7 +3006,7 @@ a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-secret]] [.property-path]# [.description] -- -If provided, indicates that JWT is signed using a secret key. +If provided, indicates that JWT is signed using a secret key. It is mutually exclusive with `key`, `key-file` and `key-store` properties. ifdef::add-copy-button-to-env-var[] @@ -3134,7 +3074,7 @@ a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key]] [.property-path]##li [.description] -- -String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +String representation of a private key. If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key-file` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -3151,7 +3091,7 @@ a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-file]] [.property-path [.description] -- -If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. +If provided, indicates that JWT is signed using a private key in PEM or JWK format. It is mutually exclusive with `secret`, `key` and `key-store` properties. You can use the `signature-algorithm` property to override the default key algorithm, `RS256`. ifdef::add-copy-button-to-env-var[] @@ -3168,7 +3108,7 @@ a| [[quarkus-oidc_quarkus-oidc-tenant-credentials-jwt-key-store-file]] [.propert [.description] -- -If provided, indicates that JWT is signed using a private key from a keystore. +If provided, indicates that JWT is signed using a private key from a keystore. It is mutually exclusive with `secret`, `key` and `key-file` properties. ifdef::add-copy-button-to-env-var[] @@ -3368,279 +3308,6 @@ endif::add-copy-button-to-env-var[] |boolean |`false` -a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-host]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-host[`quarkus.oidc."tenant".proxy.host`]## - -[.description] --- -The host name or IP address of the Proxy. + -Note: If the OIDC adapter requires a Proxy to talk with the OIDC server (Provider), set this value to enable the usage of a Proxy. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_HOST+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_HOST+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-port]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-port[`quarkus.oidc."tenant".proxy.port`]## - -[.description] --- -The port number of the Proxy. The default value is `80`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_PORT+++` -endif::add-copy-button-to-env-var[] --- -|int -|`80` - -a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-username]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-username[`quarkus.oidc."tenant".proxy.username`]## - -[.description] --- -The username, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_USERNAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-proxy-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-proxy-password[`quarkus.oidc."tenant".proxy.password`]## - -[.description] --- -The password, if the Proxy needs authentication. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__PROXY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__PROXY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-verification]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-verification[`quarkus.oidc."tenant".tls.verification`]## - -[.description] --- -Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is `required`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_VERIFICATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_VERIFICATION+++` -endif::add-copy-button-to-env-var[] --- -a|tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.], tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.], tooltip:none[All certificates are trusted and hostname verification is disabled.] -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-key-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-key-store-file[`quarkus.oidc."tenant".tls.key-store-file`]## - -[.description] --- -An optional keystore that holds the certificate information instead of specifying separate files. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-key-store-file-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-key-store-file-type[`quarkus.oidc."tenant".tls.key-store-file-type`]## - -[.description] --- -The type of the keystore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-key-store-provider]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-key-store-provider[`quarkus.oidc."tenant".tls.key-store-provider`]## - -[.description] --- -The provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-key-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-key-store-password[`quarkus.oidc."tenant".tls.key-store-password`]## - -[.description] --- -The password of the keystore file. If not given, the default value, `password`, is used. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-key-store-key-alias]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-key-store-key-alias[`quarkus.oidc."tenant".tls.key-store-key-alias`]## - -[.description] --- -The alias of a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_KEY_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_KEY_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-key-store-key-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-key-store-key-password[`quarkus.oidc."tenant".tls.key-store-key-password`]## - -[.description] --- -The password of the key, if it is different from the `key-store-password`. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_KEY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_KEY_STORE_KEY_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-file]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-file[`quarkus.oidc."tenant".tls.trust-store-file`]## - -[.description] --- -The truststore that holds the certificate information of the certificates to trust. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_FILE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_FILE+++` -endif::add-copy-button-to-env-var[] --- -|path -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-password]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-password[`quarkus.oidc."tenant".tls.trust-store-password`]## - -[.description] --- -The password of the truststore file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-cert-alias]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-cert-alias[`quarkus.oidc."tenant".tls.trust-store-cert-alias`]## - -[.description] --- -The alias of the truststore certificate. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_CERT_ALIAS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_CERT_ALIAS+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-file-type]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-file-type[`quarkus.oidc."tenant".tls.trust-store-file-type`]## - -[.description] --- -The type of the truststore file. If not given, the type is automatically detected based on the file name. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_FILE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_FILE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-provider]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tls-trust-store-provider[`quarkus.oidc."tenant".tls.trust-store-provider`]## - -[.description] --- -The provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OIDC__TENANT__TLS_TRUST_STORE_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a| [[quarkus-oidc_quarkus-oidc-tenant-tenant-id]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-tenant-id[`quarkus.oidc."tenant".tenant-id`]## [.description] @@ -3690,7 +3357,7 @@ Environment variable: `+++QUARKUS_OIDC__TENANT__APPLICATION_TYPE+++` endif::add-copy-button-to-env-var[] -- a|tooltip:web-app[A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users.], tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.], tooltip:hybrid[A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method is used if the Authorization header is set and Authorization Code Flow - if not.] -|tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.] +|tooltip:service[A {@code SERVICE} is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.] a| [[quarkus-oidc_quarkus-oidc-tenant-authorization-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authorization-path[`quarkus.oidc."tenant".authorization-path`]## @@ -4031,7 +3698,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-tenant-token-issued-at-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-issued-at-required[`quarkus.oidc."tenant".token.issued-at-required`]## @@ -4099,7 +3766,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_REFRESH_TOKEN_TIME_SKEW+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-tenant-token-forced-jwk-refresh-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-forced-jwk-refresh-interval[`quarkus.oidc."tenant".token.forced-jwk-refresh-interval`]## @@ -4116,7 +3783,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__TOKEN_FORCED_JWK_REFRESH_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`10M` a| [[quarkus-oidc_quarkus-oidc-tenant-token-header]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-token-header[`quarkus.oidc."tenant".token.header`]## @@ -4388,7 +4055,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`10M` a| [[quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-clean-up-timer-interval[`quarkus.oidc."tenant".logout.backchannel.clean-up-timer-interval`]## @@ -4405,7 +4072,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-logout-token-key]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-logout-token-key[`quarkus.oidc."tenant".logout.backchannel.logout-token-key`]## @@ -4954,7 +4621,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_AGE_EXTENSION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-state-cookie-age]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-state-cookie-age[`quarkus.oidc."tenant".authentication.state-cookie-age`]## @@ -4971,7 +4638,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_STATE_COOKIE_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-java-script-auto-redirect]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-java-script-auto-redirect[`quarkus.oidc."tenant".authentication.java-script-auto-redirect`]## @@ -5024,7 +4691,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`5M` a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-pkce-required]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-authentication-pkce-required[`quarkus.oidc."tenant".authentication.pkce-required`]## @@ -5293,7 +4960,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] |`10M` a| [[quarkus-oidc_quarkus-oidc-tenant-jwks-clean-up-timer-interval]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-jwks-clean-up-timer-interval[`quarkus.oidc."tenant".jwks.clean-up-timer-interval`]## @@ -5310,7 +4977,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-oidc_quarkus-oidc[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-oidc_quarkus-oidc-tenant-jwks-try-all]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-tenant-jwks-try-all[`quarkus.oidc."tenant".jwks.try-all`]## @@ -5369,5 +5036,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-opentelemetry.adoc b/_generated-doc/latest/config/quarkus-opentelemetry.adoc index 9475ff0b221..fb143bc7fb1 100644 --- a/_generated-doc/latest/config/quarkus-opentelemetry.adoc +++ b/_generated-doc/latest/config/quarkus-opentelemetry.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-opentelemetry_quarkus-otel [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -126,11 +125,32 @@ endif::add-copy-button-to-env-var[] |list of string |`cdi` +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-logs-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-logs-enabled[`quarkus.otel.logs.enabled`]## + +[.description] +-- +Enable logs with OpenTelemetry. + +This property is not available in the Open Telemetry SDK. It's Quarkus specific. + +Support for logs will be enabled if OpenTelemetry support is enabled and either this value is true, or this value is unset. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_LOGS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_LOGS_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-logs-exporter]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-logs-exporter[`quarkus.otel.logs.exporter`]## [.description] -- -No Log exporter for now. +The Logs exporter to use. ifdef::add-copy-button-to-env-var[] @@ -141,7 +161,7 @@ Environment variable: `+++QUARKUS_OTEL_LOGS_EXPORTER+++` endif::add-copy-button-to-env-var[] -- |list of string -|`none` +|`cdi` a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-propagators]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-propagators[`quarkus.otel.propagators`]## @@ -383,9 +403,28 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_METRIC_EXPORT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] |`60S` +a| [[quarkus-opentelemetry_quarkus-otel-logs-handler-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-logs-handler-enabled[`quarkus.otel.logs.handler.enabled`]## + +[.description] +-- +Determine whether to enable the OpenTelemetry logging handler. + +This is a Quarkus specific property. The OpenTelemetry logging handler is enabled by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_LOGS_HANDLER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_LOGS_HANDLER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + a| [[quarkus-opentelemetry_quarkus-otel-attribute-value-length-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-attribute-value-length-limit[`quarkus.otel.attribute.value.length.limit`]## [.description] @@ -516,7 +555,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_BSP_SCHEDULE_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-opentelemetry_quarkus-otel-bsp-max-queue-size]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-bsp-max-queue-size[`quarkus.otel.bsp.max.queue.size`]## @@ -573,7 +612,83 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_BSP_EXPORT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-opentelemetry_quarkus-otel-blrp-schedule-delay]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-blrp-schedule-delay[`quarkus.otel.blrp.schedule.delay`]## + +[.description] +-- +The interval, in milliseconds, between two consecutive exports. + +Default is `1000`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BLRP_SCHEDULE_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_BLRP_SCHEDULE_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] +|`1S` + +a| [[quarkus-opentelemetry_quarkus-otel-blrp-max-queue-size]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-blrp-max-queue-size[`quarkus.otel.blrp.max.queue.size`]## + +[.description] +-- +The maximum queue size. + +Default is `2048`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BLRP_MAX_QUEUE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_BLRP_MAX_QUEUE_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`2048` + +a| [[quarkus-opentelemetry_quarkus-otel-blrp-max-export-batch-size]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-blrp-max-export-batch-size[`quarkus.otel.blrp.max.export.batch.size`]## + +[.description] +-- +The maximum batch size. + +Default is `512`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BLRP_MAX_EXPORT_BATCH_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_BLRP_MAX_EXPORT_BATCH_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`512` + +a| [[quarkus-opentelemetry_quarkus-otel-blrp-export-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-blrp-export-timeout[`quarkus.otel.blrp.export.timeout`]## + +[.description] +-- +The maximum allowed time, in milliseconds, to export data. + +Default is `30s`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BLRP_EXPORT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_BLRP_EXPORT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-opentelemetry_quarkus-otel-resource-attributes]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-resource-attributes[`quarkus.otel.resource.attributes`]## @@ -643,8 +758,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_EXPERIMENTAL_SHUTDOWN_WAIT_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`1S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] +|`2S` a| [[quarkus-opentelemetry_quarkus-otel-instrument-vertx-http]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-vertx-http[`quarkus.otel.instrument.vertx-http`]## @@ -808,7 +923,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] |`10s` a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-protocol[`quarkus.otel.exporter.otlp.protocol`]## @@ -1076,7 +1191,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] |`10s` a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-protocol[`quarkus.otel.exporter.otlp.traces.protocol`]## @@ -1344,7 +1459,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] |`10s` a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-protocol[`quarkus.otel.exporter.otlp.metrics.protocol`]## @@ -1579,6 +1694,274 @@ endif::add-copy-button-to-env-var[] |string |`explicit_bucket_histogram` +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-endpoint]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-endpoint[`quarkus.otel.exporter.otlp.logs.endpoint`]## + +[.description] +-- +Sets the OTLP endpoint to send telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..endpoint` where is one of the supported signal types, like `traces` or `metrics`. + +If protocol is `http/protobuf` the version and signal will be appended to the path (e.g. v1/traces or v1/metrics) and the default port will be `OtlpExporterRuntimeConfig++#++DEFAULT_HTTP_BASE_URI`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`http://localhost:4317/` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-headers]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-headers[`quarkus.otel.exporter.otlp.logs.headers`]## + +[.description] +-- +Key-value pairs to be used as headers associated with exporter requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the "=" character. i.e.: key1=value1,key2=value2 + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..headers` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_HEADERS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_HEADERS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-compression]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-compression[`quarkus.otel.exporter.otlp.logs.compression`]## + +[.description] +-- +Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..compression` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_COMPRESSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_COMPRESSION+++` +endif::add-copy-button-to-env-var[] +-- +a|`gzip`, `none` +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-timeout[`quarkus.otel.exporter.otlp.logs.timeout`]## + +[.description] +-- +Sets the maximum time to wait for the collector to process an exported batch of telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..timeout` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] +|`10s` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-protocol[`quarkus.otel.exporter.otlp.logs.protocol`]## + +[.description] +-- +OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different. + +Currently, only `grpc` and `http/protobuf` are allowed. + +Please mind that changing the protocol requires changing the port in the endpoint as well. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..protocol` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`grpc` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-key-cert-keys]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-key-cert-keys[`quarkus.otel.exporter.otlp.logs.key-cert.keys`]## + +[.description] +-- +Comma-separated list of the path to the key files (Pem format). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_KEY_CERT_KEYS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_KEY_CERT_KEYS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-key-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-key-cert-certs[`quarkus.otel.exporter.otlp.logs.key-cert.certs`]## + +[.description] +-- +Comma-separated list of the path to the certificate files (Pem format). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_KEY_CERT_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_KEY_CERT_CERTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-trust-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-trust-cert-certs[`quarkus.otel.exporter.otlp.logs.trust-cert.certs`]## + +[.description] +-- +Comma-separated list of the trust certificate files (Pem format). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TRUST_CERT_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TRUST_CERT_CERTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-tls-configuration-name]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-tls-configuration-name[`quarkus.otel.exporter.otlp.logs.tls-configuration-name`]## + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..tls-configuration-name` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-enabled[`quarkus.otel.exporter.otlp.logs.proxy-options.enabled`]## + +[.description] +-- +If proxy connection must be used. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.enabled` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-username]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-username[`quarkus.otel.exporter.otlp.logs.proxy-options.username`]## + +[.description] +-- +Set proxy username. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.username` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-password]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-password[`quarkus.otel.exporter.otlp.logs.proxy-options.password`]## + +[.description] +-- +Set proxy password. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.password` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-port]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-port[`quarkus.otel.exporter.otlp.logs.proxy-options.port`]## + +[.description] +-- +Set proxy port. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.port` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-host]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-host[`quarkus.otel.exporter.otlp.logs.proxy-options.host`]## + +[.description] +-- +Set proxy host. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.host` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + |=== ifndef::no-duration-note[] @@ -1600,5 +1983,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-opentelemetry_quarkus.otel.adoc b/_generated-doc/latest/config/quarkus-opentelemetry_quarkus.otel.adoc index 9475ff0b221..fb143bc7fb1 100644 --- a/_generated-doc/latest/config/quarkus-opentelemetry_quarkus.otel.adoc +++ b/_generated-doc/latest/config/quarkus-opentelemetry_quarkus.otel.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-opentelemetry_quarkus-otel [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -126,11 +125,32 @@ endif::add-copy-button-to-env-var[] |list of string |`cdi` +a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-logs-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-logs-enabled[`quarkus.otel.logs.enabled`]## + +[.description] +-- +Enable logs with OpenTelemetry. + +This property is not available in the Open Telemetry SDK. It's Quarkus specific. + +Support for logs will be enabled if OpenTelemetry support is enabled and either this value is true, or this value is unset. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_LOGS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_LOGS_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-logs-exporter]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-logs-exporter[`quarkus.otel.logs.exporter`]## [.description] -- -No Log exporter for now. +The Logs exporter to use. ifdef::add-copy-button-to-env-var[] @@ -141,7 +161,7 @@ Environment variable: `+++QUARKUS_OTEL_LOGS_EXPORTER+++` endif::add-copy-button-to-env-var[] -- |list of string -|`none` +|`cdi` a|icon:lock[title=Fixed at build time] [[quarkus-opentelemetry_quarkus-otel-propagators]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-propagators[`quarkus.otel.propagators`]## @@ -383,9 +403,28 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_METRIC_EXPORT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] |`60S` +a| [[quarkus-opentelemetry_quarkus-otel-logs-handler-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-logs-handler-enabled[`quarkus.otel.logs.handler.enabled`]## + +[.description] +-- +Determine whether to enable the OpenTelemetry logging handler. + +This is a Quarkus specific property. The OpenTelemetry logging handler is enabled by default. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_LOGS_HANDLER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_LOGS_HANDLER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + a| [[quarkus-opentelemetry_quarkus-otel-attribute-value-length-limit]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-attribute-value-length-limit[`quarkus.otel.attribute.value.length.limit`]## [.description] @@ -516,7 +555,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_BSP_SCHEDULE_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-opentelemetry_quarkus-otel-bsp-max-queue-size]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-bsp-max-queue-size[`quarkus.otel.bsp.max.queue.size`]## @@ -573,7 +612,83 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_BSP_EXPORT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-opentelemetry_quarkus-otel-blrp-schedule-delay]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-blrp-schedule-delay[`quarkus.otel.blrp.schedule.delay`]## + +[.description] +-- +The interval, in milliseconds, between two consecutive exports. + +Default is `1000`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BLRP_SCHEDULE_DELAY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_BLRP_SCHEDULE_DELAY+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] +|`1S` + +a| [[quarkus-opentelemetry_quarkus-otel-blrp-max-queue-size]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-blrp-max-queue-size[`quarkus.otel.blrp.max.queue.size`]## + +[.description] +-- +The maximum queue size. + +Default is `2048`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BLRP_MAX_QUEUE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_BLRP_MAX_QUEUE_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`2048` + +a| [[quarkus-opentelemetry_quarkus-otel-blrp-max-export-batch-size]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-blrp-max-export-batch-size[`quarkus.otel.blrp.max.export.batch.size`]## + +[.description] +-- +The maximum batch size. + +Default is `512`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BLRP_MAX_EXPORT_BATCH_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_BLRP_MAX_EXPORT_BATCH_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`512` + +a| [[quarkus-opentelemetry_quarkus-otel-blrp-export-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-blrp-export-timeout[`quarkus.otel.blrp.export.timeout`]## + +[.description] +-- +The maximum allowed time, in milliseconds, to export data. + +Default is `30s`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_BLRP_EXPORT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_BLRP_EXPORT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-opentelemetry_quarkus-otel-resource-attributes]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-resource-attributes[`quarkus.otel.resource.attributes`]## @@ -643,8 +758,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_EXPERIMENTAL_SHUTDOWN_WAIT_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`1S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] +|`2S` a| [[quarkus-opentelemetry_quarkus-otel-instrument-vertx-http]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-instrument-vertx-http[`quarkus.otel.instrument.vertx-http`]## @@ -808,7 +923,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] |`10s` a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-protocol[`quarkus.otel.exporter.otlp.protocol`]## @@ -1076,7 +1191,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_TRACES_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] |`10s` a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-traces-protocol[`quarkus.otel.exporter.otlp.traces.protocol`]## @@ -1344,7 +1459,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] |`10s` a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-metrics-protocol[`quarkus.otel.exporter.otlp.metrics.protocol`]## @@ -1579,6 +1694,274 @@ endif::add-copy-button-to-env-var[] |string |`explicit_bucket_histogram` +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-endpoint]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-endpoint[`quarkus.otel.exporter.otlp.logs.endpoint`]## + +[.description] +-- +Sets the OTLP endpoint to send telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_GRPC_BASE_URI`. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..endpoint` where is one of the supported signal types, like `traces` or `metrics`. + +If protocol is `http/protobuf` the version and signal will be appended to the path (e.g. v1/traces or v1/metrics) and the default port will be `OtlpExporterRuntimeConfig++#++DEFAULT_HTTP_BASE_URI`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`http://localhost:4317/` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-headers]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-headers[`quarkus.otel.exporter.otlp.logs.headers`]## + +[.description] +-- +Key-value pairs to be used as headers associated with exporter requests. The format is similar to the `OTEL_EXPORTER_OTLP_HEADERS` environment variable, a list of key-value pairs separated by the "=" character. i.e.: key1=value1,key2=value2 + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..headers` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_HEADERS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_HEADERS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-compression]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-compression[`quarkus.otel.exporter.otlp.logs.compression`]## + +[.description] +-- +Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include `gzip` and `none`. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..compression` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_COMPRESSION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_COMPRESSION+++` +endif::add-copy-button-to-env-var[] +-- +a|`gzip`, `none` +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-timeout]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-timeout[`quarkus.otel.exporter.otlp.logs.timeout`]## + +[.description] +-- +Sets the maximum time to wait for the collector to process an exported batch of telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig++#++DEFAULT_TIMEOUT_SECS`s. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..timeout` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-opentelemetry_quarkus-otel[icon:question-circle[title=More information about the Duration format]] +|`10s` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-protocol]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-protocol[`quarkus.otel.exporter.otlp.logs.protocol`]## + +[.description] +-- +OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different. + +Currently, only `grpc` and `http/protobuf` are allowed. + +Please mind that changing the protocol requires changing the port in the endpoint as well. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..protocol` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`grpc` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-key-cert-keys]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-key-cert-keys[`quarkus.otel.exporter.otlp.logs.key-cert.keys`]## + +[.description] +-- +Comma-separated list of the path to the key files (Pem format). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_KEY_CERT_KEYS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_KEY_CERT_KEYS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-key-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-key-cert-certs[`quarkus.otel.exporter.otlp.logs.key-cert.certs`]## + +[.description] +-- +Comma-separated list of the path to the certificate files (Pem format). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_KEY_CERT_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_KEY_CERT_CERTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-trust-cert-certs]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-trust-cert-certs[`quarkus.otel.exporter.otlp.logs.trust-cert.certs`]## + +[.description] +-- +Comma-separated list of the trust certificate files (Pem format). + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TRUST_CERT_CERTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TRUST_CERT_CERTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-tls-configuration-name]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-tls-configuration-name[`quarkus.otel.exporter.otlp.logs.tls-configuration-name`]## + +[.description] +-- +The name of the TLS configuration to use. + +If not set and the default TLS configuration is configured (`quarkus.tls.++*++`) then that will be used. If a name is configured, it uses the configuration from `quarkus.tls..++*++` If a name is configured, but no TLS configuration is found with that name then an error will be thrown. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..tls-configuration-name` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-enabled]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-enabled[`quarkus.otel.exporter.otlp.logs.proxy-options.enabled`]## + +[.description] +-- +If proxy connection must be used. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.enabled` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-username]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-username[`quarkus.otel.exporter.otlp.logs.proxy-options.username`]## + +[.description] +-- +Set proxy username. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.username` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-password]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-password[`quarkus.otel.exporter.otlp.logs.proxy-options.password`]## + +[.description] +-- +Set proxy password. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.password` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-port]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-port[`quarkus.otel.exporter.otlp.logs.proxy-options.port`]## + +[.description] +-- +Set proxy port. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.port` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_PORT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_PORT+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-host]] [.property-path]##link:#quarkus-opentelemetry_quarkus-otel-exporter-otlp-logs-proxy-options-host[`quarkus.otel.exporter.otlp.logs.proxy-options.host`]## + +[.description] +-- +Set proxy host. + +There is a generic property, that will apply to all signals and a signal specific one, following the pattern: `quarkus.otel.exporter.otlp..proxy-options.host` where is one of the supported signal types, like `traces` or `metrics`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_HOST+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OTEL_EXPORTER_OTLP_LOGS_PROXY_OPTIONS_HOST+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + |=== ifndef::no-duration-note[] @@ -1600,5 +1983,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-picocli.adoc b/_generated-doc/latest/config/quarkus-picocli.adoc index 206d24aedda..627447bace9 100644 --- a/_generated-doc/latest/config/quarkus-picocli.adoc +++ b/_generated-doc/latest/config/quarkus-picocli.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-picocli_quarkus-picocli [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -50,5 +49,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-picocli_quarkus.picocli.adoc b/_generated-doc/latest/config/quarkus-picocli_quarkus.picocli.adoc index 206d24aedda..627447bace9 100644 --- a/_generated-doc/latest/config/quarkus-picocli_quarkus.picocli.adoc +++ b/_generated-doc/latest/config/quarkus-picocli_quarkus.picocli.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-picocli_quarkus-picocli [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -50,5 +49,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-quartz.adoc b/_generated-doc/latest/config/quarkus-quartz.adoc index c3c795f50d6..d86ea2777c7 100644 --- a/_generated-doc/latest/config/quarkus-quartz.adoc +++ b/_generated-doc/latest/config/quarkus-quartz.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-quartz_quarkus-quartz [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -269,7 +268,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_QUARTZ_MISFIRE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-quartz_quarkus-quartz[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-quartz_quarkus-quartz-shutdown-wait-time]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-shutdown-wait-time[`quarkus.quartz.shutdown-wait-time`]## @@ -286,7 +285,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_QUARTZ_SHUTDOWN_WAIT_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-quartz_quarkus-quartz[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-quartz_quarkus-quartz-simple-trigger-misfire-policy]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-simple-trigger-misfire-policy[`quarkus.quartz.simple-trigger.misfire-policy`]## @@ -541,5 +540,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-quartz_quarkus.quartz.adoc b/_generated-doc/latest/config/quarkus-quartz_quarkus.quartz.adoc index c3c795f50d6..d86ea2777c7 100644 --- a/_generated-doc/latest/config/quarkus-quartz_quarkus.quartz.adoc +++ b/_generated-doc/latest/config/quarkus-quartz_quarkus.quartz.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-quartz_quarkus-quartz [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -269,7 +268,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_QUARTZ_MISFIRE_THRESHOLD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-quartz_quarkus-quartz[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-quartz_quarkus-quartz-shutdown-wait-time]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-shutdown-wait-time[`quarkus.quartz.shutdown-wait-time`]## @@ -286,7 +285,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_QUARTZ_SHUTDOWN_WAIT_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-quartz_quarkus-quartz[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-quartz_quarkus-quartz-simple-trigger-misfire-policy]] [.property-path]##link:#quarkus-quartz_quarkus-quartz-simple-trigger-misfire-policy[`quarkus.quartz.simple-trigger.misfire-policy`]## @@ -541,5 +540,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-qute.adoc b/_generated-doc/latest/config/quarkus-qute.adoc index 5ac0145c898..a0d001404c9 100644 --- a/_generated-doc/latest/config/quarkus-qute.adoc +++ b/_generated-doc/latest/config/quarkus-qute.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-qute_quarkus-qute [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -278,5 +277,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-qute_quarkus.qute.adoc b/_generated-doc/latest/config/quarkus-qute_quarkus.qute.adoc index 5ac0145c898..a0d001404c9 100644 --- a/_generated-doc/latest/config/quarkus-qute_quarkus.qute.adoc +++ b/_generated-doc/latest/config/quarkus-qute_quarkus.qute.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-qute_quarkus-qute [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -278,5 +277,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-reactive-datasource.adoc b/_generated-doc/latest/config/quarkus-reactive-datasource.adoc index de54dbfe164..55beb8ded1b 100644 --- a/_generated-doc/latest/config/quarkus-reactive-datasource.adoc +++ b/_generated-doc/latest/config/quarkus-reactive-datasource.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-reactive-datasource_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -10,6 +9,8 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-reactive-datasource_quarkus-datasource-reactive]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive[`quarkus.datasource.reactive`]## +`quarkus.datasource."datasource-name".reactive` + [.description] -- If we create a Reactive datasource for this datasource. @@ -27,6 +28,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-cache-prepared-statements]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-cache-prepared-statements[`quarkus.datasource.reactive.cache-prepared-statements`]## +`quarkus.datasource."datasource-name".reactive.cache-prepared-statements` + [.description] -- Whether prepared statements should be cached on the client side. @@ -44,6 +47,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-url]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-url[`quarkus.datasource.reactive.url`]## +`quarkus.datasource."datasource-name".reactive.url` + [.description] -- The datasource URLs. @@ -63,6 +68,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-max-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-max-size[`quarkus.datasource.reactive.max-size`]## +`quarkus.datasource."datasource-name".reactive.max-size` + [.description] -- The datasource pool maximum size. @@ -80,6 +87,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-event-loop-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-event-loop-size[`quarkus.datasource.reactive.event-loop-size`]## +`quarkus.datasource."datasource-name".reactive.event-loop-size` + [.description] -- When a new connection object is created, the pool assigns it an event loop. @@ -99,6 +108,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-all]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-all[`quarkus.datasource.reactive.trust-all`]## +`quarkus.datasource."datasource-name".reactive.trust-all` + [.description] -- Whether all server certificates should be trusted. @@ -116,6 +127,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem[`quarkus.datasource.reactive.trust-certificate-pem`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-pem` + [.description] -- PEM Trust config is disabled by default. @@ -133,6 +146,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem-certs[`quarkus.datasource.reactive.trust-certificate-pem.certs`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-pem.certs` + [.description] -- Comma-separated list of the trust certificate files (Pem format). @@ -150,6 +165,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks[`quarkus.datasource.reactive.trust-certificate-jks`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-jks` + [.description] -- JKS config is disabled by default. @@ -167,6 +184,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-path[`quarkus.datasource.reactive.trust-certificate-jks.path`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-jks.path` + [.description] -- Path of the key file (JKS format). @@ -184,6 +203,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-password[`quarkus.datasource.reactive.trust-certificate-jks.password`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-jks.password` + [.description] -- Password of the key file. @@ -201,6 +222,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx[`quarkus.datasource.reactive.trust-certificate-pfx`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx` + [.description] -- PFX config is disabled by default. @@ -218,6 +241,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-path[`quarkus.datasource.reactive.trust-certificate-pfx.path`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.path` + [.description] -- Path to the key file (PFX format). @@ -235,6 +260,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-password[`quarkus.datasource.reactive.trust-certificate-pfx.password`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.password` + [.description] -- Password of the key. @@ -252,6 +279,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem[`quarkus.datasource.reactive.key-certificate-pem`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-pem` + [.description] -- PEM Key/cert config is disabled by default. @@ -269,6 +298,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-keys]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-keys[`quarkus.datasource.reactive.key-certificate-pem.keys`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-pem.keys` + [.description] -- Comma-separated list of the path to the key files (Pem format). @@ -286,6 +317,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-certs[`quarkus.datasource.reactive.key-certificate-pem.certs`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-pem.certs` + [.description] -- Comma-separated list of the path to the certificate files (Pem format). @@ -303,6 +336,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks[`quarkus.datasource.reactive.key-certificate-jks`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-jks` + [.description] -- JKS config is disabled by default. @@ -320,6 +355,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-path[`quarkus.datasource.reactive.key-certificate-jks.path`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-jks.path` + [.description] -- Path of the key file (JKS format). @@ -337,6 +374,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-password[`quarkus.datasource.reactive.key-certificate-jks.password`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-jks.password` + [.description] -- Password of the key file. @@ -354,6 +393,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx[`quarkus.datasource.reactive.key-certificate-pfx`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-pfx` + [.description] -- PFX config is disabled by default. @@ -371,6 +412,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-path[`quarkus.datasource.reactive.key-certificate-pfx.path`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-pfx.path` + [.description] -- Path to the key file (PFX format). @@ -388,6 +431,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-password[`quarkus.datasource.reactive.key-certificate-pfx.password`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-pfx.password` + [.description] -- Password of the key. @@ -405,6 +450,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-attempts]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-attempts[`quarkus.datasource.reactive.reconnect-attempts`]## +`quarkus.datasource."datasource-name".reactive.reconnect-attempts` + [.description] -- The number of reconnection attempts when a pooled connection cannot be established on first try. @@ -422,6 +469,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-interval]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-interval[`quarkus.datasource.reactive.reconnect-interval`]## +`quarkus.datasource."datasource-name".reactive.reconnect-interval` + [.description] -- The interval between reconnection attempts when a pooled connection cannot be established on first try. @@ -434,11 +483,13 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-reactive-datasource_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`PT1S` a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-hostname-verification-algorithm]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-hostname-verification-algorithm[`quarkus.datasource.reactive.hostname-verification-algorithm`]## +`quarkus.datasource."datasource-name".reactive.hostname-verification-algorithm` + [.description] -- The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or `NONE`. `NONE` is the default value and disables the verification. @@ -456,6 +507,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-idle-timeout]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-idle-timeout[`quarkus.datasource.reactive.idle-timeout`]## +`quarkus.datasource."datasource-name".reactive.idle-timeout` + [.description] -- The maximum time a connection remains unused in the pool before it is closed. @@ -468,11 +521,13 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-reactive-datasource_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`no timeout` a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-max-lifetime]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-max-lifetime[`quarkus.datasource.reactive.max-lifetime`]## +`quarkus.datasource."datasource-name".reactive.max-lifetime` + [.description] -- The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary. @@ -485,11 +540,13 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_MAX_LIFETIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-reactive-datasource_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`no timeout` a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-shared]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-shared[`quarkus.datasource.reactive.shared`]## +`quarkus.datasource."datasource-name".reactive.shared` + [.description] -- Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used. @@ -507,6 +564,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-name]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-name[`quarkus.datasource.reactive.name`]## +`quarkus.datasource."datasource-name".reactive.name` + [.description] -- Set the pool name, used when the pool is shared among datasources, otherwise ignored. @@ -524,6 +583,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-additional-properties-property-key]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-additional-properties-property-key[`quarkus.datasource.reactive.additional-properties."property-key"`]## +`quarkus.datasource."datasource-name".reactive.additional-properties."property-key"` + [.description] -- Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated. @@ -539,542 +600,6 @@ endif::add-copy-button-to-env-var[] |Map | -h|[[quarkus-reactive-datasource_section_quarkus-datasource]] [.section-name.section-level0]##link:#quarkus-reactive-datasource_section_quarkus-datasource[Additional named datasources]## -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive[`quarkus.datasource."datasource-name".reactive`]## - -[.description] --- -If we create a Reactive datasource for this datasource. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-cache-prepared-statements]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-cache-prepared-statements[`quarkus.datasource."datasource-name".reactive.cache-prepared-statements`]## - -[.description] --- -Whether prepared statements should be cached on the client side. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_CACHE_PREPARED_STATEMENTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_CACHE_PREPARED_STATEMENTS+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-url]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-url[`quarkus.datasource."datasource-name".reactive.url`]## - -[.description] --- -The datasource URLs. - -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++` -endif::add-copy-button-to-env-var[] --- -|list of string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-max-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-max-size[`quarkus.datasource."datasource-name".reactive.max-size`]## - -[.description] --- -The datasource pool maximum size. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_SIZE+++` -endif::add-copy-button-to-env-var[] --- -|int -|`20` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-event-loop-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-event-loop-size[`quarkus.datasource."datasource-name".reactive.event-loop-size`]## - -[.description] --- -When a new connection object is created, the pool assigns it an event loop. - -When `++#++event-loop-size` is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If `++#++event-loop-size` is set to zero or a negative value, the pool assigns the current event loop to the new connection. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_EVENT_LOOP_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_EVENT_LOOP_SIZE+++` -endif::add-copy-button-to-env-var[] --- -|int -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-all]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-all[`quarkus.datasource."datasource-name".reactive.trust-all`]## - -[.description] --- -Whether all server certificates should be trusted. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_ALL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_ALL+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pem[`quarkus.datasource."datasource-name".reactive.trust-certificate-pem`]## - -[.description] --- -PEM Trust config is disabled by default. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pem-certs[`quarkus.datasource."datasource-name".reactive.trust-certificate-pem.certs`]## - -[.description] --- -Comma-separated list of the trust certificate files (Pem format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++` -endif::add-copy-button-to-env-var[] --- -|list of string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks[`quarkus.datasource."datasource-name".reactive.trust-certificate-jks`]## - -[.description] --- -JKS config is disabled by default. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-path[`quarkus.datasource."datasource-name".reactive.trust-certificate-jks.path`]## - -[.description] --- -Path of the key file (JKS format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-password[`quarkus.datasource."datasource-name".reactive.trust-certificate-jks.password`]## - -[.description] --- -Password of the key file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx[`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx`]## - -[.description] --- -PFX config is disabled by default. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-path[`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.path`]## - -[.description] --- -Path to the key file (PFX format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-password[`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.password`]## - -[.description] --- -Password of the key. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem[`quarkus.datasource."datasource-name".reactive.key-certificate-pem`]## - -[.description] --- -PEM Key/cert config is disabled by default. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem-keys]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem-keys[`quarkus.datasource."datasource-name".reactive.key-certificate-pem.keys`]## - -[.description] --- -Comma-separated list of the path to the key files (Pem format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++` -endif::add-copy-button-to-env-var[] --- -|list of string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem-certs[`quarkus.datasource."datasource-name".reactive.key-certificate-pem.certs`]## - -[.description] --- -Comma-separated list of the path to the certificate files (Pem format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++` -endif::add-copy-button-to-env-var[] --- -|list of string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks[`quarkus.datasource."datasource-name".reactive.key-certificate-jks`]## - -[.description] --- -JKS config is disabled by default. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks-path[`quarkus.datasource."datasource-name".reactive.key-certificate-jks.path`]## - -[.description] --- -Path of the key file (JKS format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PATH+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks-password[`quarkus.datasource."datasource-name".reactive.key-certificate-jks.password`]## - -[.description] --- -Password of the key file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx[`quarkus.datasource."datasource-name".reactive.key-certificate-pfx`]## - -[.description] --- -PFX config is disabled by default. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-path[`quarkus.datasource."datasource-name".reactive.key-certificate-pfx.path`]## - -[.description] --- -Path to the key file (PFX format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PATH+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-password[`quarkus.datasource."datasource-name".reactive.key-certificate-pfx.password`]## - -[.description] --- -Password of the key. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-reconnect-attempts]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-reconnect-attempts[`quarkus.datasource."datasource-name".reactive.reconnect-attempts`]## - -[.description] --- -The number of reconnection attempts when a pooled connection cannot be established on first try. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_ATTEMPTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_ATTEMPTS+++` -endif::add-copy-button-to-env-var[] --- -|int -|`0` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-reconnect-interval]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-reconnect-interval[`quarkus.datasource."datasource-name".reactive.reconnect-interval`]## - -[.description] --- -The interval between reconnection attempts when a pooled connection cannot be established on first try. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_INTERVAL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_INTERVAL+++` -endif::add-copy-button-to-env-var[] --- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT1S` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-hostname-verification-algorithm]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-hostname-verification-algorithm[`quarkus.datasource."datasource-name".reactive.hostname-verification-algorithm`]## - -[.description] --- -The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or `NONE`. `NONE` is the default value and disables the verification. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++` -endif::add-copy-button-to-env-var[] --- -|string -|`NONE` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-idle-timeout]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-idle-timeout[`quarkus.datasource."datasource-name".reactive.idle-timeout`]## - -[.description] --- -The maximum time a connection remains unused in the pool before it is closed. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_IDLE_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_IDLE_TIMEOUT+++` -endif::add-copy-button-to-env-var[] --- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`no timeout` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-max-lifetime]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-max-lifetime[`quarkus.datasource."datasource-name".reactive.max-lifetime`]## - -[.description] --- -The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_LIFETIME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_LIFETIME+++` -endif::add-copy-button-to-env-var[] --- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`no timeout` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-shared]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-shared[`quarkus.datasource."datasource-name".reactive.shared`]## - -[.description] --- -Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_SHARED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_SHARED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-name]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-name[`quarkus.datasource."datasource-name".reactive.name`]## - -[.description] --- -Set the pool name, used when the pool is shared among datasources, otherwise ignored. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_NAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-additional-properties-property-key]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-additional-properties-property-key[`quarkus.datasource."datasource-name".reactive.additional-properties."property-key"`]## - -[.description] --- -Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++` -endif::add-copy-button-to-env-var[] --- -|Map -| - - |=== ifndef::no-duration-note[] @@ -1096,5 +621,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-reactive-datasource_quarkus.datasource.adoc b/_generated-doc/latest/config/quarkus-reactive-datasource_quarkus.datasource.adoc index de54dbfe164..55beb8ded1b 100644 --- a/_generated-doc/latest/config/quarkus-reactive-datasource_quarkus.datasource.adoc +++ b/_generated-doc/latest/config/quarkus-reactive-datasource_quarkus.datasource.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-reactive-datasource_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -10,6 +9,8 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-reactive-datasource_quarkus-datasource-reactive]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive[`quarkus.datasource.reactive`]## +`quarkus.datasource."datasource-name".reactive` + [.description] -- If we create a Reactive datasource for this datasource. @@ -27,6 +28,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-cache-prepared-statements]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-cache-prepared-statements[`quarkus.datasource.reactive.cache-prepared-statements`]## +`quarkus.datasource."datasource-name".reactive.cache-prepared-statements` + [.description] -- Whether prepared statements should be cached on the client side. @@ -44,6 +47,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-url]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-url[`quarkus.datasource.reactive.url`]## +`quarkus.datasource."datasource-name".reactive.url` + [.description] -- The datasource URLs. @@ -63,6 +68,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-max-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-max-size[`quarkus.datasource.reactive.max-size`]## +`quarkus.datasource."datasource-name".reactive.max-size` + [.description] -- The datasource pool maximum size. @@ -80,6 +87,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-event-loop-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-event-loop-size[`quarkus.datasource.reactive.event-loop-size`]## +`quarkus.datasource."datasource-name".reactive.event-loop-size` + [.description] -- When a new connection object is created, the pool assigns it an event loop. @@ -99,6 +108,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-all]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-all[`quarkus.datasource.reactive.trust-all`]## +`quarkus.datasource."datasource-name".reactive.trust-all` + [.description] -- Whether all server certificates should be trusted. @@ -116,6 +127,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem[`quarkus.datasource.reactive.trust-certificate-pem`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-pem` + [.description] -- PEM Trust config is disabled by default. @@ -133,6 +146,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pem-certs[`quarkus.datasource.reactive.trust-certificate-pem.certs`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-pem.certs` + [.description] -- Comma-separated list of the trust certificate files (Pem format). @@ -150,6 +165,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks[`quarkus.datasource.reactive.trust-certificate-jks`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-jks` + [.description] -- JKS config is disabled by default. @@ -167,6 +184,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-path[`quarkus.datasource.reactive.trust-certificate-jks.path`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-jks.path` + [.description] -- Path of the key file (JKS format). @@ -184,6 +203,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-jks-password[`quarkus.datasource.reactive.trust-certificate-jks.password`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-jks.password` + [.description] -- Password of the key file. @@ -201,6 +222,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx[`quarkus.datasource.reactive.trust-certificate-pfx`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx` + [.description] -- PFX config is disabled by default. @@ -218,6 +241,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-path[`quarkus.datasource.reactive.trust-certificate-pfx.path`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.path` + [.description] -- Path to the key file (PFX format). @@ -235,6 +260,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-trust-certificate-pfx-password[`quarkus.datasource.reactive.trust-certificate-pfx.password`]## +`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.password` + [.description] -- Password of the key. @@ -252,6 +279,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem[`quarkus.datasource.reactive.key-certificate-pem`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-pem` + [.description] -- PEM Key/cert config is disabled by default. @@ -269,6 +298,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-keys]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-keys[`quarkus.datasource.reactive.key-certificate-pem.keys`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-pem.keys` + [.description] -- Comma-separated list of the path to the key files (Pem format). @@ -286,6 +317,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pem-certs[`quarkus.datasource.reactive.key-certificate-pem.certs`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-pem.certs` + [.description] -- Comma-separated list of the path to the certificate files (Pem format). @@ -303,6 +336,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks[`quarkus.datasource.reactive.key-certificate-jks`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-jks` + [.description] -- JKS config is disabled by default. @@ -320,6 +355,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-path[`quarkus.datasource.reactive.key-certificate-jks.path`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-jks.path` + [.description] -- Path of the key file (JKS format). @@ -337,6 +374,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-jks-password[`quarkus.datasource.reactive.key-certificate-jks.password`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-jks.password` + [.description] -- Password of the key file. @@ -354,6 +393,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx[`quarkus.datasource.reactive.key-certificate-pfx`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-pfx` + [.description] -- PFX config is disabled by default. @@ -371,6 +412,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-path[`quarkus.datasource.reactive.key-certificate-pfx.path`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-pfx.path` + [.description] -- Path to the key file (PFX format). @@ -388,6 +431,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-key-certificate-pfx-password[`quarkus.datasource.reactive.key-certificate-pfx.password`]## +`quarkus.datasource."datasource-name".reactive.key-certificate-pfx.password` + [.description] -- Password of the key. @@ -405,6 +450,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-attempts]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-attempts[`quarkus.datasource.reactive.reconnect-attempts`]## +`quarkus.datasource."datasource-name".reactive.reconnect-attempts` + [.description] -- The number of reconnection attempts when a pooled connection cannot be established on first try. @@ -422,6 +469,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-interval]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-reconnect-interval[`quarkus.datasource.reactive.reconnect-interval`]## +`quarkus.datasource."datasource-name".reactive.reconnect-interval` + [.description] -- The interval between reconnection attempts when a pooled connection cannot be established on first try. @@ -434,11 +483,13 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-reactive-datasource_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`PT1S` a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-hostname-verification-algorithm]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-hostname-verification-algorithm[`quarkus.datasource.reactive.hostname-verification-algorithm`]## +`quarkus.datasource."datasource-name".reactive.hostname-verification-algorithm` + [.description] -- The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or `NONE`. `NONE` is the default value and disables the verification. @@ -456,6 +507,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-idle-timeout]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-idle-timeout[`quarkus.datasource.reactive.idle-timeout`]## +`quarkus.datasource."datasource-name".reactive.idle-timeout` + [.description] -- The maximum time a connection remains unused in the pool before it is closed. @@ -468,11 +521,13 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-reactive-datasource_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`no timeout` a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-max-lifetime]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-max-lifetime[`quarkus.datasource.reactive.max-lifetime`]## +`quarkus.datasource."datasource-name".reactive.max-lifetime` + [.description] -- The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary. @@ -485,11 +540,13 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DATASOURCE_REACTIVE_MAX_LIFETIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-reactive-datasource_quarkus-datasource[icon:question-circle[title=More information about the Duration format]] |`no timeout` a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-shared]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-shared[`quarkus.datasource.reactive.shared`]## +`quarkus.datasource."datasource-name".reactive.shared` + [.description] -- Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used. @@ -507,6 +564,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-name]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-name[`quarkus.datasource.reactive.name`]## +`quarkus.datasource."datasource-name".reactive.name` + [.description] -- Set the pool name, used when the pool is shared among datasources, otherwise ignored. @@ -524,6 +583,8 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-reactive-datasource_quarkus-datasource-reactive-additional-properties-property-key]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-reactive-additional-properties-property-key[`quarkus.datasource.reactive.additional-properties."property-key"`]## +`quarkus.datasource."datasource-name".reactive.additional-properties."property-key"` + [.description] -- Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated. @@ -539,542 +600,6 @@ endif::add-copy-button-to-env-var[] |Map | -h|[[quarkus-reactive-datasource_section_quarkus-datasource]] [.section-name.section-level0]##link:#quarkus-reactive-datasource_section_quarkus-datasource[Additional named datasources]## -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive[`quarkus.datasource."datasource-name".reactive`]## - -[.description] --- -If we create a Reactive datasource for this datasource. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`true` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-cache-prepared-statements]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-cache-prepared-statements[`quarkus.datasource."datasource-name".reactive.cache-prepared-statements`]## - -[.description] --- -Whether prepared statements should be cached on the client side. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_CACHE_PREPARED_STATEMENTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_CACHE_PREPARED_STATEMENTS+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-url]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-url[`quarkus.datasource."datasource-name".reactive.url`]## - -[.description] --- -The datasource URLs. - -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++` -endif::add-copy-button-to-env-var[] --- -|list of string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-max-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-max-size[`quarkus.datasource."datasource-name".reactive.max-size`]## - -[.description] --- -The datasource pool maximum size. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_SIZE+++` -endif::add-copy-button-to-env-var[] --- -|int -|`20` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-event-loop-size]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-event-loop-size[`quarkus.datasource."datasource-name".reactive.event-loop-size`]## - -[.description] --- -When a new connection object is created, the pool assigns it an event loop. - -When `++#++event-loop-size` is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If `++#++event-loop-size` is set to zero or a negative value, the pool assigns the current event loop to the new connection. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_EVENT_LOOP_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_EVENT_LOOP_SIZE+++` -endif::add-copy-button-to-env-var[] --- -|int -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-all]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-all[`quarkus.datasource."datasource-name".reactive.trust-all`]## - -[.description] --- -Whether all server certificates should be trusted. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_ALL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_ALL+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pem[`quarkus.datasource."datasource-name".reactive.trust-certificate-pem`]## - -[.description] --- -PEM Trust config is disabled by default. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pem-certs[`quarkus.datasource."datasource-name".reactive.trust-certificate-pem.certs`]## - -[.description] --- -Comma-separated list of the trust certificate files (Pem format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM_CERTS+++` -endif::add-copy-button-to-env-var[] --- -|list of string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks[`quarkus.datasource."datasource-name".reactive.trust-certificate-jks`]## - -[.description] --- -JKS config is disabled by default. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-path[`quarkus.datasource."datasource-name".reactive.trust-certificate-jks.path`]## - -[.description] --- -Path of the key file (JKS format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PATH+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-jks-password[`quarkus.datasource."datasource-name".reactive.trust-certificate-jks.password`]## - -[.description] --- -Password of the key file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx[`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx`]## - -[.description] --- -PFX config is disabled by default. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-path[`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.path`]## - -[.description] --- -Path to the key file (PFX format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PATH+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-trust-certificate-pfx-password[`quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.password`]## - -[.description] --- -Password of the key. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem[`quarkus.datasource."datasource-name".reactive.key-certificate-pem`]## - -[.description] --- -PEM Key/cert config is disabled by default. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem-keys]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem-keys[`quarkus.datasource."datasource-name".reactive.key-certificate-pem.keys`]## - -[.description] --- -Comma-separated list of the path to the key files (Pem format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_KEYS+++` -endif::add-copy-button-to-env-var[] --- -|list of string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem-certs]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pem-certs[`quarkus.datasource."datasource-name".reactive.key-certificate-pem.certs`]## - -[.description] --- -Comma-separated list of the path to the certificate files (Pem format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_CERTS+++` -endif::add-copy-button-to-env-var[] --- -|list of string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks[`quarkus.datasource."datasource-name".reactive.key-certificate-jks`]## - -[.description] --- -JKS config is disabled by default. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks-path[`quarkus.datasource."datasource-name".reactive.key-certificate-jks.path`]## - -[.description] --- -Path of the key file (JKS format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PATH+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-jks-password[`quarkus.datasource."datasource-name".reactive.key-certificate-jks.password`]## - -[.description] --- -Password of the key file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx[`quarkus.datasource."datasource-name".reactive.key-certificate-pfx`]## - -[.description] --- -PFX config is disabled by default. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-path]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-path[`quarkus.datasource."datasource-name".reactive.key-certificate-pfx.path`]## - -[.description] --- -Path to the key file (PFX format). - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PATH+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-password]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-key-certificate-pfx-password[`quarkus.datasource."datasource-name".reactive.key-certificate-pfx.password`]## - -[.description] --- -Password of the key. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-reconnect-attempts]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-reconnect-attempts[`quarkus.datasource."datasource-name".reactive.reconnect-attempts`]## - -[.description] --- -The number of reconnection attempts when a pooled connection cannot be established on first try. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_ATTEMPTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_ATTEMPTS+++` -endif::add-copy-button-to-env-var[] --- -|int -|`0` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-reconnect-interval]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-reconnect-interval[`quarkus.datasource."datasource-name".reactive.reconnect-interval`]## - -[.description] --- -The interval between reconnection attempts when a pooled connection cannot be established on first try. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_INTERVAL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_INTERVAL+++` -endif::add-copy-button-to-env-var[] --- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`PT1S` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-hostname-verification-algorithm]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-hostname-verification-algorithm[`quarkus.datasource."datasource-name".reactive.hostname-verification-algorithm`]## - -[.description] --- -The hostname verification algorithm to use in case the server's identity should be checked. Should be `HTTPS`, `LDAPS` or `NONE`. `NONE` is the default value and disables the verification. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM+++` -endif::add-copy-button-to-env-var[] --- -|string -|`NONE` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-idle-timeout]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-idle-timeout[`quarkus.datasource."datasource-name".reactive.idle-timeout`]## - -[.description] --- -The maximum time a connection remains unused in the pool before it is closed. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_IDLE_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_IDLE_TIMEOUT+++` -endif::add-copy-button-to-env-var[] --- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`no timeout` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-max-lifetime]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-max-lifetime[`quarkus.datasource."datasource-name".reactive.max-lifetime`]## - -[.description] --- -The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_LIFETIME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_LIFETIME+++` -endif::add-copy-button-to-env-var[] --- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`no timeout` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-shared]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-shared[`quarkus.datasource."datasource-name".reactive.shared`]## - -[.description] --- -Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_SHARED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_SHARED+++` -endif::add-copy-button-to-env-var[] --- -|boolean -|`false` - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-name]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-name[`quarkus.datasource."datasource-name".reactive.name`]## - -[.description] --- -Set the pool name, used when the pool is shared among datasources, otherwise ignored. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_NAME+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-additional-properties-property-key]] [.property-path]##link:#quarkus-reactive-datasource_quarkus-datasource-datasource-name-reactive-additional-properties-property-key[`quarkus.datasource."datasource-name".reactive.additional-properties."property-key"`]## - -[.description] --- -Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_+++` -endif::add-copy-button-to-env-var[] --- -|Map -| - - |=== ifndef::no-duration-note[] @@ -1096,5 +621,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-reactive-db2-client.adoc b/_generated-doc/latest/config/quarkus-reactive-db2-client.adoc index db9d31d07eb..59d158bb86b 100644 --- a/_generated-doc/latest/config/quarkus-reactive-db2-client.adoc +++ b/_generated-doc/latest/config/quarkus-reactive-db2-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-reactive-db2-client_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -34,5 +33,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-reactive-db2-client_quarkus.datasource.adoc b/_generated-doc/latest/config/quarkus-reactive-db2-client_quarkus.datasource.adoc index db9d31d07eb..59d158bb86b 100644 --- a/_generated-doc/latest/config/quarkus-reactive-db2-client_quarkus.datasource.adoc +++ b/_generated-doc/latest/config/quarkus-reactive-db2-client_quarkus.datasource.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-reactive-db2-client_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -34,5 +33,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-reactive-mssql-client.adoc b/_generated-doc/latest/config/quarkus-reactive-mssql-client.adoc index c977860733c..4e26201a613 100644 --- a/_generated-doc/latest/config/quarkus-reactive-mssql-client.adoc +++ b/_generated-doc/latest/config/quarkus-reactive-mssql-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-reactive-mssql-client_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -53,5 +52,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-reactive-mssql-client_quarkus.datasource.adoc b/_generated-doc/latest/config/quarkus-reactive-mssql-client_quarkus.datasource.adoc index c977860733c..4e26201a613 100644 --- a/_generated-doc/latest/config/quarkus-reactive-mssql-client_quarkus.datasource.adoc +++ b/_generated-doc/latest/config/quarkus-reactive-mssql-client_quarkus.datasource.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-reactive-mssql-client_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -53,5 +52,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-reactive-mysql-client.adoc b/_generated-doc/latest/config/quarkus-reactive-mysql-client.adoc index 373e467dfb5..07ed9252ea4 100644 --- a/_generated-doc/latest/config/quarkus-reactive-mysql-client.adoc +++ b/_generated-doc/latest/config/quarkus-reactive-mysql-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-reactive-mysql-client_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -150,5 +149,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-reactive-mysql-client_quarkus.datasource.adoc b/_generated-doc/latest/config/quarkus-reactive-mysql-client_quarkus.datasource.adoc index 373e467dfb5..07ed9252ea4 100644 --- a/_generated-doc/latest/config/quarkus-reactive-mysql-client_quarkus.datasource.adoc +++ b/_generated-doc/latest/config/quarkus-reactive-mysql-client_quarkus.datasource.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-reactive-mysql-client_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -150,5 +149,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-reactive-oracle-client.adoc b/_generated-doc/latest/config/quarkus-reactive-oracle-client.adoc index 07d894d1001..8410f0a8c9d 100644 --- a/_generated-doc/latest/config/quarkus-reactive-oracle-client.adoc +++ b/_generated-doc/latest/config/quarkus-reactive-oracle-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-reactive-oracle-client_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -8,12 +7,7 @@ h|[.header-title]##Configuration property## h|Type h|Default -h|[[quarkus-reactive-oracle-client_section_quarkus-datasource]] [.section-name.section-level0]##link:#quarkus-reactive-oracle-client_section_quarkus-datasource[Datasources]## -h|Type -h|Default - +3+|No configuration properties found. |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-reactive-oracle-client_quarkus.datasource.adoc b/_generated-doc/latest/config/quarkus-reactive-oracle-client_quarkus.datasource.adoc index 07d894d1001..8410f0a8c9d 100644 --- a/_generated-doc/latest/config/quarkus-reactive-oracle-client_quarkus.datasource.adoc +++ b/_generated-doc/latest/config/quarkus-reactive-oracle-client_quarkus.datasource.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-reactive-oracle-client_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -8,12 +7,7 @@ h|[.header-title]##Configuration property## h|Type h|Default -h|[[quarkus-reactive-oracle-client_section_quarkus-datasource]] [.section-name.section-level0]##link:#quarkus-reactive-oracle-client_section_quarkus-datasource[Datasources]## -h|Type -h|Default - +3+|No configuration properties found. |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-reactive-pg-client.adoc b/_generated-doc/latest/config/quarkus-reactive-pg-client.adoc index 13de9a4ee06..98084ae2d1c 100644 --- a/_generated-doc/latest/config/quarkus-reactive-pg-client.adoc +++ b/_generated-doc/latest/config/quarkus-reactive-pg-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-reactive-pg-client_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -74,5 +73,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-reactive-pg-client_quarkus.datasource.adoc b/_generated-doc/latest/config/quarkus-reactive-pg-client_quarkus.datasource.adoc index 13de9a4ee06..98084ae2d1c 100644 --- a/_generated-doc/latest/config/quarkus-reactive-pg-client_quarkus.datasource.adoc +++ b/_generated-doc/latest/config/quarkus-reactive-pg-client_quarkus.datasource.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-reactive-pg-client_quarkus-datasource [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -74,5 +73,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-redis-cache.adoc b/_generated-doc/latest/config/quarkus-redis-cache.adoc index 3c6be758a67..276919303a8 100644 --- a/_generated-doc/latest/config/quarkus-redis-cache.adoc +++ b/_generated-doc/latest/config/quarkus-redis-cache.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-redis-cache_quarkus-cache [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -73,7 +72,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_REDIS_EXPIRE_AFTER_WRITE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-cache_quarkus-cache-redis-expire-after-access]] [.property-path]##link:#quarkus-redis-cache_quarkus-cache-redis-expire-after-access[`quarkus.cache.redis.expire-after-access`]## @@ -90,7 +89,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_REDIS_EXPIRE_AFTER_ACCESS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-cache_quarkus-cache-redis-prefix]] [.property-path]##link:#quarkus-redis-cache_quarkus-cache-redis-prefix[`quarkus.cache.redis.prefix`]## @@ -179,7 +178,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_WRITE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-cache_quarkus-cache-redis-cache-name-expire-after-access]] [.property-path]##link:#quarkus-redis-cache_quarkus-cache-redis-cache-name-expire-after-access[`quarkus.cache.redis."cache-name".expire-after-access`]## @@ -196,7 +195,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_ACCESS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-cache_quarkus-cache-redis-cache-name-prefix]] [.property-path]##link:#quarkus-redis-cache_quarkus-cache-redis-cache-name-prefix[`quarkus.cache.redis."cache-name".prefix`]## @@ -255,5 +254,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-redis-cache_quarkus.cache.adoc b/_generated-doc/latest/config/quarkus-redis-cache_quarkus.cache.adoc index 3c6be758a67..276919303a8 100644 --- a/_generated-doc/latest/config/quarkus-redis-cache_quarkus.cache.adoc +++ b/_generated-doc/latest/config/quarkus-redis-cache_quarkus.cache.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-redis-cache_quarkus-cache [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -73,7 +72,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_REDIS_EXPIRE_AFTER_WRITE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-cache_quarkus-cache-redis-expire-after-access]] [.property-path]##link:#quarkus-redis-cache_quarkus-cache-redis-expire-after-access[`quarkus.cache.redis.expire-after-access`]## @@ -90,7 +89,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_REDIS_EXPIRE_AFTER_ACCESS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-cache_quarkus-cache-redis-prefix]] [.property-path]##link:#quarkus-redis-cache_quarkus-cache-redis-prefix[`quarkus.cache.redis.prefix`]## @@ -179,7 +178,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_WRITE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-cache_quarkus-cache-redis-cache-name-expire-after-access]] [.property-path]##link:#quarkus-redis-cache_quarkus-cache-redis-cache-name-expire-after-access[`quarkus.cache.redis."cache-name".expire-after-access`]## @@ -196,7 +195,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_ACCESS+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-cache_quarkus-cache[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-cache_quarkus-cache-redis-cache-name-prefix]] [.property-path]##link:#quarkus-redis-cache_quarkus-cache-redis-cache-name-prefix[`quarkus.cache.redis."cache-name".prefix`]## @@ -255,5 +254,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-redis-client.adoc b/_generated-doc/latest/config/quarkus-redis-client.adoc index d183c400e58..d53b85541de 100644 --- a/_generated-doc/latest/config/quarkus-redis-client.adoc +++ b/_generated-doc/latest/config/quarkus-redis-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-redis-client_quarkus-redis [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -86,7 +85,7 @@ a| [[quarkus-redis-client_quarkus-redis-hosts]] [.property-path]##link:#quarkus- [.description] -- -The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element. +The Redis hosts to use while connecting to the Redis server. Only the cluster and sentinel modes will consider more than 1 element. The URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically. @@ -126,7 +125,7 @@ a| [[quarkus-redis-client_quarkus-redis-timeout]] [.property-path]##link:#quarku [.description] -- -The maximum delay to wait before a blocking command to redis server times out +The maximum delay to wait before a blocking command to Redis server times out ifdef::add-copy-button-to-env-var[] @@ -136,14 +135,14 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-redis-client_quarkus-redis-client-type]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-client-type[`quarkus.redis.client-type`]## [.description] -- -The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`. +The Redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`. ifdef::add-copy-button-to-env-var[] @@ -160,7 +159,7 @@ a| [[quarkus-redis-client_quarkus-redis-master-name]] [.property-path]##link:#qu [.description] -- -The master name (only considered in HA mode). +The master name (only considered in the Sentinel mode). ifdef::add-copy-button-to-env-var[] @@ -177,7 +176,7 @@ a| [[quarkus-redis-client_quarkus-redis-role]] [.property-path]##link:#quarkus-r [.description] -- -The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`. +The role name (only considered in the Sentinel mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`. ifdef::add-copy-button-to-env-var[] @@ -194,7 +193,7 @@ a| [[quarkus-redis-client_quarkus-redis-replicas]] [.property-path]##link:#quark [.description] -- -Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`. +Whether to use replicas nodes (only considered in Cluster mode and Replication mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`. ifdef::add-copy-button-to-env-var[] @@ -211,9 +210,9 @@ a| [[quarkus-redis-client_quarkus-redis-password]] [.property-path]##link:#quark [.description] -- -The default password for cluster/sentinel connections. +The default password for Redis connections. -If not set it will try to extract the value from the current default `++#++hosts`. +If not set, it will try to extract the value from the `hosts`. ifdef::add-copy-button-to-env-var[] @@ -230,7 +229,7 @@ a| [[quarkus-redis-client_quarkus-redis-max-pool-size]] [.property-path]##link:# [.description] -- -The maximum size of the connection pool. When working with cluster or sentinel, this value should be at least the total number of cluster members (or number of sentinels {plus} 1) +The maximum size of the connection pool. ifdef::add-copy-button-to-env-var[] @@ -264,7 +263,7 @@ a| [[quarkus-redis-client_quarkus-redis-pool-cleaner-interval]] [.property-path] [.description] -- -The duration indicating how often should the connection pool cleaner executes. +The duration indicating how often should the connection pool cleaner execute. ifdef::add-copy-button-to-env-var[] @@ -274,14 +273,14 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_POOL_CLEANER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] +|`30s` a| [[quarkus-redis-client_quarkus-redis-pool-recycle-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-pool-recycle-timeout[`quarkus.redis.pool-recycle-timeout`]## [.description] -- -The timeout for a connection recycling. +The timeout for unused connection recycling. ifdef::add-copy-button-to-env-var[] @@ -291,8 +290,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_POOL_RECYCLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`15S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] +|`3M` a| [[quarkus-redis-client_quarkus-redis-max-waiting-handlers]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-max-waiting-handlers[`quarkus.redis.max-waiting-handlers`]## @@ -317,7 +316,7 @@ a| [[quarkus-redis-client_quarkus-redis-max-nested-arrays]] [.property-path]##li [.description] -- -Tune how much nested arrays are allowed on a redis response. This affects the parser performance. +Tune how much nested arrays are allowed on a Redis response. This affects the parser performance. ifdef::add-copy-button-to-env-var[] @@ -361,7 +360,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-redis-client_quarkus-redis-protocol-negotiation]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-protocol-negotiation[`quarkus.redis.protocol-negotiation`]## @@ -414,9 +413,91 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_HASH_SLOT_CACHE_TTL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] |`1S` +a| [[quarkus-redis-client_quarkus-redis-auto-failover]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-auto-failover[`quarkus.redis.auto-failover`]## + +[.description] +-- +Whether automatic failover is enabled. This only makes sense for sentinel clients with role of `MASTER` and is ignored otherwise. + +If enabled, the sentinel client will additionally create a connection to one sentinel node and watch for failover events. When new master is elected, all connections to the old master are automatically closed and new connections to the new master are created. Automatic failover makes sense for connections executing regular commands, but not for connections used to subscribe to Redis pub/sub channels. + +Note that there is a brief period of time between the old master failing and the new master being elected when the existing connections will temporarily fail all operations. After the new master is elected, the connections will automatically fail over and start working again. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_AUTO_FAILOVER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_AUTO_FAILOVER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-redis-client_quarkus-redis-topology]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-topology[`quarkus.redis.topology`]## + +[.description] +-- +How the Redis topology is obtained. By default, the topology is discovered automatically. This is the only mode for the clustered and sentinel client. For replication client, topology may be set _statically_. + +In case of a static topology for replication Redis client, the first node in the list is considered a _master_ and the remaining nodes in the list are considered _replicas_. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_TOPOLOGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_TOPOLOGY+++` +endif::add-copy-button-to-env-var[] +-- +a|`discover`, `static` +|`discover` + +a| [[quarkus-redis-client_quarkus-redis-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-client-name[`quarkus.redis.client-name`]## + +[.description] +-- +The client name used to identify the connection. + +If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation. + +If the `RedisClientConfig++#++configureClientName()` is enabled, both this property and the `RedisClientName++#++value()` must adhere to the pattern '++[++a-zA-Z0-9++\\++-_.~++]*++'; if not, this may result in an incorrect client name after URI encoding. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-redis-client_quarkus-redis-configure-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-configure-client-name[`quarkus.redis.configure-client-name`]## + +[.description] +-- +Whether it should set the client name while connecting with Redis. + +This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}. + +This property can be used with `RedisClientConfig++#++clientName()` configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a| [[quarkus-redis-client_quarkus-redis-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tls-configuration-name[`quarkus.redis.tls-configuration-name`]## [.description] @@ -501,7 +582,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-hosts]] [.property-pat [.description] -- -The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element. +The Redis hosts to use while connecting to the Redis server. Only the cluster and sentinel modes will consider more than 1 element. The URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically. @@ -541,7 +622,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-timeout]] [.property-p [.description] -- -The maximum delay to wait before a blocking command to redis server times out +The maximum delay to wait before a blocking command to Redis server times out ifdef::add-copy-button-to-env-var[] @@ -551,14 +632,14 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-redis-client_quarkus-redis-redis-client-name-client-type]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-client-type[`quarkus.redis."redis-client-name".client-type`]## [.description] -- -The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`. +The Redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`. ifdef::add-copy-button-to-env-var[] @@ -575,7 +656,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-master-name]] [.proper [.description] -- -The master name (only considered in HA mode). +The master name (only considered in the Sentinel mode). ifdef::add-copy-button-to-env-var[] @@ -592,7 +673,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-role]] [.property-path [.description] -- -The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`. +The role name (only considered in the Sentinel mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`. ifdef::add-copy-button-to-env-var[] @@ -609,7 +690,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-replicas]] [.property- [.description] -- -Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`. +Whether to use replicas nodes (only considered in Cluster mode and Replication mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`. ifdef::add-copy-button-to-env-var[] @@ -626,9 +707,9 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-password]] [.property- [.description] -- -The default password for cluster/sentinel connections. +The default password for Redis connections. -If not set it will try to extract the value from the current default `++#++hosts`. +If not set, it will try to extract the value from the `hosts`. ifdef::add-copy-button-to-env-var[] @@ -645,7 +726,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-max-pool-size]] [.prop [.description] -- -The maximum size of the connection pool. When working with cluster or sentinel, this value should be at least the total number of cluster members (or number of sentinels {plus} 1) +The maximum size of the connection pool. ifdef::add-copy-button-to-env-var[] @@ -679,7 +760,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-pool-cleaner-interval] [.description] -- -The duration indicating how often should the connection pool cleaner executes. +The duration indicating how often should the connection pool cleaner execute. ifdef::add-copy-button-to-env-var[] @@ -689,14 +770,14 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_CLEANER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] +|`30s` a| [[quarkus-redis-client_quarkus-redis-redis-client-name-pool-recycle-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-pool-recycle-timeout[`quarkus.redis."redis-client-name".pool-recycle-timeout`]## [.description] -- -The timeout for a connection recycling. +The timeout for unused connection recycling. ifdef::add-copy-button-to-env-var[] @@ -706,8 +787,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_RECYCLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`15S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] +|`3M` a| [[quarkus-redis-client_quarkus-redis-redis-client-name-max-waiting-handlers]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-max-waiting-handlers[`quarkus.redis."redis-client-name".max-waiting-handlers`]## @@ -732,7 +813,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-max-nested-arrays]] [. [.description] -- -Tune how much nested arrays are allowed on a redis response. This affects the parser performance. +Tune how much nested arrays are allowed on a Redis response. This affects the parser performance. ifdef::add-copy-button-to-env-var[] @@ -776,7 +857,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-redis-client_quarkus-redis-redis-client-name-protocol-negotiation]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-protocol-negotiation[`quarkus.redis."redis-client-name".protocol-negotiation`]## @@ -829,9 +910,91 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__HASH_SLOT_CACHE_TTL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] |`1S` +a| [[quarkus-redis-client_quarkus-redis-redis-client-name-auto-failover]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-auto-failover[`quarkus.redis."redis-client-name".auto-failover`]## + +[.description] +-- +Whether automatic failover is enabled. This only makes sense for sentinel clients with role of `MASTER` and is ignored otherwise. + +If enabled, the sentinel client will additionally create a connection to one sentinel node and watch for failover events. When new master is elected, all connections to the old master are automatically closed and new connections to the new master are created. Automatic failover makes sense for connections executing regular commands, but not for connections used to subscribe to Redis pub/sub channels. + +Note that there is a brief period of time between the old master failing and the new master being elected when the existing connections will temporarily fail all operations. After the new master is elected, the connections will automatically fail over and start working again. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__AUTO_FAILOVER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__AUTO_FAILOVER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-redis-client_quarkus-redis-redis-client-name-topology]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-topology[`quarkus.redis."redis-client-name".topology`]## + +[.description] +-- +How the Redis topology is obtained. By default, the topology is discovered automatically. This is the only mode for the clustered and sentinel client. For replication client, topology may be set _statically_. + +In case of a static topology for replication Redis client, the first node in the list is considered a _master_ and the remaining nodes in the list are considered _replicas_. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TOPOLOGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TOPOLOGY+++` +endif::add-copy-button-to-env-var[] +-- +a|`discover`, `static` +|`discover` + +a| [[quarkus-redis-client_quarkus-redis-redis-client-name-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-client-name[`quarkus.redis."redis-client-name".client-name`]## + +[.description] +-- +The client name used to identify the connection. + +If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation. + +If the `RedisClientConfig++#++configureClientName()` is enabled, both this property and the `RedisClientName++#++value()` must adhere to the pattern '++[++a-zA-Z0-9++\\++-_.~++]*++'; if not, this may result in an incorrect client name after URI encoding. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-redis-client_quarkus-redis-redis-client-name-configure-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-configure-client-name[`quarkus.redis."redis-client-name".configure-client-name`]## + +[.description] +-- +Whether it should set the client name while connecting with Redis. + +This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}. + +This property can be used with `RedisClientConfig++#++clientName()` configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name[`quarkus.redis."redis-client-name".tls-configuration-name`]## [.description] @@ -1158,7 +1321,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-connection-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-connection-timeout[`quarkus.redis.tcp.connection-timeout`]## @@ -1175,7 +1338,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-non-proxy-hosts]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-non-proxy-hosts[`quarkus.redis.tcp.non-proxy-hosts`]## @@ -1294,7 +1457,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_READ_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-receive-buffer-size]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-receive-buffer-size[`quarkus.redis.tcp.receive-buffer-size`]## @@ -1345,7 +1508,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-reuse-address]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-reuse-address[`quarkus.redis.tcp.reuse-address`]## @@ -1413,7 +1576,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_SO_LINGER+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-cork]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-cork[`quarkus.redis.tcp.cork`]## @@ -1532,7 +1695,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_WRITE_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-local-address]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-local-address[`quarkus.redis.tcp.local-address`]## @@ -1969,7 +2132,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-connection-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-connection-timeout[`quarkus.redis."redis-client-name".tcp.connection-timeout`]## @@ -1986,7 +2149,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-non-proxy-hosts]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-non-proxy-hosts[`quarkus.redis."redis-client-name".tcp.non-proxy-hosts`]## @@ -2105,7 +2268,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_READ_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-receive-buffer-size]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-receive-buffer-size[`quarkus.redis."redis-client-name".tcp.receive-buffer-size`]## @@ -2156,7 +2319,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-reuse-address]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-reuse-address[`quarkus.redis."redis-client-name".tcp.reuse-address`]## @@ -2224,7 +2387,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_SO_LINGER+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-cork]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-cork[`quarkus.redis."redis-client-name".tcp.cork`]## @@ -2343,7 +2506,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_WRITE_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-local-address]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-local-address[`quarkus.redis."redis-client-name".tcp.local-address`]## @@ -2732,5 +2895,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-redis-client_quarkus.redis.-additional-redis-clients-.devservices.adoc b/_generated-doc/latest/config/quarkus-redis-client_quarkus.redis.-additional-redis-clients-.devservices.adoc index 015251561c1..73ba99c41dd 100644 --- a/_generated-doc/latest/config/quarkus-redis-client_quarkus.redis.-additional-redis-clients-.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-redis-client_quarkus.redis.-additional-redis-clients-.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-redis-client_quarkus-redis-additional-redis-clients-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -122,5 +121,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-redis-client_quarkus.redis.adoc b/_generated-doc/latest/config/quarkus-redis-client_quarkus.redis.adoc index d183c400e58..d53b85541de 100644 --- a/_generated-doc/latest/config/quarkus-redis-client_quarkus.redis.adoc +++ b/_generated-doc/latest/config/quarkus-redis-client_quarkus.redis.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-redis-client_quarkus-redis [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -86,7 +85,7 @@ a| [[quarkus-redis-client_quarkus-redis-hosts]] [.property-path]##link:#quarkus- [.description] -- -The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element. +The Redis hosts to use while connecting to the Redis server. Only the cluster and sentinel modes will consider more than 1 element. The URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically. @@ -126,7 +125,7 @@ a| [[quarkus-redis-client_quarkus-redis-timeout]] [.property-path]##link:#quarku [.description] -- -The maximum delay to wait before a blocking command to redis server times out +The maximum delay to wait before a blocking command to Redis server times out ifdef::add-copy-button-to-env-var[] @@ -136,14 +135,14 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-redis-client_quarkus-redis-client-type]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-client-type[`quarkus.redis.client-type`]## [.description] -- -The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`. +The Redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`. ifdef::add-copy-button-to-env-var[] @@ -160,7 +159,7 @@ a| [[quarkus-redis-client_quarkus-redis-master-name]] [.property-path]##link:#qu [.description] -- -The master name (only considered in HA mode). +The master name (only considered in the Sentinel mode). ifdef::add-copy-button-to-env-var[] @@ -177,7 +176,7 @@ a| [[quarkus-redis-client_quarkus-redis-role]] [.property-path]##link:#quarkus-r [.description] -- -The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`. +The role name (only considered in the Sentinel mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`. ifdef::add-copy-button-to-env-var[] @@ -194,7 +193,7 @@ a| [[quarkus-redis-client_quarkus-redis-replicas]] [.property-path]##link:#quark [.description] -- -Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`. +Whether to use replicas nodes (only considered in Cluster mode and Replication mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`. ifdef::add-copy-button-to-env-var[] @@ -211,9 +210,9 @@ a| [[quarkus-redis-client_quarkus-redis-password]] [.property-path]##link:#quark [.description] -- -The default password for cluster/sentinel connections. +The default password for Redis connections. -If not set it will try to extract the value from the current default `++#++hosts`. +If not set, it will try to extract the value from the `hosts`. ifdef::add-copy-button-to-env-var[] @@ -230,7 +229,7 @@ a| [[quarkus-redis-client_quarkus-redis-max-pool-size]] [.property-path]##link:# [.description] -- -The maximum size of the connection pool. When working with cluster or sentinel, this value should be at least the total number of cluster members (or number of sentinels {plus} 1) +The maximum size of the connection pool. ifdef::add-copy-button-to-env-var[] @@ -264,7 +263,7 @@ a| [[quarkus-redis-client_quarkus-redis-pool-cleaner-interval]] [.property-path] [.description] -- -The duration indicating how often should the connection pool cleaner executes. +The duration indicating how often should the connection pool cleaner execute. ifdef::add-copy-button-to-env-var[] @@ -274,14 +273,14 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_POOL_CLEANER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] +|`30s` a| [[quarkus-redis-client_quarkus-redis-pool-recycle-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-pool-recycle-timeout[`quarkus.redis.pool-recycle-timeout`]## [.description] -- -The timeout for a connection recycling. +The timeout for unused connection recycling. ifdef::add-copy-button-to-env-var[] @@ -291,8 +290,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_POOL_RECYCLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`15S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] +|`3M` a| [[quarkus-redis-client_quarkus-redis-max-waiting-handlers]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-max-waiting-handlers[`quarkus.redis.max-waiting-handlers`]## @@ -317,7 +316,7 @@ a| [[quarkus-redis-client_quarkus-redis-max-nested-arrays]] [.property-path]##li [.description] -- -Tune how much nested arrays are allowed on a redis response. This affects the parser performance. +Tune how much nested arrays are allowed on a Redis response. This affects the parser performance. ifdef::add-copy-button-to-env-var[] @@ -361,7 +360,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-redis-client_quarkus-redis-protocol-negotiation]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-protocol-negotiation[`quarkus.redis.protocol-negotiation`]## @@ -414,9 +413,91 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_HASH_SLOT_CACHE_TTL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] |`1S` +a| [[quarkus-redis-client_quarkus-redis-auto-failover]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-auto-failover[`quarkus.redis.auto-failover`]## + +[.description] +-- +Whether automatic failover is enabled. This only makes sense for sentinel clients with role of `MASTER` and is ignored otherwise. + +If enabled, the sentinel client will additionally create a connection to one sentinel node and watch for failover events. When new master is elected, all connections to the old master are automatically closed and new connections to the new master are created. Automatic failover makes sense for connections executing regular commands, but not for connections used to subscribe to Redis pub/sub channels. + +Note that there is a brief period of time between the old master failing and the new master being elected when the existing connections will temporarily fail all operations. After the new master is elected, the connections will automatically fail over and start working again. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_AUTO_FAILOVER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_AUTO_FAILOVER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-redis-client_quarkus-redis-topology]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-topology[`quarkus.redis.topology`]## + +[.description] +-- +How the Redis topology is obtained. By default, the topology is discovered automatically. This is the only mode for the clustered and sentinel client. For replication client, topology may be set _statically_. + +In case of a static topology for replication Redis client, the first node in the list is considered a _master_ and the remaining nodes in the list are considered _replicas_. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_TOPOLOGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_TOPOLOGY+++` +endif::add-copy-button-to-env-var[] +-- +a|`discover`, `static` +|`discover` + +a| [[quarkus-redis-client_quarkus-redis-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-client-name[`quarkus.redis.client-name`]## + +[.description] +-- +The client name used to identify the connection. + +If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation. + +If the `RedisClientConfig++#++configureClientName()` is enabled, both this property and the `RedisClientName++#++value()` must adhere to the pattern '++[++a-zA-Z0-9++\\++-_.~++]*++'; if not, this may result in an incorrect client name after URI encoding. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-redis-client_quarkus-redis-configure-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-configure-client-name[`quarkus.redis.configure-client-name`]## + +[.description] +-- +Whether it should set the client name while connecting with Redis. + +This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}. + +This property can be used with `RedisClientConfig++#++clientName()` configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS_CONFIGURE_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a| [[quarkus-redis-client_quarkus-redis-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tls-configuration-name[`quarkus.redis.tls-configuration-name`]## [.description] @@ -501,7 +582,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-hosts]] [.property-pat [.description] -- -The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element. +The Redis hosts to use while connecting to the Redis server. Only the cluster and sentinel modes will consider more than 1 element. The URI provided uses the following schema `redis://++[++username:password@++][++host++][++:port++][++/database++]++` Use `quarkus.redis.hosts-provider-name` to provide the hosts programmatically. @@ -541,7 +622,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-timeout]] [.property-p [.description] -- -The maximum delay to wait before a blocking command to redis server times out +The maximum delay to wait before a blocking command to Redis server times out ifdef::add-copy-button-to-env-var[] @@ -551,14 +632,14 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-redis-client_quarkus-redis-redis-client-name-client-type]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-client-type[`quarkus.redis."redis-client-name".client-type`]## [.description] -- -The redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`. +The Redis client type. Accepted values are: `STANDALONE` (default), `CLUSTER`, `REPLICATION`, `SENTINEL`. ifdef::add-copy-button-to-env-var[] @@ -575,7 +656,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-master-name]] [.proper [.description] -- -The master name (only considered in HA mode). +The master name (only considered in the Sentinel mode). ifdef::add-copy-button-to-env-var[] @@ -592,7 +673,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-role]] [.property-path [.description] -- -The role name (only considered in Sentinel / HA mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`. +The role name (only considered in the Sentinel mode). Accepted values are: `MASTER`, `REPLICA`, `SENTINEL`. ifdef::add-copy-button-to-env-var[] @@ -609,7 +690,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-replicas]] [.property- [.description] -- -Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`. +Whether to use replicas nodes (only considered in Cluster mode and Replication mode). Accepted values are: `ALWAYS`, `NEVER`, `SHARE`. ifdef::add-copy-button-to-env-var[] @@ -626,9 +707,9 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-password]] [.property- [.description] -- -The default password for cluster/sentinel connections. +The default password for Redis connections. -If not set it will try to extract the value from the current default `++#++hosts`. +If not set, it will try to extract the value from the `hosts`. ifdef::add-copy-button-to-env-var[] @@ -645,7 +726,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-max-pool-size]] [.prop [.description] -- -The maximum size of the connection pool. When working with cluster or sentinel, this value should be at least the total number of cluster members (or number of sentinels {plus} 1) +The maximum size of the connection pool. ifdef::add-copy-button-to-env-var[] @@ -679,7 +760,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-pool-cleaner-interval] [.description] -- -The duration indicating how often should the connection pool cleaner executes. +The duration indicating how often should the connection pool cleaner execute. ifdef::add-copy-button-to-env-var[] @@ -689,14 +770,14 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_CLEANER_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] +|`30s` a| [[quarkus-redis-client_quarkus-redis-redis-client-name-pool-recycle-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-pool-recycle-timeout[`quarkus.redis."redis-client-name".pool-recycle-timeout`]## [.description] -- -The timeout for a connection recycling. +The timeout for unused connection recycling. ifdef::add-copy-button-to-env-var[] @@ -706,8 +787,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_RECYCLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`15S` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] +|`3M` a| [[quarkus-redis-client_quarkus-redis-redis-client-name-max-waiting-handlers]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-max-waiting-handlers[`quarkus.redis."redis-client-name".max-waiting-handlers`]## @@ -732,7 +813,7 @@ a| [[quarkus-redis-client_quarkus-redis-redis-client-name-max-nested-arrays]] [. [.description] -- -Tune how much nested arrays are allowed on a redis response. This affects the parser performance. +Tune how much nested arrays are allowed on a Redis response. This affects the parser performance. ifdef::add-copy-button-to-env-var[] @@ -776,7 +857,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-redis-client_quarkus-redis-redis-client-name-protocol-negotiation]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-protocol-negotiation[`quarkus.redis."redis-client-name".protocol-negotiation`]## @@ -829,9 +910,91 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__HASH_SLOT_CACHE_TTL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] |`1S` +a| [[quarkus-redis-client_quarkus-redis-redis-client-name-auto-failover]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-auto-failover[`quarkus.redis."redis-client-name".auto-failover`]## + +[.description] +-- +Whether automatic failover is enabled. This only makes sense for sentinel clients with role of `MASTER` and is ignored otherwise. + +If enabled, the sentinel client will additionally create a connection to one sentinel node and watch for failover events. When new master is elected, all connections to the old master are automatically closed and new connections to the new master are created. Automatic failover makes sense for connections executing regular commands, but not for connections used to subscribe to Redis pub/sub channels. + +Note that there is a brief period of time between the old master failing and the new master being elected when the existing connections will temporarily fail all operations. After the new master is elected, the connections will automatically fail over and start working again. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__AUTO_FAILOVER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__AUTO_FAILOVER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-redis-client_quarkus-redis-redis-client-name-topology]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-topology[`quarkus.redis."redis-client-name".topology`]## + +[.description] +-- +How the Redis topology is obtained. By default, the topology is discovered automatically. This is the only mode for the clustered and sentinel client. For replication client, topology may be set _statically_. + +In case of a static topology for replication Redis client, the first node in the list is considered a _master_ and the remaining nodes in the list are considered _replicas_. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TOPOLOGY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TOPOLOGY+++` +endif::add-copy-button-to-env-var[] +-- +a|`discover`, `static` +|`discover` + +a| [[quarkus-redis-client_quarkus-redis-redis-client-name-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-client-name[`quarkus.redis."redis-client-name".client-name`]## + +[.description] +-- +The client name used to identify the connection. + +If the `RedisClientConfig++#++configureClientName()` is enabled, and this property is not set it will attempt to extract the value from the `RedisClientName++#++value()` annotation. + +If the `RedisClientConfig++#++configureClientName()` is enabled, both this property and the `RedisClientName++#++value()` must adhere to the pattern '++[++a-zA-Z0-9++\\++-_.~++]*++'; if not, this may result in an incorrect client name after URI encoding. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-redis-client_quarkus-redis-redis-client-name-configure-client-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-configure-client-name[`quarkus.redis."redis-client-name".configure-client-name`]## + +[.description] +-- +Whether it should set the client name while connecting with Redis. + +This is necessary because Redis only accepts `client=my-client-name` query parameter in version 6{plus}. + +This property can be used with `RedisClientConfig++#++clientName()` configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__CONFIGURE_CLIENT_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tls-configuration-name[`quarkus.redis."redis-client-name".tls-configuration-name`]## [.description] @@ -1158,7 +1321,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-connection-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-connection-timeout[`quarkus.redis.tcp.connection-timeout`]## @@ -1175,7 +1338,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-non-proxy-hosts]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-non-proxy-hosts[`quarkus.redis.tcp.non-proxy-hosts`]## @@ -1294,7 +1457,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_READ_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-receive-buffer-size]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-receive-buffer-size[`quarkus.redis.tcp.receive-buffer-size`]## @@ -1345,7 +1508,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-reuse-address]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-reuse-address[`quarkus.redis.tcp.reuse-address`]## @@ -1413,7 +1576,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_SO_LINGER+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-cork]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-cork[`quarkus.redis.tcp.cork`]## @@ -1532,7 +1695,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS_TCP_WRITE_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-tcp-local-address]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-tcp-local-address[`quarkus.redis.tcp.local-address`]## @@ -1969,7 +2132,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-connection-timeout]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-connection-timeout[`quarkus.redis."redis-client-name".tcp.connection-timeout`]## @@ -1986,7 +2149,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-non-proxy-hosts]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-non-proxy-hosts[`quarkus.redis."redis-client-name".tcp.non-proxy-hosts`]## @@ -2105,7 +2268,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_READ_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-receive-buffer-size]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-receive-buffer-size[`quarkus.redis."redis-client-name".tcp.receive-buffer-size`]## @@ -2156,7 +2319,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-reuse-address]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-reuse-address[`quarkus.redis."redis-client-name".tcp.reuse-address`]## @@ -2224,7 +2387,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_SO_LINGER+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-cork]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-cork[`quarkus.redis."redis-client-name".tcp.cork`]## @@ -2343,7 +2506,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_WRITE_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-redis-client_quarkus-redis[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-redis-client_quarkus-redis-redis-client-name-tcp-local-address]] [.property-path]##link:#quarkus-redis-client_quarkus-redis-redis-client-name-tcp-local-address[`quarkus.redis."redis-client-name".tcp.local-address`]## @@ -2732,5 +2895,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-redis-client_quarkus.redis.devservices.adoc b/_generated-doc/latest/config/quarkus-redis-client_quarkus.redis.devservices.adoc index 351bbbf70e1..0c37b73c6a1 100644 --- a/_generated-doc/latest/config/quarkus-redis-client_quarkus.redis.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-redis-client_quarkus.redis.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-redis-client_quarkus-redis-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -122,5 +121,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-client-config.adoc b/_generated-doc/latest/config/quarkus-rest-client-config.adoc index dc9ec02606d..0821142fe96 100644 --- a/_generated-doc/latest/config/quarkus-rest-client-config.adoc +++ b/_generated-doc/latest/config/quarkus-rest-client-config.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-client-config_quarkus-rest-client [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -572,7 +571,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REST_CLIENT_MAX_CHUNK_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-rest-client-config_quarkus-rest-client[icon:question-circle[title=More information about the MemorySize format]] |`8k` a| [[quarkus-rest-client-config_quarkus-rest-client-alpn]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-alpn[`quarkus.rest-client.alpn`]## @@ -607,7 +606,7 @@ Environment variable: `+++QUARKUS_REST_CLIENT_CAPTURE_STACKTRACE+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` +|`false` a| [[quarkus-rest-client-config_quarkus-rest-client-logging-scope]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-logging-scope[`quarkus.rest-client.logging.scope`]## @@ -1287,7 +1286,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__MAX_CHUNK_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-rest-client-config_quarkus-rest-client[icon:question-circle[title=More information about the MemorySize format]] |`8K` a| [[quarkus-rest-client-config_quarkus-rest-client-client-alpn]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-alpn[`quarkus.rest-client."client".alpn`]## @@ -1336,5 +1335,3 @@ A size configuration option recognizes strings in this format (shown as a regula If no suffix is given, assume bytes. ==== ifndef::no-memory-size-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-client-config_quarkus.rest-client.adoc b/_generated-doc/latest/config/quarkus-rest-client-config_quarkus.rest-client.adoc index dc9ec02606d..0821142fe96 100644 --- a/_generated-doc/latest/config/quarkus-rest-client-config_quarkus.rest-client.adoc +++ b/_generated-doc/latest/config/quarkus-rest-client-config_quarkus.rest-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-client-config_quarkus-rest-client [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -572,7 +571,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REST_CLIENT_MAX_CHUNK_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-rest-client-config_quarkus-rest-client[icon:question-circle[title=More information about the MemorySize format]] |`8k` a| [[quarkus-rest-client-config_quarkus-rest-client-alpn]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-alpn[`quarkus.rest-client.alpn`]## @@ -607,7 +606,7 @@ Environment variable: `+++QUARKUS_REST_CLIENT_CAPTURE_STACKTRACE+++` endif::add-copy-button-to-env-var[] -- |boolean -|`true` +|`false` a| [[quarkus-rest-client-config_quarkus-rest-client-logging-scope]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-logging-scope[`quarkus.rest-client.logging.scope`]## @@ -1287,7 +1286,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__MAX_CHUNK_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-rest-client-config_quarkus-rest-client[icon:question-circle[title=More information about the MemorySize format]] |`8K` a| [[quarkus-rest-client-config_quarkus-rest-client-client-alpn]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-alpn[`quarkus.rest-client."client".alpn`]## @@ -1336,5 +1335,3 @@ A size configuration option recognizes strings in this format (shown as a regula If no suffix is given, assume bytes. ==== ifndef::no-memory-size-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-client-oidc-filter.adoc b/_generated-doc/latest/config/quarkus-rest-client-oidc-filter.adoc index 6bb3f6e1b97..3a919a3fa0f 100644 --- a/_generated-doc/latest/config/quarkus-rest-client-oidc-filter.adoc +++ b/_generated-doc/latest/config/quarkus-rest-client-oidc-filter.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-client-oidc-filter_quarkus-rest-client-oidc-filter [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-client-oidc-filter_quarkus.rest-client-oidc-filter.adoc b/_generated-doc/latest/config/quarkus-rest-client-oidc-filter_quarkus.rest-client-oidc-filter.adoc index 6bb3f6e1b97..3a919a3fa0f 100644 --- a/_generated-doc/latest/config/quarkus-rest-client-oidc-filter_quarkus.rest-client-oidc-filter.adoc +++ b/_generated-doc/latest/config/quarkus-rest-client-oidc-filter_quarkus.rest-client-oidc-filter.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-client-oidc-filter_quarkus-rest-client-oidc-filter [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-client-oidc-token-propagation.adoc b/_generated-doc/latest/config/quarkus-rest-client-oidc-token-propagation.adoc index 90c3ed3bd77..4c3c00fb60d 100644 --- a/_generated-doc/latest/config/quarkus-rest-client-oidc-token-propagation.adoc +++ b/_generated-doc/latest/config/quarkus-rest-client-oidc-token-propagation.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-client-oidc-token-propagation_quarkus-rest-client-oidc-token-propagation [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -84,5 +83,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-client-oidc-token-propagation_quarkus.rest-client-oidc-token-propagation.adoc b/_generated-doc/latest/config/quarkus-rest-client-oidc-token-propagation_quarkus.rest-client-oidc-token-propagation.adoc index 90c3ed3bd77..4c3c00fb60d 100644 --- a/_generated-doc/latest/config/quarkus-rest-client-oidc-token-propagation_quarkus.rest-client-oidc-token-propagation.adoc +++ b/_generated-doc/latest/config/quarkus-rest-client-oidc-token-propagation_quarkus.rest-client-oidc-token-propagation.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-client-oidc-token-propagation_quarkus-rest-client-oidc-token-propagation [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -84,5 +83,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-client.adoc b/_generated-doc/latest/config/quarkus-rest-client.adoc index 5553b88c2e3..2db243a7a9b 100644 --- a/_generated-doc/latest/config/quarkus-rest-client.adoc +++ b/_generated-doc/latest/config/quarkus-rest-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-client_quarkus-rest-client [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -8,6 +7,25 @@ h|[.header-title]##Configuration property## h|Type h|Default +a|icon:lock[title=Fixed at build time] [[quarkus-rest-client_quarkus-rest-client-disable-smart-produces]] [.property-path]##link:#quarkus-rest-client_quarkus-rest-client-disable-smart-produces[`quarkus.rest-client.disable-smart-produces`]## + +[.description] +-- +By default, RESTEasy Reactive uses text/plain content type for String values and application/json for everything else. + +MicroProfile Rest Client spec requires the implementations to always default to application/json. This build item disables the "smart" behavior of RESTEasy Reactive to comply to the spec + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_DISABLE_SMART_PRODUCES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_CLIENT_DISABLE_SMART_PRODUCES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a|icon:lock[title=Fixed at build time] [[quarkus-rest-client_quarkus-rest-client-provider-autodiscovery]] [.property-path]##link:#quarkus-rest-client_quarkus-rest-client-provider-autodiscovery[`quarkus.rest-client.provider-autodiscovery`]## [.description] @@ -27,5 +45,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-client_quarkus.rest-client.adoc b/_generated-doc/latest/config/quarkus-rest-client_quarkus.rest-client.adoc index 5553b88c2e3..2db243a7a9b 100644 --- a/_generated-doc/latest/config/quarkus-rest-client_quarkus.rest-client.adoc +++ b/_generated-doc/latest/config/quarkus-rest-client_quarkus.rest-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-client_quarkus-rest-client [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -8,6 +7,25 @@ h|[.header-title]##Configuration property## h|Type h|Default +a|icon:lock[title=Fixed at build time] [[quarkus-rest-client_quarkus-rest-client-disable-smart-produces]] [.property-path]##link:#quarkus-rest-client_quarkus-rest-client-disable-smart-produces[`quarkus.rest-client.disable-smart-produces`]## + +[.description] +-- +By default, RESTEasy Reactive uses text/plain content type for String values and application/json for everything else. + +MicroProfile Rest Client spec requires the implementations to always default to application/json. This build item disables the "smart" behavior of RESTEasy Reactive to comply to the spec + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_DISABLE_SMART_PRODUCES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_REST_CLIENT_DISABLE_SMART_PRODUCES+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a|icon:lock[title=Fixed at build time] [[quarkus-rest-client_quarkus-rest-client-provider-autodiscovery]] [.property-path]##link:#quarkus-rest-client_quarkus-rest-client-provider-autodiscovery[`quarkus.rest-client.provider-autodiscovery`]## [.description] @@ -27,5 +45,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-csrf.adoc b/_generated-doc/latest/config/quarkus-rest-csrf.adoc index 510c73351e7..3308e9f2eaa 100644 --- a/_generated-doc/latest/config/quarkus-rest-csrf.adoc +++ b/_generated-doc/latest/config/quarkus-rest-csrf.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-csrf_quarkus-rest-csrf [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -90,7 +89,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REST_CSRF_COOKIE_MAX_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-rest-csrf_quarkus-rest-csrf[icon:question-circle[title=More information about the Duration format]] |`2H` a| [[quarkus-rest-csrf_quarkus-rest-csrf-cookie-path]] [.property-path]##link:#quarkus-rest-csrf_quarkus-rest-csrf-cookie-path[`quarkus.rest-csrf.cookie-path`]## @@ -267,5 +266,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-csrf_quarkus.rest-csrf.adoc b/_generated-doc/latest/config/quarkus-rest-csrf_quarkus.rest-csrf.adoc index 510c73351e7..3308e9f2eaa 100644 --- a/_generated-doc/latest/config/quarkus-rest-csrf_quarkus.rest-csrf.adoc +++ b/_generated-doc/latest/config/quarkus-rest-csrf_quarkus.rest-csrf.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-csrf_quarkus-rest-csrf [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -90,7 +89,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REST_CSRF_COOKIE_MAX_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-rest-csrf_quarkus-rest-csrf[icon:question-circle[title=More information about the Duration format]] |`2H` a| [[quarkus-rest-csrf_quarkus-rest-csrf-cookie-path]] [.property-path]##link:#quarkus-rest-csrf_quarkus-rest-csrf-cookie-path[`quarkus.rest-csrf.cookie-path`]## @@ -267,5 +266,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-jackson.adoc b/_generated-doc/latest/config/quarkus-rest-jackson.adoc index 1decde158d1..9d1cce7ed70 100644 --- a/_generated-doc/latest/config/quarkus-rest-jackson.adoc +++ b/_generated-doc/latest/config/quarkus-rest-jackson.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-jackson_quarkus-rest [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-jackson_quarkus.rest.adoc b/_generated-doc/latest/config/quarkus-rest-jackson_quarkus.rest.adoc index 1decde158d1..9d1cce7ed70 100644 --- a/_generated-doc/latest/config/quarkus-rest-jackson_quarkus.rest.adoc +++ b/_generated-doc/latest/config/quarkus-rest-jackson_quarkus.rest.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-jackson_quarkus-rest [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-kotlin-serialization.adoc b/_generated-doc/latest/config/quarkus-rest-kotlin-serialization.adoc index 487cf949349..93775b60117 100644 --- a/_generated-doc/latest/config/quarkus-rest-kotlin-serialization.adoc +++ b/_generated-doc/latest/config/quarkus-rest-kotlin-serialization.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-kotlin-serialization_quarkus-kotlin-serialization [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -301,5 +300,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-kotlin-serialization_quarkus.kotlin-serialization.adoc b/_generated-doc/latest/config/quarkus-rest-kotlin-serialization_quarkus.kotlin-serialization.adoc index 487cf949349..93775b60117 100644 --- a/_generated-doc/latest/config/quarkus-rest-kotlin-serialization_quarkus.kotlin-serialization.adoc +++ b/_generated-doc/latest/config/quarkus-rest-kotlin-serialization_quarkus.kotlin-serialization.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-kotlin-serialization_quarkus-kotlin-serialization [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -301,5 +300,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-qute.adoc b/_generated-doc/latest/config/quarkus-rest-qute.adoc index e26dec6a648..8410f0a8c9d 100644 --- a/_generated-doc/latest/config/quarkus-rest-qute.adoc +++ b/_generated-doc/latest/config/quarkus-rest-qute.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-qute_quarkus-rest [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -8,7 +7,7 @@ h|[.header-title]##Configuration property## h|Type h|Default -|=== +3+|No configuration properties found. +|=== -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest-qute_quarkus.rest.adoc b/_generated-doc/latest/config/quarkus-rest-qute_quarkus.rest.adoc index e26dec6a648..8410f0a8c9d 100644 --- a/_generated-doc/latest/config/quarkus-rest-qute_quarkus.rest.adoc +++ b/_generated-doc/latest/config/quarkus-rest-qute_quarkus.rest.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest-qute_quarkus-rest [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -8,7 +7,7 @@ h|[.header-title]##Configuration property## h|Type h|Default -|=== +3+|No configuration properties found. +|=== -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest_quarkus.rest.adoc b/_generated-doc/latest/config/quarkus-rest_quarkus.rest.adoc index 6ab83fb4d36..1df7d361914 100644 --- a/_generated-doc/latest/config/quarkus-rest_quarkus.rest.adoc +++ b/_generated-doc/latest/config/quarkus-rest_quarkus.rest.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest_quarkus-rest [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -41,7 +40,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_REST_INPUT_BUFFER_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-rest_quarkus-rest[icon:question-circle[title=More information about the MemorySize format]] |`10k` a|icon:lock[title=Fixed at build time] [[quarkus-rest_quarkus-rest-min-chunk-size]] [.property-path]##link:#quarkus-rest_quarkus-rest-min-chunk-size[`quarkus.rest.min-chunk-size`]## @@ -196,5 +195,3 @@ A size configuration option recognizes strings in this format (shown as a regula If no suffix is given, assume bytes. ==== ifndef::no-memory-size-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-rest_quarkus.security.adoc b/_generated-doc/latest/config/quarkus-rest_quarkus.security.adoc index 8d0978729c5..09e58e1ed19 100644 --- a/_generated-doc/latest/config/quarkus-rest_quarkus.security.adoc +++ b/_generated-doc/latest/config/quarkus-rest_quarkus.security.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-rest_quarkus-security [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-resteasy-client-oidc-filter.adoc b/_generated-doc/latest/config/quarkus-resteasy-client-oidc-filter.adoc index 76daedc79ce..4fed8fa406a 100644 --- a/_generated-doc/latest/config/quarkus-resteasy-client-oidc-filter.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy-client-oidc-filter.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-resteasy-client-oidc-filter_quarkus-resteasy-client-oidc-filter [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-resteasy-client-oidc-filter_quarkus.resteasy-client-oidc-filter.adoc b/_generated-doc/latest/config/quarkus-resteasy-client-oidc-filter_quarkus.resteasy-client-oidc-filter.adoc index 76daedc79ce..4fed8fa406a 100644 --- a/_generated-doc/latest/config/quarkus-resteasy-client-oidc-filter_quarkus.resteasy-client-oidc-filter.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy-client-oidc-filter_quarkus.resteasy-client-oidc-filter.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-resteasy-client-oidc-filter_quarkus-resteasy-client-oidc-filter [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-resteasy-client-oidc-token-propagation.adoc b/_generated-doc/latest/config/quarkus-resteasy-client-oidc-token-propagation.adoc index 26d076d4fe0..58b0e4fb9af 100644 --- a/_generated-doc/latest/config/quarkus-resteasy-client-oidc-token-propagation.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy-client-oidc-token-propagation.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-resteasy-client-oidc-token-propagation_quarkus-resteasy-client-oidc-token-propagation [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -135,5 +134,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-resteasy-client-oidc-token-propagation_quarkus.resteasy-client-oidc-token-propagation.adoc b/_generated-doc/latest/config/quarkus-resteasy-client-oidc-token-propagation_quarkus.resteasy-client-oidc-token-propagation.adoc index 26d076d4fe0..58b0e4fb9af 100644 --- a/_generated-doc/latest/config/quarkus-resteasy-client-oidc-token-propagation_quarkus.resteasy-client-oidc-token-propagation.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy-client-oidc-token-propagation_quarkus.resteasy-client-oidc-token-propagation.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-resteasy-client-oidc-token-propagation_quarkus-resteasy-client-oidc-token-propagation [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -135,5 +134,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-resteasy-multipart.adoc b/_generated-doc/latest/config/quarkus-resteasy-multipart.adoc index 8b2187644e0..90b6007b6e0 100644 --- a/_generated-doc/latest/config/quarkus-resteasy-multipart.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy-multipart.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-resteasy-multipart_quarkus-resteasy [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -46,5 +45,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-resteasy-multipart_quarkus.resteasy.adoc b/_generated-doc/latest/config/quarkus-resteasy-multipart_quarkus.resteasy.adoc index 8b2187644e0..90b6007b6e0 100644 --- a/_generated-doc/latest/config/quarkus-resteasy-multipart_quarkus.resteasy.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy-multipart_quarkus.resteasy.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-resteasy-multipart_quarkus-resteasy [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -46,5 +45,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-resteasy-server.adoc b/_generated-doc/latest/config/quarkus-resteasy-server.adoc index 1b0d11cfdfa..e26ccfa15f9 100644 --- a/_generated-doc/latest/config/quarkus-resteasy-server.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy-server.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-resteasy-server_quarkus-resteasy [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -87,5 +86,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-resteasy-server_quarkus.resteasy.adoc b/_generated-doc/latest/config/quarkus-resteasy-server_quarkus.resteasy.adoc index 1b0d11cfdfa..e26ccfa15f9 100644 --- a/_generated-doc/latest/config/quarkus-resteasy-server_quarkus.resteasy.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy-server_quarkus.resteasy.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-resteasy-server_quarkus-resteasy [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -87,5 +86,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-resteasy_quarkus.resteasy-json.adoc b/_generated-doc/latest/config/quarkus-resteasy_quarkus.resteasy-json.adoc index d16a32c0fa1..740c89eb29c 100644 --- a/_generated-doc/latest/config/quarkus-resteasy_quarkus.resteasy-json.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy_quarkus.resteasy-json.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-resteasy_quarkus-resteasy-json [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-resteasy_quarkus.resteasy.adoc b/_generated-doc/latest/config/quarkus-resteasy_quarkus.resteasy.adoc index 071985ff0d7..5c9d4e54db5 100644 --- a/_generated-doc/latest/config/quarkus-resteasy_quarkus.resteasy.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy_quarkus.resteasy.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-resteasy_quarkus-resteasy [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -58,7 +57,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_RESTEASY_GZIP_MAX_INPUT+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-resteasy_quarkus-resteasy[icon:question-circle[title=More information about the MemorySize format]] |`10M` |=== @@ -73,5 +72,3 @@ A size configuration option recognizes strings in this format (shown as a regula If no suffix is given, assume bytes. ==== ifndef::no-memory-size-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-resteasy_quarkus.security.adoc b/_generated-doc/latest/config/quarkus-resteasy_quarkus.security.adoc index 078370adf72..63513e19d99 100644 --- a/_generated-doc/latest/config/quarkus-resteasy_quarkus.security.adoc +++ b/_generated-doc/latest/config/quarkus-resteasy_quarkus.security.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-resteasy_quarkus-security [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-scheduler.adoc b/_generated-doc/latest/config/quarkus-scheduler.adoc index 107e9a61dee..0b0f714d5df 100644 --- a/_generated-doc/latest/config/quarkus-scheduler.adoc +++ b/_generated-doc/latest/config/quarkus-scheduler.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-scheduler_quarkus-scheduler [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -109,7 +108,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SCHEDULER_OVERDUE_GRACE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-scheduler_quarkus-scheduler[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-scheduler_quarkus-scheduler-start-mode]] [.property-path]##link:#quarkus-scheduler_quarkus-scheduler-start-mode[`quarkus.scheduler.start-mode`]## @@ -150,5 +149,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-scheduler_quarkus.scheduler.adoc b/_generated-doc/latest/config/quarkus-scheduler_quarkus.scheduler.adoc index 107e9a61dee..0b0f714d5df 100644 --- a/_generated-doc/latest/config/quarkus-scheduler_quarkus.scheduler.adoc +++ b/_generated-doc/latest/config/quarkus-scheduler_quarkus.scheduler.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-scheduler_quarkus-scheduler [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -109,7 +108,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SCHEDULER_OVERDUE_GRACE_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-scheduler_quarkus-scheduler[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-scheduler_quarkus-scheduler-start-mode]] [.property-path]##link:#quarkus-scheduler_quarkus-scheduler-start-mode[`quarkus.scheduler.start-mode`]## @@ -150,5 +149,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-schema-registry-devservice.adoc b/_generated-doc/latest/config/quarkus-schema-registry-devservice.adoc index d974ffcf32e..707dd330ab9 100644 --- a/_generated-doc/latest/config/quarkus-schema-registry-devservice.adoc +++ b/_generated-doc/latest/config/quarkus-schema-registry-devservice.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-schema-registry-devservice_quarkus-apicurio-registry [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -125,5 +124,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-schema-registry-devservice_quarkus.apicurio-registry.adoc b/_generated-doc/latest/config/quarkus-schema-registry-devservice_quarkus.apicurio-registry.adoc index d974ffcf32e..707dd330ab9 100644 --- a/_generated-doc/latest/config/quarkus-schema-registry-devservice_quarkus.apicurio-registry.adoc +++ b/_generated-doc/latest/config/quarkus-schema-registry-devservice_quarkus.apicurio-registry.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-schema-registry-devservice_quarkus-apicurio-registry [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -125,5 +124,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-schema-registry-devservice_quarkus.apicurio-registry.devservices.adoc b/_generated-doc/latest/config/quarkus-schema-registry-devservice_quarkus.apicurio-registry.devservices.adoc index dd75f119b8f..8120d8767f8 100644 --- a/_generated-doc/latest/config/quarkus-schema-registry-devservice_quarkus.apicurio-registry.devservices.adoc +++ b/_generated-doc/latest/config/quarkus-schema-registry-devservice_quarkus.apicurio-registry.devservices.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-schema-registry-devservice_quarkus-apicurio-registry-devservices [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -120,5 +119,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-security-jpa.adoc b/_generated-doc/latest/config/quarkus-security-jpa.adoc index ccedbc117ce..7885542890e 100644 --- a/_generated-doc/latest/config/quarkus-security-jpa.adoc +++ b/_generated-doc/latest/config/quarkus-security-jpa.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-security-jpa_quarkus-security-jpa [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-security-jpa_quarkus.security-jpa.adoc b/_generated-doc/latest/config/quarkus-security-jpa_quarkus.security-jpa.adoc index ccedbc117ce..7885542890e 100644 --- a/_generated-doc/latest/config/quarkus-security-jpa_quarkus.security-jpa.adoc +++ b/_generated-doc/latest/config/quarkus-security-jpa_quarkus.security-jpa.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-security-jpa_quarkus-security-jpa [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-security-webauthn.adoc b/_generated-doc/latest/config/quarkus-security-webauthn.adoc index dfe08222e1e..15f5ec7e1b6 100644 --- a/_generated-doc/latest/config/quarkus-security-webauthn.adoc +++ b/_generated-doc/latest/config/quarkus-security-webauthn.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-security-webauthn_quarkus-webauthn [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -170,7 +169,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBAUTHN_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-security-webauthn_quarkus-webauthn[icon:question-circle[title=More information about the Duration format]] |`60s` a| [[quarkus-security-webauthn_quarkus-webauthn-attestation]] [.property-path]##link:#quarkus-security-webauthn_quarkus-webauthn-attestation[`quarkus.webauthn.attestation`]## @@ -260,7 +259,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBAUTHN_SESSION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-security-webauthn_quarkus-webauthn[icon:question-circle[title=More information about the Duration format]] |`PT30M` a| [[quarkus-security-webauthn_quarkus-webauthn-new-cookie-interval]] [.property-path]##link:#quarkus-security-webauthn_quarkus-webauthn-new-cookie-interval[`quarkus.webauthn.new-cookie-interval`]## @@ -277,7 +276,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBAUTHN_NEW_COOKIE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-security-webauthn_quarkus-webauthn[icon:question-circle[title=More information about the Duration format]] |`PT1M` a| [[quarkus-security-webauthn_quarkus-webauthn-cookie-name]] [.property-path]##link:#quarkus-security-webauthn_quarkus-webauthn-cookie-name[`quarkus.webauthn.cookie-name`]## @@ -365,6 +364,23 @@ endif::add-copy-button-to-env-var[] |string |`/` +a| [[quarkus-security-webauthn_quarkus-webauthn-cookie-max-age]] [.property-path]##link:#quarkus-security-webauthn_quarkus-webauthn-cookie-max-age[`quarkus.webauthn.cookie-max-age`]## + +[.description] +-- +Max-Age attribute for the session cookie. This is the amount of time the browser will keep the cookie. The default value is empty, which means the cookie will be kept until the browser is closed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBAUTHN_COOKIE_MAX_AGE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBAUTHN_COOKIE_MAX_AGE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-security-webauthn_quarkus-webauthn[icon:question-circle[title=More information about the Duration format]] +| + |=== ifndef::no-duration-note[] @@ -386,5 +402,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-security-webauthn_quarkus.webauthn.adoc b/_generated-doc/latest/config/quarkus-security-webauthn_quarkus.webauthn.adoc index dfe08222e1e..15f5ec7e1b6 100644 --- a/_generated-doc/latest/config/quarkus-security-webauthn_quarkus.webauthn.adoc +++ b/_generated-doc/latest/config/quarkus-security-webauthn_quarkus.webauthn.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-security-webauthn_quarkus-webauthn [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -170,7 +169,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBAUTHN_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-security-webauthn_quarkus-webauthn[icon:question-circle[title=More information about the Duration format]] |`60s` a| [[quarkus-security-webauthn_quarkus-webauthn-attestation]] [.property-path]##link:#quarkus-security-webauthn_quarkus-webauthn-attestation[`quarkus.webauthn.attestation`]## @@ -260,7 +259,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBAUTHN_SESSION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-security-webauthn_quarkus-webauthn[icon:question-circle[title=More information about the Duration format]] |`PT30M` a| [[quarkus-security-webauthn_quarkus-webauthn-new-cookie-interval]] [.property-path]##link:#quarkus-security-webauthn_quarkus-webauthn-new-cookie-interval[`quarkus.webauthn.new-cookie-interval`]## @@ -277,7 +276,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBAUTHN_NEW_COOKIE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-security-webauthn_quarkus-webauthn[icon:question-circle[title=More information about the Duration format]] |`PT1M` a| [[quarkus-security-webauthn_quarkus-webauthn-cookie-name]] [.property-path]##link:#quarkus-security-webauthn_quarkus-webauthn-cookie-name[`quarkus.webauthn.cookie-name`]## @@ -365,6 +364,23 @@ endif::add-copy-button-to-env-var[] |string |`/` +a| [[quarkus-security-webauthn_quarkus-webauthn-cookie-max-age]] [.property-path]##link:#quarkus-security-webauthn_quarkus-webauthn-cookie-max-age[`quarkus.webauthn.cookie-max-age`]## + +[.description] +-- +Max-Age attribute for the session cookie. This is the amount of time the browser will keep the cookie. The default value is empty, which means the cookie will be kept until the browser is closed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_WEBAUTHN_COOKIE_MAX_AGE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_WEBAUTHN_COOKIE_MAX_AGE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-security-webauthn_quarkus-webauthn[icon:question-circle[title=More information about the Duration format]] +| + |=== ifndef::no-duration-note[] @@ -386,5 +402,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-security.adoc b/_generated-doc/latest/config/quarkus-security.adoc index eba6e94450c..b10b4cfa3ab 100644 --- a/_generated-doc/latest/config/quarkus-security.adoc +++ b/_generated-doc/latest/config/quarkus-security.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-security_quarkus-security [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -108,5 +107,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-security_quarkus.security.adoc b/_generated-doc/latest/config/quarkus-security_quarkus.security.adoc index eba6e94450c..b10b4cfa3ab 100644 --- a/_generated-doc/latest/config/quarkus-security_quarkus.security.adoc +++ b/_generated-doc/latest/config/quarkus-security_quarkus.security.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-security_quarkus-security [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -108,5 +107,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-graphql-client.adoc b/_generated-doc/latest/config/quarkus-smallrye-graphql-client.adoc index 825b35a9d12..bbd44219f8a 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-graphql-client.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-graphql-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -110,108 +109,6 @@ endif::add-copy-button-to-env-var[] |int | -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store[`quarkus.smallrye-graphql-client."clients".trust-store`]## - -[.description] --- -The trust store location. Can point to either a classpath resource or a file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store-password]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store-password[`quarkus.smallrye-graphql-client."clients".trust-store-password`]## - -[.description] --- -The trust store password. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store-type]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store-type[`quarkus.smallrye-graphql-client."clients".trust-store-type`]## - -[.description] --- -The type of the trust store. Defaults to "JKS". - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store[`quarkus.smallrye-graphql-client."clients".key-store`]## - -[.description] --- -The key store location. Can point to either a classpath resource or a file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store-password]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store-password[`quarkus.smallrye-graphql-client."clients".key-store-password`]## - -[.description] --- -The key store password. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store-type]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store-type[`quarkus.smallrye-graphql-client."clients".key-store-type`]## - -[.description] --- -The type of the key store. Defaults to "JKS". - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-proxy-host]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-proxy-host[`quarkus.smallrye-graphql-client."clients".proxy-host`]## [.description] @@ -331,7 +228,22 @@ endif::add-copy-button-to-env-var[] |boolean | -|=== +a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-tls-configuration-name]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-tls-configuration-name[`quarkus.smallrye-graphql-client."clients".tls-configuration-name`]## +[.description] +-- +The name of the TLS configuration (bucket) used for client authentication in the TLS registry. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +|=== -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-graphql-client_quarkus.smallrye-graphql-client.adoc b/_generated-doc/latest/config/quarkus-smallrye-graphql-client_quarkus.smallrye-graphql-client.adoc index 825b35a9d12..bbd44219f8a 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-graphql-client_quarkus.smallrye-graphql-client.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-graphql-client_quarkus.smallrye-graphql-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -110,108 +109,6 @@ endif::add-copy-button-to-env-var[] |int | -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store[`quarkus.smallrye-graphql-client."clients".trust-store`]## - -[.description] --- -The trust store location. Can point to either a classpath resource or a file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store-password]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store-password[`quarkus.smallrye-graphql-client."clients".trust-store-password`]## - -[.description] --- -The trust store password. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store-type]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-trust-store-type[`quarkus.smallrye-graphql-client."clients".trust-store-type`]## - -[.description] --- -The type of the trust store. Defaults to "JKS". - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store[`quarkus.smallrye-graphql-client."clients".key-store`]## - -[.description] --- -The key store location. Can point to either a classpath resource or a file. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store-password]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store-password[`quarkus.smallrye-graphql-client."clients".key-store-password`]## - -[.description] --- -The key store password. - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] --- -|string -| - -a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store-type]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-key-store-type[`quarkus.smallrye-graphql-client."clients".key-store-type`]## - -[.description] --- -The type of the key store. Defaults to "JKS". - - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_TYPE+++` -endif::add-copy-button-to-env-var[] --- -|string -| - a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-proxy-host]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-proxy-host[`quarkus.smallrye-graphql-client."clients".proxy-host`]## [.description] @@ -331,7 +228,22 @@ endif::add-copy-button-to-env-var[] |boolean | -|=== +a| [[quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-tls-configuration-name]] [.property-path]##link:#quarkus-smallrye-graphql-client_quarkus-smallrye-graphql-client-clients-tls-configuration-name[`quarkus.smallrye-graphql-client."clients".tls-configuration-name`]## +[.description] +-- +The name of the TLS configuration (bucket) used for client authentication in the TLS registry. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TLS_CONFIGURATION_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TLS_CONFIGURATION_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +|=== -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-graphql.adoc b/_generated-doc/latest/config/quarkus-smallrye-graphql.adoc index 9f0694467ec..a75daffcc73 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-graphql.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-graphql.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-graphql_quarkus-smallrye-graphql [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -627,5 +626,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-graphql_quarkus.smallrye-graphql.adoc b/_generated-doc/latest/config/quarkus-smallrye-graphql_quarkus.smallrye-graphql.adoc index 9f0694467ec..a75daffcc73 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-graphql_quarkus.smallrye-graphql.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-graphql_quarkus.smallrye-graphql.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-graphql_quarkus-smallrye-graphql [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -627,5 +626,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-health_quarkus.health.adoc b/_generated-doc/latest/config/quarkus-smallrye-health_quarkus.health.adoc index 0328af14860..8410f0a8c9d 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-health_quarkus.health.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-health_quarkus.health.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-health_quarkus-health [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -8,7 +7,7 @@ h|[.header-title]##Configuration property## h|Type h|Default -|=== +3+|No configuration properties found. +|=== -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-health_quarkus.smallrye-health.adoc b/_generated-doc/latest/config/quarkus-smallrye-health_quarkus.smallrye-health.adoc index 44d99eda267..3d84dd98b88 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-health_quarkus.smallrye-health.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-health_quarkus.smallrye-health.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-health_quarkus-smallrye-health [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -229,6 +228,23 @@ endif::add-copy-button-to-env-var[] |boolean |`true` +a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-health_quarkus-smallrye-health-include-problem-details]] [.property-path]##link:#quarkus-smallrye-health_quarkus-smallrye-health-include-problem-details[`quarkus.smallrye-health.include-problem-details`]## + +[.description] +-- +Specify the reported DOWN responses should be aligned with RFC 9457 - Problem Details for HTTP APIs. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_HEALTH_INCLUDE_PROBLEM_DETAILS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SMALLRYE_HEALTH_INCLUDE_PROBLEM_DETAILS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a| [[quarkus-smallrye-health_quarkus-smallrye-health-ui-enable]] [.property-path]##link:#quarkus-smallrye-health_quarkus-smallrye-health-ui-enable[`quarkus.smallrye-health.ui.enable`]## [.description] @@ -321,5 +337,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-jwt.adoc b/_generated-doc/latest/config/quarkus-smallrye-jwt.adoc index c4d56840f1c..08ba38f04a4 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-jwt.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-jwt.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-jwt_quarkus-smallrye-jwt [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-jwt_quarkus.smallrye-jwt.adoc b/_generated-doc/latest/config/quarkus-smallrye-jwt_quarkus.smallrye-jwt.adoc index c4d56840f1c..08ba38f04a4 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-jwt_quarkus.smallrye-jwt.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-jwt_quarkus.smallrye-jwt.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-jwt_quarkus-smallrye-jwt [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-metrics.adoc b/_generated-doc/latest/config/quarkus-smallrye-metrics.adoc index 55b7fbbe12f..59ddd64790a 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-metrics.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-metrics.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-metrics_quarkus-smallrye-metrics [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -80,5 +79,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-metrics_quarkus.smallrye-metrics.adoc b/_generated-doc/latest/config/quarkus-smallrye-metrics_quarkus.smallrye-metrics.adoc index 55b7fbbe12f..59ddd64790a 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-metrics_quarkus.smallrye-metrics.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-metrics_quarkus.smallrye-metrics.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-metrics_quarkus-smallrye-metrics [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -80,5 +79,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-openapi.adoc b/_generated-doc/latest/config/quarkus-smallrye-openapi.adoc index 231f78d58e4..f44ac38fe54 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-openapi.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-openapi.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-openapi_quarkus-smallrye-openapi [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -656,5 +655,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-openapi_quarkus.smallrye-openapi.adoc b/_generated-doc/latest/config/quarkus-smallrye-openapi_quarkus.smallrye-openapi.adoc index 231f78d58e4..f44ac38fe54 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-openapi_quarkus.smallrye-openapi.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-openapi_quarkus.smallrye-openapi.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-openapi_quarkus-smallrye-openapi [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -656,5 +655,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-stork.adoc b/_generated-doc/latest/config/quarkus-smallrye-stork.adoc index 9f32c78b761..1724e79c1b6 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-stork.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-stork.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-stork_quarkus-stork [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -117,5 +116,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-smallrye-stork_quarkus.stork.adoc b/_generated-doc/latest/config/quarkus-smallrye-stork_quarkus.stork.adoc index 9f32c78b761..1724e79c1b6 100644 --- a/_generated-doc/latest/config/quarkus-smallrye-stork_quarkus.stork.adoc +++ b/_generated-doc/latest/config/quarkus-smallrye-stork_quarkus.stork.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-smallrye-stork_quarkus-stork [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -117,5 +116,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-spring-boot-properties.adoc b/_generated-doc/latest/config/quarkus-spring-boot-properties.adoc index b1d2f1390f8..bd1b078b65d 100644 --- a/_generated-doc/latest/config/quarkus-spring-boot-properties.adoc +++ b/_generated-doc/latest/config/quarkus-spring-boot-properties.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-spring-boot-properties_quarkus-spring-boot-properties [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ a|`verbatim`, `kebab-case`, `snake-case` |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-spring-boot-properties_quarkus.spring-boot-properties.adoc b/_generated-doc/latest/config/quarkus-spring-boot-properties_quarkus.spring-boot-properties.adoc index b1d2f1390f8..bd1b078b65d 100644 --- a/_generated-doc/latest/config/quarkus-spring-boot-properties_quarkus.spring-boot-properties.adoc +++ b/_generated-doc/latest/config/quarkus-spring-boot-properties_quarkus.spring-boot-properties.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-spring-boot-properties_quarkus-spring-boot-properties [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -27,5 +26,3 @@ a|`verbatim`, `kebab-case`, `snake-case` |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-spring-cloud-config-client.adoc b/_generated-doc/latest/config/quarkus-spring-cloud-config-client.adoc index e5f9a2fb70c..f8dcda73d09 100644 --- a/_generated-doc/latest/config/quarkus-spring-cloud-config-client.adoc +++ b/_generated-doc/latest/config/quarkus-spring-cloud-config-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-spring-cloud-config-client_quarkus-spring-cloud-config [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -109,7 +108,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-spring-cloud-config-client_quarkus-spring-cloud-config[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-read-timeout]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-read-timeout[`quarkus.spring-cloud-config.read-timeout`]## @@ -128,7 +127,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-spring-cloud-config-client_quarkus-spring-cloud-config[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-username]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-username[`quarkus.spring-cloud-config.username`]## @@ -322,5 +321,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-spring-cloud-config-client_quarkus.spring-cloud-config.adoc b/_generated-doc/latest/config/quarkus-spring-cloud-config-client_quarkus.spring-cloud-config.adoc index e5f9a2fb70c..f8dcda73d09 100644 --- a/_generated-doc/latest/config/quarkus-spring-cloud-config-client_quarkus.spring-cloud-config.adoc +++ b/_generated-doc/latest/config/quarkus-spring-cloud-config-client_quarkus.spring-cloud-config.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-spring-cloud-config-client_quarkus-spring-cloud-config [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -109,7 +108,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-spring-cloud-config-client_quarkus-spring-cloud-config[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-read-timeout]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-read-timeout[`quarkus.spring-cloud-config.read-timeout`]## @@ -128,7 +127,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-spring-cloud-config-client_quarkus-spring-cloud-config[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-username]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-username[`quarkus.spring-cloud-config.username`]## @@ -322,5 +321,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-spring-di.adoc b/_generated-doc/latest/config/quarkus-spring-di.adoc index 0392c6d617d..42918210010 100644 --- a/_generated-doc/latest/config/quarkus-spring-di.adoc +++ b/_generated-doc/latest/config/quarkus-spring-di.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-spring-di_quarkus-spring-di [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -29,5 +28,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-spring-di_quarkus.spring-di.adoc b/_generated-doc/latest/config/quarkus-spring-di_quarkus.spring-di.adoc index 0392c6d617d..42918210010 100644 --- a/_generated-doc/latest/config/quarkus-spring-di_quarkus.spring-di.adoc +++ b/_generated-doc/latest/config/quarkus-spring-di_quarkus.spring-di.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-spring-di_quarkus-spring-di [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -29,5 +28,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-swagger-ui.adoc b/_generated-doc/latest/config/quarkus-swagger-ui.adoc index 28d8e7fcfcb..647c0421c0c 100644 --- a/_generated-doc/latest/config/quarkus-swagger-ui.adoc +++ b/_generated-doc/latest/config/quarkus-swagger-ui.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-swagger-ui_quarkus-swagger-ui [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -913,5 +912,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-swagger-ui_quarkus.swagger-ui.adoc b/_generated-doc/latest/config/quarkus-swagger-ui_quarkus.swagger-ui.adoc index 28d8e7fcfcb..647c0421c0c 100644 --- a/_generated-doc/latest/config/quarkus-swagger-ui_quarkus.swagger-ui.adoc +++ b/_generated-doc/latest/config/quarkus-swagger-ui_quarkus.swagger-ui.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-swagger-ui_quarkus-swagger-ui [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -913,5 +912,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-tls-registry.adoc b/_generated-doc/latest/config/quarkus-tls-registry.adoc index edca3d1db67..5d3f3e66060 100644 --- a/_generated-doc/latest/config/quarkus-tls-registry.adoc +++ b/_generated-doc/latest/config/quarkus-tls-registry.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-tls-registry_quarkus-tls [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -585,7 +584,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TLS_HANDSHAKE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-tls-registry_quarkus-tls[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-tls-registry_quarkus-tls-alpn]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-alpn[`quarkus.tls.alpn`]## @@ -686,7 +685,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TLS_RELOAD_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-tls-registry_quarkus-tls[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-tls-registry_quarkus-tls-key-store-pem-key-certs-key]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-key-store-pem-key-certs-key[`quarkus.tls.key-store.pem."key-certs".key`]## @@ -1317,7 +1316,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-tls-registry_quarkus-tls[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-alpn]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-alpn[`quarkus.tls."tls-bucket-name".alpn`]## @@ -1418,7 +1417,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__RELOAD_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-tls-registry_quarkus-tls[icon:question-circle[title=More information about the Duration format]] | |=== @@ -1442,5 +1441,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-tls-registry_quarkus.tls.adoc b/_generated-doc/latest/config/quarkus-tls-registry_quarkus.tls.adoc index edca3d1db67..5d3f3e66060 100644 --- a/_generated-doc/latest/config/quarkus-tls-registry_quarkus.tls.adoc +++ b/_generated-doc/latest/config/quarkus-tls-registry_quarkus.tls.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-tls-registry_quarkus-tls [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -585,7 +584,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TLS_HANDSHAKE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-tls-registry_quarkus-tls[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-tls-registry_quarkus-tls-alpn]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-alpn[`quarkus.tls.alpn`]## @@ -686,7 +685,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TLS_RELOAD_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-tls-registry_quarkus-tls[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-tls-registry_quarkus-tls-key-store-pem-key-certs-key]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-key-store-pem-key-certs-key[`quarkus.tls.key-store.pem."key-certs".key`]## @@ -1317,7 +1316,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-tls-registry_quarkus-tls[icon:question-circle[title=More information about the Duration format]] |`10S` a| [[quarkus-tls-registry_quarkus-tls-tls-bucket-name-alpn]] [.property-path]##link:#quarkus-tls-registry_quarkus-tls-tls-bucket-name-alpn[`quarkus.tls."tls-bucket-name".alpn`]## @@ -1418,7 +1417,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_TLS__TLS_BUCKET_NAME__RELOAD_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-tls-registry_quarkus-tls[icon:question-circle[title=More information about the Duration format]] | |=== @@ -1442,5 +1441,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-undertow.adoc b/_generated-doc/latest/config/quarkus-undertow.adoc index 2270a752b55..9fa3586590f 100644 --- a/_generated-doc/latest/config/quarkus-undertow.adoc +++ b/_generated-doc/latest/config/quarkus-undertow.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-undertow_quarkus-servlet [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -61,7 +60,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SERVLET_BUFFER_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-undertow_quarkus-servlet[icon:question-circle[title=More information about the MemorySize format]] | a| [[quarkus-undertow_quarkus-servlet-direct-buffers]] [.property-path]##link:#quarkus-undertow_quarkus-servlet-direct-buffers[`quarkus.servlet.direct-buffers`]## @@ -110,5 +109,3 @@ A size configuration option recognizes strings in this format (shown as a regula If no suffix is given, assume bytes. ==== ifndef::no-memory-size-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-undertow_quarkus.servlet.adoc b/_generated-doc/latest/config/quarkus-undertow_quarkus.servlet.adoc index 2270a752b55..9fa3586590f 100644 --- a/_generated-doc/latest/config/quarkus-undertow_quarkus.servlet.adoc +++ b/_generated-doc/latest/config/quarkus-undertow_quarkus.servlet.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-undertow_quarkus-servlet [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -61,7 +60,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SERVLET_BUFFER_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-undertow_quarkus-servlet[icon:question-circle[title=More information about the MemorySize format]] | a| [[quarkus-undertow_quarkus-servlet-direct-buffers]] [.property-path]##link:#quarkus-undertow_quarkus-servlet-direct-buffers[`quarkus.servlet.direct-buffers`]## @@ -110,5 +109,3 @@ A size configuration option recognizes strings in this format (shown as a regula If no suffix is given, assume bytes. ==== ifndef::no-memory-size-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx-graphql.adoc b/_generated-doc/latest/config/quarkus-vertx-graphql.adoc index 6f63e00bead..6611315407a 100644 --- a/_generated-doc/latest/config/quarkus-vertx-graphql.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-graphql.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx-graphql_quarkus-vertx-graphql [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -46,5 +45,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx-graphql_quarkus.vertx-graphql.adoc b/_generated-doc/latest/config/quarkus-vertx-graphql_quarkus.vertx-graphql.adoc index 6f63e00bead..6611315407a 100644 --- a/_generated-doc/latest/config/quarkus-vertx-graphql_quarkus.vertx-graphql.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-graphql_quarkus.vertx-graphql.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx-graphql_quarkus-vertx-graphql [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -46,5 +45,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.dev-ui.adoc b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.dev-ui.adoc index de8febf7858..9e0bcb78b98 100644 --- a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.dev-ui.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.dev-ui.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx-http_quarkus-dev-ui [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -46,7 +45,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-dev-ui-hosts [.description] -- -More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com By default localhost and 127.0.0.1 will always be allowed +More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com (This can also be a regex) By default localhost and 127.0.0.1 will always be allowed ifdef::add-copy-button-to-env-var[] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.access-log.adoc b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.access-log.adoc index a0add31cbcd..20c52d25d1e 100644 --- a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.access-log.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.access-log.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx-http_quarkus-http-access-log [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -188,5 +187,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.adoc b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.adoc index 51a066440ae..e6d8f703476 100644 --- a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx-http_quarkus-http [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -93,6 +92,34 @@ endif::add-copy-button-to-env-var[] |boolean |`true` +a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-auth-inclusive]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-inclusive[`quarkus.http.auth.inclusive`]## + +[.description] +-- +Require that all registered HTTP authentication mechanisms must complete the authentication. + +Typically, this property has to be true when the credentials are carried over mTLS, when both mTLS and another authentication, for example, OIDC bearer token authentication, must succeed. In such cases, `SecurityIdentity` created by the first mechanism, mTLS, can be injected, identities created by other mechanisms will be available on `SecurityIdentity`. The identities can be retrieved using utility method as in the example below: + +``` +``` + +`io.quarkus.vertx.http.runtime.security.HttpSecurityUtils.getSecurityIdentities(securityIdentity)` + +This property is false by default which means that the authentication process is complete as soon as the first `SecurityIdentity` is created. + +This property will be ignored if the path specific authentication is enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_INCLUSIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_INCLUSIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-ssl-client-auth]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-ssl-client-auth[`quarkus.http.ssl.client-auth`]## [.description] @@ -172,7 +199,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_TEST_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the Duration format]] |`30S` a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-enable-compression]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-enable-compression[`quarkus.http.enable-compression`]## @@ -247,7 +274,7 @@ Environment variable: `+++QUARKUS_HTTP_COMPRESS_MEDIA_TYPES+++` endif::add-copy-button-to-env-var[] -- |list of string -|`text/html,text/plain,text/xml,text/css,text/javascript,application/javascript,application/graphql+json` +|`text/html,text/plain,text/xml,text/css,text/javascript,application/javascript,application/json,application/graphql+json,application/xhtml+xml` a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-http-compression-level]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-compression-level[`quarkus.http.compression-level`]## @@ -831,7 +858,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_SSL_CERTIFICATE_RELOAD_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx-http_quarkus-http-ssl-cipher-suites]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-ssl-cipher-suites[`quarkus.http.ssl.cipher-suites`]## @@ -960,7 +987,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the Duration format]] |`30M` a| [[quarkus-vertx-http_quarkus-http-read-timeout]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-read-timeout[`quarkus.http.read-timeout`]## @@ -977,7 +1004,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-vertx-http_quarkus-http-body-handle-file-uploads]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-body-handle-file-uploads[`quarkus.http.body.handle-file-uploads`]## @@ -1739,7 +1766,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the Duration format]] |`PT30M` a| [[quarkus-vertx-http_quarkus-http-auth-form-new-cookie-interval]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-form-new-cookie-interval[`quarkus.http.auth.form.new-cookie-interval`]## @@ -1756,7 +1783,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_NEW_COOKIE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the Duration format]] |`PT1M` a| [[quarkus-vertx-http_quarkus-http-auth-form-cookie-name]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-form-cookie-name[`quarkus.http.auth.form.cookie-name`]## @@ -1827,6 +1854,23 @@ endif::add-copy-button-to-env-var[] a|`strict`, `lax`, `none` |`strict` +a| [[quarkus-vertx-http_quarkus-http-auth-form-cookie-max-age]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth-form-cookie-max-age[`quarkus.http.auth.form.cookie-max-age`]## + +[.description] +-- +Max-Age attribute for the session cookie. This is the amount of time the browser will keep the cookie. The default value is empty, which means the cookie will be kept until the browser is closed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_FORM_COOKIE_MAX_AGE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_COOKIE_MAX_AGE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the Duration format]] +| + h|[[quarkus-vertx-http_section_quarkus-http-cors]] [.section-name.section-level0]##link:#quarkus-vertx-http_section_quarkus-http-cors[The CORS config]## h|Type @@ -1914,7 +1958,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_CORS_ACCESS_CONTROL_MAX_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx-http_quarkus-http-cors-access-control-allow-credentials]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-cors-access-control-allow-credentials[`quarkus.http.cors.access-control-allow-credentials`]## @@ -2021,7 +2065,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_STATIC_RESOURCES_CACHE_ENTRY_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-vertx-http_quarkus-http-static-resources-max-age]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-static-resources-max-age[`quarkus.http.static-resources.max-age`]## @@ -2038,7 +2082,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_STATIC_RESOURCES_MAX_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the Duration format]] |`24H` a| [[quarkus-vertx-http_quarkus-http-static-resources-max-cache-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-static-resources-max-cache-size[`quarkus.http.static-resources.max-cache-size`]## @@ -2094,7 +2138,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_HEADER_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the MemorySize format]] |`20K` a| [[quarkus-vertx-http_quarkus-http-limits-max-body-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits-max-body-size[`quarkus.http.limits.max-body-size`]## @@ -2111,7 +2155,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_BODY_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the MemorySize format]] |`10240K` a| [[quarkus-vertx-http_quarkus-http-limits-max-chunk-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits-max-chunk-size[`quarkus.http.limits.max-chunk-size`]## @@ -2128,7 +2172,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_CHUNK_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the MemorySize format]] |`8192` a| [[quarkus-vertx-http_quarkus-http-limits-max-initial-line-length]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits-max-initial-line-length[`quarkus.http.limits.max-initial-line-length`]## @@ -2162,7 +2206,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_FORM_ATTRIBUTE_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the MemorySize format]] |`2048` a| [[quarkus-vertx-http_quarkus-http-limits-max-form-fields]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits-max-form-fields[`quarkus.http.limits.max-form-fields`]## @@ -2196,7 +2240,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_FORM_BUFFERED_BYTES+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the MemorySize format]] |`1K` a| [[quarkus-vertx-http_quarkus-http-limits-max-parameters]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits-max-parameters[`quarkus.http.limits.max-parameters`]## @@ -2338,7 +2382,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_RST_FLOOD_WINDOW_DURATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the Duration format]] | @@ -2560,7 +2604,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_TRAFFIC_SHAPING_INBOUND_GLOBAL_BANDWIDTH+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the MemorySize format]] | a| [[quarkus-vertx-http_quarkus-http-traffic-shaping-outbound-global-bandwidth]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-traffic-shaping-outbound-global-bandwidth[`quarkus.http.traffic-shaping.outbound-global-bandwidth`]## @@ -2577,7 +2621,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_TRAFFIC_SHAPING_OUTBOUND_GLOBAL_BANDWIDTH+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the MemorySize format]] | a| [[quarkus-vertx-http_quarkus-http-traffic-shaping-max-delay]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-traffic-shaping-max-delay[`quarkus.http.traffic-shaping.max-delay`]## @@ -2594,7 +2638,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_TRAFFIC_SHAPING_MAX_DELAY+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx-http_quarkus-http-traffic-shaping-check-interval]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-traffic-shaping-check-interval[`quarkus.http.traffic-shaping.check-interval`]## @@ -2613,7 +2657,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_TRAFFIC_SHAPING_CHECK_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx-http_quarkus-http-traffic-shaping-peak-outbound-global-bandwidth]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-traffic-shaping-peak-outbound-global-bandwidth[`quarkus.http.traffic-shaping.peak-outbound-global-bandwidth`]## @@ -2630,7 +2674,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_TRAFFIC_SHAPING_PEAK_OUTBOUND_GLOBAL_BANDWIDTH+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-http[icon:question-circle[title=More information about the MemorySize format]] | @@ -2938,6 +2982,45 @@ endif::add-copy-button-to-env-var[] |`All proxy addresses are trusted` +h|[[quarkus-vertx-http_section_quarkus-http-websocket-server]] [.section-name.section-level0]##link:#quarkus-vertx-http_section_quarkus-http-websocket-server[WebSocket Server configuration]## +h|Type +h|Default + +a| [[quarkus-vertx-http_quarkus-http-websocket-server-max-frame-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-websocket-server-max-frame-size[`quarkus.http.websocket-server.max-frame-size`]## + +[.description] +-- +The maximum amount of data that can be sent in a single frame. Messages larger than this must be broken up into continuation frames. Default 65536 (from HttpServerOptions of Vert.X HttpServerOptions) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_FRAME_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_FRAME_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-vertx-http_quarkus-http-websocket-server-max-message-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-websocket-server-max-message-size[`quarkus.http.websocket-server.max-message-size`]## + +[.description] +-- +The maximum WebSocket message size. Default 262144 (from HttpServerOptions of Vert.X HttpServerOptions) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_MESSAGE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_WEBSOCKET_SERVER_MAX_MESSAGE_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + + |=== ifndef::no-duration-note[] @@ -2969,5 +3052,3 @@ A size configuration option recognizes strings in this format (shown as a regula If no suffix is given, assume bytes. ==== ifndef::no-memory-size-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.auth.adoc b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.auth.adoc index 4e480f7cddc..f78419d6213 100644 --- a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.auth.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.auth.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx-http_quarkus-http-auth [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -388,7 +387,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http-auth[icon:question-circle[title=More information about the Duration format]] |`PT30M` a| [[quarkus-vertx-http_quarkus-http-auth_quarkus-http-auth-form-new-cookie-interval]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth_quarkus-http-auth-form-new-cookie-interval[`quarkus.http.auth.form.new-cookie-interval`]## @@ -405,7 +404,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_NEW_COOKIE_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http-auth[icon:question-circle[title=More information about the Duration format]] |`PT1M` a| [[quarkus-vertx-http_quarkus-http-auth_quarkus-http-auth-form-cookie-name]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth_quarkus-http-auth-form-cookie-name[`quarkus.http.auth.form.cookie-name`]## @@ -476,6 +475,23 @@ endif::add-copy-button-to-env-var[] a|`strict`, `lax`, `none` |`strict` +a| [[quarkus-vertx-http_quarkus-http-auth_quarkus-http-auth-form-cookie-max-age]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-auth_quarkus-http-auth-form-cookie-max-age[`quarkus.http.auth.form.cookie-max-age`]## + +[.description] +-- +Max-Age attribute for the session cookie. This is the amount of time the browser will keep the cookie. The default value is empty, which means the cookie will be kept until the browser is closed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_FORM_COOKIE_MAX_AGE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_COOKIE_MAX_AGE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http-auth[icon:question-circle[title=More information about the Duration format]] +| + |=== ifndef::no-duration-note[] @@ -497,5 +513,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.cors.adoc b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.cors.adoc index 7585736cdc6..09e32be8c5d 100644 --- a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.cors.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.cors.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx-http_quarkus-http-cors [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -90,7 +89,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_CORS_ACCESS_CONTROL_MAX_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http-cors[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx-http_quarkus-http-cors_quarkus-http-cors-access-control-allow-credentials]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-cors_quarkus-http-cors-access-control-allow-credentials[`quarkus.http.cors.access-control-allow-credentials`]## @@ -131,5 +130,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.filter.adoc b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.filter.adoc index 267d8806052..ca9200f73cf 100644 --- a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.filter.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.filter.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx-http_quarkus-http-filter [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.header.adoc b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.header.adoc index 24b600acca5..ac7f88b9563 100644 --- a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.header.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.header.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx-http_quarkus-http-header [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -61,5 +60,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.limits.adoc b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.limits.adoc index b8fd373304d..160d5247c2c 100644 --- a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.limits.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.limits.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx-http_quarkus-http-limits [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -22,7 +21,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_HEADER_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-http-limits[icon:question-circle[title=More information about the MemorySize format]] |`20K` a| [[quarkus-vertx-http_quarkus-http-limits_quarkus-http-limits-max-body-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits_quarkus-http-limits-max-body-size[`quarkus.http.limits.max-body-size`]## @@ -39,7 +38,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_BODY_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-http-limits[icon:question-circle[title=More information about the MemorySize format]] |`10240K` a| [[quarkus-vertx-http_quarkus-http-limits_quarkus-http-limits-max-chunk-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits_quarkus-http-limits-max-chunk-size[`quarkus.http.limits.max-chunk-size`]## @@ -56,7 +55,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_CHUNK_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-http-limits[icon:question-circle[title=More information about the MemorySize format]] |`8192` a| [[quarkus-vertx-http_quarkus-http-limits_quarkus-http-limits-max-initial-line-length]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits_quarkus-http-limits-max-initial-line-length[`quarkus.http.limits.max-initial-line-length`]## @@ -90,7 +89,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_FORM_ATTRIBUTE_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-http-limits[icon:question-circle[title=More information about the MemorySize format]] |`2048` a| [[quarkus-vertx-http_quarkus-http-limits_quarkus-http-limits-max-form-fields]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits_quarkus-http-limits-max-form-fields[`quarkus.http.limits.max-form-fields`]## @@ -124,7 +123,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_MAX_FORM_BUFFERED_BYTES+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-http-limits[icon:question-circle[title=More information about the MemorySize format]] |`1K` a| [[quarkus-vertx-http_quarkus-http-limits_quarkus-http-limits-max-parameters]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-limits_quarkus-http-limits-max-parameters[`quarkus.http.limits.max-parameters`]## @@ -266,7 +265,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_LIMITS_RST_FLOOD_WINDOW_DURATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http-limits[icon:question-circle[title=More information about the Duration format]] | |=== @@ -300,5 +299,3 @@ A size configuration option recognizes strings in this format (shown as a regula If no suffix is given, assume bytes. ==== ifndef::no-memory-size-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.static-resources.adoc b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.static-resources.adoc index 17cf6e22c53..53d738ef7d2 100644 --- a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.static-resources.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.http.static-resources.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx-http_quarkus-http-static-resources [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference, cols="80,.^10,.^10"] @@ -90,7 +89,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_STATIC_RESOURCES_CACHE_ENTRY_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http-static-resources[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-vertx-http_quarkus-http-static-resources_quarkus-http-static-resources-max-age]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-static-resources_quarkus-http-static-resources-max-age[`quarkus.http.static-resources.max-age`]## @@ -107,7 +106,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_HTTP_STATIC_RESOURCES_MAX_AGE+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-http-static-resources[icon:question-circle[title=More information about the Duration format]] |`24H` a| [[quarkus-vertx-http_quarkus-http-static-resources_quarkus-http-static-resources-max-cache-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-http-static-resources_quarkus-http-static-resources-max-cache-size[`quarkus.http.static-resources.max-cache-size`]## @@ -165,5 +164,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.management.adoc b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.management.adoc index ad8b0e82b56..e7c837455c2 100644 --- a/_generated-doc/latest/config/quarkus-vertx-http_quarkus.management.adoc +++ b/_generated-doc/latest/config/quarkus-vertx-http_quarkus.management.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx-http_quarkus-management [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -594,7 +593,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_SSL_CERTIFICATE_RELOAD_PERIOD+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-management[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx-http_quarkus-management-ssl-cipher-suites]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-ssl-cipher-suites[`quarkus.management.ssl.cipher-suites`]## @@ -704,7 +703,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_LIMITS_MAX_HEADER_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-management[icon:question-circle[title=More information about the MemorySize format]] |`20K` a| [[quarkus-vertx-http_quarkus-management-limits-max-body-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-limits-max-body-size[`quarkus.management.limits.max-body-size`]## @@ -721,7 +720,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_LIMITS_MAX_BODY_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-management[icon:question-circle[title=More information about the MemorySize format]] |`10240K` a| [[quarkus-vertx-http_quarkus-management-limits-max-chunk-size]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-limits-max-chunk-size[`quarkus.management.limits.max-chunk-size`]## @@ -738,7 +737,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_LIMITS_MAX_CHUNK_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-management[icon:question-circle[title=More information about the MemorySize format]] |`8192` a| [[quarkus-vertx-http_quarkus-management-limits-max-initial-line-length]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-limits-max-initial-line-length[`quarkus.management.limits.max-initial-line-length`]## @@ -772,7 +771,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_LIMITS_MAX_FORM_ATTRIBUTE_SIZE+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-management[icon:question-circle[title=More information about the MemorySize format]] |`2048` a| [[quarkus-vertx-http_quarkus-management-limits-max-form-fields]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-limits-max-form-fields[`quarkus.management.limits.max-form-fields`]## @@ -806,7 +805,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_LIMITS_MAX_FORM_BUFFERED_BYTES+++` endif::add-copy-button-to-env-var[] -- -|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|MemorySize link:#memory-size-note-anchor-quarkus-vertx-http_quarkus-management[icon:question-circle[title=More information about the MemorySize format]] |`1K` a| [[quarkus-vertx-http_quarkus-management-limits-max-parameters]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-limits-max-parameters[`quarkus.management.limits.max-parameters`]## @@ -948,7 +947,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_LIMITS_RST_FLOOD_WINDOW_DURATION+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-management[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx-http_quarkus-management-idle-timeout]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-idle-timeout[`quarkus.management.idle-timeout`]## @@ -965,7 +964,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_MANAGEMENT_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx-http_quarkus-management[icon:question-circle[title=More information about the Duration format]] |`30M` a| [[quarkus-vertx-http_quarkus-management-body-handle-file-uploads]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-body-handle-file-uploads[`quarkus.management.body.handle-file-uploads`]## @@ -1638,5 +1637,3 @@ A size configuration option recognizes strings in this format (shown as a regula If no suffix is given, assume bytes. ==== ifndef::no-memory-size-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx.adoc b/_generated-doc/latest/config/quarkus-vertx.adoc index e40da782ae8..e461f802376 100644 --- a/_generated-doc/latest/config/quarkus-vertx.adoc +++ b/_generated-doc/latest/config/quarkus-vertx.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx_quarkus-vertx [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -92,7 +91,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_MAX_EVENT_LOOP_EXECUTE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-vertx_quarkus-vertx-warning-exception-time]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-warning-exception-time[`quarkus.vertx.warning-exception-time`]## @@ -109,7 +108,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_WARNING_EXCEPTION_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-vertx_quarkus-vertx-max-worker-execute-time]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-max-worker-execute-time[`quarkus.vertx.max-worker-execute-time`]## @@ -126,7 +125,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_MAX_WORKER_EXECUTE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-vertx_quarkus-vertx-internal-blocking-pool-size]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-internal-blocking-pool-size[`quarkus.vertx.internal-blocking-pool-size`]## @@ -196,7 +195,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_KEEP_ALIVE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-vertx_quarkus-vertx-prefill]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-prefill[`quarkus.vertx.prefill`]## @@ -570,7 +569,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_EVENTBUS_CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-vertx_quarkus-vertx-eventbus-idle-timeout]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-eventbus-idle-timeout[`quarkus.vertx.eventbus.idle-timeout`]## @@ -587,7 +586,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_EVENTBUS_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx_quarkus-vertx-eventbus-receive-buffer-size]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-eventbus-receive-buffer-size[`quarkus.vertx.eventbus.receive-buffer-size`]## @@ -638,7 +637,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_EVENTBUS_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-vertx_quarkus-vertx-eventbus-reuse-address]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-eventbus-reuse-address[`quarkus.vertx.eventbus.reuse-address`]## @@ -893,7 +892,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_CLUSTER_PING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`20S` a| [[quarkus-vertx_quarkus-vertx-cluster-ping-reply-interval]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-cluster-ping-reply-interval[`quarkus.vertx.cluster.ping-reply-interval`]## @@ -910,7 +909,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_CLUSTER_PING_REPLY_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`20S` a| [[quarkus-vertx_quarkus-vertx-resolver-cache-max-time-to-live]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-resolver-cache-max-time-to-live[`quarkus.vertx.resolver.cache-max-time-to-live`]## @@ -997,7 +996,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_RESOLVER_QUERY_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-vertx_quarkus-vertx-resolver-hosts-path]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-resolver-hosts-path[`quarkus.vertx.resolver.hosts-path`]## @@ -1197,5 +1196,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-vertx_quarkus.vertx.adoc b/_generated-doc/latest/config/quarkus-vertx_quarkus.vertx.adoc index e40da782ae8..e461f802376 100644 --- a/_generated-doc/latest/config/quarkus-vertx_quarkus.vertx.adoc +++ b/_generated-doc/latest/config/quarkus-vertx_quarkus.vertx.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-vertx_quarkus-vertx [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -92,7 +91,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_MAX_EVENT_LOOP_EXECUTE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-vertx_quarkus-vertx-warning-exception-time]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-warning-exception-time[`quarkus.vertx.warning-exception-time`]## @@ -109,7 +108,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_WARNING_EXCEPTION_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`2S` a| [[quarkus-vertx_quarkus-vertx-max-worker-execute-time]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-max-worker-execute-time[`quarkus.vertx.max-worker-execute-time`]## @@ -126,7 +125,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_MAX_WORKER_EXECUTE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-vertx_quarkus-vertx-internal-blocking-pool-size]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-internal-blocking-pool-size[`quarkus.vertx.internal-blocking-pool-size`]## @@ -196,7 +195,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_KEEP_ALIVE_TIME+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`30S` a| [[quarkus-vertx_quarkus-vertx-prefill]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-prefill[`quarkus.vertx.prefill`]## @@ -570,7 +569,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_EVENTBUS_CONNECT_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`60S` a| [[quarkus-vertx_quarkus-vertx-eventbus-idle-timeout]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-eventbus-idle-timeout[`quarkus.vertx.eventbus.idle-timeout`]## @@ -587,7 +586,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_EVENTBUS_IDLE_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-vertx_quarkus-vertx-eventbus-receive-buffer-size]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-eventbus-receive-buffer-size[`quarkus.vertx.eventbus.receive-buffer-size`]## @@ -638,7 +637,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_EVENTBUS_RECONNECT_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`1S` a| [[quarkus-vertx_quarkus-vertx-eventbus-reuse-address]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-eventbus-reuse-address[`quarkus.vertx.eventbus.reuse-address`]## @@ -893,7 +892,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_CLUSTER_PING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`20S` a| [[quarkus-vertx_quarkus-vertx-cluster-ping-reply-interval]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-cluster-ping-reply-interval[`quarkus.vertx.cluster.ping-reply-interval`]## @@ -910,7 +909,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_CLUSTER_PING_REPLY_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`20S` a| [[quarkus-vertx_quarkus-vertx-resolver-cache-max-time-to-live]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-resolver-cache-max-time-to-live[`quarkus.vertx.resolver.cache-max-time-to-live`]## @@ -997,7 +996,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VERTX_RESOLVER_QUERY_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-vertx_quarkus-vertx[icon:question-circle[title=More information about the Duration format]] |`5S` a| [[quarkus-vertx_quarkus-vertx-resolver-hosts-path]] [.property-path]##link:#quarkus-vertx_quarkus-vertx-resolver-hosts-path[`quarkus.vertx.resolver.hosts-path`]## @@ -1197,5 +1196,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-virtual-threads.adoc b/_generated-doc/latest/config/quarkus-virtual-threads.adoc index a7999aa70b5..9a7cee059bd 100644 --- a/_generated-doc/latest/config/quarkus-virtual-threads.adoc +++ b/_generated-doc/latest/config/quarkus-virtual-threads.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-virtual-threads_quarkus-virtual-threads [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -39,7 +38,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-virtual-threads_quarkus-virtual-threads[icon:question-circle[title=More information about the Duration format]] |`1M` a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-shutdown-check-interval]] [.property-path]##link:#quarkus-virtual-threads_quarkus-virtual-threads-shutdown-check-interval[`quarkus.virtual-threads.shutdown-check-interval`]## @@ -56,7 +55,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_CHECK_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-virtual-threads_quarkus-virtual-threads[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-enabled]] [.property-path]##link:#quarkus-virtual-threads_quarkus-virtual-threads-enabled[`quarkus.virtual-threads.enabled`]## @@ -99,5 +98,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-virtual-threads_quarkus.virtual-threads.adoc b/_generated-doc/latest/config/quarkus-virtual-threads_quarkus.virtual-threads.adoc index a7999aa70b5..9a7cee059bd 100644 --- a/_generated-doc/latest/config/quarkus-virtual-threads_quarkus.virtual-threads.adoc +++ b/_generated-doc/latest/config/quarkus-virtual-threads_quarkus.virtual-threads.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-virtual-threads_quarkus-virtual-threads [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -39,7 +38,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_TIMEOUT+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-virtual-threads_quarkus-virtual-threads[icon:question-circle[title=More information about the Duration format]] |`1M` a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-shutdown-check-interval]] [.property-path]##link:#quarkus-virtual-threads_quarkus-virtual-threads-shutdown-check-interval[`quarkus.virtual-threads.shutdown-check-interval`]## @@ -56,7 +55,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_VIRTUAL_THREADS_SHUTDOWN_CHECK_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-virtual-threads_quarkus-virtual-threads[icon:question-circle[title=More information about the Duration format]] |`5S` a|icon:lock[title=Fixed at build time] [[quarkus-virtual-threads_quarkus-virtual-threads-enabled]] [.property-path]##link:#quarkus-virtual-threads_quarkus-virtual-threads-enabled[`quarkus.virtual-threads.enabled`]## @@ -99,5 +98,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-web-dependency-locator.adoc b/_generated-doc/latest/config/quarkus-web-dependency-locator.adoc index 4695a98a174..22e33da8278 100644 --- a/_generated-doc/latest/config/quarkus-web-dependency-locator.adoc +++ b/_generated-doc/latest/config/quarkus-web-dependency-locator.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-web-dependency-locator_quarkus-web-dependency-locator [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-web-dependency-locator_quarkus.web-dependency-locator.adoc b/_generated-doc/latest/config/quarkus-web-dependency-locator_quarkus.web-dependency-locator.adoc index 4695a98a174..22e33da8278 100644 --- a/_generated-doc/latest/config/quarkus-web-dependency-locator_quarkus.web-dependency-locator.adoc +++ b/_generated-doc/latest/config/quarkus-web-dependency-locator_quarkus.web-dependency-locator.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-web-dependency-locator_quarkus-web-dependency-locator [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -78,5 +77,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-websockets-client.adoc b/_generated-doc/latest/config/quarkus-websockets-client.adoc index 81d2ef01132..9d58977bee2 100644 --- a/_generated-doc/latest/config/quarkus-websockets-client.adoc +++ b/_generated-doc/latest/config/quarkus-websockets-client.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-websockets-client_quarkus-websocket [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-websockets-client_quarkus.websocket.adoc b/_generated-doc/latest/config/quarkus-websockets-client_quarkus.websocket.adoc index 81d2ef01132..9d58977bee2 100644 --- a/_generated-doc/latest/config/quarkus-websockets-client_quarkus.websocket.adoc +++ b/_generated-doc/latest/config/quarkus-websockets-client_quarkus.websocket.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-websockets-client_quarkus-websocket [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -44,5 +43,3 @@ endif::add-copy-button-to-env-var[] |=== - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-websockets-next.adoc b/_generated-doc/latest/config/quarkus-websockets-next.adoc index 7890e0b9eca..265ba0e4083 100644 --- a/_generated-doc/latest/config/quarkus-websockets-next.adoc +++ b/_generated-doc/latest/config/quarkus-websockets-next.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-websockets-next_quarkus-websockets-next [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -77,7 +76,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_AUTO_PING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-websockets-next_quarkus-websockets-next[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy[`quarkus.websockets-next.client.unhandled-failure-strategy`]## @@ -86,7 +85,9 @@ a| [[quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-st -- The strategy used when an error occurs but no error handler can handle the failure. -By default, the connection is closed when an unhandled failure occurs. +By default, the error message is logged when an unhandled failure occurs. + +Note that clients should not close the WebSocket connection arbitrarily. See also RFC-6455 link:https://datatracker.ietf.org/doc/html/rfc6455#section-7.3[section 7.3]. ifdef::add-copy-button-to-env-var[] @@ -96,8 +97,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_UNHANDLED_FAILURE_STRATEGY+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:close[Close the connection.], tooltip:log[Log an error message.], tooltip:noop[No operation.] -|tooltip:close[Close the connection.] +a|tooltip:log-and-close[Log the error message and close the connection.], tooltip:close[Close the connection silently.], tooltip:log[Log the error message.], tooltip:noop[No operation.] +|tooltip:log[Log the error message.] a| [[quarkus-websockets-next_quarkus-websockets-next-client-tls-configuration-name]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-tls-configuration-name[`quarkus.websockets-next.client.tls-configuration-name`]## @@ -240,7 +241,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-websockets-next_quarkus-websockets-next[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-websockets-next_quarkus-websockets-next-server-unhandled-failure-strategy]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-server-unhandled-failure-strategy[`quarkus.websockets-next.server.unhandled-failure-strategy`]## @@ -249,7 +250,7 @@ a| [[quarkus-websockets-next_quarkus-websockets-next-server-unhandled-failure-st -- The strategy used when an error occurs but no error handler can handle the failure. -By default, the connection is closed when an unhandled failure occurs. +By default, the error message is logged and the connection is closed when an unhandled failure occurs. ifdef::add-copy-button-to-env-var[] @@ -259,8 +260,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_UNHANDLED_FAILURE_STRATEGY+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:close[Close the connection.], tooltip:log[Log an error message.], tooltip:noop[No operation.] -|tooltip:close[Close the connection.] +a|tooltip:log-and-close[Log the error message and close the connection.], tooltip:close[Close the connection silently.], tooltip:log[Log the error message.], tooltip:noop[No operation.] +|tooltip:log-and-close[Log the error message and close the connection.] a| [[quarkus-websockets-next_quarkus-websockets-next-server-security-auth-failure-redirect-url]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-server-security-auth-failure-redirect-url[`quarkus.websockets-next.server.security.auth-failure-redirect-url`]## @@ -351,5 +352,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/config/quarkus-websockets-next_quarkus.websockets-next.adoc b/_generated-doc/latest/config/quarkus-websockets-next_quarkus.websockets-next.adoc index 7890e0b9eca..265ba0e4083 100644 --- a/_generated-doc/latest/config/quarkus-websockets-next_quarkus.websockets-next.adoc +++ b/_generated-doc/latest/config/quarkus-websockets-next_quarkus.websockets-next.adoc @@ -1,4 +1,3 @@ -:summaryTableId: quarkus-websockets-next_quarkus-websockets-next [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -77,7 +76,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_AUTO_PING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-websockets-next_quarkus-websockets-next[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy[`quarkus.websockets-next.client.unhandled-failure-strategy`]## @@ -86,7 +85,9 @@ a| [[quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-st -- The strategy used when an error occurs but no error handler can handle the failure. -By default, the connection is closed when an unhandled failure occurs. +By default, the error message is logged when an unhandled failure occurs. + +Note that clients should not close the WebSocket connection arbitrarily. See also RFC-6455 link:https://datatracker.ietf.org/doc/html/rfc6455#section-7.3[section 7.3]. ifdef::add-copy-button-to-env-var[] @@ -96,8 +97,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_UNHANDLED_FAILURE_STRATEGY+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:close[Close the connection.], tooltip:log[Log an error message.], tooltip:noop[No operation.] -|tooltip:close[Close the connection.] +a|tooltip:log-and-close[Log the error message and close the connection.], tooltip:close[Close the connection silently.], tooltip:log[Log the error message.], tooltip:noop[No operation.] +|tooltip:log[Log the error message.] a| [[quarkus-websockets-next_quarkus-websockets-next-client-tls-configuration-name]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-tls-configuration-name[`quarkus.websockets-next.client.tls-configuration-name`]## @@ -240,7 +241,7 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL+++` endif::add-copy-button-to-env-var[] -- -|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-websockets-next_quarkus-websockets-next[icon:question-circle[title=More information about the Duration format]] | a| [[quarkus-websockets-next_quarkus-websockets-next-server-unhandled-failure-strategy]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-server-unhandled-failure-strategy[`quarkus.websockets-next.server.unhandled-failure-strategy`]## @@ -249,7 +250,7 @@ a| [[quarkus-websockets-next_quarkus-websockets-next-server-unhandled-failure-st -- The strategy used when an error occurs but no error handler can handle the failure. -By default, the connection is closed when an unhandled failure occurs. +By default, the error message is logged and the connection is closed when an unhandled failure occurs. ifdef::add-copy-button-to-env-var[] @@ -259,8 +260,8 @@ ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_UNHANDLED_FAILURE_STRATEGY+++` endif::add-copy-button-to-env-var[] -- -a|tooltip:close[Close the connection.], tooltip:log[Log an error message.], tooltip:noop[No operation.] -|tooltip:close[Close the connection.] +a|tooltip:log-and-close[Log the error message and close the connection.], tooltip:close[Close the connection silently.], tooltip:log[Log the error message.], tooltip:noop[No operation.] +|tooltip:log-and-close[Log the error message and close the connection.] a| [[quarkus-websockets-next_quarkus-websockets-next-server-security-auth-failure-redirect-url]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-server-security-auth-failure-redirect-url[`quarkus.websockets-next.server.security.auth-failure-redirect-url`]## @@ -351,5 +352,3 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - -:!summaryTableId: \ No newline at end of file diff --git a/_generated-doc/latest/infra/quarkus-all-build-items.adoc b/_generated-doc/latest/infra/quarkus-all-build-items.adoc index df302b652d9..c8a92c6f116 100644 --- a/_generated-doc/latest/infra/quarkus-all-build-items.adoc +++ b/_generated-doc/latest/infra/quarkus-all-build-items.adoc @@ -2230,13 +2230,6 @@ _No Javadoc found_ -a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/SetClassPathSystemPropBuildItem.java[`io.quarkus.deployment.builditem.SetClassPathSystemPropBuildItem`, window="_blank"] -[.description] --- -A marker build item to make Quarkus set the `java.class.path` system property. This system property is used in rare by libraries (Truffle for example) to create their own ClassLoaders. The value of the system property is simply best effort, as there is no way to faithfully represent the Quarkus ClassLoader hierarchies in a system property value. --- a|None - - a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/ShutdownContextBuildItem.java[`io.quarkus.deployment.builditem.ShutdownContextBuildItem`, window="_blank"] [.description] -- @@ -3645,6 +3638,44 @@ _No Javadoc found_ _No Javadoc found_ +|=== +== DevServices - Keycloak +[.configuration-reference,cols=2*] +|=== +h|Class Name +h|Attributes + + + + +a| https://github.com/quarkusio/quarkus/blob/main/extensions/devservices/keycloak/src/main/java/io/quarkus/devservices/keycloak/KeycloakDevServicesConfigBuildItem.java[`io.quarkus.devservices.keycloak.KeycloakDevServicesConfigBuildItem`, window="_blank"] +[.description] +-- +_No Javadoc found_ +-- a|`java.util.Map config` + +_No Javadoc found_ + +`java.util.Map properties` + +_No Javadoc found_ + +`boolean containerRestarted` + +_No Javadoc found_ + + + + +a| https://github.com/quarkusio/quarkus/blob/main/extensions/devservices/keycloak/src/main/java/io/quarkus/devservices/keycloak/KeycloakDevServicesRequiredBuildItem.java[`io.quarkus.devservices.keycloak.KeycloakDevServicesRequiredBuildItem`, window="_blank"] +[.description] +-- +A marker build item signifying that integrating extensions (like OIDC and OIDC client) are enabled. The Keycloak Dev Service will be started in DEV mode if at least one item is produced and the Dev Service is not disabled in other fashion. +-- a|`io.quarkus.devservices.keycloak.Capability capability` + +_No Javadoc found_ + + |=== == Elasticsearch REST client common [.configuration-reference,cols=2*] @@ -4700,6 +4731,29 @@ _No Javadoc found_ +a| https://github.com/quarkusio/quarkus/blob/main/extensions/kubernetes/spi/src/main/java/io/quarkus/kubernetes/spi/KubernetesClusterRoleBindingBuildItem.java[`io.quarkus.kubernetes.spi.KubernetesClusterRoleBindingBuildItem`, window="_blank"] +[.description] +-- +Produce this build item to request the Kubernetes extension to generate a Kubernetes `ClusterRoleBinding` resource. The configuration here is limited; in particular, you can't specify subjects of the role binding. The role will always be bound to the application's service account. +-- a|`java.lang.String name` + +Name of the generated `RoleBinding` resource. Can be `null` , in which case the resource name is autogenerated. + +`io.quarkus.kubernetes.spi.RoleRef roleRef` + +RoleRef configuration. + +`io.quarkus.kubernetes.spi.Subject[] subjects` + +The target subjects. + +`java.util.Map labels` + +The labels of the cluster role resource. + + + + a| https://github.com/quarkusio/quarkus/blob/main/extensions/kubernetes/spi/src/main/java/io/quarkus/kubernetes/spi/KubernetesClusterRoleBuildItem.java[`io.quarkus.kubernetes.spi.KubernetesClusterRoleBuildItem`, window="_blank"] [.description] -- @@ -4712,10 +4766,6 @@ Name of the generated `ClusterRole` resource. The `PolicyRule` resources for this `ClusterRole` . -`java.lang.String target` - -The target manifest that should include this role. - @@ -4780,6 +4830,25 @@ _No Javadoc found_ +a| https://github.com/quarkusio/quarkus/blob/main/extensions/kubernetes/spi/src/main/java/io/quarkus/kubernetes/spi/KubernetesEffectiveServiceAccountBuildItem.java[`io.quarkus.kubernetes.spi.KubernetesEffectiveServiceAccountBuildItem`, window="_blank"] +[.description] +-- +This build item is produced once the effective service account used for the generated resources is computed. Useful for downstream extensions that need to know this information to wait until it is made available. +-- a|`java.lang.String serviceAccountName` + +_No Javadoc found_ + +`java.lang.String namespace` + +_No Javadoc found_ + +`boolean wasSet` + +_No Javadoc found_ + + + + a| https://github.com/quarkusio/quarkus/blob/main/extensions/kubernetes/spi/src/main/java/io/quarkus/kubernetes/spi/KubernetesEnvBuildItem.java[`io.quarkus.kubernetes.spi.KubernetesEnvBuildItem`, window="_blank"] [.description] -- @@ -4808,10 +4877,6 @@ _No Javadoc found_ _No Javadoc found_ -`java.lang.String target` - -_No Javadoc found_ - `boolean oldStyle` _No Javadoc found_ @@ -4859,7 +4924,8 @@ _No Javadoc found_ a| https://github.com/quarkusio/quarkus/blob/main/extensions/kubernetes/spi/src/main/java/io/quarkus/kubernetes/spi/KubernetesInitContainerBuildItem.java[`io.quarkus.kubernetes.spi.KubernetesInitContainerBuildItem`, window="_blank"] [.description] -- -A Built item for generating init containers. The generated container will have the specified fields and may optionally inherit env vars and volumes from the app container. Env vars specified through this build item, will take precedence over inherited ones. +A Built item for generating init containers. The generated container will have the specified fields and may optionally inherit env vars and volumes from the app container. +Env vars specified through this build item, will take precedence over inherited ones. -- a|`java.lang.String name` _No Javadoc found_ @@ -4898,7 +4964,8 @@ _No Javadoc found_ a| https://github.com/quarkusio/quarkus/blob/main/extensions/kubernetes/spi/src/main/java/io/quarkus/kubernetes/spi/KubernetesJobBuildItem.java[`io.quarkus.kubernetes.spi.KubernetesJobBuildItem`, window="_blank"] [.description] -- -A Built item for generating init containers. The generated container will have the specified fields and may optionally inherit env vars and volumes from the app container. Env vars specified through this build item, will take precedence over inherited ones. +A Built item for generating init containers. The generated container will have the specified fields and may optionally inherit env vars and volumes from the app container. +Env vars specified through this build item, will take precedence over inherited ones. -- a|`java.lang.String name` _No Javadoc found_ @@ -4953,6 +5020,17 @@ _No Javadoc found_ +a| https://github.com/quarkusio/quarkus/blob/main/extensions/kubernetes/spi/src/main/java/io/quarkus/kubernetes/spi/KubernetesNamespaceBuildItem.java[`io.quarkus.kubernetes.spi.KubernetesNamespaceBuildItem`, window="_blank"] +[.description] +-- +_No Javadoc found_ +-- a|`java.lang.String namespace` + +_No Javadoc found_ + + + + a| https://github.com/quarkusio/quarkus/blob/main/extensions/kubernetes/spi/src/main/java/io/quarkus/kubernetes/spi/KubernetesOptionalResourceDefinitionBuildItem.java[`io.quarkus.kubernetes.spi.KubernetesOptionalResourceDefinitionBuildItem`, window="_blank"] [.description] -- @@ -5021,11 +5099,7 @@ a| https://github.com/quarkusio/quarkus/blob/main/extensions/kubernetes/spi/src/ [.description] -- _No Javadoc found_ --- a|`java.lang.String target` - -_No Javadoc found_ - -`java.lang.String group` +-- a|`java.lang.String group` _No Javadoc found_ @@ -5047,19 +5121,19 @@ _No Javadoc found_ a| https://github.com/quarkusio/quarkus/blob/main/extensions/kubernetes/spi/src/main/java/io/quarkus/kubernetes/spi/KubernetesRoleBindingBuildItem.java[`io.quarkus.kubernetes.spi.KubernetesRoleBindingBuildItem`, window="_blank"] [.description] -- -Produce this build item to request the Kubernetes extension to generate a Kubernetes `RoleBinding` resource. The configuration here is limited; in particular, you can't specify subjects of the role binding. The role will always be bound to the application's service account. -Note that this can't be used to generate a `ClusterRoleBinding` . +Produce this build item to request the Kubernetes extension to generate a Kubernetes `RoleBinding` resource. +Use `KubernetesClusterRoleBindingBuildItem` to generate a `ClusterRoleBinding` . -- a|`java.lang.String name` Name of the generated `RoleBinding` resource. Can be `null` , in which case the resource name is autogenerated. -`io.quarkus.kubernetes.spi.RoleRef roleRef` +`java.lang.String namespace` -RoleRef configuration. +_No Javadoc found_ -`java.lang.String target` +`io.quarkus.kubernetes.spi.RoleRef roleRef` -The target manifest that should include this role. +RoleRef configuration. `io.quarkus.kubernetes.spi.Subject[] subjects` @@ -5089,10 +5163,6 @@ Namespace of the generated `Role` resource. The `PolicyRule` resources for this `Role` . -`java.lang.String target` - -The target manifest that should include this role. - @@ -5630,7 +5700,7 @@ _No Javadoc found_ |=== -== OpenID Connect Adapter +== Observability Dev Services [.configuration-reference,cols=2*] |=== h|Class Name @@ -5639,30 +5709,15 @@ h|Attributes -a| https://github.com/quarkusio/quarkus/blob/main/extensions/oidc/deployment/src/main/java/io/quarkus/oidc/deployment/devservices/keycloak/KeycloakDevServicesConfigBuildItem.java[`io.quarkus.oidc.deployment.devservices.keycloak.KeycloakDevServicesConfigBuildItem`, window="_blank"] +a| https://github.com/quarkusio/quarkus/blob/main/extensions/observability-devservices/deployment/src/main/java/io/quarkus/observability/deployment/devui/ObservabilityDevServicesConfigBuildItem.java[`io.quarkus.observability.deployment.devui.ObservabilityDevServicesConfigBuildItem`, window="_blank"] [.description] -- -_No Javadoc found_ +Build item used to carry running DevService values to Dev UI. -- a|`java.util.Map config` _No Javadoc found_ -`java.util.Map properties` - -_No Javadoc found_ - -`boolean containerRestarted` - -_No Javadoc found_ - - - -a| https://github.com/quarkusio/quarkus/blob/main/extensions/oidc/deployment/src/main/java/io/quarkus/oidc/deployment/devservices/OidcDevServicesBuildItem.java[`io.quarkus.oidc.deployment.devservices.OidcDevServicesBuildItem`, window="_blank"] -[.description] --- -Marker build item which indicates that Dev Services for OIDC are provided by another extension. Dev Services for Keycloak will be disabled if this item is detected. --- a|None |=== == OpenID Connect Client [.configuration-reference,cols=2*] @@ -6551,6 +6606,21 @@ h|Attributes +a| https://github.com/quarkusio/quarkus/blob/main/extensions/resteasy-reactive/rest-common/deployment/src/main/java/io/quarkus/resteasy/reactive/common/deployment/AggregatedParameterContainersBuildItem.java[`io.quarkus.resteasy.reactive.common.deployment.AggregatedParameterContainersBuildItem`, window="_blank"] +[.description] +-- +_No Javadoc found_ +-- a|`java.util.Set classNames` + +This contains all the parameter containers (bean param classes and records) as well as resources/endpoints + +`java.util.Set nonRecordClassNames` + +This contains all the non-record parameter containers (bean param classes only) as well as resources/endpoints + + + + a| https://github.com/quarkusio/quarkus/blob/main/extensions/resteasy-reactive/rest-common/deployment/src/main/java/io/quarkus/resteasy/reactive/common/deployment/ApplicationResultBuildItem.java[`io.quarkus.resteasy.reactive.common.deployment.ApplicationResultBuildItem`, window="_blank"] [.description] -- @@ -7714,6 +7784,17 @@ _No Javadoc found_ +a| https://github.com/quarkusio/quarkus/blob/main/extensions/security/spi/src/main/java/io/quarkus/security/spi/AdditionalSecurityAnnotationBuildItem.java[`io.quarkus.security.spi.AdditionalSecurityAnnotationBuildItem`, window="_blank"] +[.description] +-- +Allows integrating extensions to signal they provide their own security annotation. Standard security annotations cannot be combined and when two different annotations are applied, one on the class level and second on the method level, the method level must win. Without this build item, the Quarkus Security extension won't know about your security annotation integration. Please beware that integrating extension-specific security annotation is responsibility of that extension. This build item is intended for very specialized Quarkus core use cases, like integration of the authorization policy in the Vert.x HTTP extension. +-- a|`org.jboss.jandex.DotName securityAnnotationName` + +_No Javadoc found_ + + + + a| https://github.com/quarkusio/quarkus/blob/main/extensions/security/spi/src/main/java/io/quarkus/security/spi/AdditionalSecurityConstrainerEventPropsBuildItem.java[`io.quarkus.security.spi.AdditionalSecurityConstrainerEventPropsBuildItem`, window="_blank"] [.description] -- @@ -7758,6 +7839,25 @@ _No Javadoc found_ +a| https://github.com/quarkusio/quarkus/blob/main/extensions/security/spi/src/main/java/io/quarkus/security/spi/PermissionsAllowedMetaAnnotationBuildItem.java[`io.quarkus.security.spi.PermissionsAllowedMetaAnnotationBuildItem`, window="_blank"] +[.description] +-- +Contains transitive `io.quarkus.security.PermissionsAllowed` instances. The `io.quarkus.security.PermissionsAllowed` annotation supports meta-annotation defined by users. Methods and classes annotated with these meta-annotations are collected and new `AnnotationInstance` s are created for them. Newly created instances are carried in the `#transitiveInstances` field. +-- a|`java.util.List metaAnnotationNames` + +_No Javadoc found_ + +`boolean empty` + +_No Javadoc found_ + +`java.util.List transitiveInstances` + +_No Javadoc found_ + + + + a| https://github.com/quarkusio/quarkus/blob/main/extensions/security/spi/src/main/java/io/quarkus/security/spi/RolesAllowedConfigExpResolverBuildItem.java[`io.quarkus.security.spi.RolesAllowedConfigExpResolverBuildItem`, window="_blank"] [.description] -- @@ -7854,6 +7954,25 @@ _No Javadoc found_ _No Javadoc found_ +|=== +== SmallRye GraphQL +[.configuration-reference,cols=2*] +|=== +h|Class Name +h|Attributes + + + + +a| https://github.com/quarkusio/quarkus/blob/main/extensions/smallrye-graphql/deployment/src/main/java/io/quarkus/smallrye/graphql/deployment/GraphQLDevUILogBuildItem.java[`io.quarkus.smallrye.graphql.deployment.GraphQLDevUILogBuildItem`, window="_blank"] +[.description] +-- +Used to create the publisher for the graphql trafic log in dev ui +-- a|`io.quarkus.runtime.RuntimeValue> publisher` + +_No Javadoc found_ + + |=== == SmallRye GraphQL Client [.configuration-reference,cols=2*] @@ -8411,6 +8530,17 @@ h|Attributes +a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment/src/main/java/io/quarkus/vertx/http/deployment/AuthorizationPolicyInstancesBuildItem.java[`io.quarkus.vertx.http.deployment.AuthorizationPolicyInstancesBuildItem`, window="_blank"] +[.description] +-- +Carries all gathered `io.quarkus.vertx.http.security.AuthorizationPolicy` instances that should be applied. +-- a|`java.util.Map methodToPolicyName` + +Contains: - Methods annotated with `io.quarkus.vertx.http.security.AuthorizationPolicy` - Methods of classes annotated with `io.quarkus.vertx.http.security.AuthorizationPolicy` that doesn't have another standard security annotation. + + + + a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment/src/main/java/io/quarkus/vertx/http/deployment/BodyHandlerBuildItem.java[`io.quarkus.vertx.http.deployment.BodyHandlerBuildItem`, window="_blank"] [.description] -- @@ -8456,6 +8586,10 @@ _No Javadoc found_ _No Javadoc found_ +`java.util.Map recordedValues` + +_No Javadoc found_ + @@ -8856,6 +8990,17 @@ _No Javadoc found_ +a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment/src/main/java/io/quarkus/vertx/http/deployment/VertxDevUILogBuildItem.java[`io.quarkus.vertx.http.deployment.VertxDevUILogBuildItem`, window="_blank"] +[.description] +-- +Used to create the publisher for the vertx access log in dev ui +-- a|`io.quarkus.runtime.RuntimeValue> publisher` + +_No Javadoc found_ + + + + a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment/src/main/java/io/quarkus/vertx/http/deployment/VertxWebRouterBuildItem.java[`io.quarkus.vertx.http.deployment.VertxWebRouterBuildItem`, window="_blank"] [.description] -- @@ -9000,6 +9145,25 @@ _No Javadoc found_ +a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/dev-ui-spi/src/main/java/io/quarkus/devui/spi/buildtime/FooterLogBuildItem.java[`io.quarkus.devui.spi.buildtime.FooterLogBuildItem`, window="_blank"] +[.description] +-- +Add a log to the footer of dev ui +-- a|`java.lang.String name` + +_No Javadoc found_ + +`java.util.function.Supplier> publisherSupplier` + +_No Javadoc found_ + +`io.quarkus.runtime.RuntimeValue> runtimePublisher` + +_No Javadoc found_ + + + + a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/dev-ui-spi/src/main/java/io/quarkus/devui/spi/page/FooterPageBuildItem.java[`io.quarkus.devui.spi.page.FooterPageBuildItem`, window="_blank"] [.description] -- diff --git a/_generated-doc/latest/infra/quarkus-maven-plugin-goals.adoc b/_generated-doc/latest/infra/quarkus-maven-plugin-goals.adoc index df6c59afde0..2a0edc49e54 100644 --- a/_generated-doc/latest/infra/quarkus-maven-plugin-goals.adoc +++ b/_generated-doc/latest/infra/quarkus-maven-plugin-goals.adoc @@ -1245,7 +1245,21 @@ a| [[quarkus-maven-plugin-goal-dev-environmentVariables]] environmentVariables |`Map` | +a| [[quarkus-maven-plugin-goal-dev-forceC2]] forceC2 + +[.description] +-- +This value is intended to be set to true when we want to require C2 compilation instead of preventing it from ever kicking in. Setting this will likely have a small negative effect on startup time and should only be done when it absolutely makes sense. +-- +|`boolean` +|`${forceC2}` + a| [[quarkus-maven-plugin-goal-dev-jvmArgs]] jvmArgs + +[.description] +-- +Allows configuring arbitrary JVM arguments. Multiple arguments can be specified by delimiting them with a space character. +-- |`String` |`${jvm.args}` @@ -2900,7 +2914,21 @@ a| [[quarkus-maven-plugin-goal-remote-dev-environmentVariables]] environmentVari |`Map` | +a| [[quarkus-maven-plugin-goal-remote-dev-forceC2]] forceC2 + +[.description] +-- +This value is intended to be set to true when we want to require C2 compilation instead of preventing it from ever kicking in. Setting this will likely have a small negative effect on startup time and should only be done when it absolutely makes sense. +-- +|`boolean` +|`${forceC2}` + a| [[quarkus-maven-plugin-goal-remote-dev-jvmArgs]] jvmArgs + +[.description] +-- +Allows configuring arbitrary JVM arguments. Multiple arguments can be specified by delimiting them with a space character. +-- |`String` |`${jvm.args}` @@ -3370,7 +3398,21 @@ a| [[quarkus-maven-plugin-goal-test-environmentVariables]] environmentVariables |`Map` | +a| [[quarkus-maven-plugin-goal-test-forceC2]] forceC2 + +[.description] +-- +This value is intended to be set to true when we want to require C2 compilation instead of preventing it from ever kicking in. Setting this will likely have a small negative effect on startup time and should only be done when it absolutely makes sense. +-- +|`boolean` +|`${forceC2}` + a| [[quarkus-maven-plugin-goal-test-jvmArgs]] jvmArgs + +[.description] +-- +Allows configuring arbitrary JVM arguments. Multiple arguments can be specified by delimiting them with a space character. +-- |`String` |`${jvm.args}` diff --git a/_guides/_attributes.adoc b/_guides/_attributes.adoc index 0f8f72c4f27..eb2ac8e1cdd 100644 --- a/_guides/_attributes.adoc +++ b/_guides/_attributes.adoc @@ -1,15 +1,15 @@ // Common attributes. // --> No blank lines (it ends the document header) :project-name: Quarkus -:quarkus-version: 3.15.1 +:quarkus-version: 3.16.1 :quarkus-platform-groupid: io.quarkus.platform // . -:maven-version: 3.9.8 +:maven-version: 3.9.9 :graalvm-version: for JDK 21 :graalvm-docs-version: jdk21 :graalvm-flavor: jdk-21 :mandrel-flavor: jdk-21 -:surefire-version: 3.3.1 +:surefire-version: 3.5.0 :gradle-version: 8.9 :elasticsearch-version: 8.15.0 :elasticsearch-image: docker.io/elastic/elasticsearch:8.15.0 @@ -19,9 +19,9 @@ :logstash-image: docker.io/elastic/logstash:8.15.0 :kibana-image: docker.io/elastic/kibana:8.15.0 :keycloak-docker-image: quay.io/keycloak/keycloak:25.0.6 -:jandex-version: 3.2.2 +:jandex-version: 3.2.3 :jandex-gradle-plugin-version: 1.0.0 -:kotlin-version: 2.0.10 +:kotlin-version: 2.0.21 :grpc-version: 1.65.1 :protoc-version: 3.25.5 :gcf-invoker-version: 1.3.0 @@ -55,13 +55,13 @@ :hibernate-orm-dialect-docs-url: https://docs.jboss.org/hibernate/orm/{hibernate-orm-version-major-minor}/dialect/dialect.html :hibernate-search-docs-url: https://docs.jboss.org/hibernate/search/{hibernate-search-version-major-minor}/reference/en-US/html_single/ // . -:amazon-services-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-amazon-services/dev/index.html -:config-consul-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-config-extensions/dev/consul.html -:hibernate-search-orm-elasticsearch-aws-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-hibernate-search-extras/dev/index.html -:neo4j-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-neo4j/dev/index.html -:vault-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-vault/dev/index.html -:vault-datasource-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-vault/dev/vault-datasource.html -:micrometer-registry-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-micrometer-registry/dev/index.html +:amazon-services-guide: https://docs.quarkiverse.io/quarkus-amazon-services/dev/index.html +:config-consul-guide: https://docs.quarkiverse.io/quarkus-config-extensions/dev/consul.html +:hibernate-search-orm-elasticsearch-aws-guide: https://docs.quarkiverse.io/quarkus-hibernate-search-extras/dev/index.html +:neo4j-guide: https://docs.quarkiverse.io/quarkus-neo4j/dev/index.html +:vault-guide: https://docs.quarkiverse.io/quarkus-vault/dev/index.html +:vault-datasource-guide: https://docs.quarkiverse.io/quarkus-vault/dev/vault-datasource.html +:micrometer-registry-guide: https://docs.quarkiverse.io/quarkus-micrometer-registry/dev/index.html :quarkus-migration-guide: https://github.com/quarkusio/quarkus/wiki/Migration-Guides[Migration Guides] :quarkus-tls-registry-reference-guide: TLS registry reference // . diff --git a/_guides/_includes/opentelemetry-config.adoc b/_guides/_includes/opentelemetry-config.adoc index 98e9507f6f8..cf4dcfff15f 100644 --- a/_guides/_includes/opentelemetry-config.adoc +++ b/_guides/_includes/opentelemetry-config.adoc @@ -1,5 +1,3 @@ -There are no mandatory configurations for the extension to work. - By default, the exporters will send out data in batches, using the gRPC protocol and endpoint `http://localhost:4317`. If you need to change any of the default property values, here is an example on how to configure the default OTLP gRPC Exporter within the application, using the `src/main/resources/application.properties` file: @@ -31,6 +29,8 @@ If you need different configurations for each signal, you can use the specific p ---- quarkus.otel.exporter.otlp.traces.endpoint=http://trace-uri:4317 // <1> quarkus.otel.exporter.otlp.metrics.endpoint=http://metrics-uri:4317 // <2> +quarkus.otel.exporter.otlp.logs.endpoint=http://logs-uri:4317 // <3> ---- <1> The endpoint for the traces exporter. <2> The endpoint for the metrics exporter. +<3> The endpoint for the logs exporter. diff --git a/_guides/_includes/smallrye-pulsar-consumer.adoc b/_guides/_includes/smallrye-pulsar-consumer.adoc index 27b089d8368..5722d25680a 100644 --- a/_guides/_includes/smallrye-pulsar-consumer.adoc +++ b/_guides/_includes/smallrye-pulsar-consumer.adoc @@ -227,7 +227,7 @@ When specifying the dead letter policy while not specifying `ackTimeoutMillis`, |false | |*autoUpdatePartitions* -|If `autoUpdatePartitions` is enabled, a consumer subscribes to partition increasement automatically. +|If `autoUpdatePartitions` is enabled, a consumer subscribes to partition increase automatically. **Note**: this is only for partitioned consumers. |boolean diff --git a/_guides/appcds.adoc b/_guides/appcds.adoc index db08254f2cc..c3cf8afc637 100644 --- a/_guides/appcds.adoc +++ b/_guides/appcds.adoc @@ -14,9 +14,11 @@ This reference guide explains how to enable Application Class Data Sharing in yo == What is Application Class Data Sharing (AppCDS)? link:https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#application-class-data-sharing[Application Class Data Sharing] is a JVM feature that helps reduce the startup time and memory footprint of a JVM application. -This is achieved by having the JVM create a pre-processed shared archived of classes that are loaded at startup time. As these classes +This is achieved by having the JVM create a pre-processed shared archived of classes that are loaded at startup time. +As these classes are loaded every time the application starts, AppCDS is a conceptually simple way of improving the application startup time, -without the application itself having to be coded or configured in a specific way. How much of an improvement depends on many factors, such as the number of classes loaded, the underlying hardware etc. +without the application itself having to be coded or configured in a specific way. +How much of an improvement depends on many factors, such as the number of classes loaded, the underlying hardware etc. == Vanilla AppCDS generation @@ -24,7 +26,7 @@ The main downside of creating AppCDS manually for an application is that their g NOTE: The exact process depends on the JVM version being used as newer JVM have incrementally made the process easier. -This fact makes the use of AppCDS difficult to use for real world deployments where a CI pipeline is responsible for building and deploying applications. +This fact makes AppCDS difficult to use for real world deployments where a CI pipeline is responsible for building and deploying applications. == AppCDS in Quarkus @@ -95,7 +97,11 @@ AppCDS has improved significantly in the latest JDK releases. This means that to === Usage in containers -When building container images using the `quarkus-container-image-jib` extension, Quarkus automatically takes care of all the steps needed to generate the archive -and make it usable at runtime in the container. +When building container images using the `quarkus-container-image-jib` extension, Quarkus automatically takes care of all the steps needed to generate the archive and make it usable at runtime in the container. -This way, by simply setting `quarkus.package.jar.appcds.enabled` to `true` the generated container can benefit from a slight reduction in startup time and memory usage. +This way, by simply setting `quarkus.package.jar.appcds.enabled` to `true`, containers using the generated image can benefit from a slight reduction in startup time and memory usage. + +You may see that Quarkus starts a container to generate the AppCDS archive. +It does this to ensure that the Java version of the build align with that of the generated container image. +It is possible to opt out of this by setting `quarkus.package.jar.appcds.use-container` to `false`. +In that case, it is your responsibility to ensure that the Java version that will run the Quarkus application matches that of the machine building it. diff --git a/_guides/building-native-image.adoc b/_guides/building-native-image.adoc index 5780d839610..760fbe72fb9 100644 --- a/_guides/building-native-image.adoc +++ b/_guides/building-native-image.adoc @@ -579,7 +579,7 @@ Sample Dockerfile for building with Maven: ---- ## Stage 1 : build with maven builder image with native capabilities FROM quay.io/quarkus/ubi-quarkus-mandrel-builder-image:{mandrel-flavor} AS build -COPY --chown=quarkus:quarkus mvnw /code/mvnw +COPY --chown=quarkus:quarkus --chmod=0755 mvnw /code/mvnw COPY --chown=quarkus:quarkus .mvn /code/.mvn COPY --chown=quarkus:quarkus pom.xml /code/ USER quarkus diff --git a/_guides/cdi-integration.adoc b/_guides/cdi-integration.adoc index 39920b6516e..a68baa17eea 100644 --- a/_guides/cdi-integration.adoc +++ b/_guides/cdi-integration.adoc @@ -419,6 +419,88 @@ public class TestRecorder { ---- <1> Pass a contextual reference of `Bar` to the constructor of `Foo`. +=== Inactive Synthetic Beans + +In the case when one needs to register multiple synthetic beans at build time but only wants a subset of them active at runtime, it is useful to be able to mark a synthetic bean as _inactive_. +This is done by configuring a "check active" procedure, which should be a `Supplier` obtained from a recorder: + +.Inactive Synthetic Bean - Build Step Example +[source,java] +---- +@BuildStep +@Record(RUNTIME_INIT) +SyntheticBeanBuildItem syntheticBean(TestRecorder recorder) { + return SyntheticBeanBuildItem.configure(Foo.class) + .scope(Singleton.class) + .startup() // <1> + .checkActive(recorder.isFooActive()) // <2> + .createWith(recorder.createFoo()) + .done(); +} +---- +<1> A bean that might be inactive is typically initialized eagerly, to make sure that an error is thrown at application startup. + If the bean is in fact inactive, but is not injected into an always-active bean, eager initialization is skipped and no error is thrown. +<2> Configures the "check active" procedure. + +.Inactive Synthetic Bean - Recorder Example +[source,java] +---- +@Recorder +public class TestRecorder { + public Supplier isFooActive() { + return () -> { + if (... should not be active ...) { // <1> + return ActiveResult.inactive("explanation"); // <2> + } + return ActiveResult.active(); + }; + } + + public Function, Foo> createFoo() { + return (context) -> { + return new Foo(); + }; + } +} +---- +<1> The condition when the synthetic bean should be inactive. +<2> Proper explanation of why the bean is inactive. + Another inactive `ActiveResult` may also be provided as a cause, if this bean's inactivity stems from another bean's inactivity. + +If an inactive bean is injected somewhere, or is dynamically looked up, an `InactiveBeanException` is thrown. +The error message contains the reason (from the `ActiveResult`), the cause chain (also from the `ActiveResult`), and possibly also a list of all injection points that resolve to this bean. + +If you want to handle the inactive case gracefully, you should always inject possibly inactive beans using `Instance<>`. +You also need to check before obtaining the actual instance: + +[source,java] +---- +import io.quarkus.arc.InjectableInstance; + +@Inject +InjectableInstance foo; + +if (foo.getHandle().getBean().isActive()) { + Foo foo = foo.get(); + ... +} +---- + +If you want to consume only active beans, you can inject an `InjectableInstance<>` and call `getActive()` to get the single instance or `listActive()` to get all instances: + +[source,java] +---- +import io.quarkus.arc.InjectableInstance; + +@Inject +@Any +InjectableInstance foos; + +for (Foo foo : foos.listActive()) + ... +} +---- + [[synthetic_observers]] == Use Case - Synthetic Observers diff --git a/_guides/cdi-reference.adoc b/_guides/cdi-reference.adoc index 31eba59680a..aaafe90d461 100644 --- a/_guides/cdi-reference.adoc +++ b/_guides/cdi-reference.adoc @@ -113,7 +113,7 @@ quarkus.index-dependency..artifact-id=(this one is optional) quarkus.index-dependency..classifier=(this one is optional) ---- -TIP: If no `artifact-id` is specified then all dependencies with the specificed `group-id` are indexed. +TIP: If no `artifact-id` is specified then all dependencies with the specified `group-id` are indexed. For example, the following entries ensure that the `org.acme:acme-api` dependency is indexed: @@ -957,6 +957,51 @@ Alternatively, you can use the `@LookupIfProperty` and `@LookupUnlessProperty` a } ---- +=== Sorting beans obtained with programmatic lookup + +If there is more than one bean that matches the required type and qualifiers and is eligible for injection, it is possible to iterate (or stream) available bean instances. +Beans returned by both stream and iterator methods are sorted by priority as defined by `io.quarkus.arc.InjectableBean#getPriority()`. Higher priority goes first. +If no priority is explicitly declared, 0 is assumed. + +[source,java] +---- +interface Service { + +} + +@Priority(100) +@ApplicationScoped +class FirstService implements Service { + +} + +@Priority(10) +@ApplicationScoped +class SecondService implements Service { + +} + +@ApplicationScoped +class ThirdService implements Service { + +} + +@ApplicationScoped +class Client { + + @Inject + Instance serviceInstance; + + void printServiceName() { + if(service.isAmbiguous()){ + for (Service service : serviceInstance) { + // FirstService, SecondService, ThirdService + } + } + } +} +---- + [[injecting-multiple-bean-instances-intuitively]] === Injecting Multiple Bean Instances Intuitively @@ -1286,6 +1331,28 @@ public void register(RegistrationContext context) { <1> The argument is the bindings source class. +=== `Instance.Handle.close()` Behavior + +Per the CDI specification, the `Instance.Handle.close()` method always delegates to `destroy()`. +In ArC, this is only true in the <>. + +In the default mode, the `close()` method only delegates to `destroy()` when the bean is `@Dependent` (or when the instance handle does not represent a CDI contextual object). +When the instance handle represents a bean of any other scope, the `close()` method does nothing; the bean is left as is and will be destroyed whenever its context is destroyed. + +This is to make the following code behave as one would naively expect: + +[source,java] +---- +Instance instance = ...; +try (Instance.Handle handle : instance.getHandle()) { + T value = handle.get(); + ... use value ... +} +---- + +The `@Dependent` beans are destroyed immediately, while other beans are not destroyed at all. +This is important when multiple beans of different scopes might be returned by the `Instance`. + [[reactive_pitfalls]] == Pitfalls with Reactive Programming @@ -1327,6 +1394,23 @@ public class MyBean { } ---- +=== Asynchronous Observers + +CDI asynchronous observers (`@ObservesAsync`) are not aware of reactive programming and are not meant to be used as part of reactive pipelines. +The observer methods are meant to be synchronous, they are just offloaded to a thread pool. + +The `Event.fireAsync()` method returns a `CompletionStage` that completes when all observers are notified. +If all observers were notified successfully, the `CompletionStage` completes with the event payload. +If some observers have thrown an exception, the `CompletionStage` completes exceptionally with a `CompletionException`. + +The return type of the observer _does not matter_. +The return value of the observer is _ignored_. + +You may declare an observer method that has a return type of `CompletionStage<>` or `Uni<>`, but neither the return type nor the actual return value affect the result of `Event.fireAsync()`. +Further, if the observer declares a return type of `Uni<>`, the returned `Uni` will not be subscribed to, so it is quite possible that part of the observer logic will not even execute. + +Therefore, it is recommended that observer methods, both synchronous and asynchronous, are always declared `void`. + [[build_time_apis]] == Build Time Extensions diff --git a/_guides/config-mappings.adoc b/_guides/config-mappings.adoc index f7027877561..fda53c12d5a 100644 --- a/_guides/config-mappings.adoc +++ b/_guides/config-mappings.adoc @@ -388,6 +388,8 @@ The `List` or `Set` mappings can use xref:config-reference.adoc#indexed-properti configuration values in mapping groups. For collection with simple element types like `String`, their configuration value is a comma separated string. +NOTE: Only the `List` mapping can maintain element order. Hence, with `Set` mappings the element order is not maintained from the configuration files but is random. + ==== Maps ==== A config mapping is also able to map a `Map`: diff --git a/_guides/config-reference.adoc b/_guides/config-reference.adoc index d11d95c38d2..25c80ee2d1c 100644 --- a/_guides/config-reference.adoc +++ b/_guides/config-reference.adoc @@ -370,7 +370,7 @@ Setting `quarkus.profile` to `staging` will activate the `staging` profile. The `io.smallrye.config.SmallRyeConfig#getProfiles` API provides a way to retrieve the active profiles programmatically. ==== -=== Profile aware files +=== Profile-aware files In this case, properties for a specific profile may reside in an `application-{profile}.properties` named file. The previous example may be expressed as: @@ -391,19 +391,22 @@ quarkus.http.test-port=9191 [NOTE] ==== -In this style, the configuration names in the profile aware file do not need to be prefixed with the profile name. +In this style, the configuration names in the profile-aware file do not need to be prefixed with the profile name. -Properties in the profile aware file have priority over profile aware properties defined in the main file. +Properties in the profile-aware file have priority over profile-aware properties defined in the main file. ==== [WARNING] ==== -Do not use profile aware files to set `quarkus.profile` or `quarkus.test.profile`. This will not work because the -profile is required in advance to load the profile aware files. +Do not use profile-aware files to set `quarkus.profile` or `quarkus.test.profile`. This will not work because the +profile is required in advance to load the profile-aware files. +==== -A profile aware file is only loaded if the unprofiled `application.properties` is also available in the same location -and the file extension matches between the files. This is required to keep a consistent loading order and pair all the -resources together. +[IMPORTANT] +==== +An `application.properties` file must exist (even if empty) in the exact location of the profile-aware +(`application-{profile}.properties`) file to be included in the configuration to ensure a consistent order when +loading the files. ==== === Parent Profile @@ -435,8 +438,8 @@ Then [WARNING] ==== -Do not use Profile aware files to set `quarkus.config.profile.parent`. This will not work because the profile is -required in advance to load the profile aware files. +Do not use Profile-aware files to set `quarkus.config.profile.parent`. This will not work because the profile is +required in advance to load the profile-aware files. ==== === Multiple Profiles diff --git a/_guides/container-image.adoc b/_guides/container-image.adoc index 3d24d1b2a7a..8fd7785a8e1 100644 --- a/_guides/container-image.adoc +++ b/_guides/container-image.adoc @@ -239,7 +239,7 @@ quarkus.container-image.builder=docker == Integrating with `systemd-notify` -If you are building a container image in order to deploy your Quarkus application as a Linux service with Podman and Systemd, you might want to consider including the https://quarkiverse.github.io/quarkiverse-docs/quarkus-systemd-notify/dev/index.html[Quarkus Systemd Notify Extension] as part of your application, with: +If you are building a container image in order to deploy your Quarkus application as a Linux service with Podman and Systemd, you might want to consider including the https://docs.quarkiverse.io/quarkus-systemd-notify/dev/index.html[Quarkus Systemd Notify Extension] as part of your application, with: :add-extension-extensions: io.quarkiverse.systemd.notify:quarkus-systemd-notify include::{includes}/devtools/extension-add.adoc[] diff --git a/_guides/databases-dev-services.adoc b/_guides/databases-dev-services.adoc index dc12592a06b..ba3c57c3336 100644 --- a/_guides/databases-dev-services.adoc +++ b/_guides/databases-dev-services.adoc @@ -158,7 +158,7 @@ quarkus.datasource.db-kind=postgresql quarkus.datasource.devservices.volumes."/local/test/data"=/var/lib/postgresql/data ---- -The appropriate in-container location varies depending on the database vendor. For PostgresSQL is "/var/lib/postgresql/data", but for MySQL, you would need this configuration instead: +The appropriate in-container location varies depending on the database vendor. For PostgreSQL is "/var/lib/postgresql/data", but for MySQL, you would need this configuration instead: [source,properties] ---- diff --git a/_guides/datasource.adoc b/_guides/datasource.adoc index 3d55c0d07e1..cc16c346dd9 100644 --- a/_guides/datasource.adoc +++ b/_guides/datasource.adoc @@ -133,6 +133,7 @@ quarkus.datasource.reactive.max-size=20 The following section describes the configuration for single or multiple datasources. For simplicity, we will reference a single datasource as the default (unnamed) datasource. +[[configure-a-single-datasource]] === Configure a single datasource A datasource can be either a JDBC datasource, reactive, or both. @@ -216,7 +217,7 @@ Read <> for suggestions re * MySQL - `quarkus-jdbc-mysql` * Oracle - `quarkus-jdbc-oracle` * PostgreSQL - `quarkus-jdbc-postgresql` -* Other JDBC extensions, such as link:https://github.com/quarkiverse/quarkus-jdbc-sqlite[SQLite] and its link:https://quarkiverse.github.io/quarkiverse-docs/quarkus-jdbc-sqlite/dev/index.html[documentation], can be found in the https://github.com/quarkiverse[Quarkiverse]. +* Other JDBC extensions, such as link:https://github.com/quarkiverse/quarkus-jdbc-sqlite[SQLite] and its link:https://docs.quarkiverse.io/quarkus-jdbc-sqlite/dev/index.html[documentation], can be found in the https://github.com/quarkiverse[Quarkiverse]. + For example, to add the PostgreSQL driver dependency: + diff --git a/_guides/deploying-to-google-cloud.adoc b/_guides/deploying-to-google-cloud.adoc index 40cc488577a..664b7c28d39 100644 --- a/_guides/deploying-to-google-cloud.adoc +++ b/_guides/deploying-to-google-cloud.adoc @@ -165,7 +165,7 @@ It uses Cloud Build to build your Docker image and deploy it to Google Container When done, the output will display the URL of your application (target url), you can use it with curl or directly open it in your browser using `gcloud app browse`. NOTE: App Engine Flexible custom runtimes support link:https://cloud.google.com/appengine/docs/flexible/reference/app-yaml?tab=java#updated_health_checks[health checks], -it is strongly advised to provide them thanks to Quarkus xref:smallrye-health.adoc[Smallrye Health] support. +it is strongly advised to provide them thanks to Quarkus xref:smallrye-health.adoc[SmallRye Health] support. == Deploying to Google Cloud Run @@ -221,7 +221,7 @@ After you answer to these questions, it will deploy your application. When the deployment is done, the output will display the URL to access your application. NOTE: Cloud Run supports link:https://cloud.google.com/run/docs/configuring/healthchecks[health checks], -it is strongly advised to provide them thanks to Quarkus xref:smallrye-health.adoc[Smallrye Health] support. +it is strongly advised to provide them thanks to Quarkus xref:smallrye-health.adoc[SmallRye Health] support. == Using Cloud SQL @@ -291,16 +291,23 @@ WARNING: This only works when your application is running inside a Google Cloud === Using Cloud SQL with native executables -When generating native executables, you must also mark `jnr.ffi.provider.jffi.NativeFinalizer$SingletonHolder` as runtime initialized. +When generating native executables, you must mark `jnr.ffi.provider.jffi.NativeFinalizer$SingletonHolder` as runtime initialized. [source,properties] ---- quarkus.native.additional-build-args=--initialize-at-run-time=jnr.ffi.provider.jffi.NativeFinalizer$SingletonHolder ---- +Additionally, starting with `com.google.cloud.sql:postgres-socket-factory:1.17.0`, you must also mark `com.kenai.jffi.internal.Cleaner` as runtime initialized. + +[source,properties] +---- +quarkus.native.additional-build-args=--initialize-at-run-time=jnr.ffi.provider.jffi.NativeFinalizer$SingletonHolder\\,com.kenai.jffi.internal.Cleaner +---- + == Going further You can find a set of extensions to access various Google Cloud Services in the Quarkiverse (a GitHub organization for Quarkus extensions maintained by the community), including PubSub, BigQuery, Storage, Spanner, Firestore, Secret Manager (visit the repository for an accurate list of supported services). -You can find some documentation about them in the link:https://quarkiverse.github.io/quarkiverse-docs/quarkus-google-cloud-services/main/index.html[Quarkiverse Google Cloud Services documentation]. +You can find some documentation about them in the link:https://docs.quarkiverse.io/quarkus-google-cloud-services/main/index.html[Quarkiverse Google Cloud Services documentation]. diff --git a/_guides/deploying-to-kubernetes.adoc b/_guides/deploying-to-kubernetes.adoc index 0092891b43b..40f358744db 100644 --- a/_guides/deploying-to-kubernetes.adoc +++ b/_guides/deploying-to-kubernetes.adoc @@ -627,7 +627,7 @@ quarkus.kubernetes.config-map-volumes.my-volume.config-map-name=my-config-map ==== Passing application configuration -Quarkus supports passing configuration from external locations (via Smallrye Config). This usually requires setting an additional environment variable or system property. +Quarkus supports passing configuration from external locations (via SmallRye Config). This usually requires setting an additional environment variable or system property. When you need to use a secret or a config map for the purpose of application configuration, you need to: - define a volume diff --git a/_guides/dev-services.adoc b/_guides/dev-services.adoc index ab8b7673348..0f1e790c1e7 100644 --- a/_guides/dev-services.adoc +++ b/_guides/dev-services.adoc @@ -102,7 +102,7 @@ The Keycloak Dev Service will be enabled when the `quarkus-oidc` extension is pr the server address has not been explicitly configured. More information can be found in the xref:security-openid-connect-dev-services.adoc[OIDC Dev Services Guide]. -include::{generated-dir}/config/quarkus-oidc_quarkus.keycloak.devservices.adoc[opts=optional, leveloffset=+1] +include::{generated-dir}/config/quarkus-devservices-keycloak_quarkus.keycloak.adoc[opts=optional, leveloffset=+1] === Kubernetes diff --git a/_guides/dev-ui.adoc b/_guides/dev-ui.adoc index ec327daaa2c..75c4d41b053 100644 --- a/_guides/dev-ui.adoc +++ b/_guides/dev-ui.adoc @@ -47,7 +47,7 @@ Extensions can: - <> - <> -- <> +- <> - <> - <> @@ -463,12 +463,12 @@ customElements.define('qwc-arc-beans', QwcArcBeans); ===== Qomponent -We also include all components from the [Qomponent](https://github.com/qomponent) library +We also include all components from the https://github.com/qomponent[Qomponent] library -- [Card](https://www.npmjs.com/package/@qomponent/qui-card) -- [Badge](https://www.npmjs.com/package/@qomponent/qui-badge) -- [Alert](https://www.npmjs.com/package/@qomponent/qui-alert) -- [Code block](https://www.npmjs.com/package/@qomponent/qui-code-block) +- https://www.npmjs.com/package/@qomponent/qui-card[Card] +- https://www.npmjs.com/package/@qomponent/qui-badge[Badge] +- https://www.npmjs.com/package/@qomponent/qui-alert[Alert] +- https://www.npmjs.com/package/@qomponent/qui-code-block[Code block] ====== Card @@ -822,7 +822,7 @@ https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/dev-ui-reso ====== Log The log controller is used to add control buttons to a (footer) log. -See <>. +See <>. image::dev-ui-log-control-v2.png[alt=Dev UI Log control,role="center"] @@ -1145,9 +1145,9 @@ See the https://github.com/quarkusio/quarkus/tree/main/extensions/vertx-http/dev The state in Dev UI uses https://github.com/gitaarik/lit-state[LitState]. You can read more about it in their https://gitaarik.github.io/lit-state/build/[documentation]. -== Add a log file +== Add a footer tab -Apart from adding a card and a page, extensions can add a log to the footer. This is useful for logging things that are happening continuously. A page will lose connection to the backend when navigating away from that page, and a log in the footer will be permanently connected. +Apart from adding a card and a page, extensions can add a tab to the footer. This is useful for things that are happening continuously. A page will lose connection to the backend when navigating away from that page, and a log in the footer will be permanently connected. Adding something to the footer works exactly like adding a Card, except you use a `FooterPageBuildItem` rather than a `CardPageBuildItem`. @@ -1179,6 +1179,59 @@ export class QwcJokesLog extends LitElement { https://github.com/phillip-kruger/quarkus-jokes/blob/main/deployment/src/main/resources/dev-ui/qwc-jokes-log.js[Example code] +=== Add a log to the footer + +There is an easy way to add a log stream to the footer, without having to create the above mentioned footer. +If you just want to stream a log to a tab you can just produce a `FooterLogBuildItem`. This way you only provide a name and a `Flow.Publisher` for your log. + +Here is an example from the Dev Services deployment module: + +[source,java] +---- +@BuildStep(onlyIf = { IsDevelopment.class }) +public List config( + // ... + BuildProducer footerLogProducer){ + + // ... + + // Dev UI Log stream + for (DevServiceDescriptionBuildItem service : serviceDescriptions) { + if (service.getContainerInfo() != null) { + footerLogProducer.produce(new FooterLogBuildItem(service.getName(), () -> { + return createLogPublisher(service.getContainerInfo().getId()); + })); + } + } +} + +// ... + +private Flow.Publisher createLogPublisher(String containerId) { + try (FrameConsumerResultCallback resultCallback = new FrameConsumerResultCallback()) { + SubmissionPublisher publisher = new SubmissionPublisher<>(); + resultCallback.addConsumer(OutputFrame.OutputType.STDERR, + frame -> publisher.submit(frame.getUtf8String())); + resultCallback.addConsumer(OutputFrame.OutputType.STDOUT, + frame -> publisher.submit(frame.getUtf8String())); + LogContainerCmd logCmd = DockerClientFactory.lazyClient() + .logContainerCmd(containerId) + .withFollowStream(true) + .withTailAll() + .withStdErr(true) + .withStdOut(true); + logCmd.exec(resultCallback); + + return publisher; + } catch (Exception e) { + throw new RuntimeException(e); + } +} + +---- + + + == Add a section menu This allows an extension to link a page directly in the section Menu. diff --git a/_guides/elasticsearch.adoc b/_guides/elasticsearch.adoc index 2fb01d9eba9..feffac5f93b 100644 --- a/_guides/elasticsearch.adoc +++ b/_guides/elasticsearch.adoc @@ -126,10 +126,13 @@ package org.acme.elasticsearch; import java.io.IOException; import java.util.ArrayList; import java.util.List; +import java.util.stream.Collectors; import jakarta.enterprise.context.ApplicationScoped; import jakarta.inject.Inject; +import org.apache.http.entity.ContentType; +import org.apache.http.entity.StringEntity; import org.apache.http.util.EntityUtils; import org.elasticsearch.client.Request; import org.elasticsearch.client.Response; @@ -151,13 +154,49 @@ public class FruitService { restClient.performRequest(request); //<4> } + public void index(List list) throws IOException { + + var entityList = new ArrayList(); + + for (var fruit : list) { + + entityList.add(new JsonObject().put("index", new JsonObject()//<5> + .put("_index", "fruits").put("_id", fruit.id))); + entityList.add(JsonObject.mapFrom(fruit)); + } + + Request request = new Request( + "POST", "fruits/_bulk?pretty"); + request.setEntity(new StringEntity( + toNdJsonString(entityList),//<6> + ContentType.create("application/x-ndjson")));//<7> + restClient.performRequest(request); + } + + public void delete(List identityList) throws IOException { + + var entityList = new ArrayList(); + + for (var id : identityList) { + entityList.add(new JsonObject().put("delete", + new JsonObject().put("_index", "fruits").put("_id", id)));//<8> + } + + Request request = new Request( + "POST", "fruits/_bulk?pretty"); + request.setEntity(new StringEntity( + toNdJsonString(entityList), + ContentType.create("application/x-ndjson"))); + restClient.performRequest(request); + } + public Fruit get(String id) throws IOException { Request request = new Request( "GET", "/fruits/_doc/" + id); Response response = restClient.performRequest(request); String responseBody = EntityUtils.toString(response.getEntity()); - JsonObject json = new JsonObject(responseBody); //<5> + JsonObject json = new JsonObject(responseBody); //<9> return json.getJsonObject("_source").mapTo(Fruit.class); } @@ -191,13 +230,42 @@ public class FruitService { } return results; } + + private static String toNdJsonString(List objects) { + return objects.stream() + .map(JsonObject::encode) + .collect(Collectors.joining("\n", "", "\n")); + } } ---- <1> We inject an Elasticsearch low level `RestClient` into our service. <2> We create an Elasticsearch request. <3> We use Vert.x `JsonObject` to serialize the object before sending it to Elasticsearch, you can use whatever you want to serialize your objects to JSON. <4> We send the request (indexing request here) to Elasticsearch. -<5> In order to deserialize the object from Elasticsearch, we again use Vert.x `JsonObject`. +<5> As we `index` collection of objects we should use `index`, `create` or `update` action. +<6> We use `toNdJsonString(entityList)` call to produce output like below ++ +[source, json] +---- +{"index", {"_index" : "fruits", "_id", "1"}} +{"id": "1", "name": "apple", "color": "red"} +... ... ... ... +{"create", {"_index" : "fruits", "_id", "N"}} +{"id": "N", "name": "dragonfruit", "color": "pink"} + +---- +<7> Pass the content type that is expected by the search backend for bulk requests. +<8> The bulk API's delete operation JSON already contains all the required information; hence, there is no request body following this operation in the Bulk API request body. ++ +[source, json] +---- +{"delete", {"_index" : "fruits", "_id", "1"}} +{"delete", {"_index" : "fruits", "_id", "2"}} +... ... ... ... +{"delete", {"_index" : "fruits", "_id", "N"}} + +---- +<9> In order to deserialize the object from Elasticsearch, we again use Vert.x JsonObject. Now, create the `org.acme.elasticsearch.FruitResource` class as follows: @@ -205,18 +273,20 @@ Now, create the `org.acme.elasticsearch.FruitResource` class as follows: ---- package org.acme.elasticsearch; -import jakarta.inject.Inject; -import jakarta.ws.rs.BadRequestException; -import jakarta.ws.rs.GET; -import jakarta.ws.rs.POST; -import jakarta.ws.rs.Path; -import jakarta.ws.rs.core.Response; import java.io.IOException; import java.net.URI; import java.util.List; import java.util.UUID; -import org.jboss.resteasy.reactive.RestQuery; +import jakarta.inject.Inject; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.POST; +import jakarta.ws.rs.DELETE; +import jakarta.ws.rs.Path; +import jakarta.ws.rs.PathParam; +import jakarta.ws.rs.QueryParam; +import jakarta.ws.rs.core.Response; +import jakarta.ws.rs.BadRequestException; @Path("/fruits") public class FruitResource { @@ -233,6 +303,20 @@ public class FruitResource { return Response.created(URI.create("/fruits/" + fruit.id)).build(); } + @Path("bulk") + @DELETE + public Response delete(List identityList) throws IOException { + fruitService.delete(identityList); + return Response.ok().build(); + } + + @Path("bulk") + @POST + public Response index(List list) throws IOException { + fruitService.index(list); + return Response.ok().build(); + } + @GET @Path("/{id}") public Fruit get(String id) throws IOException { @@ -384,18 +468,26 @@ Here is a version of the `FruitService` using the Elasticsearch Java Client inst [source,java] ---- +import java.io.IOException; +import java.io.StringReader; +import java.util.List; +import java.util.stream.Collectors; + +import jakarta.enterprise.context.ApplicationScoped; +import jakarta.inject.Inject; + import co.elastic.clients.elasticsearch.ElasticsearchClient; +import co.elastic.clients.elasticsearch.core.IndexRequest; import co.elastic.clients.elasticsearch._types.FieldValue; import co.elastic.clients.elasticsearch._types.query_dsl.QueryBuilders; -import co.elastic.clients.elasticsearch.core.*; +import co.elastic.clients.elasticsearch.core.search.Hit; import co.elastic.clients.elasticsearch.core.search.HitsMetadata; -import jakarta.enterprise.context.ApplicationScoped; -import jakarta.inject.Inject; -import org.acme.elasticsearch.Fruit; - -import java.io.IOException; -import java.util.List; -import java.util.stream.Collectors; +import co.elastic.clients.elasticsearch.core.GetRequest; +import co.elastic.clients.elasticsearch.core.GetResponse; +import co.elastic.clients.elasticsearch.core.SearchRequest; +import co.elastic.clients.elasticsearch.core.SearchResponse; +import co.elastic.clients.elasticsearch.core.BulkRequest; +import co.elastic.clients.elasticsearch.core.BulkResponse; @ApplicationScoped public class FruitService { @@ -410,6 +502,37 @@ public class FruitService { client.index(request); // <4> } + public void index(List list) throws IOException { + + BulkRequest.Builder br = new BulkRequest.Builder(); + + for (var fruit : list) { + br.operations(op -> op + .index(idx -> idx.index("fruits").id(fruit.id).document(fruit))); + } + + BulkResponse result = client.bulk(br.build()); + + if (result.errors()) { + throw new RuntimeException("The indexing operation encountered errors."); + } + } + + public void delete(List list) throws IOException { + + BulkRequest.Builder br = new BulkRequest.Builder(); + + for (var id : list) { + br.operations(op -> op.delete(idx -> idx.index("fruits").id(id))); + } + + BulkResponse result = client.bulk(br.build()); + + if (result.errors()) { + throw new RuntimeException("The indexing operation encountered errors."); + } + } + public Fruit get(String id) throws IOException { GetRequest getRequest = GetRequest.of( b -> b.index("fruits") diff --git a/_guides/extension-codestart.adoc b/_guides/extension-codestart.adoc index 3d5dba084ee..1ad93294c78 100644 --- a/_guides/extension-codestart.adoc +++ b/_guides/extension-codestart.adoc @@ -194,7 +194,7 @@ tags: extension-codestart metadata: title: Aloha description: Start to code with the Aloha extension. - related-guide-section: https://quarkiverse.github.io/quarkiverse-docs/quarkus-aloha/dev/ + related-guide-section: https://docs.quarkiverse.io/quarkus-aloha/dev/ path: /aloha # (optional) for web extensions providing HTTP resources ---- @@ -532,6 +532,53 @@ It is going to be merged with the other codestarts config and automatically conv * You can start with java and add kotlin later in another PR (create an issue so you don't forget). * If you have a question, ping me @ia3andy on https://quarkusio.zulipchat.com/. +=== Platform codestarts data + +This chapter is relevant for https://quarkus.io/guides/platform[Quarkus platform] developers who want to provide codestart data in the https://quarkus.io/guides/platform#platform-descriptor[platform metadata]. + +While typically codestart data is configured in <> files, platform developers may also provide codestart data in a platform descriptor with the purpose of customizing certain values. + +For example, given a `codestart.yml` such as +[source,yaml] +---- +name: quarkus-magic-codestart +ref: quarkus-magic +type: code +tags: extension-codestart +metadata: + title: Quarkus Magic + description: Quarkus magic +language: + base: + data: + magic: + source: codestart.yml +---- + +The value of `magic.source` can be customized in a platform descriptor like this +[source,yaml] +---- +{ + "id" : "org.acme.platform:acme-bom-quarkus-platform-descriptor:7.0.7:json:7.0.7", + "platform" : true, + "bom" : "org.acme.platform:acme-magic-bom::pom:7.0.7", + "metadata" : { + "project" : { <1> + "codestart-data" : { <2> + "quarkus-magic-codestart" : { <3> + "magic" : { + "source" : "acme-platform" + } + } + } + }, +... +---- + +<1> `project` groups metadata that is relevant for project creation tools +<2> `codestart-data` is a source of data for various codestarts +<3> a name of the codestart to which the data nested under it should be passed + == The generator sources * https://github.com/quarkusio/quarkus/tree/main/independent-projects/tools/codestarts[Codestart generator, window="_blank"] diff --git a/_guides/extension-faq.adoc b/_guides/extension-faq.adoc new file mode 100644 index 00000000000..15398580b20 --- /dev/null +++ b/_guides/extension-faq.adoc @@ -0,0 +1,97 @@ +//// +This document is maintained in the main Quarkus repository +and pull requests should be submitted there: +https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc +//// +[id="extensions-faq"] += Frequently asked questions about writing extensions +include::_attributes.adoc[] +:diataxis-type: howto +:categories: extensions +//// +:extension-status: preview +TODO: uncomment the above for experimental or tech-preview content. +The document header ends at the first blank line. Do not remove the blank line between the header and the abstract summary. +//// + +## Should you write an extension? + +### Why would I want to write an extension? + +See the xref:writing-extensions#extension-philosophy[extension philosophy]. + +One useful thing extensions can do is bundle other extensions. +Have a look at the link:https://quarkus.io/extensions/io.quarkiverse.microprofile/quarkus-microprofile/[Quarkus MicroProfile extension] for an example of aggregator extensions. + +### Are there cases an extension isn't necessary? + +Not every problem needs an extension! + If you're just bundling up external libraries (that aren't already extensions) and making minor adjustments, you might not need an extension. + For example, plain libraries can create new configuration elements and register classes with Jandex (this link:https://www.loicmathieu.fr/wordpress/en/informatique/quarkus-tip-comment-ne-pas-creer-une-extension-quarkus/[blog shows how]). + + +## Bytecode transformation + +### How can I change the code of things on the classpath? + +A `BytecodeTransformerBuildItem` can be used to manipulate bytecode. +For example, see this link:https://quarkus.io/blog/solving-problems-with-extensions/[blog about removed problematic bridge methods from a dependency]. + +## CDI + +### I'm working with CDI, and I don't know how to ... + +The xref:cdi-integration.adoc[CDI integration guide] presents solutions to a number of CDI-related use cases for extension authors. + +### I have transformed a user class to add an injected field, but CDI isn't working + +What happens if an extension transforms a user class using `BytecodeTransformerBuildItem`, and replaces `@jakarta.annotation.Resource` with `@jakarta.inject.Inject`? The field will not be injected by Arc. +Debugging will show the transformed class being loaded in the app, but it looks like Arc doesn't see the new code. + +Arc-related transformations should generally be done with link:https://github.com/quarkusio/quarkus/blob/main/extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/AnnotationsTransformerBuildItem.java[AnnotationsTransformerBuildItem]. +The reason is that _all_ Quarkus's bytecode transformations are done after Jandex indexing. This means changes are never reflected back in Jandex. + +Most extensions use Jandex as a source of truth to find out what to do. Those extensions won't see new/modified endpoints in the bytecode itself. +The solution to this limitation is annotation transformers. You should also be aware that while Arc and Quarkus REST honour annotation transformers, not all extensions do. + +### Something in my classpath has @Inject annotations, which are confusing CDI. How can I fix that? + +You will need to implement an `AnnotationsTransformer` and strip out out the problematic injection sites. (Remember, if the use case involves CDI, it needs to be an `AnnotationsTransformer`, not a BytecodeTransformer`.) See link:https://quarkus.io/blog/solving-problems-with-extensions-2/[this blog] about on using an `AnnotationsTransformer` extension to clean non `@Inject` annotations from the Airline library so that it can be used in CDI-enabled runtimes. + +## Cross-cutting concerns + +### How can I redirect application logging to an external service? + +A `LogHandlerBuildItem` is a convenient way to redirect application logs. See this link:https://quarkus.io/blog/quarkus-aws-cloudwatch_extension/[worked example of an extension which directs output to AWS CloudWatch]. + +## Build and hosting infrastructure for extensions + +### Can I use Gradle to build my extension? + +Yes, but it's not the most typical pattern. +See the xref:building-my-first-extension.adoc#gradle-setup[Building Your First Extension Guide] for instructions on setting up a Gradle extension. Have a look at the link:https://quarkus.io/extensions/org.jobrunr/quarkus-jobrunr/[JobRunr extension] for an example implementation. + +### If I want my extension to be in code.quarkus.io, does it have to be in the Quarkiverse GitHub org? + +Registering an extension in the catalog is independent from where the source code is. +The link:https://hub.quarkiverse.io[quarkiverse repository] has some shortcuts to make releasing and testing extensions easier, but any extension can link:https://hub.quarkiverse.io/checklistfornewprojects/#make-your-extension-available-in-the-tooling[register into the catalog]. + +### My extension isn't showing up on extensions.quarkus.io + +Every extension in the link:https://github.com/quarkusio/quarkus-extension-catalog/tree/main/extensions[extension catalog] should appear in http://code.quarkus.io, http://extensions.quarkus.io, and the command line tools. +The web pages at http://extensions.quarkus.io are refreshed a few times a delay, so there may be a delay in new extensions showing up there. +To debug a missing extension, first: + +- Check your extension is present in link:https://central.sonatype.com/[Maven Central] +- Check the extension is included the link:https://github.com/quarkusio/quarkus-extension-catalog/tree/main/extensions[extensions catalog list] (it only needs to be included once, and future versions will be automatically detected) +- Check if the extension is listed in the http://https://registry.quarkus.io/q/swagger-ui/#/Client/get_client_extensions_all[Quarkus registry] list of all known extensions +- Check if there has been a green link:https://github.com/quarkusio/extensions/actions/workflows/build_and_publish.yml[build of the extensions site] since updating the catalog + +## Other topics + + +### What's the difference between a quickstart and a codestart? + +Both codestarts and quickstarts are designed to help users get coding quickly. +A codestarts is a generated application and a quickstart is browsable source code. +Codestarts allow the creation of customised apps, which makes them quite powerful. diff --git a/_guides/extension-metadata.adoc b/_guides/extension-metadata.adoc index 220ff69f480..2fc7a7efe4d 100644 --- a/_guides/extension-metadata.adoc +++ b/_guides/extension-metadata.adoc @@ -89,11 +89,12 @@ metadata: - "quarkus.rest." built-with-quarkus-core: "3.8.5" <2> requires-quarkus-core: "[3.8,)" <3> - capabilities: <4> + minimum-java-version: "17" <4> + capabilities: <5> provides: - "io.quarkus.rest" - "io.quarkus.resteasy.reactive" - extension-dependencies: <5> + extension-dependencies: <6> - "io.quarkus:quarkus-rest-common" - "io.quarkus:quarkus-mutiny" - "io.quarkus:quarkus-smallrye-context-propagation" @@ -103,16 +104,17 @@ metadata: - "io.quarkus:quarkus-vertx-http" - "io.quarkus:quarkus-core" - "io.quarkus:quarkus-jsonp" - scm-url: "https://github.com/quarkusio/quarkus" <6> - sponsor: A Sponsoring Organisation <7> +scm-url: "https://github.com/quarkusio/quarkus" <7> +sponsor: A Sponsoring Organisation <8> ---- <1> Description that can be displayed to users. In this case, the description was copied from the `pom.xml` of the extension module but it could also be provided in the template file. <2> Quarkus version the extension was built with <3> The Quarkus version range this extension requires. Optional, and will be set automatically by using the `built-with-quarkus-core` as the minimum range. -<4> https://quarkus.io/guides/capabilities[Capabilities] this extension provides -<5> Direct dependencies on other extensions -<6> The source code repository of this extension. Optional, and will often be set automatically by using the `` information in the pom. In GitHub Actions builds, it will be inferred from the CI environment. For other GitHub repositories, it can be controlled by setting a `GITHUB_REPOSITORY` environment variable. -<7> The sponsor(s) of this extension. Optional, and will sometimes be determined automatically from commit history. +<4> The minimum Java version required for this extension to run. Will be generated based on the `maven.compiler.release` used in the build. +<5> https://quarkus.io/guides/capabilities[Capabilities] this extension provides +<6> Direct dependencies on other extensions +<7> The source code repository of this extension. Optional, and will often be set automatically by using the `` information in the pom. In GitHub Actions builds, it will be inferred from the CI environment. For other GitHub repositories, it can be controlled by setting a `GITHUB_REPOSITORY` environment variable. +<8> The sponsor(s) of this extension. Optional, and will sometimes be determined automatically from commit history. [[quarkus-extension-properties]] diff --git a/_guides/extension-writing-dev-service.adoc b/_guides/extension-writing-dev-service.adoc index 7f9e18f3ba4..27d96ce3807 100644 --- a/_guides/extension-writing-dev-service.adoc +++ b/_guides/extension-writing-dev-service.adoc @@ -23,11 +23,11 @@ include::_attributes.adoc[] If your extension provides APIs for connecting to an external service, it's a good idea to provide a xref:dev-services.adoc[Dev Service] implementation. To create a Dev Service, add a new build step into the extension processor class that returns a `DevServicesResultBuildItem`. -Here, the link:https://hub.docker.com/_/hello-world`hello-world` image is used, but you should set up the right image for your service. +Here, the https://hub.docker.com/_/hello-world[`hello-world`] image is used, but you should set up the right image for your service. [source%nowrap,java] ---- - @BuildStep(onlyIfNot = IsNormal.class, onlyIf = GlobalDevServicesConfig.Enabled.class) { + @BuildStep(onlyIfNot = IsNormal.class, onlyIf = GlobalDevServicesConfig.Enabled.class) public DevServicesResultBuildItem createContainer() { DockerImageName dockerImageName = DockerImageName.parse("hello-world"); GenericContainer container = new GenericContainer<>(dockerImageName) @@ -89,7 +89,7 @@ For example, [source%nowrap,java] ---- - @BuildStep(onlyIfNot = IsNormal.class, onlyIf = GlobalDevServicesConfig.Enabled.class) { + @BuildStep(onlyIfNot = IsNormal.class, onlyIf = GlobalDevServicesConfig.Enabled.class) public DevServicesResultBuildItem createContainer(MyConfig config) { ---- diff --git a/_guides/flyway.adoc b/_guides/flyway.adoc index 84120b19321..1428f19649f 100644 --- a/_guides/flyway.adoc +++ b/_guides/flyway.adoc @@ -63,7 +63,7 @@ In your build file, add the following dependencies: flyway-database-oracle - + org.flywaydb flyway-database-postgresql @@ -156,7 +156,7 @@ implementation("org.flywaydb:flyway-sqlserver") implementation("org.flywaydb:flyway-mysql") // Flyway Oracle specific dependencies implementation("org.flywaydb:flyway-database-oracle") -// Flyway Postgres specific dependencies +// Flyway PostgreSQL specific dependencies implementation("org.flywaydb:flyway-database-postgresql") // Flyway DB2 specific dependencies implementation("org.flywaydb:flyway-database-db2") diff --git a/_guides/getting-started-dev-services.adoc b/_guides/getting-started-dev-services.adoc index c9647a9fdef..172ad5db118 100644 --- a/_guides/getting-started-dev-services.adoc +++ b/_guides/getting-started-dev-services.adoc @@ -125,7 +125,7 @@ You should see in your terminal that the tests are now passing. 1. To add the persistence libraries, run -:add-extension-extensions: hibernate-orm-panache jdbc-postgresql +:add-extension-extensions: hibernate-orm-panache,jdbc-postgresql include::{includes}/devtools/extension-add.adoc[] The application will record the names of people it greets. Define an Entity diff --git a/_guides/getting-started-testing.adoc b/_guides/getting-started-testing.adoc index 7495ce2c114..ab8ff2b88e4 100644 --- a/_guides/getting-started-testing.adoc +++ b/_guides/getting-started-testing.adoc @@ -1475,6 +1475,87 @@ You can use this tag to isolate the `@QuarkusTest` test in a specific execution ---- +[NOTE] +-- +Currently `@QuarkusTest` and `@QuarkusIntegrationTest` should not be run in the same test run. + +For Maven, this means that the former should be run by the surefire plugin while the latter should be run by the failsafe plugin. + +For Gradle, this means the two types of tests should belong to different source sets. + +.Source set configuration example +[%collapsible] +==== +[source,kotlin,subs=attributes+] +---- +/** custom source sets + * + * io.quarkus.gradle.QuarkusPlugin + * io.quarkus.test.junit.IntegrationTestUtil + * + * to work around + * https://github.com/quarkusio/quarkus/issues/43796 + * https://github.com/quarkusio/quarkus/issues/43804 + */ + +sourceSets { + create("intTest") { + compileClasspath += sourceSets.main.get().output + runtimeClasspath += sourceSets.main.get().output + } + create("e2eTest") { + compileClasspath += sourceSets.main.get().output + runtimeClasspath += sourceSets.main.get().output + } +} + +configurations { + getByName("intTestImplementation") { + extendsFrom(configurations.testImplementation.get()) + } + getByName("intTestRuntimeOnly") { + extendsFrom(configurations.testRuntimeOnly.get()) + } + getByName("e2eTestImplementation") { + extendsFrom(configurations.testImplementation.get()) + } + getByName("e2eTestRuntimeOnly") { + extendsFrom(configurations.testRuntimeOnly.get()) + } +} + +tasks.register("intTest") { + group = "verification" + description = "Runs integration tests" + + testClassesDirs = sourceSets["intTest"].output.classesDirs + classpath = sourceSets["intTest"].runtimeClasspath + + systemProperty("build.output.directory", "build") + systemProperty("quarkus.profile", "intTest") +} + +tasks.register("e2eTest") { + group = "verification" + description = "Runs e2e tests" + + val quarkusBuild = tasks.getByName("quarkusBuild") + dependsOn(quarkusBuild) + + testClassesDirs = sourceSets["e2eTest"].output.classesDirs + classpath = sourceSets["e2eTest"].runtimeClasspath + + systemProperty("build.output.directory", "build") +} + +idea.module { + testSources.from(sourceSets["intTest"].kotlin.srcDirs) + testSources.from(sourceSets["e2eTest"].kotlin.srcDirs) +} +---- +==== +-- + [[test-from-ide]] == Running `@QuarkusTest` from an IDE @@ -1607,7 +1688,7 @@ public class FooTest { <1> The `QuarkusComponentTest` annotation registers the JUnit extension. <2> Sets a configuration property for the test. <3> The test injects the component under the test. The types of all fields annotated with `@Inject` are considered the component types under test. You can also specify additional component classes via `@QuarkusComponentTest#value()`. Furthermore, the static nested classes declared on the test class are components too. -<4> The test also injects a mock for `Charlie`. `Charlie` is an _unsatisifed_ dependency for which a synthetic `@Singleton` bean is registered automatically. The injected reference is an "unconfigured" Mockito mock. +<4> The test also injects a mock for `Charlie`. `Charlie` is an _unsatisfied_ dependency for which a synthetic `@Singleton` bean is registered automatically. The injected reference is an "unconfigured" Mockito mock. <5> We can leverage the Mockito API in a test method to configure the behavior. You can find more examples and hints in the xref:testing-components.adoc[testing components reference guide]. diff --git a/_guides/gradle-tooling.adoc b/_guides/gradle-tooling.adoc index 6cd28b895a8..0ba1a19ae1e 100644 --- a/_guides/gradle-tooling.adoc +++ b/_guides/gradle-tooling.adoc @@ -814,5 +814,33 @@ action must be declared as an input of the task. The Quarkus Gradle plugin works with builds that have the link:https://docs.gradle.org/current/userguide/configuration_cache.html[Gradle's configuration cache] enabled, but -the configuration cache is disabled for the Quarkus tasks. This means, that the Quarkus plugin does not break such +the configuration cache is disabled for some of the Quarkus tasks. This means, that the Quarkus plugin does not break such Gradle builds. +The current state of compatibility is shown in the following table: + +[cols="2","4"] +|==== +|Quarkus task|Configuration Cache Compatibility +|`quarkusGenerateCode` |✅ +|`quarkusGenerateCodeDev`|✅ +|`quarkusGenerateCodeTests`|✅ +|`quarkusDependenciesBuild`|✅ +|`quarkusAppPartsBuild`|✅ +|`quarkusShowEffectiveConfig`|✅ +|`quarkusBuild`|✅ +|`imageBuild`|✅ +|`imagePush`|✅ +|`quarkusDev`|❌ +|`quarkusRun`|❌ +|`quarkusRemoteDev`|❌ +|`quarkusTest`|❌ +|`quarkusGoOffline`|❌ +|`quarkusInfo`|❌ +|`quarkusUpdate`|❌ +|`deploy`|❌ +|`listExtensions`|❌ +|`listCategories`|❌ +|`listPlatforms`|❌ +|`addExtension`|❌ +|`removeExtension`|❌ +|==== diff --git a/_guides/grpc-kubernetes.adoc b/_guides/grpc-kubernetes.adoc index f5fe5f33e18..34cf3ea4f69 100644 --- a/_guides/grpc-kubernetes.adoc +++ b/_guides/grpc-kubernetes.adoc @@ -65,7 +65,7 @@ You can find more information about how to deploy the application in Kubernetes == Using gRPC Health probes -By default, the Kubernetes resources do not contain readiness and liveness probes. To add them, import the Smallrye Health extension to your build file: +By default, the Kubernetes resources do not contain readiness and liveness probes. To add them, import the SmallRye Health extension to your build file: [source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"] .pom.xml diff --git a/_guides/grpc-service-implementation.adoc b/_guides/grpc-service-implementation.adoc index ab736562e20..3715e45c006 100644 --- a/_guides/grpc-service-implementation.adoc +++ b/_guides/grpc-service-implementation.adoc @@ -521,29 +521,48 @@ quarkus.http.auth.basic=true <1> ---- package org.acme.grpc.auth; -import static org.assertj.core.api.Assertions.assertThat; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; +import org.acme.proto.Greeter; +import org.acme.proto.HelloRequest; import io.grpc.Metadata; import io.quarkus.grpc.GrpcClient; import io.quarkus.grpc.GrpcClientUtils; import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; + +import io.quarkus.test.junit.QuarkusTest; import org.junit.jupiter.api.Test; -public class HelloServiceTest implements Greeter { +@QuarkusTest +public class GreeterServiceTest { + + private static final Metadata.Key AUTHORIZATION = Metadata.Key.of("Authorization", Metadata.ASCII_STRING_MARSHALLER); @GrpcClient Greeter greeterClient; @Test - void shouldReturnHello() { + void shouldReturnHello() throws ExecutionException, InterruptedException, TimeoutException { Metadata headers = new Metadata(); - headers.put("Authorization", "Basic am9objpqb2hu"); + + // Set the headers - Basic auth for testing + headers.put(AUTHORIZATION, "Basic YWxpY2U6YWxpY2U="); // alice:alice with "admin" role var client = GrpcClientUtils.attachHeaders(greeterClient, headers); + // Call the client CompletableFuture message = new CompletableFuture<>(); client.sayHello(HelloRequest.newBuilder().setName("Quarkus").build()) .subscribe().with(reply -> message.complete(reply.getMessage())); - assertThat(message.get(5, TimeUnit.SECONDS)).isEqualTo("Hello Quarkus"); + + // Get the values + String theValue = message.get(5, TimeUnit.SECONDS); + + // Assert + assertThat(theValue, is("Hello Quarkus")); } } ---- @@ -596,7 +615,7 @@ import io.quarkus.security.identity.request.UsernamePasswordAuthenticationReques @Singleton public class CustomGrpcSecurityMechanism implements GrpcSecurityMechanism { - private static final String AUTHORIZATION = "Authorization"; + private static final Metadata.Key AUTHORIZATION = Metadata.Key.of("Authorization", Metadata.ASCII_STRING_MARSHALLER); @Override public boolean handles(Metadata metadata) { diff --git a/_guides/hibernate-orm.adoc b/_guides/hibernate-orm.adoc index 60a73363aa6..e8d9c7c3f5c 100644 --- a/_guides/hibernate-orm.adoc +++ b/_guides/hibernate-orm.adoc @@ -205,11 +205,20 @@ or implicitly set by the Quarkus build process to a minimum supported version of Quarkus will try to check this preconfigured version against the actual database version on startup, leading to a startup failure when the actual version is lower. -This is because Hibernate ORM may generate SQL that is invalid -for versions of the database older than what is configured, -which would lead to runtime exceptions. +This is a safeguard: for versions of the database older than what is configured, +Hibernate ORM may generate SQL that is invalid which would lead to runtime exceptions. +// TODO disable the check by default when offline startup is opted in +// See https://github.com/quarkusio/quarkus/issues/13522 If the database cannot be reached, a warning will be logged but startup will proceed. +You can optionally disable the version check if you know the database won't be reachable on startup +using <>. + +// TODO change the default to "always enabled" when we solve version detection problems +// See https://github.com/quarkusio/quarkus/issues/43703 +// See https://github.com/quarkusio/quarkus/issues/42255 +The version check is disabled by default when a dialect is set explicitly, +as a workaround for https://github.com/quarkusio/quarkus/issues/42255[#42255]/link:https://github.com/quarkusio/quarkus/issues/43703[#43703]. ==== [[hibernate-dialect-other-databases]] @@ -584,17 +593,29 @@ public class MyProducer { [[persistence-xml]] == Setting up and configuring Hibernate ORM with a `persistence.xml` -Alternatively, you can use a `META-INF/persistence.xml` to set up Hibernate ORM. -This is useful for: +To set up and configure Hibernate ORM, <> is recommended, +but you can alternatively use a `META-INF/persistence.xml` file. +This is mainly useful for migrating existing code to Quarkus. -* migrating existing code -* when you have relatively complex settings requiring the full flexibility of the configuration -* or if you like it the good old way - -[NOTE] +[WARNING] ==== -If you use a `persistence.xml`, then you cannot use the `quarkus.hibernate-orm.*` properties -and only persistence units defined in `persistence.xml` will be taken into account. +Using a `persistence.xml` file implies a few constraints: + +* Persistence units defined in `persistence.xml` always use the xref:datasource.adoc#configure-a-single-datasource[default datasource]. +* Persistence units defined in `persistence.xml` must be configured explicitly: +Quarkus will keep injection of environment-related configuration to a minimum. ++ +In particular, Quarkus will not configure the dialect or database version automatically based on the datasource, +so if the default configuration of Hibernate ORM doesn't suit your needs, +you will need to include in `persistence.xml` configuration such as +link:{hibernate-orm-docs-url}#settings-hibernate.dialect[`hibernate.dialect`]/link:{hibernate-orm-docs-url}#settings-jakarta.persistence.database-product-name[`jakarta.persistence.database-product-name`] +and possibly link:{hibernate-orm-docs-url}#settings-jakarta.persistence.database-product-version[`jakarta.persistence.database-product-version`]. +* Using `persistence.xml` is incompatible with using `quarkus.hibernate-orm.*` properties in `{config-file}`: +if you mix them, Quarkus will raise an exception. +* Developer experience may be impacted negatively when using `persistence.xml` +compared to when <>, +due to unavailable features, limited guidance in the Quarkus documentation, +and error messages providing resolution hints that cannot be applied (e.g. using `quarkus.hibernate-orm.*` properties). If your classpath contains a `persistence.xml` that you want to ignore, set the following configuration property: diff --git a/_guides/hibernate-reactive-panache.adoc b/_guides/hibernate-reactive-panache.adoc index 3b542fc9883..f129c82d5fc 100644 --- a/_guides/hibernate-reactive-panache.adoc +++ b/_guides/hibernate-reactive-panache.adoc @@ -1133,7 +1133,7 @@ public class PanacheFunctionalityTest { } ---- <1> Make sure the test method is run on the Vert.x event loop. -<2> The injected `UniAsserter` agrument is used to make assertions. +<2> The injected `UniAsserter` argument is used to make assertions. == How and why we simplify Hibernate Reactive mappings diff --git a/_guides/http-reference.adoc b/_guides/http-reference.adoc index 4415c326ca9..10b58e6b286 100644 --- a/_guides/http-reference.adoc +++ b/_guides/http-reference.adoc @@ -69,7 +69,7 @@ The response body of a static resource is not compressed by default. You can enable the HTTP compression support by means of `quarkus.http.enable-compression=true`. If compression support is enabled then the response body is compressed if the `Content-Type` header derived from the file name of a resource is a compressed media type as configured via `quarkus.http.compress-media-types`. -TIP: By default, the following list of media types is compressed: `text/html`, `text/plain`, `text/xml`, `text/css`, `text/javascript`, `application/javascript`, `application/graphql+json`. It means some other noteworthy media types such as `application/json`, `application/xhtml+xml` are NOT compressed by default. +TIP: By default, the following list of media types is compressed: `text/html`, `text/plain`, `text/xml`, `text/css`, `text/javascript`, `application/javascript`, `application/json`, `application/graphql+json` and `application/xhtml+xml`. NOTE: If the client does not indicate its support for HTTP compression in a request header, e.g. `Accept-Encoding: deflate, gzip, br`, then the response body is not compressed. @@ -145,7 +145,7 @@ quarkus.tls.key-store.pem.0.key=server.key quarkus.http.insecure-requests=disabled # Reject HTTP requests ---- -So you a `p12` (PKCS12) key store, use the following configuration: +To use a `p12` (PKCS12) key store, apply the following configuration: [source,properties] ---- diff --git a/_guides/images/dev-ui-observability-card.png b/_guides/images/dev-ui-observability-card.png new file mode 100644 index 00000000000..339565abd36 Binary files /dev/null and b/_guides/images/dev-ui-observability-card.png differ diff --git a/_guides/images/oidc-github-1.png b/_guides/images/oidc-github-1.png index bb183b3a038..581f6e47f22 100644 Binary files a/_guides/images/oidc-github-1.png and b/_guides/images/oidc-github-1.png differ diff --git a/_guides/images/oidc-github-2.png b/_guides/images/oidc-github-2.png index 62a304bc580..8868c371daf 100644 Binary files a/_guides/images/oidc-github-2.png and b/_guides/images/oidc-github-2.png differ diff --git a/_guides/images/oidc-github-3.png b/_guides/images/oidc-github-3.png index 407d1844547..ffa2e806a6a 100644 Binary files a/_guides/images/oidc-github-3.png and b/_guides/images/oidc-github-3.png differ diff --git a/_guides/images/oidc-google-1.png b/_guides/images/oidc-google-1.png index dabe55dfa77..f8f801c5aa0 100644 Binary files a/_guides/images/oidc-google-1.png and b/_guides/images/oidc-google-1.png differ diff --git a/_guides/images/oidc-google-2.png b/_guides/images/oidc-google-2.png index 9d57c819192..7818fd708ec 100644 Binary files a/_guides/images/oidc-google-2.png and b/_guides/images/oidc-google-2.png differ diff --git a/_guides/images/oidc-google-3.png b/_guides/images/oidc-google-3.png index a2c17240bdc..b3833ab38dd 100644 Binary files a/_guides/images/oidc-google-3.png and b/_guides/images/oidc-google-3.png differ diff --git a/_guides/images/oidc-google-4.png b/_guides/images/oidc-google-4.png index 49906b8ecc5..131938af0fc 100644 Binary files a/_guides/images/oidc-google-4.png and b/_guides/images/oidc-google-4.png differ diff --git a/_guides/images/oidc-google-5.png b/_guides/images/oidc-google-5.png index fdf9e0df6c2..5707dac165d 100644 Binary files a/_guides/images/oidc-google-5.png and b/_guides/images/oidc-google-5.png differ diff --git a/_guides/images/oidc-google-6.png b/_guides/images/oidc-google-6.png index 0810343ec22..3e5eae7c881 100644 Binary files a/_guides/images/oidc-google-6.png and b/_guides/images/oidc-google-6.png differ diff --git a/_guides/images/oidc-google-7.png b/_guides/images/oidc-google-7.png index 32a7a6c157b..116601ea0e8 100644 Binary files a/_guides/images/oidc-google-7.png and b/_guides/images/oidc-google-7.png differ diff --git a/_guides/images/oidc-google-8.png b/_guides/images/oidc-google-8.png index 87be4462cde..79305e82d1e 100644 Binary files a/_guides/images/oidc-google-8.png and b/_guides/images/oidc-google-8.png differ diff --git a/_guides/images/oidc-google-9.png b/_guides/images/oidc-google-9.png index 0da8d5f488b..6aae02ceb5a 100644 Binary files a/_guides/images/oidc-google-9.png and b/_guides/images/oidc-google-9.png differ diff --git a/_guides/images/oidc-microsoft-1.png b/_guides/images/oidc-microsoft-1.png index 9a6216eb45d..71dc1365262 100644 Binary files a/_guides/images/oidc-microsoft-1.png and b/_guides/images/oidc-microsoft-1.png differ diff --git a/_guides/images/oidc-microsoft-2.png b/_guides/images/oidc-microsoft-2.png index 2db15f18656..a8a9e73ea10 100644 Binary files a/_guides/images/oidc-microsoft-2.png and b/_guides/images/oidc-microsoft-2.png differ diff --git a/_guides/images/oidc-microsoft-3.png b/_guides/images/oidc-microsoft-3.png index 7c32b5931fa..830466c0271 100644 Binary files a/_guides/images/oidc-microsoft-3.png and b/_guides/images/oidc-microsoft-3.png differ diff --git a/_guides/images/oidc-microsoft-4.png b/_guides/images/oidc-microsoft-4.png index fdb1140af74..ceabf347cdb 100644 Binary files a/_guides/images/oidc-microsoft-4.png and b/_guides/images/oidc-microsoft-4.png differ diff --git a/_guides/images/oidc-microsoft-5.png b/_guides/images/oidc-microsoft-5.png index e6adf4a5a00..573cfc40b62 100644 Binary files a/_guides/images/oidc-microsoft-5.png and b/_guides/images/oidc-microsoft-5.png differ diff --git a/_guides/images/oidc-microsoft-7.png b/_guides/images/oidc-microsoft-7.png index 9349461a98a..b96df94bef2 100644 Binary files a/_guides/images/oidc-microsoft-7.png and b/_guides/images/oidc-microsoft-7.png differ diff --git a/_guides/javascript/config.js b/_guides/javascript/config.js index bfd37622f14..cacd6be7a3f 100644 --- a/_guides/javascript/config.js +++ b/_guides/javascript/config.js @@ -120,7 +120,8 @@ function findText(row, search){ var elementText = n.nodeValue; if(elementText == undefined) continue; - if(elementText.toLowerCase().indexOf(search) != -1 + if((elementText.toLowerCase().indexOf(search) != -1 + || elementText.toLowerCase().indexOf(search.replace(" ", "-")) != -1) // check that it's not decoration && acceptTextForSearch(n)){ iter.detach(); @@ -198,11 +199,15 @@ function search(input){ function applySearch(table, search, autoExpand){ // clear highlights clearHighlights(table); + var lastExtensionHeader = null; + var lastConfigRootHeader = null; var lastSectionHeader = null; var idx = 0; for (var row of table.querySelectorAll("table.configuration-reference > tbody > tr")) { - var heads = row.querySelectorAll("table.configuration-reference > tbody > tr > th"); - if(!heads || heads.length == 0){ + var isExtensionNameRow = row.querySelectorAll("th span.extension-name").length > 0; + var isConfigRootNameRow = row.querySelectorAll("th span.configroot-name").length > 0; + var isSectionNameRow = row.querySelectorAll("th span.section-name").length > 0; + if(!isExtensionNameRow && !isConfigRootNameRow && !isSectionNameRow){ // mark even rows if(++idx % 2){ row.classList.add("odd"); @@ -221,7 +226,17 @@ function applySearch(table, search, autoExpand){ && !row.classList.contains("row-collapsed")) row.click(); }else{ - if(heads && heads.length > 0){ + if(isExtensionNameRow){ + // keep the column header with no highlight, but start hidden + lastExtensionHeader = row; + lastConfigRootHeader = null; + lastSectionHeader = null; + row.style.display = "none"; + } else if(isConfigRootNameRow){ + lastConfigRootHeader = row; + lastSectionHeader = null; + row.style.display = "none"; + } else if(isSectionNameRow){ // keep the column header with no highlight, but start hidden lastSectionHeader = row; row.style.display = "none"; @@ -231,6 +246,16 @@ function applySearch(table, search, autoExpand){ if(autoExpand && row.classList.contains("row-collapsed")) row.click(); highlight(row, search); + if(lastExtensionHeader){ + lastExtensionHeader.style.removeProperty("display"); + // avoid showing it more than once + lastExtensionHeader = null; + } + if(lastConfigRootHeader){ + lastConfigRootHeader.style.removeProperty("display"); + // avoid showing it more than once + lastConfigRootHeader = null; + } if(lastSectionHeader){ lastSectionHeader.style.removeProperty("display"); // avoid showing it more than once diff --git a/_guides/jms.adoc b/_guides/jms.adoc index c1f285e5c33..ba8b2697987 100644 --- a/_guides/jms.adoc +++ b/_guides/jms.adoc @@ -390,5 +390,5 @@ With the Artemis properties configured, you can resume the steps above from <>). +SmallRye Reactive Messaging keeps this order for processing, unless `@Blocking(ordered = false)` is used (see <>). Note that due to consumer rebalances, Kafka consumers only guarantee at-least-once processing of single records, meaning that uncommitted records _can_ be processed again by consumers. ==== @@ -761,7 +761,7 @@ You can configure batch mode explicitly with `mp.messaging.incoming.$channel.bat The `checkpoint` commit strategy is an experimental feature and can change in the future. ==== -Smallrye Reactive Messaging `checkpoint` commit strategy allows consumer applications to process messages in a stateful manner, while also respecting Kafka consumer scalability. +SmallRye Reactive Messaging `checkpoint` commit strategy allows consumer applications to process messages in a stateful manner, while also respecting Kafka consumer scalability. An incoming channel with `checkpoint` commit strategy persists consumer offsets on an external <>, such as a relational database or a key-value store. As a result of processing consumed records, the consumer application can accumulate an internal state for each topic-partition assigned to the Kafka consumer. @@ -1469,7 +1469,7 @@ which it expects to be sent back in the reply record. The replier can be implemented using a Reactive Messaging processor (see <>). For more information on Kafka Request Reply feature and advanced configuration options, -see the https://smallrye.io/smallrye-reactive-messaging/latest/kafka/request-reply/[Smallrye Reactive Messaging Documentation]. +see the https://smallrye.io/smallrye-reactive-messaging/latest/kafka/request-reply/[SmallRye Reactive Messaging Documentation]. [[processing-messages]] == Processing Messages @@ -3092,7 +3092,7 @@ perform database updates and commit the Kafka transaction only if the database t The following example demonstrates: * Receive a payload by serving HTTP requests using Quarkus REST, -* Limit concurrency of that HTTP endpoint using Smallrye Fault Tolerance, +* Limit concurrency of that HTTP endpoint using SmallRye Fault Tolerance, * Start a Kafka transaction and send the payload to Kafka record, * Store the payload in the database using Hibernate Reactive with Panache, * Commit the Kafka transaction only if the entity is persisted successfully. diff --git a/_guides/logging.adoc b/_guides/logging.adoc index ceca6071f7e..aa47489dade 100644 --- a/_guides/logging.adoc +++ b/_guides/logging.adoc @@ -631,6 +631,11 @@ Use a centralized location to efficiently collect, store, and analyze log data f To send logs to a centralized tool such as Graylog, Logstash, or Fluentd, see the Quarkus xref:centralized-log-management.adoc[Centralized log management] guide. +=== OpenTelemetry logging +Logging entries from all appenders can be sent using OpenTelemetry Logging. + +For details, see the Quarkus xref:opentelemetry-logging.adoc[OpenTelemetry Logging] guide. + == Configure logging for `@QuarkusTest` Enable proper logging for `@QuarkusTest` by setting the `java.util.logging.manager` system property to `org.jboss.logmanager.LogManager`. diff --git a/_guides/mailer-reference.adoc b/_guides/mailer-reference.adoc index d433c79e631..14d523190fb 100644 --- a/_guides/mailer-reference.adoc +++ b/_guides/mailer-reference.adoc @@ -356,7 +356,7 @@ the only way to get the new value would be to restart the application. [NOTE] Do use Vault, you need the https://github.com/quarkiverse/quarkus-vault[Quarkus Vault] extension. -More details about this extension and its configuration can be found in the https://quarkiverse.github.io/quarkiverse-docs/quarkus-vault/dev/index.html[extension documentation]. +More details about this extension and its configuration can be found in the https://docs.quarkiverse.io/quarkus-vault/dev/index.html[extension documentation]. [TIP] diff --git a/_guides/maven-tooling.adoc b/_guides/maven-tooling.adoc index 233cb4bf9e7..2491ec6f318 100644 --- a/_guides/maven-tooling.adoc +++ b/_guides/maven-tooling.adoc @@ -595,7 +595,7 @@ Uber-Jar's final name is configurable via a Maven's build settings `finalName` o ==== Uber-Jar file name suffix -By default the generated uber JAR file name will have the `-runner` suffix, unless it was overriden by configuring a custom one with `quarkus.package.runner-suffix` configuration option. +By default the generated uber JAR file name will have the `-runner` suffix, unless it was overridden by configuring a custom one with `quarkus.package.runner-suffix` configuration option. If the runner suffix is not desired, it can be disabled by setting `quarkus.package.jar.add-runner-suffix` configuration option to `false`, in which case the uber JAR will replace the original JAR file generated by `maven-jar-plugin` for the application module. diff --git a/_guides/messaging.adoc b/_guides/messaging.adoc index 38bd19ddd68..e7cc35d6d2b 100644 --- a/_guides/messaging.adoc +++ b/_guides/messaging.adoc @@ -41,7 +41,7 @@ Some of these extensions are maintained in the core Quarkus repository: Some extensions are contributed and maintained by the community: -* link:{camel-smallrye-reactive-messaging}[Camel Smallrye Reactive Messaging] +* link:{camel-smallrye-reactive-messaging}[Camel SmallRye Reactive Messaging] * link:{nats-jetstream}[Nats Jetstream Connector] * link:{solace-quarkus}[Solace Messaging Connector] * link:{http-websocket-connector}[Reactive HTTP and WebSocket Connector] @@ -562,7 +562,7 @@ This is the case, for example, for Kafka, where multiple consumers can consume d == Health Checks -Together with the Smallrye Health extension, Quarkus Messaging extensions provide health check support per channel. +Together with the SmallRye Health extension, Quarkus Messaging extensions provide health check support per channel. The implementation of _startup_, _readiness_ and _liveness_ checks depends on the connector. Some connectors allow configuring the health check behavior or disabling them completely or per channel. diff --git a/_guides/mongodb-panache.adoc b/_guides/mongodb-panache.adoc index 60ab35867ab..bef7cf9c635 100644 --- a/_guides/mongodb-panache.adoc +++ b/_guides/mongodb-panache.adoc @@ -572,12 +572,14 @@ Here are some query examples: - `amount > ?1 and firstname != ?2` will be mapped to `{'amount': {'$gt': ?1}, 'firstname': {'$ne': ?2}}` - `lastname like ?1` will be mapped to `{'lastname': {'$regex': ?1}}`. Be careful that this will be link:https://docs.mongodb.com/manual/reference/operator/query/regex/#op._S_regex[MongoDB regex] support and not SQL like pattern. - `lastname is not null` will be mapped to `{'lastname':{'$exists': true}}` -- `status in ?1` will be mapped to `{'status':{$in: [?1]}}` +- `status in ?1` will be mapped to `{'status':{$in: ?1}}` WARNING: MongoDB queries must be valid JSON documents, using the same field multiple times in a query is not allowed using PanacheQL as it would generate an invalid JSON (see link:https://github.com/quarkusio/quarkus/issues/12086[this issue on GitHub]). +WARNING: Prior to Quarkus 3.16, when using `$in` with a list, you had to write your query with `{'status':{$in: [?1]}}`. Starting with Quarkus 3.16, make sure you use `{'status':{$in: ?1}}` instead. The list will be properly expanded with surrounding square brackets. + We also handle some basic date type transformations: all fields of type `Date`, `LocalDate`, `LocalDateTime` or `Instant` will be mapped to the link:https://docs.mongodb.com/manual/reference/bson-types/#date[BSON Date] using the `ISODate` type (UTC datetime). The MongoDB POJO codec doesn't support `ZonedDateTime` and `OffsetDateTime` so you should convert them prior usage. diff --git a/_guides/mongodb.adoc b/_guides/mongodb.adoc index 811a332c59d..59d936c5544 100644 --- a/_guides/mongodb.adoc +++ b/_guides/mongodb.adoc @@ -708,40 +708,6 @@ This means that the `org.acme.MyVariable` class is not known to GraalVM, the rem More details about the `@RegisterForReflection` annotation can be found on the xref:writing-native-applications-tips.adoc#registerForReflection[native application tips] page. ==== -== Using mongo+srv:// urls - -`mongo+srv://` urls are supported out of the box in JVM mode. -However, in native, the default DNS resolver, provided by the MongoDB client, uses JNDI and does not work in native mode. - -If you need to use `mongo+srv://` in native mode, you can configure an alternative DNS resolver. -This feature is **experimental** and may introduce a difference between JVM applications and native applications. - -To enable the alternative DNS resolver, use: - -[source, properties] ----- -quarkus.mongodb.native.dns.use-vertx-dns-resolver=true ----- - -As indicated in the property name, it uses Vert.x to retrieve the DNS records. -By default, it tries to read the first `nameserver` from `/etc/resolv.conf`, if this file exists. -You can also configure your DNS server: - -[source,properties] ----- -quarkus.mongodb.native.dns.use-vertx-dns-resolver=true -quarkus.mongodb.native.dns.server-host=10.0.0.1 -quarkus.mongodb.native.dns.server-port=53 # 53 is the default port ----- - -Also, you can configure the lookup timeout using: - -[source,properties] ----- -quarkus.mongodb.native.dns.use-vertx-dns-resolver=true -quarkus.mongodb.native.dns.lookup-timeout=10s # the default is 5s ----- - == Customize the Mongo client configuration programmatically If you need to customize the Mongo client configuration programmatically, you need to implement the `io.quarkus.mongodb.runtime.MongoClientCustomizer` interface and expose it as a CDI _application scoped_ bean: diff --git a/_guides/native-reference.adoc b/_guides/native-reference.adoc index 41466ced2f7..f2ae15a6aee 100644 --- a/_guides/native-reference.adoc +++ b/_guides/native-reference.adoc @@ -602,7 +602,7 @@ For example: ---- $ ./mvnw verify -DskipITs=false -Dquarkus.test.integration-test-profile=test-with-native-agent ... -[INFO] --- failsafe:3.3.1:integration-test (default) @ new-project --- +[INFO] --- failsafe:3.5.0:integration-test (default) @ new-project --- ... [INFO] ------------------------------------------------------- [INFO] T E S T S diff --git a/_guides/observability-devservices-lgtm.adoc b/_guides/observability-devservices-lgtm.adoc index b34862ceb86..90b65608a3d 100644 --- a/_guides/observability-devservices-lgtm.adoc +++ b/_guides/observability-devservices-lgtm.adoc @@ -97,6 +97,10 @@ If you miss the message you can always check the port with this Docker command: docker ps | grep grafana ---- +Another option is to use the Dev UI as the Grafana URL link will be available and if selected will open a new browser tab directly to the running Grafana instance: + +image::dev-ui-observability-card.png[alt=Dev UI LGTM, align=center,width=80%] + === Additional configuration This extension will configure your `quarkus-opentelemetry` and `quarkus-micrometer-registry-otlp` extensions to send data to the OTel Collector bundled with the Grafana OTel LGTM image. diff --git a/_guides/openapi-swaggerui.adoc b/_guides/openapi-swaggerui.adoc index ab660bbb6b9..514d5af986d 100644 --- a/_guides/openapi-swaggerui.adoc +++ b/_guides/openapi-swaggerui.adoc @@ -162,7 +162,7 @@ public class FruitResourceTest { == Expose OpenAPI Specifications -Quarkus provides the https://github.com/smallrye/smallrye-open-api/[Smallrye OpenAPI] extension compliant with the +Quarkus provides the https://github.com/smallrye/smallrye-open-api/[SmallRye OpenAPI] extension compliant with the https://github.com/eclipse/microprofile-open-api/[MicroProfile OpenAPI] specification in order to generate your API https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md[OpenAPI v3 specification]. @@ -573,6 +573,11 @@ If you plan to consume this application from a Single Page Application running o == Configuration Reference +=== MicroProfile OpenAPI + +MicroProfile OpenAPI Core configuration is defined in https://download.eclipse.org/microprofile/microprofile-open-api-3.1.1/microprofile-openapi-spec-3.1.1.html#_core_configurations[MicroProfile OpenAPI Specification]. +More information about the MicroProfile OpenAPI annotations can be found in the https://download.eclipse.org/microprofile/microprofile-open-api-3.1.1/apidocs/org/eclipse/microprofile/openapi/annotations/package-summary.html[MicroProfile OpenAPI API Javadoc]. + === OpenAPI include::{generated-dir}/config/quarkus-smallrye-openapi.adoc[opts=optional, leveloffset=+1] diff --git a/_guides/opentelemetry-logging.adoc b/_guides/opentelemetry-logging.adoc new file mode 100644 index 00000000000..5621cc747ee --- /dev/null +++ b/_guides/opentelemetry-logging.adoc @@ -0,0 +1,176 @@ +//// +This guide is maintained in the main Quarkus repository +and pull requests should be submitted there: +https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc +//// += Using OpenTelemetry Logging +include::_attributes.adoc[] +:extension-status: preview +:categories: observability +:summary: This guide explains how your Quarkus application can utilize OpenTelemetry Logging to provide distributed logging for interactive web applications. +:topics: observability,opentelemetry,logging +:extensions: io.quarkus:quarkus-opentelemetry + +This guide explains how your Quarkus application can utilize https://opentelemetry.io/[OpenTelemetry] (OTel) to provide +distributed logging for interactive web applications. + +include::{includes}/extension-status.adoc[] + +[NOTE] +==== +- OpenTelemetry Logging is considered _tech preview_ and is disabled by default. +- The xref:opentelemetry.adoc[OpenTelemetry Guide] is available with signal independent information about the OpenTelemetry extension. +==== + +== Prerequisites + +:prerequisites-docker-compose: +include::{includes}/prerequisites.adoc[] + +== Architecture + +In this guide, we create a straightforward REST application to demonstrate distributed logging, similar to the other OpenTelemetry guides. + +== Solution + +We recommend that you follow the instructions in the next sections and create the application step by step. +However, you can skip right to the completed example. + +Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive]. + +The solution is located in the `opentelemetry-quickstart` link:{quickstarts-tree-url}/opentelemetry-quickstart[directory]. + +== Creating the Maven project + +First, we need a new project. Create a new project with the following command: + +:create-app-artifact-id: opentelemetry-quickstart +:create-app-extensions: rest,quarkus-opentelemetry +include::{includes}/devtools/create-app.adoc[] + +This command generates the Maven project and imports the `quarkus-opentelemetry` extension, +which includes the default OpenTelemetry support, +and a gRPC span exporter for https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md[OTLP]. + +If you already have your Quarkus project configured, you can add the `quarkus-opentelemetry` extension +to your project by running the following command in your project base directory: + +:add-extension-extensions: opentelemetry +include::{includes}/devtools/extension-add.adoc[] + +This will add the following to your build file: + +[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"] +.pom.xml +---- + + io.quarkus + quarkus-opentelemetry + +---- + +[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"] +.build.gradle +---- +implementation("io.quarkus:quarkus-opentelemetry") +---- + +=== Examine the Jakarta REST resource + +Create a `src/main/java/org/acme/opentelemetry/TracedResource.java` file with the following content: + +[source,java] +---- +package org.acme.opentelemetry; + +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; +import jakarta.ws.rs.Produces; +import jakarta.ws.rs.core.MediaType; +import org.jboss.logging.Logger; + +@Path("/hello") +public class TracedResource { + + private static final Logger LOG = Logger.getLogger(TracedResource.class); + + @GET + @Produces(MediaType.TEXT_PLAIN) + public String hello() { + LOG.info("hello"); + return "hello"; + } +} +---- + +If you have followed the tracing guide, this class will seem familiar. The main difference is that now, the `hello` message logged with `org.jboss.logging.Logger` will end up in the OpenTelemetry logs. + +=== Create the configuration + +The only mandatory configuration for OpenTelemetry Logging is the one enabling it: +[source,properties] +---- +quarkus.otel.logs.enabled=true +---- + +To change any of the default property values, here is an example on how to configure the default OTLP gRPC Exporter within the application, using the `src/main/resources/application.properties` file: + +[source,properties] +---- +quarkus.application.name=myservice // <1> +quarkus.otel.logs.enabled=true // <2> +quarkus.otel.exporter.otlp.logs.endpoint=http://localhost:4317 // <3> +quarkus.otel.exporter.otlp.logs.headers=authorization=Bearer my_secret // <4> +---- + +<1> All logs created from the application will include an OpenTelemetry `Resource` indicating the logs were created by the `myservice` application. +If not set, it will default to the artifact id. +<2> Enable the OpenTelemetry logging. +Must be set at build time. +<3> gRPC endpoint to send the logs. +If not set, it will default to `http://localhost:4317`. +<4> Optional gRPC headers commonly used for authentication. + +To configure the connection using the same properties for all signals, please check the base xref:opentelemetry.adoc#create-the-configuration[configuration section of the OpenTelemetry guide]. + +== Run the application + +First we need to start a system to visualise the OpenTelemetry data. +We have 2 options: + +* Start an all-in-one Grafana OTel LGTM system for traces, metrics and logs. + +=== See the data + +==== Grafana OTel LGTM option + +* Take a look at: xref:observability-devservices-lgtm.adoc[Getting Started with Grafana-OTel-LGTM]. + +This features a Quarkus Dev service including a Grafana for visualizing data, Loki to store logs, Tempo to store traces and Prometheus to store metrics. Also provides and OTel collector to receive the data. + +==== Logging exporter + +You can output all logs to the console by setting the exporter to `logging` in the `application.properties` file: +[source, properties] +---- +quarkus.otel.logs.exporter=logging <1> +---- + +<1> Set the exporter to `logging`. +Normally you don't need to set this. +The default is `cdi`. + + +Also add this dependency to your project: +[source,xml] +---- + + io.opentelemetry + opentelemetry-exporter-logging + +---- + +[[configuration-reference]] +== OpenTelemetry Configuration Reference + +See the main xref:opentelemetry.adoc#configuration-reference[OpenTelemetry Guide configuration] reference. diff --git a/_guides/opentelemetry-metrics.adoc b/_guides/opentelemetry-metrics.adoc index 4efa5e11c70..a974d934e29 100644 --- a/_guides/opentelemetry-metrics.adoc +++ b/_guides/opentelemetry-metrics.adoc @@ -5,6 +5,7 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using OpenTelemetry Metrics include::_attributes.adoc[] +:extension-status: preview :categories: observability :summary: This guide explains how your Quarkus application can utilize OpenTelemetry to provide metrics for interactive web applications. :topics: observability,opentelemetry,metrics @@ -13,8 +14,11 @@ include::_attributes.adoc[] This guide explains how your Quarkus application can utilize https://opentelemetry.io/[OpenTelemetry] (OTel) to provide metrics for interactive web applications. +include::{includes}/extension-status.adoc[] + [NOTE] ==== +- OpenTelemetry Metrics is considered _tech preview_ and is disabled by default. - The xref:opentelemetry.adoc[OpenTelemetry Guide] is available with signal independent information about the OpenTelemetry extension. - If you search more information about OpenTelemetry Tracing, please refer to the xref:opentelemetry-tracing.adoc[OpenTelemetry Tracing Guide]. ==== @@ -123,9 +127,13 @@ Here we are creating a counter for the number of invocations of the `hello()` me === Create the configuration -There are no mandatory configurations for the extension to work. +The only mandatory configuration for OpenTelemetry Metrics is the one enabling it: +[source,properties] +---- +quarkus.otel.metrics.enabled=true +---- -If you need to change any of the default property values, here is an example on how to configure the default OTLP gRPC Exporter within the application, using the `src/main/resources/application.properties` file: +To change any of the default property values, here is an example on how to configure the default OTLP gRPC Exporter within the application, using the `src/main/resources/application.properties` file: [source,properties] ---- @@ -174,6 +182,15 @@ The default is `cdi`. <2> Set the interval to export the metrics. The default is `1m`, which is too long for debugging. +Also add this dependency to your project: +[source,xml] +---- + + io.opentelemetry + opentelemetry-exporter-logging + +---- + === Start the application Now we are ready to run our application. diff --git a/_guides/opentelemetry-tracing.adoc b/_guides/opentelemetry-tracing.adoc index 088dbbf14a0..ef62e35cbb4 100644 --- a/_guides/opentelemetry-tracing.adoc +++ b/_guides/opentelemetry-tracing.adoc @@ -359,7 +359,7 @@ quarkus.otel.traces.sampler.arg=0.5 [TIP] ==== -An interesting use case for the sampler is to activate and deactivate tracing export at runtime, acording to this example: +An interesting use case for the sampler is to activate and deactivate tracing export at runtime, according to this example: [source,application.properties] ---- # build time property only: @@ -371,33 +371,6 @@ quarkus.otel.traces.sampler.arg=0.0 ---- ==== -[NOTE] -==== -Quarkus 3.0 introduced breaking changes on the configuration. - -Sampler related property names and values change to comply with the latest Java OpenTelemetry SDK. During a transition period it will be possible to set the new configuration values in the old property because we are mapping `quarkus.opentelemetry.tracer.sampler` -> `quarkus.otel.traces.sampler`. - -If the sampler is parent based, there is no need to set, the now dropped property, `quarkus.opentelemetry.tracer.sampler.parent-based`. - -The values you need to set on `quarkus.opentelemetry.tracer.sampler` are now: - -|=== -|Old Sampler config value |New Sampler config value|New Sampler config value (Parent based) - -|`on` -|`always_on` -|`parentbased_always_on` - -|`off` -|`always_off` -|`parentbased_always_off` - -|`ratio` -|`traceidratio` -|`parentbased_traceidratio` -|=== -==== - If you need to use a custom sampler there are now 2 different ways: ==== Sampler CDI Producer diff --git a/_guides/opentelemetry.adoc b/_guides/opentelemetry.adoc index f3a79b928b7..395296b218b 100644 --- a/_guides/opentelemetry.adoc +++ b/_guides/opentelemetry.adoc @@ -18,15 +18,14 @@ On these page we show the signal independent features of the extension. [NOTE] ==== -- The old OpenTelemetry guide has been split into this generic guide, the xref:opentelemetry-tracing.adoc[OpenTelemetry Tracing Guide] and the new xref:opentelemetry-metrics.adoc[OpenTelemetry Metrics Guide] has been created. -- OpenTelemetry Logging is not yet supported. +- The old OpenTelemetry guide has been split into this generic guide, the xref:opentelemetry-tracing.adoc[OpenTelemetry Tracing Guide], the new xref:opentelemetry-metrics.adoc[OpenTelemetry Metrics Guide] and the xref:opentelemetry-logging.adoc[OpenTelemetry Logging Guide]. - The use of *the https://opentelemetry.io/docs/instrumentation/java/automatic/[OpenTelemetry Agent] is not needed nor recommended*. Quarkus Extensions and the libraries they provide, are directly instrumented. That agent doesn't work with native mode. ==== == Introduction https://opentelemetry.io/docs/what-is-opentelemetry/[OpenTelemetry] is an Observability framework and toolkit designed to create and manage telemetry data such as traces, metrics, and logs. Crucially, OpenTelemetry is vendor- and tool-agnostic. -Quarkus provides manual and automatic instrumentation for tracing and manual instrumentation capabilities for metrics. +Quarkus provides manual and automatic instrumentation for tracing and manual instrumentation capabilities for metrics. This will allow Quarkus based applications to be observable by tools and services supporting OpenTelemetry. @@ -63,6 +62,17 @@ For now only manual instrumentation is supported. You can use the OpenTelemetry In the future, we plan to bridge current Micrometer metrics to OpenTelemetry and maintain compatibility when possible. +=== xref:opentelemetry-logging.adoc[OpenTelemetry Logging Guide] + +==== Enable Logs +The logging functionality is experimental and *off* by default. You will need to activate it by setting: + +[source,properties] +---- +quarkus.otel.logs.enabled=true +---- +At build time on your `application.properties` file. + == Using the extension If you already have your Quarkus project, you can add the `quarkus-opentelemetry` extension diff --git a/_guides/picocli.adoc b/_guides/picocli.adoc index 641dfa08312..2545b9f81bd 100644 --- a/_guides/picocli.adoc +++ b/_guides/picocli.adoc @@ -300,6 +300,11 @@ annotationProcessor 'info.picocli:picocli-codegen' In the development mode, i.e. when running `mvn quarkus:dev`, the application is executed and restarted every time the `Space bar` key is pressed. You can also pass arguments to your command line app via the `quarkus.args` system property, e.g. `mvn quarkus:dev -Dquarkus.args='--help'` and `mvn quarkus:dev -Dquarkus.args='-c -w --val 1'`. For Gradle projects, arguments can be passed using `--quarkus-args`. +[NOTE] +==== +If you're creating a typical Quarkus application (e.g., HTTP-based services) that includes command-line functionality, you'll need to handle the application's lifecycle differently. In the `Runnable.run()` method of your command, make sure to use `Quarkus.waitForExit()` or `Quarkus.asyncExit()`. This will prevent the application from shutting down prematurely and ensure a proper shutdown process. +==== + == Kubernetes support Once you have your command line application, you can also generate the resources necessary to install and use this application in Kubernetes by adding the `kubernetes` extension. To install the `kubernetes` extension, run the following command in your project base directory. diff --git a/_guides/qute-reference.adoc b/_guides/qute-reference.adoc index ec2baa1116b..68a15868301 100644 --- a/_guides/qute-reference.adoc +++ b/_guides/qute-reference.adoc @@ -335,7 +335,7 @@ You can learn more about virtual methods in the <> is used. The first part of the expression is always resolved against the <>. If no result is found for the first part, it's resolved against the parent context object (if available). For an expression that starts with a namespace the current context object is found using all the available ``NamespaceResolver``s. @@ -1451,6 +1451,11 @@ NOTE: The template rendering is divided in two phases. During the first phase, w ==== Value Resolvers Value resolvers are used when evaluating expressions. +First the resolvers that apply to the given `EvalContext` are filtered. +Then the resolver with _highest priority_ is used to resolve the data. +If a `io.quarkus.qute.Results.NotFound` object is returned then the next available resolver is used instead. +However, `null` return value is considered a valid result. + A custom `io.quarkus.qute.ValueResolver` can be registered programmatically via `EngineBuilder.addValueResolver()`. .`ValueResolver` Builder Example @@ -1462,6 +1467,10 @@ engineBuilder.addValueResolver(ValueResolver.builder() .build()); ---- +TIP: In Quarkus, the <> annotation can be used to register a `ValueResolver` implemented as a CDI bean. + +NOTE: Keep in mind that the reflection-based value resolver has priority `-1` and the max priority value for resolvers generated from <> and <> is `10`. + [[template-locator]] ==== Template Locator @@ -1701,15 +1710,31 @@ A CDI bean annotated with `@Named` can be referenced in any template through `cd NOTE: `@Named @Dependent` beans are shared across all expressions in a template for a single rendering operation, and destroyed after the rendering finished. All expressions with `cdi` and `inject` namespaces are validated during build. - For the expression `cdi:personService.findPerson(10).name`, the implementation class of the injected bean must either declare the `findPerson` method or a matching <> must exist. - For the expression `inject:foo.price`, the implementation class of the injected bean must either have the `price` property (e.g. a `getPrice()` method) or a matching <> must exist. NOTE: A `ValueResolver` is also generated for all beans annotated with `@Named` so that it's possible to access its properties without reflection. TIP: If your application serves xref:http-reference.adoc[HTTP requests] you can also inject the current `io.vertx.core.http.HttpServerRequest` via the `inject` namespace, e.g. `{inject:vertxRequest.getParam('foo')}`. +Sometimes it may be necessary to access public methods and properties of a CDI bean that is not annotated with `@Named`. +However, if you don't control the source of the bean it is not possible to add the `@Named` annotation. +Nevertheless, it is possible to create an intermediate CDI bean annotated with `@Named`. +This intermediate bean can inject the bean in question and make it accessible. +A Java record is a very convenient way to define such an intermediate CDI bean. + +[source,java] +---- +@Named <1> <2> +public record UserData(UserInfo info, @LoggedIn String username) { <3> +} +---- +<1> If no name is explicitly specified by the `value` member the https://jakarta.ee/specifications/cdi/4.1/jakarta-cdi-spec-4.1#default_name[default name is assigned] - the simple name of the bean class, after converting the first character to lower case. In this particular case, the default name is `userData`. +<2> The `@Singleton` scope is added automatically. +<3> All parameters of the canonical constructor are injection points. The accessor methods can be used to obtain the injected bean. + +And then in a template you can simply use `{cdi:userData.info}` or `{cdi:userData.username}`. + [[typesafe_expressions]] === Type-safe Expressions diff --git a/_guides/rabbitmq-dev-services.adoc b/_guides/rabbitmq-dev-services.adoc index 7a6fd287081..e2e986e8c41 100644 --- a/_guides/rabbitmq-dev-services.adoc +++ b/_guides/rabbitmq-dev-services.adoc @@ -13,7 +13,7 @@ Dev Services for RabbitMQ automatically starts a RabbitMQ broker in dev mode and So, you don't have to start a broker manually. The application is configured automatically. -== Enabling / Disabling Dev Services for RabbitMQ +== Enabling / disabling Dev Services for RabbitMQ Dev Services for RabbitMQ is automatically enabled unless: @@ -22,15 +22,15 @@ Dev Services for RabbitMQ is automatically enabled unless: - all the Reactive Messaging RabbitMQ channels have the `host` or `port` attributes set Dev Services for RabbitMQ relies on Docker to start the broker. -If your environment does not support Docker, you will need to start the broker manually, or connect to an already running broker. -You can configure the broker access using the `rabbitmq-host`, `rabbitmq-port`, `rabbitmq-username` and `rabbitmq-password` properties. +If your environment does not support Docker, you must start the broker manually, or connect to an already running broker. +You can configure the broker access by using the `rabbitmq-host`, `rabbitmq-port`, `rabbitmq-username` and `rabbitmq-password` properties. == Shared broker -Most of the time you need to share the broker between applications. +Most of the time you want to share the broker between applications. Dev Services for RabbitMQ implements a _service discovery_ mechanism for your multiple Quarkus applications running in _dev_ mode to share a single broker. -NOTE: Dev Services for RabbitMQ starts the container with the `quarkus-dev-service-rabbitmq` label which is used to identify the container. +NOTE: Dev Services for RabbitMQ starts the container with the `quarkus-dev-service-rabbitmq` label, which is used to identify the container. If you need multiple (shared) brokers, you can configure the `quarkus.rabbitmq.devservices.service-name` attribute and indicate the broker name. It looks for a container with the same value, or starts a new one if none can be found. @@ -48,7 +48,7 @@ You can set the port by configuring the `quarkus.rabbitmq.devservices.port` prop == Configuring the image Dev Services for RabbitMQ uses official images available at https://hub.docker.com/_/rabbitmq. -You can configure the image and version using the `quarkus.rabbitmq.devservices.image-name` property: +You can configure the image and version with the `quarkus.rabbitmq.devservices.image-name` property: [source, properties] ---- @@ -58,14 +58,24 @@ quarkus.rabbitmq.devservices.image-name=rabbitmq:latest == Access the management UI By default, Dev Services for RabbitMQ use the official image with the `management` tag. This means you have the https://github.com/docker-library/docs/tree/master/rabbitmq#management-plugin[management plugin] available. You can use the xref:dev-ui.adoc[Dev UI] to find the HTTP port randomly affected -or configure a static one via `quarkus.rabbitmq.devservices.http-port`. +or configure a static one by using `quarkus.rabbitmq.devservices.http-port`. -== Predefined Topology +== Predefined topology -Dev Services for RabbitMQ supports defining topology upon broker start. You can define Exchanges, Queues, and -Bindings using standard Quarkus configuration. +Dev Services for RabbitMQ supports defining topology upon broker start. You can define Virtual Hosts, Exchanges, Queues, +and Bindings through standard Quarkus configuration. -=== Defining Exchanges +=== Defining virtual hosts + +RabbitMQ uses a default virtual host of `/`. To define additional RabbitMQ virtual hosts, provide the names +of the virtual hosts in the `quarkus.rabbitmq.devservices.vhosts` key: + +[source, properties] +---- +quarkus.rabbitmq.devservices.vhosts=my-vhost-1,my-vhost-2 +---- + +=== Defining exchanges To define a RabbitMQ exchange you provide the exchange's name after the `quarkus.rabbitmq.devservices.exchanges` key, followed by one (or more) of the exchange's properties: @@ -75,16 +85,17 @@ followed by one (or more) of the exchange's properties: quarkus.rabbitmq.devservices.exchanges.my-exchange.type=topic # defaults to 'direct' quarkus.rabbitmq.devservices.exchanges.my-exchange.auto-delete=false # defaults to 'false' quarkus.rabbitmq.devservices.exchanges.my-exchange.durable=true # defaults to 'false' +quarkus.rabbitmq.devservices.exchanges.my-exchange.vhost=my-vhost # defaults to '/' ---- -Additionally, any additional arguments may be provided to the exchange's definition by using the `arguments` key: +Additionally, any additional arguments can be provided to the exchange's definition by using the `arguments` key: [source, properties] ---- quarkus.rabbitmq.devservices.exchanges.my-exchange.arguments.alternate-exchange=another-exchange ---- -=== Defining Queues +=== Defining queues To define a RabbitMQ queue you provide the queue's name after the `quarkus.rabbitmq.devservices.queues` key, followed by one (or more) of the queue's properties: @@ -93,16 +104,17 @@ followed by one (or more) of the queue's properties: ---- quarkus.rabbitmq.devservices.queues.my-queue.auto-delete=false # defaults to 'false' quarkus.rabbitmq.devservices.queues.my-queue.durable=true # defaults to 'false' +quarkus.rabbitmq.devservices.queues.my-queue.vhost=my-vhost # defaults to '/' ---- -Additionally, any additional arguments may be provided to the queue's definition by using the `arguments` key: +Additionally, any additional arguments can be provided to the queue's definition by using the `arguments` key: [source, properties] ---- quarkus.rabbitmq.devservices.queues.my-queue.arguments.x-dead-letter-exchange=another-exchange ---- -=== Defining Bindings +=== Defining bindings To define a RabbitMQ binding you provide the binding's name after the `quarkus.rabbitmq.devservices.bindings` key, followed by one (or more) of the binding's properties: @@ -113,12 +125,13 @@ quarkus.rabbitmq.devservices.bindings.a-binding.source=my-exchange # defaul quarkus.rabbitmq.devservices.bindings.a-binding.routing-key=some-key # defaults to '#' quarkus.rabbitmq.devservices.bindings.a-binding.destination=my-queue # defaults to name of binding quarkus.rabbitmq.devservices.bindings.a-binding.destination-type=queue # defaults to 'queue' +quarkus.rabbitmq.devservices.bindings.a-binding.vhost=my-vhost # defaults to '/' ---- NOTE: The name of the binding is only used for the purposes of the Dev Services configuration and is not part of the binding defined in RabbitMQ. -Additionally, any additional arguments may be provided to the binding's definition by using the `arguments` key: +Additionally, any additional arguments can be provided to the binding's definition by using the `arguments` key: [source, properties] ---- diff --git a/_guides/reactive-routes.adoc b/_guides/reactive-routes.adoc index c8e5a0cfe86..a2608c64c85 100644 --- a/_guides/reactive-routes.adoc +++ b/_guides/reactive-routes.adoc @@ -716,7 +716,7 @@ The response body is never compressed if: - the route method is annotated with `@io.quarkus.vertx.http.Uncompressed`, or - the `Content-Type` header is not set. -TIP: By default, the following list of media types is compressed: `text/html`, `text/plain`, `text/xml`, `text/css`, `text/javascript` and `application/javascript`. +TIP: By default, the following list of media types is compressed: `text/html`, `text/plain`, `text/xml`, `text/css`, `text/javascript`, `application/javascript`, `application/json`, `application/graphql+json` and `application/xhtml+xml`. NOTE: If the client does not support HTTP compression then the response body is not compressed. diff --git a/_guides/redis-reference.adoc b/_guides/redis-reference.adoc index 313b6f7df5b..87cd8313d36 100644 --- a/_guides/redis-reference.adoc +++ b/_guides/redis-reference.adoc @@ -145,7 +145,7 @@ The Redis extension can operate in 4 distinct modes: * Simple client (probably what most users need). * Sentinel (when working with Redis in High Availability mode). * Cluster (when working with Redis in Clustered mode). -* Replication (single shard, one node write, multiple read). +* Replication (single shard, one node writes, multiple read). The connection url is configured with the `quarkus.redis.hosts` (or `quarkus.redis..hosts`) as follows: @@ -183,6 +183,22 @@ The client will obtain the URLs of actual Redis servers (master or replicas, dep Note that you practically never want to configure `quarkus.redis.role=sentinel`. This setting means that the Redis client will execute commands directly on one of the sentinel servers, instead of an actual Redis server guarded by the sentinels. +==== Automatic Failover + +In the sentinel mode, it is possible to configure automatic failover of _master_ connections: + +[source,properties] +---- +quarkus.redis.auto-failover=true +---- + +If enabled, the sentinel client will additionally create a connection to one sentinel node and watch for failover events. +When new master is elected, all connections to the old master are automatically closed and new connections to the new master are created. +Automatic failover makes sense for connections executing regular commands, but not for connections used to subscribe to Redis pub/sub channels. + +Note that there is a brief period of time between the old master failing and the new master being elected when the existing connections will temporarily fail all operations. +After the new master is elected, the connections will automatically fail over and start working again. + === Use the Cluster Mode When using Redis in cluster mode, you need to pass multiple _host urls_, configure the client type to `cluster` and configure the `replicas` mode: @@ -233,6 +249,30 @@ Set the `quarkus.redis.replicas` configuration property to: Note that replication in Redis is asynchronous, so replica nodes may be lagging behind the master node. +==== Static Topology + +In the replication mode, it is possible to reconfigure the Redis client to skip automatic discovery of the topology: + +[source,properties] +---- +quarkus.redis.topology=static +---- + +With static topology, the first node in the configuration is assumed to be a _master_ node, while the remaining nodes are assumed to be _replicas_. +The nodes are not verified; it is a responsibility of the application developer to ensure that the static configuration is correct. + +Note that automatic discovery of the topology is usually the preferred choice. +Static configuration should only be used when necessary. +One such case is _Amazon Elasticache for Redis (Cluster Mode Disabled)_, where: + +* master node should be set to the _primary endpoint_, and +* one replica node should be set to the _reader endpoint_. + +WARNING: Note that the reader endpoint of Elasticache for Redis (Cluster Mode Disabled) is a domain name which resolves to a CNAME record that points to one of the replicas. +The CNAME record to which the reader endpoint resolves changes over time. +This form of DNS-based load balancing does not work well with DNS resolution caching and connection pooling. +As a result, some replicas are likely to be underutilized. + === Connect to Redis Cloud To connect to redis cloud, you need the following properties: diff --git a/_guides/rest-client.adoc b/_guides/rest-client.adoc index bb2330f2465..1099003e892 100644 --- a/_guides/rest-client.adoc +++ b/_guides/rest-client.adoc @@ -337,6 +337,89 @@ Furthermore, the client can also send arbitrarily large files if one of the foll * `File` * `Path` +=== Getting other response properties + +==== Using RestResponse + +If you need to get more properties of the HTTP response than just the body, such as the status code +or headers, you can make your method return `org.jboss.resteasy.reactive.RestResponse` from a method. +An example of this could look like: + +[source,java] +---- +package org.acme.rest.client; + +import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; + +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; +import org.jboss.resteasy.reactive.RestQuery; +import org.jboss.resteasy.reactive.RestResponse; + +import java.util.Set; + +@Path("/extensions") +@RegisterRestClient +public interface ExtensionsService { + + @GET + RestResponse> getByIdResponseProperties(@RestQuery String id); +} +---- + +NOTE: You can also use the Jakarta REST type link:{jaxrsapi}/jakarta/ws/rs/core/Response.html[`Response`] but it is +not strongly typed to your entity. + +== Create the Jakarta REST resource + +Create the `src/main/java/org/acme/rest/client/ExtensionsResource.java` file with the following content: + + +[source,java] +---- +package org.acme.rest.client; + +import org.eclipse.microprofile.rest.client.inject.RestClient; + +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; +import java.util.Set; + +@Path("/extension") +public class ExtensionsResource { + + @RestClient // <1> + ExtensionsService extensionsService; + + + @GET + @Path("/id/{id}") + public Set id(String id) { + return extensionsService.getById(id); + } + + @GET + @Path("/properties") + public RestResponse> responseProperties(@RestQuery String id) { + RestResponse> clientResponse = extensionsService.getByIdResponseProperties(id); //<2> + String contentType = clientResponse.getHeaderString("Content-Type"); + int status = clientResponse.getStatus(); + String setCookie = clientResponse.getHeaderString("Set-Cookie"); + Date lastModified = clientResponse.getLastModified(); + + Log.infof("content-Type: %s status: %s Last-Modified: %s Set-Cookie: %s", contentType, status, lastModified, + setCookie); + + return RestResponse.fromResponse(clientResponse); + } +} +---- + +There are two interesting parts in this listing: + +<1> the client stub is injected with the `@RestClient` annotation instead of the usual CDI `@Inject` +<2> `org.jboss.resteasy.reactive.RestResponse` used as effective way of getting response properties via RestResponse directly from RestClient, +as described in <> == Create the configuration @@ -372,6 +455,11 @@ quarkus.rest-client.extensions-api.url=https://stage.code.quarkus.io/api quarkus.rest-client.extensions-api.scope=jakarta.inject.Singleton ---- +[IMPORTANT] +==== +Setting the base URL of the client is **mandatory**, however the REST Client supports per-invocation overrides of the base URL using the `@io.quarkus.rest.client.reactive.Url` annotation. +==== + === Disabling Hostname Verification To disable the SSL hostname verification for a specific REST client, add the following property to your configuration: @@ -406,40 +494,6 @@ quarkus.rest-client.alpn=true quarkus.rest-client.extensions-api.alpn=true ---- -== Create the Jakarta REST resource - -Create the `src/main/java/org/acme/rest/client/ExtensionsResource.java` file with the following content: - - -[source,java] ----- -package org.acme.rest.client; - -import org.eclipse.microprofile.rest.client.inject.RestClient; - -import jakarta.ws.rs.GET; -import jakarta.ws.rs.Path; -import java.util.Set; - -@Path("/extension") -public class ExtensionsResource { - - @RestClient // <1> - ExtensionsService extensionsService; - - - @GET - @Path("/id/{id}") - public Set id(String id) { - return extensionsService.getById(id); - } -} ----- - -There are two interesting parts in this listing: - -<1> the client stub is injected with the `@RestClient` annotation instead of the usual CDI `@Inject` - == Programmatic client creation with QuarkusRestClientBuilder Instead of annotating the client with `@RegisterRestClient`, and injecting @@ -1975,8 +2029,11 @@ To change this behavior, set the `quarkus.rest-client-reactive.scope` property t - it is not possible to set `HostnameVerifier` or `SSLContext` - a few things that don't make sense for a non-blocking implementations, such as setting the `ExecutorService`, don't work - - == Further reading * link:https://download.eclipse.org/microprofile/microprofile-rest-client-2.0/microprofile-rest-client-spec-2.0.html[MicroProfile Rest Client specification] + +== Configuration Reference + +include::{generated-dir}/config/quarkus-rest-client_quarkus.rest-client.adoc[opts=optional, leveloffset=+1] +include::{generated-dir}/config/quarkus-rest-client-config.adoc[opts=optional, leveloffset=+1] diff --git a/_guides/rest-migration.adoc b/_guides/rest-migration.adoc index e8b8b8680b0..6ba3120372f 100644 --- a/_guides/rest-migration.adoc +++ b/_guides/rest-migration.adoc @@ -225,7 +225,7 @@ extension is used by a specific set of users / applications. When opting for supporting both extensions, the deployment module of the custom extension will usually depend on the SPI modules - `quarkus-jaxrs-spi-deployment`, `quarkus-resteasy-common-spi`, `quarkus-rest-spi-deployment`, while the runtime modules will have `optional` dependencies on the runtime modules of both RESTEasy flavors. -A couple good examples of how Quarkus uses this strategy to support both RESTEasy flavors in the core repository can be seen [here](https://github.com/quarkusio/quarkus/pull/21089) and [here](https://github.com/quarkusio/quarkus/pull/20874). +A couple good examples of how Quarkus uses this strategy to support both RESTEasy flavors in the core repository can be seen https://github.com/quarkusio/quarkus/pull/21089[here] and https://github.com/quarkusio/quarkus/pull/20874[here]. In general, it should not be needed to have two different versions of the custom extension to support both flavors. Such a choice is only strictly necessary if it is desired for the extension consumers (i.e. Quarkus applications) to not have to select a RESTEasy version themselves. diff --git a/_guides/rest.adoc b/_guides/rest.adoc index 81aca81ff5a..aa0ffb37523 100644 --- a/_guides/rest.adoc +++ b/_guides/rest.adoc @@ -394,6 +394,30 @@ public class Endpoint { ---- <1> `BeanParam` is required to comply with the Jakarta REST specification so that libraries like OpenAPI can introspect the parameters. +Record classes are also supported, so you could rewrite the previous example as a record: + +[source,java] +---- + public record Parameters( + @RestPath + String type, + + @RestMatrix + String variant, + + @RestQuery + String age, + + @RestCookie + String level, + + @RestHeader("X-Cheese-Secret-Handshake") + String secretHandshake, + + @RestForm + String smell){} +---- + [[uri-parameters]] === [[declaring-uri-parameters]] Declaring URI parameters @@ -3255,7 +3279,7 @@ The response body is never compressed if: - the resource method is annotated with `@io.quarkus.vertx.http.Uncompressed`, or - the `Content-Type` header is not set. -TIP: By default, the following list of media types is compressed: `text/html`, `text/plain`, `text/xml`, `text/css`, `text/javascript` and `application/javascript`. +TIP: By default, the following list of media types is compressed: `text/html`, `text/plain`, `text/xml`, `text/css`, `text/javascript`, `application/javascript`, `application/json`, `application/graphql+json` and `application/xhtml+xml`. NOTE: If the client does not support HTTP compression then the response body is not compressed. diff --git a/_guides/resteasy-client.adoc b/_guides/resteasy-client.adoc index a7df076880e..6116c395b60 100644 --- a/_guides/resteasy-client.adoc +++ b/_guides/resteasy-client.adoc @@ -670,3 +670,7 @@ describes how to set it up in detail. == Further reading * link:https://download.eclipse.org/microprofile/microprofile-rest-client-2.0/microprofile-rest-client-spec-2.0.html[MicroProfile Rest Client specification] + +== Configuration Reference + +include::{generated-dir}/config/quarkus-rest-client-config.adoc[opts=optional, leveloffset=+1] diff --git a/_guides/resteasy.adoc b/_guides/resteasy.adoc index 7c8c4f710ef..8dbd22a73fc 100644 --- a/_guides/resteasy.adoc +++ b/_guides/resteasy.adoc @@ -776,7 +776,7 @@ Configuration via an application-supplied subclass of `Application` is supported === Only a single Jakarta REST application -In contrast to Jakarta REST (and RESTeasy) running in a standard servlet container, Quarkus only supports the deployment of a single Jakarta REST application. +In contrast to Jakarta REST (and RESTEasy) running in a standard servlet container, Quarkus only supports the deployment of a single Jakarta REST application. If multiple Jakarta REST `Application` classes are defined, the build will fail with the message `Multiple classes have been annotated with @ApplicationPath which is currently not supported`. If multiple Jakarta REST applications are defined, the property `quarkus.resteasy.ignore-application-classes=true` can be used to ignore all explicit `Application` classes. diff --git a/_guides/scheduler-reference.adoc b/_guides/scheduler-reference.adoc index 8039175bb7a..f72c020ab44 100644 --- a/_guides/scheduler-reference.adoc +++ b/_guides/scheduler-reference.adoc @@ -64,7 +64,7 @@ Some CDI events are fired synchronously and asynchronously when specific events |Type |Event description |`io.quarkus.scheduler.SuccessfulExecution` -|An execution of a scheduled job completed successfuly. +|An execution of a scheduled job completed successfully. |`io.quarkus.scheduler.FailedExecution` |An execution of a scheduled job completed with an exception. @@ -220,7 +220,8 @@ Property Expressions. (Note that `"{property.path}"` style expressions are still void myMethod() { } ---- -=== Delayed Execution +[[delayed_start]] +=== Delayed Start of a Trigger `@Scheduled` provides two ways to delay the time a trigger should start firing at. @@ -249,9 +250,8 @@ void everyTwoSeconds() { } NOTE: If `@Scheduled#delay()` is set to a value greater than zero the value of `@Scheduled#delayed()` is ignored. The main advantage over `@Scheduled#delay()` is that the value is configurable. -The `delay` attribute supports <> including default values and nested -Property Expressions. (Note that `"{property.path}"` style expressions are still supported but don't offer the full functionality of Property Expressions.) - +The `delay` attribute supports <> including default values and nested Property Expressions. +(Note that `"{property.path}"` style expressions are still supported but don't offer the full functionality of Property Expressions.) [source,java] ---- @@ -260,6 +260,25 @@ void everyTwoSeconds() { } ---- <1> The config property `myMethod.delay.expr` is used to set the delay. +[[delayed_execution]] +=== Delayed Execution + +`@Scheduled#executionMaxDelay()` can be set to delay each execution of a scheduled method. +The value represents the maximum delay between the activation of the trigger and the execution of the scheduled method. +The actual delay is a randomized number between 0 and the maximum specified delay. + +The value is parsed with `DurationConverter#parseDuration(String)`. +It can be a property expression, in which case, the scheduler attempts to use the configured value instead: `@Scheduled(executionMaxDelay = "${myJob.maxDelay}")`. +Additionally, the property expression can specify a default value: +`@Scheduled(executionMaxDelay = "${myJob.maxDelay}:500ms}")`. + +[source,java] +---- +@Scheduled(every = "2s", executionMaxDelay = "500ms") <1> +void everyTwoSeconds() { } +---- +<1> The delay will be a value between 0 and 500 milliseconds. As a result, the period between to `everyTwoSeconds()` executions will be roughly between one and a half and two and a half seconds. + [[concurrent_execution]] === Concurrent Execution diff --git a/_guides/security-architecture.adoc b/_guides/security-architecture.adoc index 46196c04c90..f4f17dda6d9 100644 --- a/_guides/security-architecture.adoc +++ b/_guides/security-architecture.adoc @@ -15,7 +15,7 @@ The primary mechanism for securing HTTP applications in Quarkus is the `HttpAuth == Overview of the Quarkus Security architecture -When a client sends an HTTP request, Quarkus Security orchestrates security authentication and authorization by interacting with several built-in core components, including `HttpAuthenticationMechanism`, `IdentityProvider`, and `SecurityIdentityAugmentor`. +When a client sends a HTTP request, Quarkus Security orchestrates security authentication and authorization by interacting with several built-in core components, including `HttpAuthenticationMechanism`, `IdentityProvider`, and `SecurityIdentityAugmentor`. The sequential security validation process results in one of three outcomes: diff --git a/_guides/security-authentication-mechanisms.adoc b/_guides/security-authentication-mechanisms.adoc index 4ff538208f2..95a32393ed9 100644 --- a/_guides/security-authentication-mechanisms.adoc +++ b/_guides/security-authentication-mechanisms.adoc @@ -49,7 +49,7 @@ ifndef::no-webauthn-authentication[] endif::no-webauthn-authentication[] ifndef::no-quarkus-kerberos[] -|Kerberos ticket |link:https://quarkiverse.github.io/quarkiverse-docs/quarkus-kerberos/dev/index.html[Kerberos] +|Kerberos ticket |link:https://docs.quarkiverse.io/quarkus-kerberos/dev/index.html[Kerberos] endif::no-quarkus-kerberos[] |==== @@ -322,7 +322,7 @@ quarkus.http.auth.policy.role-policy-cert.roles-allowed=user,admin <2> <1> The `cert-role-mappings.properties` classpath resource contains a map of certificate's CN values to roles in the form `CN=role` or `CN=role1,role2`, etc. Let us assume it contains three entries: `alice=user,admin`, `bob=user` and `jdoe=tester`. <2> Use HTTP security policy to require that `SecurityIdentity` must have either `user` or `admin` roles for the requests to be authorized. -Given the preceeding configuration, the request is authorized if the client certificate's CN attribute is equal to `alice` or `bob` and forbidden if it is equal to `jdoe`. +Given the preceding configuration, the request is authorized if the client certificate's CN attribute is equal to `alice` or `bob` and forbidden if it is equal to `jdoe`. ==== Using certificate attributes to augment SecurityIdentity @@ -584,6 +584,70 @@ ifndef::no-quarkus-elytron-security-oauth2[ ^|Yes] If different sources provide the user credentials, you can combine authentication mechanisms. For example, you can combine the built-in Basic and the Quarkus `quarkus-oidc` Bearer token authentication mechanisms. +The authentication process completes as soon as the first `SecurityIdentity` is produced by one of the authentication mechanisms. + +In some cases it can be required that all registered authentication mechanisms create their `SecurityIdentity`. +It can be required when the credentials such as tokens have to be passed over <>, +for example, when users are authenticating via `Virtual Private Network`, or when the current token has to be bound +to the client certificate for the token verification to succeed, guaranteeing that the token was issued exactly +to the same client which is currently passing this token to Quarkus alongside its client certificate. + +In Quarkus such authentication is called `inclusive` and you can enable it like this: + +[source,properties] +---- +quarkus.http.auth.inclusive=true +---- + +If the authentication is inclusive then `SecurityIdentity` created by the first authentication mechanism can be +injected into the application code. +For example, if both <> and basic authentication mechanism authentications are required, +the <> authentication mechanism will create `SecurityIdentity` first. + +Additional `SecurityIdentity` instances can be accessed as a `quarkus.security.identities` attribute on the first +`SecurityIdentity`, however, accessing these extra identities directly may not be necessary, for example, +when both <> and xref:security-oidc-bearer-token-authentication.adoc[OIDC Bearer authentication] mechanisms +have been combined and done their authentications, the authenticated bearer token can be injected as a token +credential alongside `SecurityIdentity` created by <>. This is exemplified below: + +[source,java] +---- +package org.acme.security; + +import io.quarkus.oidc.AccessTokenCredential; +import io.quarkus.oidc.common.runtime.OidcConstants; +import io.quarkus.security.identity.SecurityIdentity; +import io.quarkus.vertx.http.runtime.security.HttpSecurityUtils; +import jakarta.enterprise.context.ApplicationScoped; +import jakarta.inject.Inject; + +@ApplicationScoped +public class InclusiveAuthExampleBean { + + @Inject + SecurityIdentity mtlsIdentity; <1> + + @Inject + AccessTokenCredential accessTokenCredential; + + private AccessTokenCredential getAccessTokenCredential() { + if (doItHardWay()) { + var securityIdentities = HttpSecurityUtils.getSecurityIdentities(mtlsIdentity); <2> + if (securityIdentities != null) { + SecurityIdentity bearerIdentity = securityIdentities.get(OidcConstants.BEARER_SCHEME); + if (bearerIdentity != null) { + return bearerIdentity.getCredential(AccessTokenCredential.class); + } + } + } + return accessTokenCredential; + } + +} +---- +<1> This is the `SecurityIdentity` created by applicable authentication mechanism with the highest priority. +<2> Other applicable authentication mechanisms performed authentication and are available on the `SecurityIdentity`. + [IMPORTANT] ==== You cannot combine the Quarkus `quarkus-oidc` Bearer token and `smallrye-jwt` authentication mechanisms because both mechanisms attempt to verify the token extracted from the HTTP Bearer token authentication scheme. diff --git a/_guides/security-authorize-web-endpoints-reference.adoc b/_guides/security-authorize-web-endpoints-reference.adoc index fd1bc7ced2d..f666e782d89 100644 --- a/_guides/security-authorize-web-endpoints-reference.adoc +++ b/_guides/security-authorize-web-endpoints-reference.adoc @@ -149,6 +149,33 @@ quarkus.http.auth.permission.custom1.policy=custom ---- <1> Custom policy name must match the value returned by the `io.quarkus.vertx.http.runtime.security.HttpSecurityPolicy.name` method. +Alternatively, you can bind custom named HttpSecurityPolicy to Jakarta REST endpoints with the `@AuthorizationPolicy` security annotation. + +[[authorization-policy-example]] +.Example of custom named HttpSecurityPolicy bound to a Jakarta REST endpoint +[source,java] +---- +import io.quarkus.vertx.http.security.AuthorizationPolicy; +import jakarta.annotation.security.DenyAll; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; + +@DenyAll <1> +@Path("hello") +public class HelloResource { + + @AuthorizationPolicy(name = "custom") <2> + @GET + public String hello() { + return "hello"; + } + +} +---- +<1> The `@AuthorizationPolicy` annotation can be used together with other standard security annotations. +As usual, the method-level annotation has priority over class-level annotation. +<2> Apply custom named HttpSecurityPolicy to the Jakarta REST `hello` endpoint. + [TIP] ==== You can also create global `HttpSecurityPolicy` invoked on every request. @@ -466,6 +493,9 @@ s| `@PermitAll` | Specifies that all security roles are allowed to invoke the sp `@PermitAll` lets everybody in, even without authentication. s| `@RolesAllowed` | Specifies the list of security roles allowed to access methods in an application. s| `@Authenticated` | {project-name} provides the `io.quarkus.security.Authenticated` annotation that permits any authenticated user to access the resource. It's equivalent to `@RolesAllowed("**")`. +s| `@PermissionsAllowed` | Specifies the list of permissions that are allowed to invoke the specified methods. +s| `@AuthorizationPolicy` | Specifies named `io.quarkus.vertx.http.runtime.security.HttpSecurityPolicy` that should authorize access to the specified endpoints.HttpSecurityPolicy. +Named HttpSecurityPolicy can be used for general authorization checks as demonstrated by <>. |=== The following <> demonstrates an endpoint that uses both Jakarta REST and Common Security annotations to describe and secure its endpoints. @@ -800,7 +830,7 @@ Your custom class must define exactly one constructor that accepts the permissio In this scenario, the permission `list` is added to the `SecurityIdentity` instance as `new CustomPermission("list")`. You can also create a custom `java.security.Permission` class with additional constructor parameters. -These additional parameters get matched with arguments of the method annotated with the `@PermissionsAllowed` annotation. +These additional parameters names get matched with arguments names of the method annotated with the `@PermissionsAllowed` annotation. Later, Quarkus instantiates your custom permission with actual arguments, with which the method annotated with the `@PermissionsAllowed` has been invoked. .Example of a custom `java.security.Permission` class that accepts additional arguments @@ -880,12 +910,12 @@ import org.acme.library.LibraryPermission.Library; public class LibraryService { @PermissionsAllowed(value = "tv:write", permission = LibraryPermission.class) <1> - public Library updateLibrary(String newDesc, Library update) { - update.description = newDesc; - return update; + public Library updateLibrary(String newDesc, Library library) { + library.description = newDesc; + return library; } - @PermissionsAllowed(value = "tv:write", permission = LibraryPermission.class, params = "library") <2> + @PermissionsAllowed(value = "tv:write", permission = LibraryPermission.class) <2> @PermissionsAllowed(value = {"tv:read", "tv:list"}, permission = LibraryPermission.class) public Library migrateLibrary(Library migrate, Library library) { // migrate libraries @@ -894,10 +924,11 @@ public class LibraryService { } ---- -<1> The formal parameter `update` is identified as the first `Library` parameter and gets passed to the `LibraryPermission` class. +<1> The formal parameter `library` is identified as the parameter matching same-named `LibraryPermission` constructor parameter. +Therefore, Quarkus will pass the `library` parameter to the `LibraryPermission` class constructor. However, the `LibraryPermission` must be instantiated each time the `updateLibrary` method is invoked. -<2> Here, the first `Library` parameter is `migrate`; therefore, the `library` parameter gets marked explicitly through `PermissionsAllowed#params`. -The permission constructor and the annotated method must have the parameter `library` set; otherwise, validation fails. +<2> Here, the second `Library` parameter matches the name `library`, +while the `migrate` parameter is ignored during the `LibraryPermission` permission instantiation. .Example of a resource secured with the `LibraryPermission` @@ -1024,6 +1055,149 @@ Because `MediaLibrary` is the `TvLibrary` class parent, a user with the `admin` CAUTION: Annotation-based permissions do not work with custom xref:security-customization.adoc#jaxrs-security-context[Jakarta REST SecurityContexts] because there are no permissions in `jakarta.ws.rs.core.SecurityContext`. +[[permission-meta-annotation]] +=== Create permission meta-annotations + +`@PermissionsAllowed` can also be used in meta-annotations. +For example, a new `@CanWrite` security annotation can be created like this: + +[source,java] +---- +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import io.quarkus.security.PermissionsAllowed; + +@Retention(RetentionPolicy.RUNTIME) +@Target({ ElementType.METHOD, ElementType.TYPE }) +@PermissionsAllowed(value = "write", permission = CustomPermission.class) <1> +public @interface CanWrite { + +} +---- +<1> Any method or class annotated with the `@CanWrite` annotation is secured with this `@PermissionsAllowed` annotation instance. + +[[permission-bean-params]] +=== Pass `@BeanParam` parameters into a custom permission + +Quarkus can map fields of a secured method parameters to a custom permission constructor parameters. +You can use this feature to pass `jakarta.ws.rs.BeanParam` parameters into your custom permission. +Let's consider following Jakarta REST resource: + +[source,java] +---- +package org.acme.security.rest.resource; + +import io.quarkus.security.PermissionsAllowed; +import jakarta.ws.rs.BeanParam; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; + +@Path("/hello") +public class SimpleResource { + + @PermissionsAllowed(value = "say:hello", permission = BeanParamPermission.class, + params = "beanParam.securityContext.userPrincipal.name") <1> + @GET + public String sayHello(@BeanParam SimpleBeanParam beanParam) { + return "Hello from " + beanParam.uriInfo.getPath(); + } + +} +---- +<1> The `params` annotation attribute specifies that user principal name should be passed to the `BeanParamPermission` constructor. +Other `BeanParamPermission` constructor parameters like `customAuthorizationHeader` and `query` are matched automatically. +Quarkus identifies the `BeanParamPermission` constructor parameters among `beanParam` fields and their public accessors. +To avoid ambiguous resolution, automatic detection only works for the `beanParam` fields. +For that reason, we had to specify path to the user principal name explicitly. + +Where the `SimpleBeanParam` class is declared like in the example below: + +[source,java] +---- +package org.acme.security.rest.dto; + +import java.util.List; + +import jakarta.ws.rs.HeaderParam; +import jakarta.ws.rs.QueryParam; +import jakarta.ws.rs.core.Context; +import jakarta.ws.rs.core.SecurityContext; +import jakarta.ws.rs.core.UriInfo; + +public class SimpleBeanParam { + + @HeaderParam("CustomAuthorization") + private String customAuthorizationHeader; + + @Context + SecurityContext securityContext; + + @Context + public UriInfo uriInfo; + + @QueryParam("query") + public String query; <1> + + public SecurityContext getSecurityContext() { <2> + return securityContext; + } + + public String customAuthorizationHeader() { <3> + return customAuthorizationHeader; + } +} +---- +<1> Quarkus Security can only pass public fields to a custom permission constructor. +<2> Quarkus Security automatically uses public getter methods if they are available. +<3> The `customAuthorizationHeader` field is not public, therefore Quarkus access this field with the `customAuthorizationHeader` accessor. +That is particularly useful with Java records, where generated accessors are not prefixed with `get`. + +Here is an example of the `BeanParamPermission` permission that checks user principal, custom header and query parameter: + +[source,java] +---- +package org.acme.security.permission; + +import java.security.Permission; + +public class BeanParamPermission extends Permission { + + private final String actions; + + public BeanParamPermission(String permissionName, String customAuthorizationHeader, String name, String query) { + super(permissionName); + this.actions = computeActions(customAuthorizationHeader, name, query); + } + + @Override + public boolean implies(Permission p) { + boolean nameMatches = getName().equals(p.getName()); + boolean actionMatches = actions.equals(p.getActions()); + return nameMatches && actionMatches; + } + + private static String computeActions(String customAuthorizationHeader, String name, String query) { + boolean queryParamAllowedForPermissionName = checkQueryParams(query); + boolean usernameWhitelisted = isUserNameWhitelisted(name); + boolean customAuthorizationMatches = checkCustomAuthorization(customAuthorizationHeader); + var isAuthorized = queryParamAllowedForPermissionName && usernameWhitelisted && customAuthorizationMatches; + if (isAuthorized) { + return "hello"; + } else { + return "goodbye"; + } + } + + ... +} +---- + +NOTE: You can pass `@BeanParam` directly into a custom permission constructor and access its fields programmatically in the constructor instead. +Ability to reference `@BeanParam` fields with the `@PermissionsAllowed#params` attribute is useful when you have multiple differently structured `@BeanParam` classes. + == References * xref:security-overview.adoc[Quarkus Security overview] diff --git a/_guides/security-jwt-build.adoc b/_guides/security-jwt-build.adoc index 40273dc4354..61da04211bc 100644 --- a/_guides/security-jwt-build.adoc +++ b/_guides/security-jwt-build.adoc @@ -36,7 +36,7 @@ SmallRye JWT Build provides an API for securing JWT claims using all of these op implementation("io.quarkus:quarkus-smallrye-jwt-build") ---- -Note you can use Smallrye JWT Build API without having to create MicroProfile JWT endpoints supported by `quarkus-smallrye-jwt`. +Note you can use SmallRye JWT Build API without having to create MicroProfile JWT endpoints supported by `quarkus-smallrye-jwt`. It can also be excluded from `quarkus-smallrye-jwt` if MP JWT endpoints do not need to generate JWT tokens. == Create JwtClaimsBuilder and set the claims @@ -349,5 +349,5 @@ SmallRye JWT supports the following properties which can be used to customize th * link:https://tools.ietf.org/html/rfc7518[JSON Web Algorithms] * link:https://bitbucket.org/b_c/jose4j/wiki/Home[Jose4J] * xref:security-oidc-bearer-token-authentication.adoc[OIDC Bearer token authentication] -* xref:security-jwt.adoc[Using Smallrye JWT to Protect Service Applications] +* xref:security-jwt.adoc[Using SmallRye JWT to Protect Service Applications] * xref:security-overview.adoc[Quarkus Security overview] diff --git a/_guides/security-jwt.adoc b/_guides/security-jwt.adoc index d7e5900a76e..b4fa7d8db23 100644 --- a/_guides/security-jwt.adoc +++ b/_guides/security-jwt.adoc @@ -1045,8 +1045,9 @@ include::{generated-dir}/config/quarkus-smallrye-jwt.adoc[opts=optional, levelof |Property Name|Default|Description |mp.jwt.verify.publickey|none|The `mp.jwt.verify.publickey` config property allows the Public Key text itself to be supplied as a string. The Public Key will be parsed from the supplied string in the order defined in the <> section. |mp.jwt.verify.publickey.location|none|Config property allows for an external or internal location of Public Key to be specified. The value may be a relative path or a URL. If the value points to an HTTPS based JWK set then, for it to work in native mode, the `quarkus.ssl.native` property must also be set to `true`, see xref:native-and-ssl.adoc[Using SSL With Native Executables] for more details. -|mp.jwt.verify.publickey.algorithm|`RS256`|Signature algorithm. Set it to `ES256` to support the Elliptic Curve signature algorithm. +|mp.jwt.verify.publickey.algorithm|`RS256`|List of signature algorithms. Set it to `ES256` to support the Elliptic Curve signature algorithm. |mp.jwt.decrypt.key.location|none|Config property allows for an external or internal location of Private Decryption Key to be specified. +|mp.jwt.decrypt.key.algorithm|`RSA-OAEP`,`RSA-OAEP-256`|List of decryption algorithms. Set it to `RSA-OAEP-256` to support RSA-OAEP with SHA-256 only. |mp.jwt.verify.issuer|none|Config property specifies the value of the `iss` (issuer) claim of the JWT that the server will accept as valid. |mp.jwt.verify.audiences|none|Comma separated list of the audiences that a token `aud` claim may contain. |mp.jwt.verify.clock.skew|`60`|Clock skew in seconds used during the token expiration and age verification. An expired token is accepted if the current time is within the number of seconds specified by this property after the token expiration time. The default value is 60 seconds. @@ -1062,6 +1063,7 @@ SmallRye JWT provides more properties which can be used to customize the token p [cols=" NOTE: Note that the xref:security-openid-connect-client.adoc[OidcClient] can also be used to acquire tokens. +== Configuring TLS + +To configure a TLS connection for the Keycloak Admin Client, use the TLS Registry extension and point the Keycloak Admin Client to respective TLS configuration. +For example, you can configure mutual TLS (mTLS) like this: + +[source,properties] +---- +quarkus.keycloak.admin-client.tls-configuration-name=kc-mtls +quarkus.tls.kc-mtls.key-store.p12.path=client-keystore.p12 +quarkus.tls.kc-mtls.key-store.p12.password=secret +quarkus.tls.kc-mtls.trust-store.p12.path=client-truststore.p12 +quarkus.tls.kc-mtls.trust-store.p12.password=secret +---- + == Testing The preferred approach for testing Keycloak Admin Client against Keycloak is xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak]. diff --git a/_guides/security-keycloak-authorization.adoc b/_guides/security-keycloak-authorization.adoc index f6bd96305e1..275bace2696 100644 --- a/_guides/security-keycloak-authorization.adoc +++ b/_guides/security-keycloak-authorization.adoc @@ -334,6 +334,21 @@ export access_token=$(\ ) ---- +[NOTE] +==== +When the `quarkus.oidc.authentication.user-info-required` property is set to `true` to require that an access token is used to request `UserInfo`, you must add a `scope=openid` query parameter to the token grant request command, for example: + +[source,bash] +---- +export access_token=$(\ + curl --insecure -X POST http://localhost:8180/realms/quarkus/protocol/openid-connect/token \ + --user backend-service:secret \ + -H 'content-type: application/x-www-form-urlencoded' \ + -d 'username=alice&password=alice&grant_type=password&scope=openid' | jq --raw-output '.access_token' \ + ) +---- +==== + The preceding example obtains an access token for user `alice`. Any user is allowed to access the @@ -620,7 +635,7 @@ public class CustomTenantPolicyConfigResolver implements TenantPolicyConfigResol == Configuration reference -This configuration adheres to the official [Keycloak Policy Enforcer Configuration](https://www.keycloak.org/docs/latest/authorization_services/index.html#_enforcer_filter) guidelines. +This configuration adheres to the official https://www.keycloak.org/docs/latest/authorization_services/index.html#_enforcer_filter[Keycloak Policy Enforcer Configuration] guidelines. For detailed insights into various configuration options, see the following documentation: include::{generated-dir}/config/quarkus-keycloak-authorization.adoc[opts=optional] diff --git a/_guides/security-oidc-bearer-token-authentication-tutorial.adoc b/_guides/security-oidc-bearer-token-authentication-tutorial.adoc index 398beed5c8b..1eef1c8771c 100644 --- a/_guides/security-oidc-bearer-token-authentication-tutorial.adoc +++ b/_guides/security-oidc-bearer-token-authentication-tutorial.adoc @@ -319,6 +319,21 @@ export access_token=$(\ ---- ==== +[NOTE] +==== +When the `quarkus.oidc.authentication.user-info-required` property is set to `true` to require that an access token is used to request `UserInfo`, you must add a `scope=openid` query parameter to the token grant request command, for example: + +[source,bash] +---- +export access_token=$(\ + curl --insecure -X POST http://localhost:8180/realms/quarkus/protocol/openid-connect/token \ + --user backend-service:secret \ + -H 'content-type: application/x-www-form-urlencoded' \ + -d 'username=alice&password=alice&grant_type=password&scope=openid' | jq --raw-output '.access_token' \ + ) +---- +==== + The preceding example obtains an access token for the user `alice`. * Any user can access the `http://localhost:8080/api/users/me` endpoint, which returns a JSON payload with details about the user. diff --git a/_guides/security-oidc-bearer-token-authentication.adoc b/_guides/security-oidc-bearer-token-authentication.adoc index eb04efd1c8e..621d512c15c 100644 --- a/_guides/security-oidc-bearer-token-authentication.adoc +++ b/_guides/security-oidc-bearer-token-authentication.adoc @@ -49,7 +49,7 @@ Also, if you use Keycloak and bearer tokens, see the Quarkus xref:security-keycl To learn about how you can protect service applications by using OIDC Bearer token authentication, see the following tutorial: -* xref:security-oidc-bearer-token-authentication-tutorial.adoc[Protect a web application by using OpenID Connect (OIDC) authorization code flow]. +* xref:security-oidc-bearer-token-authentication-tutorial.adoc[Protect a service application by using OpenID Connect (OIDC) Bearer token authentication]. For information about how to support multiple tenants, see the Quarkus xref:security-openid-connect-multitenancy.adoc[Using OpenID Connect Multi-Tenancy] guide. diff --git a/_guides/security-oidc-code-flow-authentication.adoc b/_guides/security-oidc-code-flow-authentication.adoc index 4d09c196d96..8568c72ac20 100644 --- a/_guides/security-oidc-code-flow-authentication.adoc +++ b/_guides/security-oidc-code-flow-authentication.adoc @@ -197,7 +197,7 @@ quarkus.oidc.credentials.jwt.key-file=privateKey.pem ---- quarkus.oidc.auth-server-url=http://localhost:8180/realms/quarkus/ quarkus.oidc.client-id=quarkus-app -quarkus.oidc.credentials.jwt.key-store-file=keystore.jks +quarkus.oidc.credentials.jwt.key-store-file=keystore.pkcs12 quarkus.oidc.credentials.jwt.key-store-password=mypassword quarkus.oidc.credentials.jwt.key-password=mykeypassword @@ -266,21 +266,24 @@ The following example shows how you can configure `quarkus-oidc` to support `mTL [source,properties] ---- -quarkus.oidc.tls.verification=certificate-validation +quarkus.oidc.tls.tls-configuration-name=oidc + +# configure hostname verification if necessary +#quarkus.tls.oidc.hostname-verification-algorithm=NONE # Keystore configuration -quarkus.oidc.tls.key-store-file=client-keystore.jks -quarkus.oidc.tls.key-store-password=${key-store-password} +quarkus.tls.oidc.key-store.p12.path=client-keystore.p12 +quarkus.tls.oidc.key-store.p12.password=${key-store-password} # Add more keystore properties if needed: -#quarkus.oidc.tls.key-store-alias=keyAlias -#quarkus.oidc.tls.key-store-alias-password=keyAliasPassword +#quarkus.tls.oidc.key-store.p12.alias=keyAlias +#quarkus.tls.oidc.key-store.p12.alias-password=keyAliasPassword # Truststore configuration -quarkus.oidc.tls.trust-store-file=client-truststore.jks -quarkus.oidc.tls.trust-store-password=${trust-store-password} +quarkus.tls.oidc.trust-store.p12.path=client-truststore.p12 +quarkus.tls.oidc.trust-store.p12.password=${trust-store-password} # Add more truststore properties if needed: -#quarkus.oidc.tls.trust-store-alias=certAlias +#quarkus.tls.oidc.trust-store.p12.alias=certAlias ---- ==== POST query @@ -323,20 +326,18 @@ import io.quarkus.oidc.OidcConfigurationMetadata; import jakarta.enterprise.context.ApplicationScoped; import io.quarkus.arc.Unremovable; -import io.quarkus.oidc.common.OidcRequestContextProperties; +import io.quarkus.oidc.common.OidcRequestContext; import io.quarkus.oidc.common.OidcRequestFilter; -import io.vertx.mutiny.core.buffer.Buffer; -import io.vertx.mutiny.ext.web.client.HttpRequest; @ApplicationScoped @Unremovable public class OidcTokenRequestCustomizer implements OidcRequestFilter { @Override - public void filter(HttpRequest request, Buffer buffer, OidcRequestContextProperties contextProps) { - OidcConfigurationMetadata metadata = contextProps.get(OidcConfigurationMetadata.class.getName()); <1> + public void filter(OidcRequestContext requestContext) { + OidcConfigurationMetadata metadata = requestContext.contextProperties().get(OidcConfigurationMetadata.class.getName()); <1> // Metadata URI is absolute, request URI value is relative - if (metadata.getTokenUri().endsWith(request.uri())) { <2> - request.putHeader("TokenGrantDigest", calculateDigest(buffer.toString())); + if (metadata.getTokenUri().endsWith(requestContext.request().uri())) { <2> + requestContext.request().putHeader("TokenGrantDigest", calculateDigest(requestContext.requestBody().toString())); } } private String calculateDigest(String bodyString) { @@ -347,7 +348,7 @@ public class OidcTokenRequestCustomizer implements OidcRequestFilter { <1> Get `OidcConfigurationMetadata`, which contains all supported OIDC endpoint addresses. <2> Use `OidcConfigurationMetadata` to filter requests to the OIDC token endpoint only. -Alternatively, you can use an `@OidcEndpoint` annotation to apply this filter to the token endpoint requests only: +Alternatively, you can use an `@OidcEndpoint` annotation to apply this filter to responses from the OIDC discovery endpoint only: [source,java] ---- @@ -358,10 +359,8 @@ import jakarta.enterprise.context.ApplicationScoped; import io.quarkus.arc.Unremovable; import io.quarkus.oidc.common.OidcEndpoint; import io.quarkus.oidc.common.OidcEndpoint.Type; -import io.quarkus.oidc.common.OidcRequestContextProperties; +import io.quarkus.oidc.common.OidcRequestContext; import io.quarkus.oidc.common.OidcRequestFilter; -import io.vertx.mutiny.core.buffer.Buffer; -import io.vertx.mutiny.ext.web.client.HttpRequest; @ApplicationScoped @Unremovable @@ -369,13 +368,63 @@ import io.vertx.mutiny.ext.web.client.HttpRequest; public class OidcDiscoveryRequestCustomizer implements OidcRequestFilter { @Override - public void filter(HttpRequest request, Buffer buffer, OidcRequestContextProperties contextProps) { - request.putHeader("Discovery", "OK"); + public void filter(OidcRequestContext requestContext) { + requestContext.request().putHeader("Discovery", "OK"); } } ---- <1> Restrict this filter to requests targeting the OIDC discovery endpoint only. +`OidcRequestContextProperties` can be used to access request properties. +Currently, you can use a `tenand_id` key to access the OIDC tenant id and a `grant_type` key to access the grant type which the OIDC provider uses to acquire tokens. +The `grant_type` can only be set to either `authorization_code` or `refresh_token` grant type, when requests are made to the token endpoint. It is `null` in all other cases. + +[[code-flow-oidc-response-filters]] +=== OIDC response filters + +You can filter responses from the OIDC providers by registering one or more `OidcResponseFilter` implementations, which can check the response status, headers and body in order to log them or perform other actions. + +You can have a single filter intercepting all the OIDC responses, or use an `@OidcEndpoint` annotation to apply this filter to the specific endpoint responses only. For example: + +[source,java] +---- +package io.quarkus.it.keycloak; + +import jakarta.enterprise.context.ApplicationScoped; + +import org.jboss.logging.Logger; + +import io.quarkus.arc.Unremovable; +import io.quarkus.oidc.common.OidcEndpoint; +import io.quarkus.oidc.common.OidcEndpoint.Type; +import io.quarkus.oidc.common.OidcResponseFilter; +import io.quarkus.oidc.common.runtime.OidcConstants; +import io.quarkus.oidc.runtime.OidcUtils; + +@ApplicationScoped +@Unremovable +@OidcEndpoint(value = Type.TOKEN) <1> +public class TokenEndpointResponseFilter implements OidcResponseFilter { + private static final Logger LOG = Logger.getLogger(TokenResponseFilter.class); + + @Override + public void filter(OidcResponseContext rc) { + String contentType = rc.responseHeaders().get("Content-Type"); <2> + if (contentType.equals("application/json") + && OidcConstants.AUTHORIZATION_CODE.equals(rc.requestProperties().get(OidcConstants.GRANT_TYPE)) <3> + && "code-flow-user-info-cached-in-idtoken".equals(rc.requestProperties().get(OidcUtils.TENANT_ID_ATTRIBUTE)) <3> + && rc.responseBody().toJsonObject().containsKey("id_token")) { <4> + LOG.debug("Authorization code completed for tenant 'code-flow-user-info-cached-in-idtoken'"); + } + } +} + +---- +<1> Restrict this filter to requests targeting the OIDC token endpoint only. +<2> Check the response `Content-Type` header. +<3> Use `OidcRequestContextProperties` request properties to check only an `authorization_code` token grant response for the `code-flow-user-info-cached-in-idtoken` tenant. +<4> Confirm the response JSON contains an `id_token` property. + === Redirecting to and from the OIDC provider When a user is redirected to the OIDC provider to authenticate, the redirect URL includes a `redirect_uri` query parameter, which indicates to the provider where the user has to be redirected to when the authentication is complete. diff --git a/_guides/security-oidc-configuration-properties-reference.adoc b/_guides/security-oidc-configuration-properties-reference.adoc index 6ada18cfc2b..82918a1bfad 100644 --- a/_guides/security-oidc-configuration-properties-reference.adoc +++ b/_guides/security-oidc-configuration-properties-reference.adoc @@ -19,7 +19,7 @@ include::{generated-dir}/config/quarkus-oidc_quarkus.oidc.adoc[opts=optional, le == Keycloak Dev Services configuration -include::{generated-dir}/config/quarkus-oidc_quarkus.keycloak.adoc[opts=optional, leveloffset=+1] +include::{generated-dir}/config/quarkus-devservices-keycloak_quarkus.keycloak.adoc[opts=optional, leveloffset=+1] == References diff --git a/_guides/security-openid-connect-client-reference.adoc b/_guides/security-openid-connect-client-reference.adoc index e1b9f2b4fc5..fa652b907ac 100644 --- a/_guides/security-openid-connect-client-reference.adoc +++ b/_guides/security-openid-connect-client-reference.adoc @@ -238,9 +238,9 @@ You can inject `Tokens` that use `OidcClient` internally. `Tokens` can be used t [source,java] ---- -import jakarta.inject.PostConstruct; import jakarta.inject.Inject; import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; import io.quarkus.oidc.client.Tokens; @@ -281,6 +281,7 @@ import org.eclipse.microprofile.rest.client.inject.RestClient; import jakarta.inject.Inject; import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; +import jakarta.ws.rs.Produces; import io.smallrye.mutiny.Uni; import io.quarkus.oidc.client.OidcClient; import io.quarkus.oidc.client.OidcClients; @@ -404,6 +405,7 @@ import org.eclipse.microprofile.rest.client.inject.RestClient; import jakarta.inject.Inject; import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; +import jakarta.ws.rs.Produces; import io.smallrye.mutiny.Uni; import io.quarkus.oidc.client.runtime.TokensHelper; @@ -442,7 +444,10 @@ import org.eclipse.microprofile.rest.client.inject.RestClient; import jakarta.inject.Inject; import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; +import jakarta.ws.rs.Produces; import io.smallrye.mutiny.Uni; +import io.quarkus.oidc.client.NamedOidcClient; +import io.quarkus.oidc.client.OidcClient; import io.quarkus.oidc.client.runtime.TokensHelper; @Path("/clients") @@ -473,6 +478,20 @@ The same qualifier can be used to specify the `OidcClient` used for a `Tokens` i [source,java] ---- +import java.io.IOException; + +import jakarta.annotation.Priority; +import jakarta.enterprise.context.RequestScoped; +import jakarta.inject.Inject; +import jakarta.ws.rs.Priorities; +import jakarta.ws.rs.client.ClientRequestContext; +import jakarta.ws.rs.client.ClientRequestFilter; +import jakarta.ws.rs.core.HttpHeaders; +import jakarta.ws.rs.ext.Provider; + +import io.quarkus.oidc.client.NamedOidcClient; +import io.quarkus.oidc.client.Tokens; + @Provider @Priority(Priorities.AUTHENTICATION) @RequestScoped @@ -502,11 +521,11 @@ Add the following Maven Dependency: ---- -Note it will also bring `io.quarkus:quarkus-oidc-client`. +NOTE: It will also bring `io.quarkus:quarkus-oidc-client`. `quarkus-rest-client-oidc-filter` extension provides `io.quarkus.oidc.client.filter.OidcClientRequestReactiveFilter`. -It works similarly to the way `OidcClientRequestFilter` does (see <>) - it uses `OidcClient` to acquire the access token, refresh it if needed, and set it as an HTTP `Authorization` `Bearer` scheme value. The difference is that it works with xref:rest-client.adoc[Reactive RestClient] and implements a non-blocking client filter that does not block the current IO thread when acquiring or refreshing the tokens. +It works similarly to the way `OidcClientRequestFilter` does (see <>) - it uses `OidcClient` to acquire the access token, refresh it if needed, and set it as an HTTP `Authorization Bearer` scheme value. The difference is that it works with xref:rest-client.adoc[Reactive RestClient] and implements a non-blocking client filter that does not block the current IO thread when acquiring or refreshing the tokens. `OidcClientRequestReactiveFilter` delays an initial token acquisition until it is executed to avoid blocking an IO thread. @@ -514,10 +533,11 @@ You can selectively register `OidcClientRequestReactiveFilter` by using either ` [source,java] ---- -import org.eclipse.microprofile.rest.client.annotation.RegisterProvider; import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.client.filter.OidcClientFilter; import io.smallrye.mutiny.Uni; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; @RegisterRestClient @OidcClientFilter @@ -537,6 +557,8 @@ import org.eclipse.microprofile.rest.client.annotation.RegisterProvider; import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.client.reactive.filter.OidcClientRequestReactiveFilter; import io.smallrye.mutiny.Uni; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; @RegisterRestClient @RegisterProvider(OidcClientRequestReactiveFilter.class) @@ -554,10 +576,11 @@ For example, given <> `jwt-secret` named OIDC client decl [source,java] ---- -import org.eclipse.microprofile.rest.client.annotation.RegisterProvider; import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.client.filter.OidcClientFilter; import io.smallrye.mutiny.Uni; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; @RegisterRestClient @OidcClientFilter("jwt-secret") @@ -582,9 +605,9 @@ Add the following Maven Dependency: ---- -Note it will also bring `io.quarkus:quarkus-oidc-client`. +NOTE: It will also bring `io.quarkus:quarkus-oidc-client`. -`quarkus-resteasy-client-oidc-filter` extension provides `io.quarkus.oidc.client.filter.OidcClientRequestFilter` Jakarta REST ClientRequestFilter which uses `OidcClient` to acquire the access token, refresh it if needed, and set it as an HTTP `Authorization` `Bearer` scheme value. +`quarkus-resteasy-client-oidc-filter` extension provides `io.quarkus.oidc.client.filter.OidcClientRequestFilter` Jakarta REST ClientRequestFilter which uses `OidcClient` to acquire the access token, refresh it if needed, and set it as an HTTP `Authorization Bearer` scheme value. By default, this filter will get `OidcClient` to acquire the first pair of access and refresh tokens at its initialization time. If the access tokens are short-lived and refresh tokens are unavailable, then the token acquisition should be delayed with `quarkus.oidc-client.early-tokens-acquisition=false`. @@ -594,6 +617,8 @@ You can selectively register `OidcClientRequestFilter` by using either `io.quark ---- import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.client.filter.OidcClientFilter; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; @RegisterRestClient @OidcClientFilter @@ -612,6 +637,8 @@ or import org.eclipse.microprofile.rest.client.annotation.RegisterProvider; import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.client.filter.OidcClientRequestFilter; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; @RegisterRestClient @RegisterProvider(OidcClientRequestFilter.class) @@ -633,6 +660,8 @@ For example, given <> `jwt-secret` named OIDC client decl ---- import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.client.filter.OidcClientFilter; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; @RegisterRestClient @OidcClientFilter("jwt-secret") @@ -650,6 +679,14 @@ If you prefer, you can use your own custom filter and inject `Tokens`: [source,java] ---- +import java.io.IOException; +import jakarta.annotation.Priority; +import jakarta.inject.Inject; +import jakarta.ws.rs.Priorities; +import jakarta.ws.rs.client.ClientRequestContext; +import jakarta.ws.rs.client.ClientRequestFilter; +import jakarta.ws.rs.core.HttpHeaders; +import jakarta.ws.rs.ext.Provider; import io.quarkus.oidc.client.Tokens; @Provider @@ -786,7 +823,7 @@ quarkus.oidc-client.credentials.jwt.key-file=privateKey.pem ---- quarkus.oidc-client.auth-server-url=http://localhost:8180/auth/realms/quarkus/ quarkus.oidc-client.client-id=quarkus-app -quarkus.oidc-client.credentials.jwt.key-store-file=keystore.jks +quarkus.oidc-client.credentials.jwt.key-store-file=keystore.pkcs12 quarkus.oidc-client.credentials.jwt.key-store-password=mypassword quarkus.oidc-client.credentials.jwt.key-password=mykeypassword @@ -868,7 +905,7 @@ public class OidcClientRequestCustomFilter extends AbstractOidcClientRequestReac } ---- -Here is an example of the RestEasy Classic custom filter: +Here is an example of the RESTEasy Classic custom filter: [source,java] ---- @@ -917,23 +954,62 @@ Some OpenID Connect Providers require that a client is authenticated as part of [source,properties] ---- -quarkus.oidc-client.tls.verification=certificate-validation +quarkus.oidc-client.tls.tls-configuration-name=oidc-client + +# configure hostname verification if necessary +#quarkus.tls.oidc-client.hostname-verification-algorithm=NONE # Keystore configuration -quarkus.oidc-client.tls.key-store-file=client-keystore.jks -quarkus.oidc-client.tls.key-store-password=${key-store-password} +quarkus.tls.oidc-client.key-store.p12.path=client-keystore.p12 +quarkus.tls.oidc-client.key-store.p12.password=${key-store-password} # Add more keystore properties if needed: -#quarkus.oidc-client.tls.key-store-alias=keyAlias -#quarkus.oidc-client.tls.key-store-alias-password=keyAliasPassword +#quarkus.tls.oidc-client.key-store.p12.alias=keyAlias +#quarkus.tls.oidc-client.key-store.p12.alias-password=keyAliasPassword # Truststore configuration -quarkus.oidc-client.tls.trust-store-file=client-truststore.jks -quarkus.oidc-client.tls.trust-store-password=${trust-store-password} +quarkus.tls.oidc-client.trust-store.p12.path=client-truststore.p12 +quarkus.tls.oidc-client.trust-store.p12.password=${trust-store-password} # Add more truststore properties if needed: -#quarkus.oidc-client.tls.trust-store-alias=certAlias +#quarkus.tls.oidc-client.trust-store.p12.alias=certAlias ---- +=== OIDC Client SPI + +When your custom extension must acquire OIDC tokens using one of the OIDC token grants supported by OIDC client, this extension can depend on the OIDC Client SPI only and let OIDC client itself acquire and refresh access tokens as necessary. + +Add the following dependency: + +[source,xml] +---- + + io.quarkus + quarkus-oidc-client-spi + +---- + +Next update your extension to use `io.quarkus.oidc.client.spi.TokenProvider` CDI bean as required, for example: + +[source,java] +---- +package org.acme.extension; + +import jakarta.inject.Inject; +import io.quarkus.oidc.client.spi.TokenProvider; + +public class ExtensionOAuth2Support { + + @Inject + TokenProvider tokenProvider; + + public Uni getAccessToken() { + return tokenProvider.getAccessToken(); + } +} +---- + +Currently, `io.quarkus.oidc.client.spi.TokenProvider` is only available for default OIDC clients, since custom extensions are unlikely to be aware of multiple named OIDC clients. + [[integration-testing-oidc-client]] === Testing @@ -964,8 +1040,10 @@ Add the following dependencies to your test project: org.wiremock wiremock test + ${wiremock.version} // <1> ---- +<1> Use a proper Wiremock version. All available versions can be found link:https://search.maven.org/artifact/org.wiremock/wiremock[here]. Write a Wiremock-based `QuarkusTestResourceLifecycleManager`, for example: [source, java] @@ -1068,7 +1146,9 @@ quarkus.log.category."io.quarkus.oidc.client.runtime.OidcClientRecorder".min-lev [[oidc-client-ref-oidc-request-filters]] == OIDC request filters -You can filter OIDC requests made by Quarkus to the OIDC provider by registering one or more `OidcRequestFilter` implementations, which can update or add new request headers. For example, a filter can analyze the request body and add its digest as a new header value: +You can filter OIDC requests made by OIDC client to the OIDC provider by registering one or more `OidcRequestFilter` implementations, which can update or add new request headers, or analyze the request body. + +You can have a single filter intercepting requests to all OIDC provider endpoints, or use an `@OidcEndpoint` annotation to apply this filter to requests to specific endpoints only. For example: [source,java] ---- @@ -1077,22 +1157,21 @@ package io.quarkus.it.keycloak; import jakarta.enterprise.context.ApplicationScoped; import io.quarkus.arc.Unremovable; -import io.quarkus.oidc.common.OidcRequestContextProperties; +import io.quarkus.oidc.common.OidcEndpoint; import io.quarkus.oidc.common.OidcRequestFilter; import io.vertx.core.http.HttpMethod; -import io.vertx.mutiny.core.buffer.Buffer; -import io.vertx.mutiny.ext.web.client.HttpRequest; @ApplicationScoped +@OidcEndpoint(value = Type.TOKEN) @Unremovable public class OidcRequestCustomizer implements OidcRequestFilter { @Override - public void filter(HttpRequest request, Buffer buffer, OidcRequestContextProperties contextProperties) { - HttpMethod method = request.method(); - String uri = request.uri(); - if (method == HttpMethod.POST && uri.endsWith("/service") && buffer != null) { - request.putHeader("Digest", calculateDigest(buffer.toString())); + public void filter(OidcRequestContext requestContext) { + HttpMethod method = requestContext.request().method(); + String uri = requestContext.request().uri(); + if (method == HttpMethod.POST && uri.endsWith("/token") && requestContext.requestBody() != null) { + requestContext.request().putHeader("Digest", calculateDigest(requestContext.requestBody().toString())); } } @@ -1102,6 +1181,53 @@ public class OidcRequestCustomizer implements OidcRequestFilter { } ---- +`OidcRequestContextProperties` can be used to access request properties. +Currently, you can use a `client_id` key to access the client tenant id and a `grant_type` key to access the grant type which the OIDC client uses to acquire tokens. + +[[oidc-client-ref-oidc-response-filters]] +== OIDC response filters + +You can filter responses to the OIDC client requests by registering one or more `OidcResponseFilter` implementations, which can check the response status, headers and body, in order to log them or perform other actions. + +You can have a single filter intercepting responses to all OIDC client requests, or use an `@OidcEndpoint` annotation to apply this filter to the responses to the specific OIDC client requests only. For example: + +[source,java] +---- +package io.quarkus.it.keycloak; + +import jakarta.enterprise.context.ApplicationScoped; + +import org.jboss.logging.Logger; + +import io.quarkus.arc.Unremovable; +import io.quarkus.oidc.common.OidcEndpoint; +import io.quarkus.oidc.common.OidcEndpoint.Type; +import io.quarkus.oidc.common.OidcResponseFilter; +import io.quarkus.oidc.common.runtime.OidcConstants; + +@ApplicationScoped +@Unremovable +@OidcEndpoint(value = Type.TOKEN) <1> +public class TokenEndpointResponseFilter implements OidcResponseFilter { + private static final Logger LOG = Logger.getLogger(TokenEndpointResponseFilter.class); + + @Override + public void filter(OidcResponseContext rc) { + String contentType = rc.responseHeaders().get("Content-Type"); <2> + if (contentType.equals("application/json") + && "refresh_token".equals(rc.requestProperties().get(OidcConstants.GRANT_TYPE)) <3> + && rc.responseBody().toJsonObject().containsKey("refresh_token")) { <4> + LOG.debug("Tokens have been refreshed"); + } + } + +} +---- +<1> Restrict this filter to requests targeting the OIDC token endpoint only. +<2> Check the response `Content-Type` header. +<3> Use `OidcRequestContextProperties` request properties to confirm it is a `refresh_grant` token grant response. +<4> Confirm the response JSON contains a `refresh_token` property. + [[token-propagation-rest]] == Token Propagation for Quarkus REST @@ -1113,6 +1239,8 @@ You can selectively register `AccessTokenRequestReactiveFilter` by using either ---- import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.token.propagation.AccessToken; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; @RegisterRestClient @AccessToken @@ -1131,6 +1259,8 @@ or import org.eclipse.microprofile.rest.client.annotation.RegisterProvider; import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.token.propagation.reactive.AccessTokenRequestReactiveFilter; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; @RegisterRestClient @RegisterProvider(AccessTokenRequestReactiveFilter.class) @@ -1159,7 +1289,7 @@ quarkus.resteasy-client-oidc-token-propagation.exchange-token=true <1> ---- <1> Please note that the `exchange-token` configuration property is ignored when the OidcClient name is set with the `io.quarkus.oidc.token.propagation.AccessToken#exchangeTokenClient` annotation attribute. -Note `AccessTokenRequestReactiveFilter` will use `OidcClient` to exchange the current token, and you can use `quarkus.oidc-client.grant-options.exchange` to set the additional exchange properties expected by your OpenID Connect Provider. +NOTE: `AccessTokenRequestReactiveFilter` will use `OidcClient` to exchange the current token, and you can use `quarkus.oidc-client.grant-options.exchange` to set the additional exchange properties expected by your OpenID Connect Provider. If you work with providers such as `Azure` that link:https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow#example[require using] link:https://www.rfc-editor.org/rfc/rfc7523#section-2.1[JWT bearer token grant] to exchange the current token, then you can configure `AccessTokenRequestReactiveFilter` to exchange the token like this: @@ -1203,6 +1333,8 @@ You can selectively register `AccessTokenRequestFilter` by using either `io.quar ---- import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.token.propagation.AccessToken; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; @RegisterRestClient @AccessToken @@ -1220,6 +1352,8 @@ or import org.eclipse.microprofile.rest.client.annotation.RegisterProvider; import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.token.propagation.AccessTokenRequestFilter; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; @RegisterRestClient @RegisterProvider(AccessTokenRequestFilter.class) @@ -1263,7 +1397,7 @@ quarkus.oidc-client.scopes=https://graph.microsoft.com/user.read,offline_access quarkus.resteasy-client-oidc-token-propagation.exchange-token=true ---- -Note `AccessTokenRequestFilter` will use `OidcClient` to exchange the current token, and you can use `quarkus.oidc-client.grant-options.exchange` to set the additional exchange properties expected by your OpenID Connect Provider. +NOTE: `AccessTokenRequestFilter` will use `OidcClient` to exchange the current token, and you can use `quarkus.oidc-client.grant-options.exchange` to set the additional exchange properties expected by your OpenID Connect Provider. `AccessTokenRequestFilter` uses a default `OidcClient` by default. A named `OidcClient` can be selected with a `quarkus.resteasy-client-oidc-token-propagation.client-name` configuration property. @@ -1271,7 +1405,7 @@ Note `AccessTokenRequestFilter` will use `OidcClient` to exchange the current to Using `JsonWebTokenRequestFilter` is recommended if you work with Bearer JWT tokens where these tokens can have their claims, such as `issuer` and `audience` modified and the updated tokens secured (for example, re-signed) again. It expects an injected `org.eclipse.microprofile.jwt.JsonWebToken` and, therefore, will not work with the opaque tokens. Also, if your OpenID Connect Provider supports a Token Exchange protocol, then it is recommended to use `AccessTokenRequestFilter` instead - as both JWT and opaque bearer tokens can be securely exchanged with `AccessTokenRequestFilter`. -`JsonWebTokenRequestFilter` makes it easy for `Service A` implementations to update the injected `org.eclipse.microprofile.jwt.JsonWebToken` with the new `issuer` and `audience` claim values and secure the updated token again with a new signature. The only difficult step is ensuring that `Service A` has a signing key; it should be provisioned from a secure file system or remote secure storage such as Vault. +`JsonWebTokenRequestFilter` makes it easy for `Service A` implementations to update the injected `org.eclipse.microprofile.jwt.JsonWebToken` with the new `issuer` and `audience` claim values and secure the updated token again with a new signature. The only difficult step is ensuring that `Service A` has a signing key which should be provisioned from a secure file system or remote secure storage such as Vault. You can selectively register `JsonWebTokenRequestFilter` by using either `io.quarkus.oidc.token.propagation.JsonWebToken` or `org.eclipse.microprofile.rest.client.annotation.RegisterProvider`, for example: @@ -1279,6 +1413,8 @@ You can selectively register `JsonWebTokenRequestFilter` by using either `io.qua ---- import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.token.propagation.JsonWebToken; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; @RegisterRestClient @JsonWebToken @@ -1296,6 +1432,8 @@ or import org.eclipse.microprofile.rest.client.annotation.RegisterProvider; import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.token.propagation.JsonWebTokenRequestFilter; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; @RegisterRestClient @RegisterProvider(JsonWebTokenRequestFilter.class) @@ -1330,8 +1468,10 @@ As mentioned, use `AccessTokenRequestFilter` if you work with Keycloak or an Ope [[integration-testing-token-propagation]] === Testing -You can generate the tokens as described in xref:security-oidc-bearer-token-authentication.adoc#bearer-token-integration-testing[OpenID Connect Bearer Token Integration testing] section. -Prepare the REST test endpoints. You can have the test front-end endpoint, which uses the injected MP REST client with a registered token propagation filter, call the downstream endpoint. For example, see the `integration-tests/resteasy-client-oidc-token-propagation` in the `main` Quarkus repository. +Typically, you must prepare two REST test endpoints. +The first endpoint uses the injected MP REST client with a registered token propagation filter to call the second endpoint. + +To learn how it can be done, please follow the xref:security-openid-connect-client.adoc[OpenID Connect client and token propagation] quickstart, and its xref:security-openid-connect-client.adoc#testing[Testing] section in particular. ifndef::no-quarkus-oidc-client-graphql[] [[quarkus-oidc-client-graphql]] diff --git a/_guides/security-openid-connect-client-registration.adoc b/_guides/security-openid-connect-client-registration.adoc new file mode 100644 index 00000000000..e5fe4efd024 --- /dev/null +++ b/_guides/security-openid-connect-client-registration.adoc @@ -0,0 +1,634 @@ +//// +This guide is maintained in the main Quarkus repository +and pull requests should be submitted there: +https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc +//// += OpenID Connect (OIDC) and OAuth2 dynamic client registration +include::_attributes.adoc[] +:diataxis-type: reference +:categories: security +:topics: security,oidc,client +:extensions: io.quarkus:quarkus-oidc-client-registration + +Typically, you have to register an OIDC client (application) manually in your OIDC provider's dashboard. +During this process, you specify the human readable application name, allowed redirect and post logout URLs, and other properties. +After the registration has been completed, you copy the generated client id and secret to your Quarkus OIDC application properties. + +OpenID Connect and OAuth2 dynamic client registration allows you to register OIDC clients dynamically, and manage individual client registrations. +You can read more about it in the https://openid.net/specs/openid-connect-registration-1_0.html[OIDC client registration] and https://datatracker.ietf.org/doc/html/rfc7592[OAuth2 Dynamic Client Registration Management Protocol] specification documents. + +You can use Quarkus `quarkus-oidc-client-registration` extension to register one or more clients using OIDC client registration configurations and read, update and delete metadata of the registered clients. + +xref:security-openid-connect-multitenancy#tenant-config-resolver[OIDC TenantConfigResolver] can be used to create OIDC tenant configurations using the metadata of the registered clients. + +[IMPORTANT] +==== +Currently, Quarkus `quarkus-oidc-client-registration` extension has an `experimental` status. +Dynamic client registration API provided by this extension may change while this extension has an experiemental status. +==== + +== OIDC Client Registration + +Add the following dependency: + +[source,xml] +---- + + io.quarkus + quarkus-oidc-client-registration + +---- + +The `quarkus-oidc-client-registration` extension allows register one or more clients using OIDC client registration configurations, either on start-up or on demand, and read, update and delete metadata of the registered clients. + +You can register and manage client registrations from the custom xref:security-openid-connect-multitenancy#tenant-config-resolver[OIDC TenantConfigResolver]. + +Alternatively, you can register clients without even using OIDC. For example, it can be a command line tool which registers clients and passes metadata of the registered clients to Quarkus services which require them. + +Each OIDC client registration configuration represents an OIDC client registration endpoint which can accept many individual client registrations. + +[[register-clients-on-startup]] +=== Register clients on start-up + +You start with declaring one or more OIDC client registration configurations, for example: + +[source,properties] +---- +# Default OIDC client registration which auto-discovers a standard client registration endpoint. +# It does not require an initial registration token. + +quarkus.oidc-client-registration.auth-server-url=${quarkus.oidc.auth-server-url} +quarkus.oidc-client-registration.metadata.client-name=Default Client +quarkus.oidc-client-registration.metadata.redirect-uri=http://localhost:8081/protected + +# Named OIDC client registration which configures a registration endpoint path: +# It require an initial registration token for a client registration to succeed. + +quarkus.oidc-client-registration.tenant-client.registration-path=${quarkus.oidc.auth-server-url}/clients-registrations/openid-connect +quarkus.oidc-client-registration.tenant-client.metadata.client-name=Tenant Client +quarkus.oidc-client-registration.tenant-client.metadata.redirect-uri=http://localhost:8081/protected/tenant +quarkus.oidc-client-registration.initial-token=${initial-registration-token} +---- + +The above configuration will lead to two new client registrations created in your OIDC provider. + +You or may not need to acquire an initial registration access token. If you don't, then you will have to enable one or more client registration policies in your OIDC provider's dashboard. For example, see https://www.keycloak.org/docs/latest/securing_apps/#_client_registration_policies[Keycloak client registration policies]. + +The next step is to inject either `quarkus.oidc.client.registration.OidcClientRegistration` if only a single default client registration is done, or `quarkus.oidc.client.registration.OidcClientRegistrations` if more than one registration is configured, and use metadata of the clients registered with these configurations. + +For example: + +[source,java] +---- +package io.quarkus.it.keycloak; + +import java.net.URI; +import java.util.List; +import java.util.Optional; + +import jakarta.inject.Inject; +import jakarta.inject.Singleton; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +import io.quarkus.oidc.OidcRequestContext; +import io.quarkus.oidc.OidcTenantConfig; +import io.quarkus.oidc.OidcTenantConfig.ApplicationType; +import io.quarkus.oidc.TenantConfigResolver; +import io.quarkus.oidc.client.registration.ClientMetadata; +import io.quarkus.oidc.client.registration.OidcClientRegistration; +import io.quarkus.oidc.client.registration.OidcClientRegistrationConfig; +import io.quarkus.oidc.client.registration.OidcClientRegistrations; +import io.quarkus.oidc.client.registration.RegisteredClient; +import io.smallrye.mutiny.Uni; +import io.vertx.ext.web.RoutingContext; + +@Singleton +public class CustomTenantConfigResolver implements TenantConfigResolver { + + @Inject + OidcClientRegistration clientReg; + + @Inject + OidcClientRegistrations clientRegs; + + @Override + public Uni resolve(RoutingContext routingContext, + OidcRequestContext requestContext) { + + if (routingContext.request().path().endsWith("/protected")) { + // Use the registered client created from the default OIDC client registration + return clientReg.registeredClient().onItem().transform(client -> createTenantConfig("registered-client", client)); + } else if (routingContext.request().path().endsWith("/protected/tenant")) { + // Use the registered client created from the named 'tenant-client' OIDC client registration + OidcClientRegistration tenantClientReg = clientRegs.getClientRegistration("tenant-client"); + return tenantClientReg.registeredClient().onItem().transform(client -> createTenantConfig("registered-client-tenant", client)); + } + return null; + } + + // Convert metadata of registered clients to OidcTenantConfig + private OidcTenantConfig createTenantConfig(String tenantId, RegisteredClient client) { + ClientMetadata metadata = client.getMetadata(); + + OidcTenantConfig oidcConfig = new OidcTenantConfig(); + oidcConfig.setTenantId(tenantId); + oidcConfig.setAuthServerUrl(authServerUrl); + oidcConfig.setApplicationType(ApplicationType.WEB_APP); + oidcConfig.setClientName(metadata.getClientName()); + oidcConfig.setClientId(metadata.getClientId()); + oidcConfig.getCredentials().setSecret(metadata.getClientSecret()); + String redirectUri = metadata.getRedirectUris().get(0); + oidcConfig.getAuthentication().setRedirectPath(URI.create(redirectUri).getPath()); + return oidcConfig; + } +} +---- + +[[register-clients-on-demand]] +=== Register clients on demand + +You can register new clients on demand. +You can add new clients to the existing, already configured `OidcClientConfiguration` or to a newly created `OidcClientConfiguration`. + +Start from configuring one or more OIDC client registrations: + +[source,properties] +---- +quarkus.oidc-client-registration.auth-server-url=${quarkus.oidc.auth-server-url} +---- + +The above configuration is sufficient for registering new clients using this configuration. For example: + +[source,java] +---- +package io.quarkus.it.keycloak; + +import java.net.URI; +import java.util.List; +import java.util.Optional; + +import jakarta.inject.Inject; +import jakarta.inject.Singleton; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +import io.quarkus.oidc.OidcRequestContext; +import io.quarkus.oidc.OidcTenantConfig; +import io.quarkus.oidc.OidcTenantConfig.ApplicationType; +import io.quarkus.oidc.TenantConfigResolver; +import io.quarkus.oidc.client.registration.ClientMetadata; +import io.quarkus.oidc.client.registration.OidcClientRegistration; +import io.quarkus.oidc.client.registration.OidcClientRegistrationConfig; +import io.smallrye.mutiny.Uni; +import io.vertx.ext.web.RoutingContext; + +@Singleton +public class CustomTenantConfigResolver implements TenantConfigResolver { + + @Inject + OidcClientRegistration clientReg; + + @Inject + @ConfigProperty(name = "quarkus.oidc.auth-server-url") + String authServerUrl; + + + @Override + public Uni resolve(RoutingContext routingContext, + OidcRequestContext requestContext) { + if (routingContext.request().path().endsWith("/protected/oidc-client-reg-existing-config")) { + // New client registration done dynamically at the request time using the configured client registration + ClientMetadata metadata = createMetadata("http://localhost:8081/protected/dynamic-tenant", + "Dynamic Tenant Client"); + + return clientReg.registerClient(metadata).onItem().transform(r -> + createTenantConfig("registered-client-dynamically", r)); + } + return null; + } + + // Create metadata of registered clients to OidcTenantConfig + private OidcTenantConfig createTenantConfig(String tenantId, ClientMetadata metadata) { + OidcTenantConfig oidcConfig = new OidcTenantConfig(); + oidcConfig.setTenantId(tenantId); + oidcConfig.setAuthServerUrl(authServerUrl); + oidcConfig.setApplicationType(ApplicationType.WEB_APP); + oidcConfig.setClientName(metadata.getClientName()); + oidcConfig.setClientId(metadata.getClientId()); + oidcConfig.getCredentials().setSecret(metadata.getClientSecret()); + String redirectUri = metadata.getRedirectUris().get(0); + oidcConfig.getAuthentication().setRedirectPath(URI.create(redirectUri).getPath()); + return oidcConfig; + } + + protected static ClientMetadata createMetadata(String redirectUri, String clientName) { + return ClientMetadata.builder() + .setRedirectUri(redirectUri) + .setClientName(clientName) + .build(); + } +} +---- + +Alternatively, you can use `OidcClientRegistrations` to prepare a new `OidcClientRegistration` and use `OidcClientRegistration` to register a client. For example: + +[source,java] +---- +package io.quarkus.it.keycloak; + +import java.net.URI; +import java.util.List; +import java.util.Map; +import java.util.Optional; + +import jakarta.inject.Inject; +import jakarta.inject.Singleton; + +import org.eclipse.microprofile.config.inject.ConfigProperty; + +import io.quarkus.oidc.OidcRequestContext; +import io.quarkus.oidc.OidcTenantConfig; +import io.quarkus.oidc.OidcTenantConfig.ApplicationType; +import io.quarkus.oidc.TenantConfigResolver; +import io.quarkus.oidc.client.registration.ClientMetadata; +import io.quarkus.oidc.client.registration.OidcClientRegistration; +import io.quarkus.oidc.client.registration.OidcClientRegistrations; +import io.quarkus.oidc.client.registration.OidcClientRegistrationConfig; +import io.smallrye.mutiny.Uni; +import io.vertx.ext.web.RoutingContext; + +@Singleton +public class CustomTenantConfigResolver implements TenantConfigResolver { + + @Inject + OidcClientRegistrations clientRegs; + + @Inject + @ConfigProperty(name = "quarkus.oidc.auth-server-url") + String authServerUrl; + + @Override + public Uni resolve(RoutingContext routingContext, + OidcRequestContext requestContext) { + if (routingContext.request().path().endsWith("/protected/new-oidc-client-reg")) { + // New client registration done dynamically at the request time + + OidcClientRegistrationConfig clientRegConfig = new OidcClientRegistrationConfig(); + clientRegConfig.auth-server-url = Optional.of(authServerUrl); + clientRegConfig.metadata.redirectUri = Optional.of("http://localhost:8081/protected/new-oidc-client-reg"); + clientRegConfig.metadata.clientName = Optional.of("Dynamic Client"); + + return clientRegs.newClientRegistration(clientRegConfig) + .onItem().transform(reg -> + createTenantConfig("registered-client-dynamically", reg.registeredClient()); + } + + return null; + } + + // Create metadata of registered clients to OidcTenantConfig + private OidcTenantConfig createTenantConfig(String tenantId, ClientMetadata metadata) { + OidcTenantConfig oidcConfig = new OidcTenantConfig(); + oidcConfig.setTenantId(tenantId); + oidcConfig.setAuthServerUrl(authServerUrl); + oidcConfig.setApplicationType(ApplicationType.WEB_APP); + oidcConfig.setClientName(metadata.getClientName()); + oidcConfig.setClientId(metadata.getClientId()); + oidcConfig.getCredentials().setSecret(metadata.getClientSecret()); + String redirectUri = metadata.getRedirectUris().get(0); + oidcConfig.getAuthentication().setRedirectPath(URI.create(redirectUri).getPath()); + return oidcConfig; + } + + protected static ClientMetadata createMetadata(String redirectUri, String clientName) { + return ClientMetadata.builder() + .setRedirectUri(redirectUri) + .setClientName(clientName) + .build(); + } +} +---- + +[[managing-registered-clients]] +=== Managing registered clients + +`io.quarkus.oidc.client.registration.RegisteredClient` represents a registered client and can be used to read and update its metadata. +It can also be used to delete this client. + +For example: + +[source,java] +---- +package io.quarkus.it.keycloak; + + +import jakarta.enterprise.event.Observes; +import jakarta.inject.Inject; +import jakarta.inject.Singleton; + +import io.quarkus.oidc.OidcRequestContext; +import io.quarkus.oidc.OidcTenantConfig; +import io.quarkus.oidc.TenantConfigResolver; +import io.quarkus.oidc.client.registration.OidcClientRegistration; +import io.quarkus.oidc.client.registration.RegisteredClient; +import io.quarkus.runtime.StartupEvent; +import io.smallrye.mutiny.Uni; +import io.vertx.ext.web.RoutingContext; + +@Singleton +public class CustomTenantConfigResolver implements TenantConfigResolver { + + @Inject + OidcClientRegistration clientReg; + + RegisteredClient registeredClient; + + void onStartup(@Observes StartupEvent event) { + + // Default OIDC client registration, client has already been registered at startup, `await()` will return immediately. + registeredClient = clientReg.registeredClient().await().indefinitely(); + + // Read the latest client metadata + registeredClient = registeredClient.read().await().indefinitely(); + } + + @Override + public Uni resolve(RoutingContext routingContext, + OidcRequestContext requestContext) { + + if (routingContext.request().path().endsWith("/protected")) { + // Use the registered client created from the default OIDC client registration + + return createTenantConfig("registered-client", registeredClient)); + } + return null; + } + + // Convert metadata of registered clients to OidcTenantConfig + private OidcTenantConfig createTenantConfig(String tenantId, RegisteredClient client) { + ClientMetadata metadata = client.getMetadata(); + + OidcTenantConfig oidcConfig = new OidcTenantConfig(); + oidcConfig.setTenantId(tenantId); + oidcConfig.setAuthServerUrl(authServerUrl); + oidcConfig.setApplicationType(ApplicationType.WEB_APP); + oidcConfig.setClientName(metadata.getClientName()); + oidcConfig.setClientId(metadata.getClientId()); + oidcConfig.getCredentials().setSecret(metadata.getClientSecret()); + String redirectUri = metadata.getRedirectUris().get(0); + oidcConfig.getAuthentication().setRedirectPath(URI.create(redirectUri).getPath()); + return oidcConfig; + } +} +---- + +[[avoiding-duplicate-registrations]] +=== Avoiding duplicate registrations + +When you register clients in startup, as described in the <> section, you will most likely want to avoid creating duplicate registrations after a restart. + +In this case, you should configure OIDC client registration to perform the registration at the request time, as opposed to at the startup time: + +[source,properties] +---- +quarkus.oidc-client-registration.register-early=false +---- + +The next thing you should do is to persist the already registered client's registration URI and registration token at the shutdown time, you can get them from the `io.quarkus.oidc.client.registration.RegisteredClient` instance. + +Finally, at the startup time, you should restore the already registered client instead of registering it again. + +For example: + +[source,java] +---- +package io.quarkus.it.keycloak; + + +import jakarta.enterprise.event.Observes; +import jakarta.inject.Inject; +import jakarta.inject.Singleton; + +import io.quarkus.oidc.OidcRequestContext; +import io.quarkus.oidc.OidcTenantConfig; +import io.quarkus.oidc.TenantConfigResolver; +import io.quarkus.oidc.client.registration.OidcClientRegistration; +import io.quarkus.oidc.client.registration.RegisteredClient; +import io.quarkus.runtime.ShutdownEvent; +import io.quarkus.runtime.StartupEvent; +import io.smallrye.mutiny.Uni; +import io.vertx.ext.web.RoutingContext; + +@Singleton +public class CustomTenantConfigResolver implements TenantConfigResolver { + + @Inject + OidcClientRegistration clientReg; + + RegisteredClient registeredClient; + + void onStartup(@Observes StartupEvent event) { + + String registrationUri = readRegistrationUriFromDatabase("Registered Client"); + String registrationToken = readRegistrationTokenFromDatabase("Registered Client"); + + if (registrationUri != null && registrationToken != null) { + // Read an already registered client + registeredClient = clientReg.readClient(registrationUri, registrationToken).await().indefinitely(); + } else { + // Register a new client + registeredClient = clientReg.registeredClient().await().indefinitely(); + } + + } + + void onShutdown(@Observes ShutdownEvent event) { + + saveRegistrationUriToDatabase("Registered Client", registeredClient.registrationUri()); + saveRegistrationTokenToDatabase("Registered Client", registeredClient.registrationToken()); + + } + + String readRegistrationUriFromDatabase(String clientName) { + // implementation is not shown for brevity + } + String readRegistrationTokenFromDatabase(String clientName) { + // implementation is not shown for brevity + } + void saveRegistrationUriToDatabase(String clientName, String registrationUri) { + // implementation is not shown for brevity + } + void saveRegistrationTokenToDatabase(String clientName, String registrationToken) { + // implementation is not shown for brevity + } + + @Override + public Uni resolve(RoutingContext routingContext, + OidcRequestContext requestContext) { + + if (routingContext.request().path().endsWith("/protected")) { + // Use the registered client created from the default OIDC client registration + + return createTenantConfig("registered-client", registeredClient)); + } + return null; + } + + // Convert metadata of registered clients to OidcTenantConfig + private OidcTenantConfig createTenantConfig(String tenantId, RegisteredClient client) { + ClientMetadata metadata = client.getMetadata(); + + OidcTenantConfig oidcConfig = new OidcTenantConfig(); + oidcConfig.setTenantId(tenantId); + oidcConfig.setAuthServerUrl(authServerUrl); + oidcConfig.setApplicationType(ApplicationType.WEB_APP); + oidcConfig.setClientName(metadata.getClientName()); + oidcConfig.setClientId(metadata.getClientId()); + oidcConfig.getCredentials().setSecret(metadata.getClientSecret()); + String redirectUri = metadata.getRedirectUris().get(0); + oidcConfig.getAuthentication().setRedirectPath(URI.create(redirectUri).getPath()); + return oidcConfig; + } +} +---- + +If you register clients dynamically, on demand, as described in the <> section, the problem of the duplicate client registration should not arise. +You can persist the already registered client's registration URI and registration token if necessary though and check them too to avoid any duplicate reservation risk. + +[[oidc-client-registration-oidc-request-filters]] +== OIDC request filters + +You can filter OIDC client registration and registered client requests registering one or more `OidcRequestFilter` implementations, which can update or add new request headers. For example, a filter can analyze the request body and add its digest as a new header value: + +You can have a single filter intercepting all the OIDC registration and registered client requests, or use an `@OidcEndpoint` annotation to apply this filter to either OIDC registration or registered client endpoint responses only. For example: + +[source,java] +---- +package io.quarkus.it.keycloak; + +import org.jboss.logging.Logger; + +import io.quarkus.arc.Unremovable; +import io.quarkus.oidc.common.OidcEndpoint; +import io.quarkus.oidc.common.OidcEndpoint.Type; +import io.quarkus.oidc.common.OidcRequestFilter; +import io.vertx.core.json.JsonObject; +import jakarta.enterprise.context.ApplicationScoped; + +@ApplicationScoped +@Unremovable +@OidcEndpoint(value = Type.CLIENT_REGISTRATION) <1> +public class ClientRegistrationRequestFilter implements OidcRequestFilter { + private static final Logger LOG = Logger.getLogger(ClientRegistrationRequestFilter.class); + + @Override + public void filter(OidcRequestContext rc) { + JsonObject body = rc.requestBody().toJsonObject(); + if ("Default Client".equals(body.getString("client_name"))) { <2> + LOG.debug("'Default Client' registration request"); + } + } + +} +---- +<1> Restrict this filter to requests targeting the OIDC client registration endpoint only. +<2> Check the 'client_name' property in the request metadata JSON. + +`OidcRequestContextProperties` can be used to access request properties. +Currently, you can use a `client_id` key to access the client tenant id and a `grant_type` key to access the grant type which the OIDC client uses to acquire tokens. + +[[oidc-client-registration-oidc-response-filters]] +== OIDC response filters + +You can filter responses to OIDC client registration and registered client requests by registering one or more `OidcResponseFilter` implementations, which can check the response status, headers and body in order to log them or perform other actions. + +You can have a single filter intercepting responses to all the OIDC registration and registered client requests, or use an `@OidcEndpoint` annotation to apply this filter to responses from either OIDC registration or registered client endpoint only. For example: + +[source,java] +---- +package io.quarkus.it.keycloak; + +import jakarta.enterprise.context.ApplicationScoped; + +import org.jboss.logging.Logger; + +import io.quarkus.arc.Unremovable; +import io.quarkus.oidc.common.OidcEndpoint; +import io.quarkus.oidc.common.OidcEndpoint.Type; +import io.quarkus.oidc.common.OidcResponseFilter; +import io.vertx.core.json.JsonObject; + +@ApplicationScoped +@Unremovable +@OidcEndpoint(value = Type.CLIENT_REGISTRATION) <1> +public class ClientRegistrationResponseFilter implements OidcResponseFilter { + private static final Logger LOG = Logger.getLogger(ClientRegistrationResponseFilter.class); + + @Override + public void filter(OidcResponseContext rc) { + String contentType = rc.responseHeaders().get("Content-Type"); <2> + JsonObject body = rc.responseBody().toJsonObject(); + if (contentType.startsWith("application/json") + && "Default Client".equals(body.getString("client_name"))) { <3> + LOG.debug("'Default Client' has been registered"); + } + } + +} + +---- +<1> Restrict this filter to requests targeting the OIDC client registration endpoint only. +<2> Check the response `Content-Type` header. +<3> Check the 'client_name' property in the response metadata JSON. + +or + +[source,java] +---- +package io.quarkus.it.keycloak; + +import jakarta.enterprise.context.ApplicationScoped; + +import org.jboss.logging.Logger; + +import io.quarkus.arc.Unremovable; +import io.quarkus.oidc.common.OidcEndpoint; +import io.quarkus.oidc.common.OidcEndpoint.Type; +import io.quarkus.oidc.common.OidcResponseFilter; + +@ApplicationScoped +@Unremovable +@OidcEndpoint(value = Type.REGISTERED_CLIENT) <1> +public class RegisteredClientResponseFilter implements OidcResponseFilter { + private static final Logger LOG = Logger.getLogger(RegisteredClientResponseFilter.class); + + @Override + public void filter(OidcResponseContext rc) { + String contentType = rc.responseHeaders().get("Content-Type"); <2> + if (contentType.startsWith("application/json") + && "Default Client Updated".equals(rc.responseBody().toJsonObject().getString("client_name"))) { <3> + LOG.debug("Registered 'Default Client' has had its name updated to 'Default Client Updated'"); + } + } + +} + +---- +<1> Restrict this filter to requests targeting the registered OIDC client endpoint only. +<2> Check the response `Content-Type` header. +<3> Confirm the client name property was updated. + +[[configuration-reference]] +== Configuration reference + +include::{generated-dir}/config/quarkus-oidc-client-registration.adoc[opts=optional, leveloffset=+1] + +== References + +* https://openid.net/specs/openid-connect-registration-1_0.html[OIDC client registration] +* https://datatracker.ietf.org/doc/html/rfc7592[OAuth2 Dynamic Client Registration Management Protocol] +* https://www.keycloak.org/docs/latest/securing_apps/#_client_registration[Keycloak Dynamic Client Registration Service] +* xref:security-oidc-bearer-token-authentication.adoc[OIDC Bearer token authentication] +* xref:security-oidc-code-flow-authentication.adoc[OIDC code flow mechanism for protecting web applications] +* xref:security-overview.adoc[Quarkus Security overview] diff --git a/_guides/security-openid-connect-client.adoc b/_guides/security-openid-connect-client.adoc index 5e6686a5c38..134a70af243 100644 --- a/_guides/security-openid-connect-client.adoc +++ b/_guides/security-openid-connect-client.adoc @@ -172,7 +172,6 @@ import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; import jakarta.ws.rs.Produces; -import org.eclipse.microprofile.rest.client.annotation.RegisterProvider; import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.client.filter.OidcClientFilter; @@ -237,7 +236,6 @@ import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; import jakarta.ws.rs.Produces; -import org.eclipse.microprofile.rest.client.annotation.RegisterProvider; import org.eclipse.microprofile.rest.client.inject.RegisterRestClient; import io.quarkus.oidc.token.propagation.AccessToken; @@ -446,7 +444,7 @@ public class FrontendExceptionMapper implements ExceptionMapper> section. @@ -530,18 +528,18 @@ include::{includes}/devtools/dev.adoc[] xref:security-openid-connect-dev-services.adoc[Dev Services for Keycloak] launches a Keycloak container and imports `quarkus-realm.json`. -Open a xref:dev-ui.adoc[Dev UI] available at http://localhost:8080/q/dev-ui[/q/dev-ui] and click a `Provider: Keycloak` link in the *OpenID Connect Dev UI* card. +Open a xref:dev-ui.adoc[Dev UI] available at http://localhost:8080/q/dev-ui[/q/dev-ui] and click a `Keycloak provider` link in the *OpenID Connect Dev UI* card. When asked, log in to a `Single Page Application` provided by the OpenID Connect Dev UI: * Log in as `alice`, with the password, `alice`. -This user has a `user` role. - ** Access `/frontend/user-name-with-propagated-token`, which returns `200`. - ** Access `/frontend/admin-name-with-propagated-token`, which returns `403`. - * Log out and back in as `admin` with the password, `admin`. This user has both `admin` and `user` roles. ** Access `/frontend/user-name-with-propagated-token`, which returns `200`. ** Access `/frontend/admin-name-with-propagated-token`, which returns `200`. + * Log out and back in as `bob` with the password, `bob`. +This user has a `user` role. + ** Access `/frontend/user-name-with-propagated-token`, which returns `200`. + ** Access `/frontend/admin-name-with-propagated-token`, which returns `403`. You have tested that `FrontendResource` can propagate the access tokens from the OpenID Connect Dev UI. @@ -580,6 +578,7 @@ After a little while, when the build finishes, you can run the native binary dir ./target/security-openid-connect-quickstart-1.0.0-SNAPSHOT-runner ---- +[[testing]] == Testing the application For more information about testing your application in dev mode, see the preceding <> section. @@ -680,7 +679,7 @@ Call the `/admin-name-with-oidc-client-token-header-param`. In contrast with the [source,bash] ---- curl -i -X GET \ - http://localhost:8080/frontend/admin-name-with-oidc-client-token-param + http://localhost:8080/frontend/admin-name-with-oidc-client-token-header-param ---- Next, test the endpoints which use OIDC client in in the blocking mode. @@ -698,7 +697,7 @@ Call the `/admin-name-with-oidc-client-token-header-param-blocking`. In contrast [source,bash] ---- curl -i -X GET \ - http://localhost:8080/frontend/admin-name-with-oidc-client-token-param-blocking + http://localhost:8080/frontend/admin-name-with-oidc-client-token-header-param-blocking ---- == References diff --git a/_guides/security-openid-connect-multitenancy.adoc b/_guides/security-openid-connect-multitenancy.adoc index 02ccf45bee9..004d220d7ac 100644 --- a/_guides/security-openid-connect-multitenancy.adoc +++ b/_guides/security-openid-connect-multitenancy.adoc @@ -609,7 +609,7 @@ OIDC tenants are resolved in the following order: 3. Static tenant resolution using one of these options: custom `TenantResolver`, configured tenant paths, and defaulting to the last request path segment as a tenant id. -Finally, the default OIDC tenant is selected if a tenant id has not been resolved after the preceeding steps. +Finally, the default OIDC tenant is selected if a tenant id has not been resolved after the preceding steps. See the following sections for more information: @@ -970,7 +970,7 @@ quarkus.oidc.credentials.secret=secret-default quarkus.oidc.application-type=web-app ---- -The preceeding example assumes that the `tenant-a`, `tenant-b` and default tenants are all used to protect the same endpoint paths. In other words, after the user has authenticated with the `tenant-a` configuration, this user will not be able to choose to authenticate with the `tenant-b` or default configuration before this user logs out and has a session cookie cleared or expired. +The preceding example assumes that the `tenant-a`, `tenant-b` and default tenants are all used to protect the same endpoint paths. In other words, after the user has authenticated with the `tenant-a` configuration, this user will not be able to choose to authenticate with the `tenant-b` or default configuration before this user logs out and has a session cookie cleared or expired. The situation where multiple OIDC `web-app` tenants protect the tenant-specific paths is less typical and also requires an extra care. When multiple OIDC `web-app` tenants such as `tenant-a`, `tenant-b` and default tenants are used to control access to the tenant specific paths, the users authenticated with one OIDC provider must not be able to access the paths requiring an authentication with another provider, otherwise the results can be unpredictable, most likely causing unexpected authentication failures. diff --git a/_guides/security-openid-connect-providers.adoc b/_guides/security-openid-connect-providers.adoc index 72ac3bbc4c7..f24cbd85555 100644 --- a/_guides/security-openid-connect-providers.adoc +++ b/_guides/security-openid-connect-providers.adoc @@ -25,7 +25,7 @@ The configuration of such providers can become complex, very technical and diffi `quarkus.oidc.provider` configuration property has been introduced to refer to well-known OpenID Connect and OAuth2 providers. This property can be used to refer to a provider such as `github` with only a minimum number of customizations required, typically, an account specific `client id`, `client secret` and some properties have to be set to complete the configuration. -This property can be used in `application.properties`, in xref:security-openid-connect-multitenancy.adoc[multi-tenant] set-ups if more than one provider has to be configured (for example, see https://quarkiverse.github.io/quarkiverse-docs/quarkus-renarde/dev/security.html#_using_oidc_for_login[Quarkus Renarde security documentation]), in custom xref:security-openid-connect-multitenancy.adoc#tenant-config-resolver[TenantConfigResolvers] if the tenant configurations are created dynamically. +This property can be used in `application.properties`, in xref:security-openid-connect-multitenancy.adoc[multi-tenant] set-ups if more than one provider has to be configured (for example, see https://docs.quarkiverse.io/quarkus-renarde/dev/security.html#_using_oidc_for_login[Quarkus Renarde security documentation]), in custom xref:security-openid-connect-multitenancy.adoc#tenant-config-resolver[TenantConfigResolvers] if the tenant configurations are created dynamically. == Well Known Providers @@ -207,7 +207,7 @@ In order to set up OIDC for GitHub you need to create a new OAuth application in image::oidc-github-1.png[role="thumb"] -Make sure to fill in the appropriate details, but more importantly the Authorization Callback URL, set to `http://localhost:8080/_renarde/security/oidc-success` +Make sure to fill in the appropriate details, but more importantly the Authorization Callback URL, set to `http://localhost:8080/github` (if you intend to test this using the Quarkus dev mode). Now click on `Register application` and you'll be shown your application page: @@ -266,7 +266,7 @@ Click on the top menu `CREATE CREDENTIALS` > `OAuth client ID`: image::oidc-google-7.png[role="thumb"] -Select `Web application` as `Application type`, and add `http://localhost:8080/_renarde/security/oidc-success` in +Select `Web application` as `Application type`, and add `http://localhost:8080/google` in the `Authorised redirect URIs` list, then press `CREATE`: image::oidc-google-8.png[role="thumb"] @@ -349,7 +349,7 @@ quarkus.oidc.credentials.client-secret.value= === Microsoft In order to set up OIDC for Microsoft you need to go to your https://portal.azure.com[Microsoft Azure Portal], -and search for `Azure Active Directory`, then click on it: +and search for `Microsoft Entra ID` formerly known as `Azure Active Directory` , then click on it: image::oidc-microsoft-1.png[role="thumb"] @@ -357,7 +357,7 @@ Once there, on the left side under `Manage`, click on `App registrations` then c image::oidc-microsoft-2.png[role="thumb"] -Fill in your application name, select `Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)` to allow anyone to log in, and add a `Web` Redirect URI as `http://localhost:8080/_renarde/security/oidc-success`, +Fill in your application name, select `Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)` to allow anyone to log in, and add a `Web` Redirect URI as `http://localhost:8080/microsoft`, then click on `Register`: image::oidc-microsoft-3.png[role="thumb"] @@ -447,8 +447,8 @@ quarkus.oidc.credentials.client-secret= # default value is '/strava' quarkus.oidc.authentication.redirect-path=/fitness/welcome <1> ---- -<1> Strava does not enforce that the redirect (callback) URI which is provided as an authorization code flow parameter is equal to the URI registered in the Strava application because it only requires configuring `ApplicationCallbackDomain`. For example, if `ApplicationCallbackDomain` is set to `www.my-strava-example.com`, Strava will accept redirect URIs such as `www.my-strava-example.com/a`, `www.my-strava-example.com/path/a`, which is not recommended by OAuth2 best security practices, see link:https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics#name-insufficient-redirect-uri-v[Insufficent redirect_uri validation] for more information. -Therefore you must configure a redirect path when working with the Strava provider and Quarkus will enforce that the current request path matches the configured `quarkus.oidc.authentication.redirect-path` value before completing the authotization code flow. See the <> for more information. +<1> Strava does not enforce that the redirect (callback) URI which is provided as an authorization code flow parameter is equal to the URI registered in the Strava application because it only requires configuring `ApplicationCallbackDomain`. For example, if `ApplicationCallbackDomain` is set to `www.my-strava-example.com`, Strava will accept redirect URIs such as `www.my-strava-example.com/a`, `www.my-strava-example.com/path/a`, which is not recommended by OAuth2 best security practices, see link:https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics#name-insufficient-redirect-uri-v[Insufficient redirect_uri validation] for more information. +Therefore you must configure a redirect path when working with the Strava provider and Quarkus will enforce that the current request path matches the configured `quarkus.oidc.authentication.redirect-path` value before completing the authorization code flow. See the <> for more information. [[twitch]] === Twitch diff --git a/_guides/security-properties.adoc b/_guides/security-properties.adoc index 259f6781627..8f6c1cb5278 100644 --- a/_guides/security-properties.adoc +++ b/_guides/security-properties.adoc @@ -4,6 +4,7 @@ and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc //// = Using Security with .properties File + include::_attributes.adoc[] :categories: security :summary: This guide demonstrates how your Quarkus application can use a .properties file to store your user identities. @@ -37,7 +38,12 @@ Both support storage of this information in properties files. The following sections detail the specific configuration properties. -include::{generated-dir}/config/quarkus-elytron-security-properties-file.adoc[opts=optional, leveloffset=+2] +[NOTE] +==== +Basic authentication must be explicitly enabled with `quarkus.http.auth.basic=true`, if more than one authentication mechanism is used. +==== + +include::{generated-dir}/config/quarkus-elytron-security-properties-file.adoc[opts=optional,leveloffset=+2] === Properties Files Realm Configuration @@ -70,10 +76,12 @@ jdoe=p4ssw0rd <2> stuart=test noadmin=n0Adm1n ---- + <1> User `scott` has password defined as `jb0ss` <2> User `jdoe` has password defined as `p4ssw0rd` -This file has usernames and passwords stored in plain text, which is not recommended. If plain text is set to false (or omitted) in the config, then passwords must be stored in the form `MD5 ( username : realm : password )`. +This file has usernames and passwords stored in plain text, which is not recommended. +If plain text is set to false (or omitted) in the config, then passwords must be stored in the form `MD5 ( username : realm : password )`. This can be generated for the first example above by running the command `echo -n scott:MyRealm:jb0ss | md5` from the command line. ==== Roles.properties @@ -86,13 +94,15 @@ jdoe=NoRolesUser <2> stuart=admin,user <3> noadmin=user ---- + <1> User `scott` has been assigned the roles `Admin`, `admin`, `Tester` and `user` <2> User `jdoe` has been assigned the role `NoRolesUser` <3> User `stuart` has been assigned the roles `admin` and `user`. === Embedded Realm Configuration -The embedded realm also supports the mapping of users to passwords and users to roles. It uses the main `application.properties` Quarkus configuration file to embed this information. +The embedded realm also supports the mapping of users to passwords and users to roles. +It uses the main `application.properties` Quarkus configuration file to embed this information. They are configured with properties starting with `quarkus.security.users.embedded`. The following is an example application.properties file section illustrating the embedded realm configuration: @@ -112,10 +122,10 @@ quarkus.security.users.embedded.roles.jdoe=NoRolesUser quarkus.security.users.embedded.roles.noadmin=user ---- -As with the first example, this file has usernames and passwords stored in plain text, which is not recommended. If plain text is set to false (or omitted) in the config, then passwords must be stored in the form `MD5 ( username : realm : password )`. +As with the first example, this file has usernames and passwords stored in plain text, which is not recommended. +If plain text is set to false (or omitted) in the config, then passwords must be stored in the form `MD5 ( username : realm : password )`. This can be generated for the first example above by running the command `echo -n scott:MyRealm:jb0ss | md5` from the command line. - ==== Embedded Users The user to password mappings are specified in the `application.properties` file by properties keys of the form `quarkus.security.users.embedded.users.=`. @@ -130,6 +140,7 @@ quarkus.security.users.embedded.users.stuart=test # <2> quarkus.security.users.embedded.users.jdoe=p4ssw0rd quarkus.security.users.embedded.users.noadmin=n0Adm1n ---- + <1> User `scott` has password `jb0ss` <2> User `stuart` has password `test` @@ -147,6 +158,7 @@ quarkus.security.users.embedded.roles.stuart=admin,user # <2> quarkus.security.users.embedded.roles.jdoe=NoRolesUser quarkus.security.users.embedded.roles.noadmin=user ---- + <1> User `scott` has roles `Admin`, `admin`, `Tester`, and `user` <2> User `stuart` has roles `admin` and `user` diff --git a/_guides/security-testing.adoc b/_guides/security-testing.adoc index 7c0a1cd435a..bed66779c75 100644 --- a/_guides/security-testing.adoc +++ b/_guides/security-testing.adoc @@ -133,6 +133,29 @@ The feature is only available for `@QuarkusTest` and will **not** work on a `@Qu This is particularly useful if the same set of security settings needs to be used in multiple test methods. ==== +The `@TestSecurity` annotation also works with the `@PermissionsAllowed` security annotation. +Consider following example: + +[source,java] +---- +@Test +@TestSecurity(user = "testUser", permissions = "see:detail") +void someTestMethod() { + ... +} +---- + +This will run the test with an identity possessing permission `see` and action `detail`. +Consequently, call to the `getDetail` method declared in the example below will succeed: + +[source,java] +---- +@PermissionsAllowed("see:detail") +public String getDetail() { + return "detail"; +} +---- + === Mixing security tests If it becomes necessary to test security features using both `@TestSecurity` and Basic Auth (which is the fallback auth diff --git a/_guides/security-vulnerability-detection.adoc b/_guides/security-vulnerability-detection.adoc index 4d11529ac6d..2e113bdb5c2 100644 --- a/_guides/security-vulnerability-detection.adoc +++ b/_guides/security-vulnerability-detection.adoc @@ -51,6 +51,13 @@ Next, configure the plugin as follows: org.owasp dependency-check-maven ${owasp-dependency-check-plugin.version} + + + + check + + + 7 @@ -92,7 +99,7 @@ To detect less severe issues, adjust the value of `failBuildOnCVSS` to suppress ^io\.smallrye\.reactive:mutiny.*:.*$ @@ -101,7 +108,7 @@ To detect less severe issues, adjust the value of `failBuildOnCVSS` to suppress ^io\.smallrye\.reactive:smallrye-mutiny.*:.*$ @@ -110,7 +117,7 @@ To detect less severe issues, adjust the value of `failBuildOnCVSS` to suppress ^io\.smallrye\.reactive:vertx-mutiny.*:.*$ diff --git a/_guides/stork-kubernetes.adoc b/_guides/stork-kubernetes.adoc index b939eb34bd1..b841e3da934 100644 --- a/_guides/stork-kubernetes.adoc +++ b/_guides/stork-kubernetes.adoc @@ -104,7 +104,7 @@ implementation("io.quarkus:quarkus-kubernetes-client") implementation("io.quarkus:quarkus-container-image-jib") ---- -`stork-service-discovery-kubernetes` provides an implementation of service discovery for Kubernetes. `stork-load-balancer-random` provides an implementation of random load balancer. `quarkus-kubernetes` enables the generation of Kubernetes manifests each time we perform a build. The `quarkuks-kubernetes-client` extension enables the use of the Fabric8 Kubernetes Client in native mode. And `quarkus-container-image-jib` enables the build of a container image using https://github.com/GoogleContainerTools/jib[Jib]. +`stork-service-discovery-kubernetes` provides an implementation of service discovery for Kubernetes. `stork-load-balancer-random` provides an implementation of random load balancer. `quarkus-kubernetes` enables the generation of Kubernetes manifests each time we perform a build. The `quarkus-kubernetes-client` extension enables the use of the Fabric8 Kubernetes Client in native mode. And `quarkus-container-image-jib` enables the build of a container image using https://github.com/GoogleContainerTools/jib[Jib]. == The Blue and Red services diff --git a/_guides/telemetry-micrometer.adoc b/_guides/telemetry-micrometer.adoc index a61966fa16d..d8d225204da 100644 --- a/_guides/telemetry-micrometer.adoc +++ b/_guides/telemetry-micrometer.adoc @@ -181,8 +181,8 @@ Given the following declaration of a timer: `registry.timer("http.server.request Metrics, single numerical measurements, often have additional data captured with them. This ancillary data is used to group or aggregate metrics for analysis. The Micrometer API refers to this dimensional data as tags, but you may see it referred to as "labels" or "attributes" in other documentation sources. -Micrometer is built primariliy for backend monitoring systems that support dimensional data (metric names that are enchriched with key/value pairs). -For heirarchical systems that only support a flat metric name, Micrometer will flatten the set of key/value pairs (sorted by key) and add them to the name. +Micrometer is built primarily for backend monitoring systems that support dimensional data (metric names that are enriched with key/value pairs). +For hierarchical systems that only support a flat metric name, Micrometer will flatten the set of key/value pairs (sorted by key) and add them to the name. Tags can be specified when a meter is registered with a `MeterRegistry` or using a <>. @@ -590,6 +590,10 @@ link:https://micrometer.io/docs/concepts[official documentation]. By providing CDI beans that implement `io.quarkus.micrometer.runtime.HttpServerMetricsTagsContributor`, user code can contribute arbitrary tags based on the details of HTTP request +=== Use `HttpClientMetricsTagsContributor` for client HTTP requests + +By providing CDI beans that implement `io.quarkus.micrometer.runtime.HttpClientMetricsTagsContributor`, user code can contribute arbitrary tags based on the details of HTTP request + === Use `MeterRegistryCustomizer` for arbitrary customizations to meter registries By providing CDI beans that implement `io.quarkus.micrometer.runtime.MeterRegistryCustomizer` user code has the change to change the configuration of any `MeterRegistry` that has been activated. diff --git a/_guides/telemetry-opentracing-to-otel-tutorial.adoc b/_guides/telemetry-opentracing-to-otel-tutorial.adoc index 35cfd903c84..74c59b19ec5 100644 --- a/_guides/telemetry-opentracing-to-otel-tutorial.adoc +++ b/_guides/telemetry-opentracing-to-otel-tutorial.adoc @@ -281,7 +281,7 @@ The OpenTelemetry tracer is not compatible with the OpenTracing API. The main ch |1 |`@Inject io.opentracing.Tracer legacyTracer;` -|`@Injectio.opentelemetry.api.trace.Tracer otelTracer;` +|`@Inject io.opentelemetry.api.trace.Tracer otelTracer;` |2 |`@Traced` diff --git a/_guides/testing-components.adoc b/_guides/testing-components.adoc index 6aeb6bfe1d0..6215ccfee67 100644 --- a/_guides/testing-components.adoc +++ b/_guides/testing-components.adoc @@ -84,7 +84,7 @@ public class FooTest { <1> The `QuarkusComponentTest` annotation registers the JUnit extension. <2> Sets a configuration property for the test. <3> The test injects the component under the test. The types of all fields annotated with `@Inject` are considered the component types under test. You can also specify additional component classes via `@QuarkusComponentTest#value()`. Furthermore, the static nested classes declared on the test class are components too. -<4> The test also injects a mock for `Charlie`. `Charlie` is an _unsatisifed_ dependency for which a synthetic `@Singleton` bean is registered automatically. The injected reference is an "unconfigured" Mockito mock. +<4> The test also injects a mock for `Charlie`. `Charlie` is an _unsatisfied_ dependency for which a synthetic `@Singleton` bean is registered automatically. The injected reference is an "unconfigured" Mockito mock. <5> We can leverage the Mockito API in a test method to configure the behavior. `QuarkusComponentTestExtension` also resolves parameters of test methods and injects matching beans. @@ -116,7 +116,7 @@ public class FooTest { ---- <1> Parameters annotated with `@io.quarkus.test.component.SkipInject` are never resolved by this extension. -Furthermore, if you need the full control over the `QuarkusComponentTestExtension` configuration then you can use the `@RegisterExtension` annotation and configure the extension programatically. +Furthermore, if you need the full control over the `QuarkusComponentTestExtension` configuration then you can use the `@RegisterExtension` annotation and configure the extension programmatically. The original test could be rewritten like: diff --git a/_guides/tests-with-coverage.adoc b/_guides/tests-with-coverage.adoc index 732b946ce14..d1bceb1b2b4 100644 --- a/_guides/tests-with-coverage.adoc +++ b/_guides/tests-with-coverage.adoc @@ -191,6 +191,8 @@ specifying a `data-file` or `report-location` will assume the path as is. Here i @{argLine} -your -extra -arguments`. + == Running the tests with coverage Run `mvn verify`, the tests will be run and the results will end up in `target/jacoco-reports`. This is all that is needed, diff --git a/_guides/tls-registry-reference.adoc b/_guides/tls-registry-reference.adoc index 2d004c41f0e..86f9a23cc39 100644 --- a/_guides/tls-registry-reference.adoc +++ b/_guides/tls-registry-reference.adoc @@ -21,7 +21,12 @@ The TLS Registry consolidates settings and supports multiple named configuration Therefore, you can tailor TLS settings for different application parts. This flexibility is particularly useful when different components require distinct security configurations. -The TLS Registry extension is automatically included in your project when you use compatible extensions, such as Quarkus REST, gRPC, or Reactive Routes. +The TLS Registry extension is automatically included in your project when you use compatible extensions, such as Quarkus REST, gRPC, SmallRye GraphQL Client +ifndef::no-reactive-routes[] +, or Reactive Routes +endif::no-reactive-routes[] +. + As a result, applications that use the TLS Registry can be ready to handle secure communications out of the box. TLS Registry also provides features like automatic certificate reloading, Let's Encrypt (ACME) integration, Kubernetes Cert-Manager support, and compatibility with various keystore formats, such as PKCS12, PEM, and JKS. @@ -145,6 +150,24 @@ quarkus.http.tls-configuration-name=MY_TLS_CONFIGURATION quarkus.grpc.clients.hello.tls-configuration-name=MY_TLS_CONFIGURATION ---- +.Example configuration for a SmallRye GraphQL client: +[source,properties] +---- +quarkus.smallrye-graphql-client.my-client.tls-configuration-name=MY_TLS_CONFIGURATION +---- + +[NOTE] +==== +When using the Typesafe GraphQL client with a certificate +reloading mechanism (see <>), it is essential to +override the bean's scope to `RequestScoped` (or another similar scope +shorter than application). This is because by default, the Typesafe client is an +application-scoped bean, so shortening the scope guarantees that new instances of the bean +created after a certificate reload will be configured with the latest +certificate. Dynamic clients are `@Dependent` scoped, so you should +inject them into components with an appropriate scope. +==== + == Configuring TLS TLS configuration primarily involves managing keystores and truststores. @@ -652,9 +675,10 @@ quarkus.tls.http.key-store.pem.0.cert=tls.crt quarkus.tls.http.key-store.pem.0.key=tls.key ---- -IMPORTANT: Impacted server and client may need to listen to the `CertificateReloadedEvent` to apply the new certificates. +IMPORTANT: Impacted server and client may need to listen to the `CertificateUpdatedEvent` to apply the new certificates. This is automatically done for the Quarkus HTTP server, including the management interface if it is enabled. +ifndef::no-kubernetes-secrets-or-cert-manager[] == Using Kubernetes secrets or cert-manager When running in Kubernetes, you can use Kubernetes secrets to store the keystores and truststores. @@ -765,6 +789,9 @@ The generated secret includes the following files: %prod.quarkus.http.tls-configuration-name=http %prod.quarkus.http.insecure-requests=disabled ---- +endif::no-kubernetes-secrets-or-cert-manager[] +// The reason for this ifndef condition is that this content is not supported in product docs. +// Feel free to add more content to this chapter, but make sure this condition encloses it. == Working with OpenShift serving certificates @@ -1211,6 +1238,7 @@ sudo update-ca-certificates sudo security -v remove-trusted-cert -d /Users/clement/.quarkus/quarkus-dev-root-ca.pem ---- +ifndef::no-lets-encrypt[] [[lets-encrypt]] == Automatic certificate management with Let's Encrypt @@ -1313,7 +1341,7 @@ java -jar quarkus-run.jar .. Keep the application running and request your first Let's Encrypt certificate. [[lets-encrypt-issue-certificate]] -=== Issue a certificate: +=== Issue a certificate . From the application directory, run the `issue-certificate` command to acquire your first Let's Encrypt certificate: + @@ -1363,7 +1391,7 @@ Once the Let's Encrypt certificate chain and private key have been successfully The TLS registry is notified when a new certificate and private key are ready, and it automatically reloads them. [[lets-encrypt-ngrok]] -=== Testing with ngrok: +=== Testing with ngrok link:https://ngrok.com/[ngrok] can be used to provide a secure HTTPS tunnel to your application running on localhost, and make it easy to test HTTPS based applications. @@ -1394,3 +1422,6 @@ ngrok http --domain 8080 --scheme http <1> Note that the application will be accessible from `http://YOUR-NGROK-DOMAIN` on port `80` but redirected to your local machine on port `8080`. . Test the Quarkus Let's Encrypt ACME feature from your local machine. +endif::no-lets-encrypt[] +// The reason for this ifndef condition is that this content is not supported in product docs. +// Feel free to add more content to this chapter, but make sure this condition encloses it. diff --git a/_guides/transaction.adoc b/_guides/transaction.adoc index e1a79bd5e1d..efed7ffa0cf 100644 --- a/_guides/transaction.adoc +++ b/_guides/transaction.adoc @@ -164,7 +164,6 @@ a functional approach that allows you to run a lambda within the scope of a tran [source,java] ---- import io.quarkus.narayana.jta.QuarkusTransaction; -import io.quarkus.narayana.jta.RunOptions; public class TransactionExample { @@ -191,7 +190,7 @@ public class TransactionExample { .timeout(10) .exceptionHandler((throwable) -> { if (throwable instanceof SomeException) { - return RunOptions.ExceptionResult.COMMIT; + return TransactionExceptionResult.COMMIT; } return TransactionExceptionResult.ROLLBACK; }) diff --git a/_guides/validation.adoc b/_guides/validation.adoc index 425d97b01fc..921c5e81de8 100644 --- a/_guides/validation.adoc +++ b/_guides/validation.adoc @@ -199,6 +199,42 @@ As you can see, we don't have to manually validate the provided `Book` anymore a If a validation error is triggered, a violation report is generated and serialized as JSON as our end point produces a JSON output. It can be extracted and manipulated to display a proper error message. +An example of such a report could be: + +[source, json] +---- +{ + "title": "Constraint Violation", + "status": 400, + "violations": [ + { + "field": "tryMeEndPointMethodValidation.book.title", + "message": "Title cannot be blank" + } + ] +} +---- + +This response is produced by Quarkus via a builtin implementation of `jakarta.ws.rs.ext.ExceptionMapper`. If the application code needs to handle `ValidationException` in some custom way, +it can provide an implementation of `jakarta.ws.rs.ext.ExceptionMapper` like so: + +[source, java] +---- +import jakarta.validation.ValidationException; +import jakarta.ws.rs.core.Response; +import jakarta.ws.rs.ext.ExceptionMapper; +import jakarta.ws.rs.ext.Provider; + +@Provider +public class ResteasyReactiveViolationExceptionMapper implements ExceptionMapper { + + @Override + public Response toResponse(ValidationException exception) { + // TODO: implement + } +} +---- + == Service method validation It might not always be handy to have the validation rules declared at the end point level as it could duplicate some business validation. diff --git a/_guides/vertx-reference.adoc b/_guides/vertx-reference.adoc index b542c1ff0f2..4e2f0ffcced 100644 --- a/_guides/vertx-reference.adoc +++ b/_guides/vertx-reference.adoc @@ -732,7 +732,7 @@ Read xref:./virtual-threads.adoc[the virtual thread guide] for more details. The https://vertx.io/docs/vertx-core/java/#event_bus[Vert.x Event Bus] uses https://vertx.io/docs/vertx-core/java/#_message_codecs[codecs] to _serialize_ and _deserialize_ message objects. Quarkus provides a default codec for local delivery. -This codec is automatically used for return types and message body parameters of local consumers, i.e. methods annotated with `@ConsumeEvent` whete `ConsumeEvent#local() == true` (which is the default). +This codec is automatically used for return types and message body parameters of local consumers, i.e. methods annotated with `@ConsumeEvent` where `ConsumeEvent#local() == true` (which is the default). So that you can exchange the message objects as follows: diff --git a/_guides/web-dependency-locator.adoc b/_guides/web-dependency-locator.adoc index b036f018c8a..b4d4c2fba7f 100644 --- a/_guides/web-dependency-locator.adoc +++ b/_guides/web-dependency-locator.adoc @@ -113,7 +113,7 @@ This means adding the following to your `index.html` will allow you to import we ===== Automatic imports -You can also automate the imports above. To do this, move your web assests from `src/main/resources/META-INF/resources` to `src/main/web` +You can also automate the imports above. To do this, move your web assets from `src/main/resources/META-INF/resources` to `src/main/resources/web` and now replace the above scripts and imports with `{#bundle /}`: [source,html] diff --git a/_guides/web.adoc b/_guides/web.adoc index dc3cf6f74aa..177b329f547 100644 --- a/_guides/web.adoc +++ b/_guides/web.adoc @@ -39,7 +39,7 @@ NOTE: *We recommend using a bundler for production* as it offers better control, There are two ways to bundle your web assets: a. Using https://docs.quarkiverse.io/quarkus-web-bundler/dev/[the Quarkus Web Bundler extension], which is the recommended way. Without any configuration, it puts everything together in an instant, and follows good practices such as dead-code elimination, minification, caching, and more. -b. Using a custom bundler such as Webpack, Parcel, Rollup, etc. This can be easily integrated with Quarkus using the https://quarkiverse.github.io/quarkiverse-docs/quarkus-quinoa/dev/[Quarkus Quinoa extension]. +b. Using a custom bundler such as Webpack, Parcel, Rollup, etc. This can be easily integrated with Quarkus using the https://docs.quarkiverse.io/quarkus-quinoa/dev/[Quarkus Quinoa extension]. image::web-bundle-transition.png[Web Bundle Transition] @@ -155,11 +155,13 @@ public class Todos extends Controller { } ---- +NOTE: Check out https://www.youtube.com/watch?v=JNmHNSmK180[Quarkus Insights Episode #178]. First part is a hands-on demonstration of creating a CMS with Renarde. You can also give it a try using https://github.com/quarkusio/quarkus-web-lab[the web-lab repo]). + == Single Page Applications Quarkus provides very solid tools for creating or integrating Single Page Applications to Quarkus (React, Angular, Vue, …), here are 3 options: -* https://quarkiverse.github.io/quarkiverse-docs/quarkus-quinoa/dev/[Quarkus Quinoa] bridges your npm-compatible web application and Quarkus for both dev and prod. No need to install Node.js or configure your framework, it will detect it and use sensible defaults. +* https://docs.quarkiverse.io/quarkus-quinoa/dev/[Quarkus Quinoa] bridges your npm-compatible web application and Quarkus for both dev and prod. No need to install Node.js or configure your framework, it will detect it and use sensible defaults. * The https://docs.quarkiverse.io/quarkus-web-bundler/dev/[Quarkus Web Bundler] is also a good approach, it is closer to the Java ecosystem and removes a lot of boilerplate and configuration, it is fast and efficient. For examples of such SPAs, see https://github.com/quarkusio/code.quarkus.io[code.quarkus.io] and https://github.com/mvnpm/mvnpm[mvnpm.org]. * Your automation using the https://github.com/eirslett/frontend-maven-plugin[maven-frontend-plugin] or similar tools. @@ -265,8 +267,3 @@ You could also split it in two services: one for the backend and one for the fro If your application involves a substantial number of static resources, consider using a CDN. Both the Web Bundler and Quinoa can be configured to work seamlessly with a CDN, providing improved performance and distribution of assets. // It would be nice to have a blog article and benchmark about this topic. - - - - - diff --git a/_guides/websockets-next-reference.adoc b/_guides/websockets-next-reference.adoc index 779057a83e1..4d93591fcd0 100644 --- a/_guides/websockets-next-reference.adoc +++ b/_guides/websockets-next-reference.adoc @@ -159,7 +159,7 @@ Endpoints are managed as CDI beans. By default, the `@Singleton` scope is used. However, developers can specify alternative scopes to fit their specific requirements. -`@Singleton` and `@ApplicationScoped` endpoints are shared accross all WebSocket connections. +`@Singleton` and `@ApplicationScoped` endpoints are shared across all WebSocket connections. Therefore, implementations should be either stateless or thread-safe. [source,java] @@ -421,11 +421,11 @@ An endpoint may declare multiple methods annotated with `@io.quarkus.websockets. However, each method must declare a different error parameter. The method that declares a most-specific supertype of the actual exception is selected. -NOTE: The `@io.quarkus.websockets.next.OnError` annotation can be also used to declare a global error handler, i.e. a method that is not declared on a WebSocket endpoint. Such a method may not accept `@PathParam` paremeters. Error handlers declared on an endpoint take precedence over the global error handlers. +NOTE: The `@io.quarkus.websockets.next.OnError` annotation can be also used to declare a global error handler, i.e. a method that is not declared on a WebSocket endpoint. Such a method may not accept `@PathParam` parameters. Error handlers declared on an endpoint take precedence over the global error handlers. When an error occurs but no error handler can handle the failure, Quarkus uses the strategy specified by `quarkus.websockets-next.server.unhandled-failure-strategy`. -By default, the connection is closed. -Alternatively, an error message can be logged or no operation performed. +For server endpoints, the error message is logged and the connection is closed by default. +For client endpoints, the error message is logged by default. [[serialization]] === Serialization and deserialization @@ -640,6 +640,40 @@ class MyBean { There are also other convenient methods. For example, `OpenConnections#findByEndpointId(String)` makes it easy to find connections for a specific endpoint. +==== User data + +It is also possible to associate arbitrary user data with a specific connection. +The `io.quarkus.websockets.next.UserData` object obtained by the `WebSocketConnection#userData()` method represents mutable user data associated with a connection. + +[source, java] +---- +import io.quarkus.websockets.next.WebSocketConnection; +import io.quarkus.websockets.next.UserData.TypedKey; + +@WebSocket(path = "/endpoint/{username}") +class MyEndpoint { + + @Inject + CoolService service; + + @OnOpen + void open(WebSocketConnection connection) { + connection.userData().put(TypedKey.forBoolean("isCool"), service.isCool(connection.pathParam("username"))); <1> + } + + @OnTextMessage + String process(String message) { + if (connection.userData().get(TypedKey.forBoolean("isCool"))) { <2> + return "Cool message processed!"; + } else { + return "Message processed!"; + } + } +} +---- +<1> `CoolService#isCool()` returns `Boolean` that is associated with the current connection. +<2> The `TypedKey.forBoolean("isCool")` is the key used to obtain the data stored when the connection was created. + [[server-cdi-events]] ==== CDI events @@ -805,6 +839,47 @@ TIP: You can choose WebSocket endpoints to which the `HttpUpgradeCheck` is appli As a direct consequence of the fact this extension reuses the _main_ HTTP server, all the relevant server configurations apply. See Refer to the xref:http-reference.adoc#ssl[HTTP guide] for more details. +=== Hibernate multitenancy +The `RoutingContext` is not available after the HTTP upgrade. However, it is possible to inject the `WebSocketConnection` and access the headers of the initial HTTP request. + +If a custom `TenantResolver` is used and you would like to combine REST/HTTP and WebSockets, the code may look like this: +[source, java] +---- +@RequestScoped +@PersistenceUnitExtension +public class CustomTenantResolver implements TenantResolver { + + @Inject + RoutingContext context; + @Inject + WebSocketConnection connection; + + @Override + public String getDefaultTenantId() { + return "public"; + } + + @Override + public String resolveTenantId() { + String schema; + try { + //Handle WebSocket + schema = connection.handshakeRequest().header("schema"); + } catch ( ContextNotActiveException e) { + // Handle REST/HTTP + schema = context.request().getHeader( "schema" ); + } + + if ( schema == null || schema.equalsIgnoreCase( "public" ) ) { + return "public"; + } + + return schema; + } +} +---- +For more information on Hibernate multitenancy, refer to the https://quarkus.io/guides/hibernate-orm#multitenancy[hibernate documentation]. + == Client API [[client-connectors]] @@ -838,7 +913,7 @@ The connector for this client endpoint is used as follows: @Singleton public class MyBean { - @ConfigProperty(name = "enpoint.uri") + @ConfigProperty(name = "endpoint.uri") URI myUri; @Inject @@ -956,6 +1031,41 @@ class MyBean { There are also other convenient methods. For example, `OpenClientConnections#findByClientId(String)` makes it easy to find connections for a specific endpoint. +==== User data + +It is also possible to associate arbitrary user data with a specific connection. +The `io.quarkus.websockets.next.UserData` object obtained by the `WebSocketClientConnection#userData()` method represents mutable user data associated with a connection. + +[source, java] +---- +import io.quarkus.websockets.next.WebSocketClientConnection; +import io.quarkus.websockets.next.UserData.TypedKey; + +@WebSocketClient(path = "/endpoint/{username}") +class MyEndpoint { + + @Inject + CoolService service; + + @OnOpen + void open(WebSocketClientConnection connection) { + connection.userData().put(TypedKey.forBoolean("isCool"), service.isCool(connection.pathParam("username"))); <1> + } + + @OnTextMessage + String process(String message) { + if (connection.userData().get(TypedKey.forBoolean("isCool"))) { <2> + return "Cool message processed!"; + } else { + return "Message processed!"; + } + } +} +---- +<1> `CoolService#isCool()` returns `Boolean` that is associated with the current connection. +<2> The `TypedKey.forBoolean("isCool")` is the key used to obtain the data stored when the connection was created. + + [[client-cdi-events]] ==== CDI events diff --git a/_guides/writing-extensions.adoc b/_guides/writing-extensions.adoc index ae68e03438e..81c18ab1513 100644 --- a/_guides/writing-extensions.adoc +++ b/_guides/writing-extensions.adoc @@ -17,7 +17,8 @@ Quarkus extensions add a new developer focused behavior to the core offering, an This means that metadata is only processed once at build time, which both saves on startup time, and also on memory usage as the classes etc that are used for processing are not loaded (or even present) in the runtime JVM. -NOTE: This is an in-depth documentation, see the xref:building-my-first-extension.adoc[building my first extension] if you need an introduction. +NOTE: This is an in-depth documentation, see the xref:building-my-first-extension.adoc[building my first extension] if you need an introduction, +or the xref:extension-faq.adoc[frequently asked questions]. == Extension philosophy @@ -1452,7 +1453,9 @@ class MyDevModeProcessor { <3> The other build step will only be executed in dev mode. [id='bytecode-recording'] -=== Bytecode Recording +=== Generating Bytecode + +==== Bytecode Recording One of the main outputs of the build process is recorded bytecode. This bytecode actually sets up the runtime environment. For example, in order to start Undertow, the resulting application will have some bytecode that directly registers all Servlet instances and then starts Undertow. @@ -1546,12 +1549,8 @@ However, this method should not be needed in most use cases because directly loa Therefore, this method is deprecated. Nonetheless, there are some use cases where this method comes in handy, such as referring to classes that were generated in previous build steps using `GeneratedClassBuildItem`. -==== Runtime Classpath check - -Extensions often need a way to determine whether a given class is part of the application's runtime classpath. -The proper way for an extension to perform this check is to use `io.quarkus.bootstrap.classloading.QuarkusClassLoader.isClassPresentAtRuntime`. -==== Printing step execution time +===== Printing step execution time At times, it can be useful to know how the exact time each startup task (which is the result of each bytecode recording) takes when the application is run. The simplest way to determine this information is to launch the Quarkus application with the `-Dquarkus.debug.print-startup-times=true` system property. @@ -1571,11 +1570,23 @@ Build step VertxHttpProcessor.openSocket completed in: 93ms Build step ShutdownListenerBuildStep.setupShutdown completed in: 1ms ---- +==== Using Gizmo + +In some scenarios, more significant manipulation of bytecode may be needed. +If bytecode recording isn't sufficient, link:https://github.com/quarkusio/gizmo/blob/main/USAGE.adoc[Gizmo] is a convenient alternative to ASM, with a higher-level API. + +==== Runtime Classpath check + +Extensions often need a way to determine whether a given class is part of the application's runtime classpath. +The proper way for an extension to perform this check is to use `io.quarkus.bootstrap.classloading.QuarkusClassLoader.isClassPresentAtRuntime`. + //// TODO: config integration //// === Contexts and Dependency Injection +The xref:cdi-integration.adoc[CDI integration guide] has more detail on common CDI-related use cases, and example code for solutions. + ==== Extension Points As a CDI based runtime, Quarkus extensions often make CDI beans available as part of the extension behavior. @@ -1973,7 +1984,7 @@ to initiate a scan for changed files. Where extensions use an external service, adding a Dev Service can improve the user experience in development and test modes. See xref:extension-writing-dev-service.adoc[how to write a Dev Service] for more details. - +[[testing-extensions]] === Testing Extensions Testing of Quarkus extensions should be done with the `io.quarkus.test.QuarkusUnitTest` JUnit 5 extension. @@ -2249,6 +2260,7 @@ Quarkus generates a lot of classes during the build phase and in many cases also It is often extremely useful to see the generated bytecode and transformed classes during the development of an extension. If you set the `quarkus.package.jar.decompiler.enabled` property to `true` then Quarkus will download and invoke the https://github.com/Vineflower/vineflower[Vineflower decompiler] and dump the result in the `decompiled` directory of the build tool output (`target/decompiled` for Maven for example). +The output directory can be changed with `quarkus.package.jar.decompiler.output-dir`. NOTE: This property only works during a normal production build (i.e. not for dev mode/tests) and when `fast-jar` packaging type is used (the default behavior). @@ -2285,6 +2297,65 @@ The property is also honored when running tests: Analogously, you can use the `quarkus.debug.transformed-classes-dir` and `quarkus.debug.generated-sources-dir` properties to dump the relevant output. +[[dump-generated-transformed-classes-with-quarkusunittest]] +==== Inspecting Generated/Transformed Classes in `QuarkusUnitTest` + +When <>, +as an alternative to <>, +you may simply call `QuarkusUnitTest#debugBytecode`: + +[source,java] +---- +public class MyTest { + + @RegisterExtension + static QuarkusUnitTest runner = new QuarkusUnitTest() + .withApplicationRoot((jar) -> jar + .addClass(MyEntity.class)) + .debugBytecode(true); + + // ... test methods go here ... + +} +---- + +This will automatically set up these configuration properties so that classes/sources +are dumped to `target/debug`, for that test class only, +in a subdirectory that is unique to each test execution. +See the javadoc of `QuarkusUnitTest#debugBytecode` for details. + +This is handy to debug flaky tests that happen only in the CI environment, in particular; +for example the GitHub Actions CI at https://github.com/quarkusio/quarkus/ +is set up so that such `target/debug` directories are +collected into build artifacts available for download after each CI run. + +[[troubleshooting-trace-logs]] +==== Enabling trace logs for a particular test only + +When <>, +if you need to enable trace logs for a particular test class, +you may simply call `QuarkusUnitTest#traceCategories` and pass the logging categories in argument: + +[source,java] +---- +public class MyTest { + + @RegisterExtension + static QuarkusUnitTest runner = new QuarkusUnitTest() + .withApplicationRoot((jar) -> jar + .addClass(MyEntity.class)) + .traceCategories("org.hibernate", "io.quarkus.hibernate", "io.quarkus.panache"); + + // ... test methods go here ... + +} +---- + +See the javadoc of `QuarkusUnitTest#traceCategories` for details. + +This is handy to debug flaky tests that happen only in the CI environment, in particular, +as this will only increase the verbosity of logs in the particular test where the option is enabled. + ==== Multi-module Maven Projects and the Development Mode It's not uncommon to develop an extension in a multi-module Maven project that also contains an "example" module. diff --git a/_guides/writing-native-applications-tips.adoc b/_guides/writing-native-applications-tips.adoc index 259f74ded76..b7ca08afcc0 100644 --- a/_guides/writing-native-applications-tips.adoc +++ b/_guides/writing-native-applications-tips.adoc @@ -537,7 +537,7 @@ depending on your use case. === Beware of common Java API overrides -Certain commonly used Java methods are overriden by user classes, +Certain commonly used Java methods are overridden by user classes, e.g. `toString`, `equals`, `hashCode`...etc. The majority of overrides do not cause problems, but if they use third party libraries (e.g. for additional formatting),