Skip to content

Commit 2cc14ec

Browse files
committed
Sync documentation of main branch
1 parent 010d808 commit 2cc14ec

27 files changed

+779
-144
lines changed

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

Lines changed: 218 additions & 31 deletions
Large diffs are not rendered by default.

_generated-doc/main/config/quarkus-container-image-jib.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,7 @@ endif::add-copy-button-to-config-props[]
397397

398398
[.description]
399399
--
400-
Whether or not to operate offline.
400+
Whether, or not to operate offline.
401401

402402

403403
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-container-image-jib_quarkus.jib.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,7 @@ endif::add-copy-button-to-config-props[]
397397

398398
[.description]
399399
--
400-
Whether or not to operate offline.
400+
Whether, or not to operate offline.
401401

402402

403403
ifdef::add-copy-button-to-env-var[]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ endif::add-copy-button-to-config-props[]
239239

240240
[.description]
241241
--
242-
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.
242+
Whether to automate the creation of AppCDS. Care must be taken to use the same exact JVM version when building and running the application.
243243

244244

245245
ifdef::add-copy-button-to-env-var[]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -583,7 +583,7 @@ endif::add-copy-button-to-config-props[]
583583

584584
[.description]
585585
--
586-
The path to a SQL script to be loaded from the classpath and applied to the Dev Service database.
586+
The paths to SQL scripts to be loaded from the classpath and applied to the Dev Service database.
587587

588588
This has no effect if the provider is not a container-based database, such as H2 or Derby.
589589

@@ -595,7 +595,7 @@ ifndef::add-copy-button-to-env-var[]
595595
Environment variable: `+++QUARKUS_DATASOURCE_DEVSERVICES_INIT_SCRIPT_PATH+++`
596596
endif::add-copy-button-to-env-var[]
597597
--
598-
|string
598+
|list of string
599599
|
600600

601601
a|icon:lock[title=Fixed at build time] [[quarkus-datasource_quarkus-datasource-devservices-volumes-host-path]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-devservices-volumes-host-path[`quarkus.datasource.devservices.volumes."host-path"`]##

_generated-doc/main/config/quarkus-datasource_quarkus.datasource.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -583,7 +583,7 @@ endif::add-copy-button-to-config-props[]
583583

584584
[.description]
585585
--
586-
The path to a SQL script to be loaded from the classpath and applied to the Dev Service database.
586+
The paths to SQL scripts to be loaded from the classpath and applied to the Dev Service database.
587587

588588
This has no effect if the provider is not a container-based database, such as H2 or Derby.
589589

@@ -595,7 +595,7 @@ ifndef::add-copy-button-to-env-var[]
595595
Environment variable: `+++QUARKUS_DATASOURCE_DEVSERVICES_INIT_SCRIPT_PATH+++`
596596
endif::add-copy-button-to-env-var[]
597597
--
598-
|string
598+
|list of string
599599
|
600600

601601
a|icon:lock[title=Fixed at build time] [[quarkus-datasource_quarkus-datasource-devservices-volumes-host-path]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-devservices-volumes-host-path[`quarkus.datasource.devservices.volumes."host-path"`]##

_generated-doc/main/config/quarkus-datasource_quarkus.datasource.devservices.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ endif::add-copy-button-to-config-props[]
291291

292292
[.description]
293293
--
294-
The path to a SQL script to be loaded from the classpath and applied to the Dev Service database.
294+
The paths to SQL scripts to be loaded from the classpath and applied to the Dev Service database.
295295

296296
This has no effect if the provider is not a container-based database, such as H2 or Derby.
297297

@@ -303,7 +303,7 @@ ifndef::add-copy-button-to-env-var[]
303303
Environment variable: `+++QUARKUS_DATASOURCE_DEVSERVICES_INIT_SCRIPT_PATH+++`
304304
endif::add-copy-button-to-env-var[]
305305
--
306-
|string
306+
|list of string
307307
|
308308

309309
a|icon:lock[title=Fixed at build time] [[quarkus-datasource_quarkus-datasource-devservices_quarkus-datasource-devservices-volumes-host-path]] [.property-path]##link:#quarkus-datasource_quarkus-datasource-devservices_quarkus-datasource-devservices-volumes-host-path[`quarkus.datasource.devservices.volumes."host-path"`]##
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
[.configuration-legend]
2+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
3+
[.configuration-reference.searchable, cols="80,.^10,.^10"]
4+
|===
5+
6+
h|[.header-title]##Configuration property##
7+
h|Type
8+
h|Default
9+
10+
a|icon:lock[title=Fixed at build time] [[quarkus-devservices-oidc_quarkus-oidc-devservices-enabled]] [.property-path]##link:#quarkus-devservices-oidc_quarkus-oidc-devservices-enabled[`quarkus.oidc.devservices.enabled`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.oidc.devservices.enabled+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
Use OpenID Connect Dev Services instead of Keycloak.
19+
20+
21+
ifdef::add-copy-button-to-env-var[]
22+
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVSERVICES_ENABLED+++[]
23+
endif::add-copy-button-to-env-var[]
24+
ifndef::add-copy-button-to-env-var[]
25+
Environment variable: `+++QUARKUS_OIDC_DEVSERVICES_ENABLED+++`
26+
endif::add-copy-button-to-env-var[]
27+
--
28+
|boolean
29+
|`Enabled when Docker and Podman are not available`
30+
31+
a|icon:lock[title=Fixed at build time] [[quarkus-devservices-oidc_quarkus-oidc-devservices-roles-role-name]] [.property-path]##link:#quarkus-devservices-oidc_quarkus-oidc-devservices-roles-role-name[`quarkus.oidc.devservices.roles."role-name"`]##
32+
ifdef::add-copy-button-to-config-props[]
33+
config_property_copy_button:+++quarkus.oidc.devservices.roles."role-name"+++[]
34+
endif::add-copy-button-to-config-props[]
35+
36+
37+
[.description]
38+
--
39+
A map of roles for OIDC identity provider users.
40+
41+
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`.
42+
43+
44+
ifdef::add-copy-button-to-env-var[]
45+
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVSERVICES_ROLES__ROLE_NAME_+++[]
46+
endif::add-copy-button-to-env-var[]
47+
ifndef::add-copy-button-to-env-var[]
48+
Environment variable: `+++QUARKUS_OIDC_DEVSERVICES_ROLES__ROLE_NAME_+++`
49+
endif::add-copy-button-to-env-var[]
50+
--
51+
|Map<String,List<String>>
52+
|
53+
54+
|===
55+
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
[.configuration-legend]
2+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
3+
[.configuration-reference.searchable, cols="80,.^10,.^10"]
4+
|===
5+
6+
h|[.header-title]##Configuration property##
7+
h|Type
8+
h|Default
9+
10+
a|icon:lock[title=Fixed at build time] [[quarkus-devservices-oidc_quarkus-oidc-devservices-enabled]] [.property-path]##link:#quarkus-devservices-oidc_quarkus-oidc-devservices-enabled[`quarkus.oidc.devservices.enabled`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.oidc.devservices.enabled+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
Use OpenID Connect Dev Services instead of Keycloak.
19+
20+
21+
ifdef::add-copy-button-to-env-var[]
22+
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVSERVICES_ENABLED+++[]
23+
endif::add-copy-button-to-env-var[]
24+
ifndef::add-copy-button-to-env-var[]
25+
Environment variable: `+++QUARKUS_OIDC_DEVSERVICES_ENABLED+++`
26+
endif::add-copy-button-to-env-var[]
27+
--
28+
|boolean
29+
|`Enabled when Docker and Podman are not available`
30+
31+
a|icon:lock[title=Fixed at build time] [[quarkus-devservices-oidc_quarkus-oidc-devservices-roles-role-name]] [.property-path]##link:#quarkus-devservices-oidc_quarkus-oidc-devservices-roles-role-name[`quarkus.oidc.devservices.roles."role-name"`]##
32+
ifdef::add-copy-button-to-config-props[]
33+
config_property_copy_button:+++quarkus.oidc.devservices.roles."role-name"+++[]
34+
endif::add-copy-button-to-config-props[]
35+
36+
37+
[.description]
38+
--
39+
A map of roles for OIDC identity provider users.
40+
41+
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`.
42+
43+
44+
ifdef::add-copy-button-to-env-var[]
45+
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVSERVICES_ROLES__ROLE_NAME_+++[]
46+
endif::add-copy-button-to-env-var[]
47+
ifndef::add-copy-button-to-env-var[]
48+
Environment variable: `+++QUARKUS_OIDC_DEVSERVICES_ROLES__ROLE_NAME_+++`
49+
endif::add-copy-button-to-env-var[]
50+
--
51+
|Map<String,List<String>>
52+
|
53+
54+
|===
55+

_generated-doc/main/config/quarkus-kubernetes_quarkus.knative.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2860,7 +2860,7 @@ endif::add-copy-button-to-config-props[]
28602860

28612861
[.description]
28622862
--
2863-
The image pull secret
2863+
The image pull secrets.
28642864

28652865

28662866
ifdef::add-copy-button-to-env-var[]
@@ -4061,7 +4061,7 @@ endif::add-copy-button-to-config-props[]
40614061

40624062
[.description]
40634063
--
4064-
The image pull secret
4064+
The image pull secrets.
40654065

40664066

40674067
ifdef::add-copy-button-to-env-var[]

0 commit comments

Comments
 (0)