Skip to content

Commit 38106be

Browse files
committed
Sync documentation of main branch
1 parent db66112 commit 38106be

19 files changed

+185
-1346
lines changed

_generated-doc/main/config/quarkus-all-config.adoc

Lines changed: 26 additions & 438 deletions
Large diffs are not rendered by default.

_generated-doc/main/config/quarkus-core_quarkus.native.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,7 @@ Enable monitoring various monitoring options. The value should be comma separate
453453
- `heapdump` for heampdump support
454454
- `jmxclient` for JMX client support (experimental)
455455
- `jmxserver` for JMX server support (experimental)
456+
- `nmt` for native memory tracking support
456457
- `all` for all monitoring features
457458

458459

@@ -463,7 +464,7 @@ ifndef::add-copy-button-to-env-var[]
463464
Environment variable: `+++QUARKUS_NATIVE_MONITORING+++`
464465
endif::add-copy-button-to-env-var[]
465466
--
466-
a|list of `heapdump`, `jvmstat`, `jfr`, `jmxserver`, `jmxclient`, `all`
467+
a|list of `heapdump`, `jvmstat`, `jfr`, `jmxserver`, `jmxclient`, `nmt`, `all`
467468
|
468469

469470
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`]##

_generated-doc/main/config/quarkus-oidc-client-registration.adoc

Lines changed: 0 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@ a| [[quarkus-oidc-client-registration_quarkus-oidc-client-registration-auth-serv
2828

2929
[.description]
3030
--
31-
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.
32-
3331

3432
ifdef::add-copy-button-to-env-var[]
3533
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
4543

4644
[.description]
4745
--
48-
Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually.
49-
5046

5147
ifdef::add-copy-button-to-env-var[]
5248
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
6258

6359
[.description]
6460
--
65-
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.
66-
6761

6862
ifdef::add-copy-button-to-env-var[]
6963
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
7973

8074
[.description]
8175
--
82-
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.
83-
8476

8577
ifdef::add-copy-button-to-env-var[]
8678
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
9688

9789
[.description]
9890
--
99-
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.
100-
10191

10292
ifdef::add-copy-button-to-env-var[]
10393
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
113103

114104
[.description]
115105
--
116-
The number of seconds after which the current OIDC connection request times out.
117-
118106

119107
ifdef::add-copy-button-to-env-var[]
120108
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
130118

131119
[.description]
132120
--
133-
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.
134-
135121

136122
ifdef::add-copy-button-to-env-var[]
137123
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-
147133

148134
[.description]
149135
--
150-
The maximum size of the connection pool used by the WebClient.
151-
152136

153137
ifdef::add-copy-button-to-env-var[]
154138
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
164148

165149
[.description]
166150
--
167-
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.
168-
169151

170152
ifdef::add-copy-button-to-env-var[]
171153
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
181163

182164
[.description]
183165
--
184-
The host name or IP address of the Proxy. +
185-
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.
186-
187166

188167
ifdef::add-copy-button-to-env-var[]
189168
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
199178

200179
[.description]
201180
--
202-
The port number of the Proxy. The default value is `80`.
203-
204181

205182
ifdef::add-copy-button-to-env-var[]
206183
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
216193

217194
[.description]
218195
--
219-
The username, if the Proxy needs authentication.
220-
221196

222197
ifdef::add-copy-button-to-env-var[]
223198
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
233208

234209
[.description]
235210
--
236-
The password, if the Proxy needs authentication.
237-
238211

239212
ifdef::add-copy-button-to-env-var[]
240213
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
250223

251224
[.description]
252225
--
253-
The name of the TLS configuration to use.
254-
255-
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.
256-
257-
The default TLS configuration is *not* used by default.
258-
259226

260227
ifdef::add-copy-button-to-env-var[]
261228
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
411378

412379
[.description]
413380
--
414-
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.
415-
416381

417382
ifdef::add-copy-button-to-env-var[]
418383
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
428393

429394
[.description]
430395
--
431-
Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually.
432-
433396

434397
ifdef::add-copy-button-to-env-var[]
435398
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
445408

446409
[.description]
447410
--
448-
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.
449-
450411

451412
ifdef::add-copy-button-to-env-var[]
452413
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
462423

463424
[.description]
464425
--
465-
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.
466-
467426

468427
ifdef::add-copy-button-to-env-var[]
469428
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
479438

480439
[.description]
481440
--
482-
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.
483-
484441

485442
ifdef::add-copy-button-to-env-var[]
486443
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
496453

497454
[.description]
498455
--
499-
The number of seconds after which the current OIDC connection request times out.
500-
501456

502457
ifdef::add-copy-button-to-env-var[]
503458
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
513468

514469
[.description]
515470
--
516-
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.
517-
518471

519472
ifdef::add-copy-button-to-env-var[]
520473
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
530483

531484
[.description]
532485
--
533-
The maximum size of the connection pool used by the WebClient.
534-
535486

536487
ifdef::add-copy-button-to-env-var[]
537488
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
547498

548499
[.description]
549500
--
550-
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.
551-
552501

553502
ifdef::add-copy-button-to-env-var[]
554503
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-
564513

565514
[.description]
566515
--
567-
The host name or IP address of the Proxy. +
568-
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.
569-
570516

571517
ifdef::add-copy-button-to-env-var[]
572518
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-
582528

583529
[.description]
584530
--
585-
The port number of the Proxy. The default value is `80`.
586-
587531

588532
ifdef::add-copy-button-to-env-var[]
589533
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-
599543

600544
[.description]
601545
--
602-
The username, if the Proxy needs authentication.
603-
604546

605547
ifdef::add-copy-button-to-env-var[]
606548
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-
616558

617559
[.description]
618560
--
619-
The password, if the Proxy needs authentication.
620-
621561

622562
ifdef::add-copy-button-to-env-var[]
623563
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
633573

634574
[.description]
635575
--
636-
The name of the TLS configuration to use.
637-
638-
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.
639-
640-
The default TLS configuration is *not* used by default.
641-
642576

643577
ifdef::add-copy-button-to-env-var[]
644578
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_CLIENT_REGISTRATION__ID__TLS_TLS_CONFIGURATION_NAME+++[]

0 commit comments

Comments
 (0)