Sync documentation of main branch

quarkusio · Nov 6, 2024 · 38106be · 38106be
1 parent db66112
commit 38106be
Show file tree

Hide file tree

Showing 19 changed files with 185 additions and 1,346 deletions.
diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc
diff --git a/_generated-doc/main/config/quarkus-core_quarkus.native.adoc b/_generated-doc/main/config/quarkus-core_quarkus.native.adoc
@@ -453,6 +453,7 @@ Enable monitoring various monitoring options. The value should be comma separate
  - `heapdump` for heampdump support
  - `jmxclient` for JMX client support (experimental)
  - `jmxserver` for JMX server support (experimental)
+ - `nmt` for native memory tracking support
  - `all` for all monitoring features
 
 
@@ -463,7 +464,7 @@ ifndef::add-copy-button-to-env-var[]
 Environment variable: `+++QUARKUS_NATIVE_MONITORING+++`
 endif::add-copy-button-to-env-var[]
 --
-a|list of `heapdump`, `jvmstat`, `jfr`, `jmxserver`, `jmxclient`, `all`
+a|list of `heapdump`, `jvmstat`, `jfr`, `jmxserver`, `jmxclient`, `nmt`, `all`
 |
 
 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`]##

diff --git a/_generated-doc/main/config/quarkus-oidc-client-registration.adoc b/_generated-doc/main/config/quarkus-oidc-client-registration.adoc
@@ -28,8 +28,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-auth-serv
 
 [.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+++[]
@@ -45,8 +43,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-discovery
 
 [.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+++[]
@@ -62,8 +58,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-registrat
 
 [.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+++[]
@@ -79,8 +73,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-connectio
 
 [.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+++[]
@@ -96,8 +88,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-connectio
 
 [.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+++[]
@@ -113,8 +103,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-connectio
 
 [.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+++[]
@@ -130,8 +118,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-use-block
 
 [.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+++[]
@@ -147,8 +133,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-max-pool-
 
 [.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+++[]
@@ -164,8 +148,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-follow-re
 
 [.description]
 --
-Follow redirects automatically when WebClient gets HTTP 302. When this property is disabled only a single redirect to exactly the same original URI is allowed but only if one or more cookies were set during the redirect request.
-
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION_FOLLOW_REDIRECTS+++[]
@@ -181,9 +163,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-hos
 
 [.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+++[]
@@ -199,8 +178,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-por
 
 [.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+++[]
@@ -216,8 +193,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-use
 
 [.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+++[]
@@ -233,8 +208,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-proxy-pas
 
 [.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+++[]
@@ -250,12 +223,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-tls-tls-c
 
 [.description]
 --
-The name of the TLS configuration to use.
-
-If a name is configured, it uses the configuration from `quarkus.tls.<name>.++*++` 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+++[]
@@ -411,8 +378,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-auth-s
 
 [.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+++[]
@@ -428,8 +393,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-discov
 
 [.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+++[]
@@ -445,8 +408,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-regist
 
 [.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+++[]
@@ -462,8 +423,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connec
 
 [.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+++[]
@@ -479,8 +438,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connec
 
 [.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+++[]
@@ -496,8 +453,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-connec
 
 [.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+++[]
@@ -513,8 +468,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-use-bl
 
 [.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+++[]
@@ -530,8 +483,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-max-po
 
 [.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+++[]
@@ -547,8 +498,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-follow
 
 [.description]
 --
-Follow redirects automatically when WebClient gets HTTP 302. When this property is disabled only a single redirect to exactly the same original URI is allowed but only if one or more cookies were set during the redirect request.
-
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__FOLLOW_REDIRECTS+++[]
@@ -564,9 +513,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-
 
 [.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+++[]
@@ -582,8 +528,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-
 
 [.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+++[]
@@ -599,8 +543,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-
 
 [.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+++[]
@@ -616,8 +558,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-proxy-
 
 [.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+++[]
@@ -633,12 +573,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-id-tls-tl
 
 [.description]
 --
-The name of the TLS configuration to use.
-
-If a name is configured, it uses the configuration from `quarkus.tls.<name>.++*++` 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+++[]