Sync documentation of main branch

Author: actions-user

_data/versioned/main/index/quarkus.yaml

@@ -128,6 +128,17 @@ types:
     - io.quarkus:quarkus-infinispan-client
     type: reference
     url: /guides/infinispan-client-reference
+  - title: Load Shedding reference guide
+    filename: load-shedding-reference.adoc
+    summary: Load shedding is the practice of detecting service overload and rejecting requests.
+    categories: web
+    topics:
+    - web
+    - load-shedding
+    extensions:
+    - io.quarkus:quarkus-load-shedding
+    type: reference
+    url: /guides/load-shedding-reference
   - title: Logging configuration
     filename: logging.adoc
     summary: "Read about the use of logging API in Quarkus, configuring logging output, and using logging adapters to unify the output from other logging APIs."

_data/versioned/main/index/relations.yaml

@@ -7186,6 +7186,10 @@
     url: /guides/websockets-next-tutorial
     type: tutorial
     matches: 1
+  - title: Load Shedding reference guide
+    url: /guides/load-shedding-reference
+    type: reference
+    matches: 1
   - title: TLS registry reference
     url: /guides/tls-registry-reference
     type: reference
@@ -9316,6 +9320,36 @@
     url: /guides/transaction
     type: reference
     matches: 1
+/guides/load-shedding-reference:
+  sameTopics:
+  - title: Getting started with WebSockets Next
+    url: /guides/websockets-next-tutorial
+    type: tutorial
+    matches: 1
+  - title: HTTP Reference
+    url: /guides/http-reference
+    type: reference
+    matches: 1
+  - title: Quarkus for the Web
+    url: /guides/web
+    type: guide
+    matches: 1
+  - title: Using Reactive Routes
+    url: /guides/reactive-routes
+    type: guide
+    matches: 1
+  - title: Using WebSockets
+    url: /guides/websockets
+    type: guide
+    matches: 1
+  - title: Web dependency locator
+    url: /guides/web-dependency-locator
+    type: guide
+    matches: 1
+  - title: WebSockets Next extension reference guide
+    url: /guides/websockets-next-reference
+    type: reference
+    matches: 1
 /guides/logging:
   sameTopics:
   - title: "Centralized log management (Graylog, Logstash, Fluentd)"
@@ -11610,6 +11644,10 @@
     url: /guides/websockets-next-tutorial
     type: tutorial
     matches: 1
+  - title: Load Shedding reference guide
+    url: /guides/load-shedding-reference
+    type: reference
+    matches: 1
   - title: TLS registry reference
     url: /guides/tls-registry-reference
     type: reference
@@ -20390,6 +20428,10 @@
     url: /guides/websockets-next-tutorial
     type: tutorial
     matches: 1
+  - title: Load Shedding reference guide
+    url: /guides/load-shedding-reference
+    type: reference
+    matches: 1
   - title: Qute Reference Guide
     url: /guides/qute-reference
     type: reference
@@ -20448,6 +20490,10 @@
     url: /guides/websockets-next-tutorial
     type: tutorial
     matches: 1
+  - title: Load Shedding reference guide
+    url: /guides/load-shedding-reference
+    type: reference
+    matches: 1
   - title: TLS registry reference
     url: /guides/tls-registry-reference
     type: reference
@@ -20474,6 +20520,10 @@
     url: /guides/http-reference
     type: reference
     matches: 1
+  - title: Load Shedding reference guide
+    url: /guides/load-shedding-reference
+    type: reference
+    matches: 1
   - title: Quarkus for the Web
     url: /guides/web
     type: guide
@@ -20500,6 +20550,10 @@
     url: /guides/http-reference
     type: reference
     matches: 1
+  - title: Load Shedding reference guide
+    url: /guides/load-shedding-reference
+    type: reference
+    matches: 1
   - title: Quarkus for the Web
     url: /guides/web
     type: guide
@@ -20531,6 +20585,10 @@
     url: /guides/http-reference
     type: reference
     matches: 1
+  - title: Load Shedding reference guide
+    url: /guides/load-shedding-reference
+    type: reference
+    matches: 1
   - title: Quarkus for the Web
     url: /guides/web
     type: guide

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.load.shedding.runtime.LoadSheddingRuntimeConfig.PriorityLoadShedding

@@ -0,0 +1 @@
+[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"Whether priority load shedding should be enabled.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENABLED","enum":false}}]

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig

@@ -1 +1 @@
-[{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager.Strategy","key":".strategy","additionalKeys":[],"configDoc":"Default TokenStateManager strategy.","withinAMap":false,"defaultValue":"keep-all-tokens","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":["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]"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STRATEGY","enum":true}},{"configDocKey":{"type":"boolean","key":".split-tokens","additionalKeys":[],"configDoc":"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","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"split-tokens","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SPLIT_TOKENS","enum":false}},{"configDocKey":{"type":"boolean","key":".encryption-required","additionalKeys":[],"configDoc":"Mandates that the Default TokenStateManager encrypt the session cookie that stores the tokens.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encryption-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENCRYPTION_REQUIRED","enum":false}},{"configDocKey":{"type":"string","key":".encryption-secret","additionalKeys":[],"configDoc":"The secret used by the Default TokenStateManager to encrypt the session cookie storing the tokens when `encryption-required` property is enabled.\n\nIf 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 if it remains uninitialized after checking all of these properties.\n\nThe 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.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"encryption-secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENCRYPTION_SECRET","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager.EncryptionAlgorithm","key":".encryption-algorithm","additionalKeys":[],"configDoc":"Session cookie key encryption algorithm","withinAMap":false,"defaultValue":"a256-gcmkw","javaDocSiteLink":"","docMapKey":"encryption-algorithm","configPhase":"BUILD_TIME","acceptedValues":["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.]"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENCRYPTION_ALGORITHM","enum":true}}]
+[{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager.Strategy","key":".strategy","additionalKeys":[],"configDoc":"Default TokenStateManager strategy.","withinAMap":false,"defaultValue":"keep-all-tokens","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":["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]"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_STRATEGY","enum":true}},{"configDocKey":{"type":"boolean","key":".split-tokens","additionalKeys":[],"configDoc":"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","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"split-tokens","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_SPLIT_TOKENS","enum":false}},{"configDocKey":{"type":"boolean","key":".encryption-required","additionalKeys":[],"configDoc":"Mandates that the Default TokenStateManager encrypt the session cookie that stores the tokens.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encryption-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENCRYPTION_REQUIRED","enum":false}},{"configDocKey":{"type":"string","key":".encryption-secret","additionalKeys":[],"configDoc":"The secret used by the Default TokenStateManager to encrypt the session cookie storing the tokens when `encryption-required` property is enabled.\n\nIf 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.\n\nThe 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.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"encryption-secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENCRYPTION_SECRET","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager.EncryptionAlgorithm","key":".encryption-algorithm","additionalKeys":[],"configDoc":"Session cookie key encryption algorithm","withinAMap":false,"defaultValue":"a256-gcmkw","javaDocSiteLink":"","docMapKey":"encryption-algorithm","configPhase":"BUILD_TIME","acceptedValues":["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.]"],"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_ENCRYPTION_ALGORITHM","enum":true}}]

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig.TokenStateManager

@@ -0,0 +1 @@
+[{"configDocKey":{"type":"boolean","key":"quarkus.load-shedding.enabled","additionalKeys":[],"configDoc":"Whether load shedding should be enabled. Currently, this only applies to incoming HTTP requests.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_ENABLED","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.load-shedding.max-limit","additionalKeys":[],"configDoc":"The maximum number of concurrent requests allowed.","withinAMap":false,"defaultValue":"1000","javaDocSiteLink":"","docMapKey":"max-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_MAX_LIMIT","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.load-shedding.alpha-factor","additionalKeys":[],"configDoc":"The `alpha` factor of the Vegas overload detection algorithm.","withinAMap":false,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"alpha-factor","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_ALPHA_FACTOR","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.load-shedding.beta-factor","additionalKeys":[],"configDoc":"The `beta` factor of the Vegas overload detection algorithm.","withinAMap":false,"defaultValue":"6","javaDocSiteLink":"","docMapKey":"beta-factor","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_BETA_FACTOR","enum":false}},{"configDocKey":{"type":"double","key":"quarkus.load-shedding.probe-factor","additionalKeys":[],"configDoc":"The probe factor of the Vegas overload detection algorithm.","withinAMap":false,"defaultValue":"30.0","javaDocSiteLink":"","docMapKey":"probe-factor","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_PROBE_FACTOR","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.load-shedding.initial-limit","additionalKeys":[],"configDoc":"The initial limit of concurrent requests allowed.","withinAMap":false,"defaultValue":"100","javaDocSiteLink":"","docMapKey":"initial-limit","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_INITIAL_LIMIT","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.load-shedding.priority.enabled","additionalKeys":[],"configDoc":"Whether priority load shedding should be enabled.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.load-shedding","since":null,"environmentVariable":"QUARKUS_LOAD_SHEDDING_PRIORITY_ENABLED","enum":false}}]

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.load.shedding.runtime.LoadSheddingRuntimeConfig

@@ -0,0 +1 @@
+[{"configDocKey":{"type":"boolean","key":"quarkus.lra.openapi.included","additionalKeys":[],"configDoc":"Whether to include LRA proxy endpoints in the generated OpenAPI document","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"openapi-included","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.lra","since":null,"environmentVariable":"QUARKUS_LRA_OPENAPI_INCLUDED","enum":false}}]

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.narayana.lra.deployment.LRABuildTimeConfiguration

@@ -0,0 +1 @@
+io.quarkus.load.shedding.runtime.LoadSheddingRuntimeConfig

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.oidc.runtime.OidcConfig

@@ -0,0 +1 @@
+io.quarkus.narayana.lra.deployment.LRABuildTimeConfiguration