Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 15, 2025
1 parent 010d808 commit 2cc14ec
Show file tree
Hide file tree
Showing 27 changed files with 779 additions and 144 deletions.
249 changes: 218 additions & 31 deletions _generated-doc/main/config/quarkus-all-config.adoc

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ endif::add-copy-button-to-config-props[]

[.description]
--
Whether or not to operate offline.
Whether, or not to operate offline.


ifdef::add-copy-button-to-env-var[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ endif::add-copy-button-to-config-props[]

[.description]
--
Whether or not to operate offline.
Whether, or not to operate offline.


ifdef::add-copy-button-to-env-var[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ endif::add-copy-button-to-config-props[]

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


ifdef::add-copy-button-to-env-var[]
Expand Down
4 changes: 2 additions & 2 deletions _generated-doc/main/config/quarkus-datasource.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,7 @@ endif::add-copy-button-to-config-props[]

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

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

Expand All @@ -595,7 +595,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_DATASOURCE_DEVSERVICES_INIT_SCRIPT_PATH+++`
endif::add-copy-button-to-env-var[]
--
|string
|list of string
|

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"`]##
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,7 @@ endif::add-copy-button-to-config-props[]

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

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

Expand All @@ -595,7 +595,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_DATASOURCE_DEVSERVICES_INIT_SCRIPT_PATH+++`
endif::add-copy-button-to-env-var[]
--
|string
|list of string
|

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"`]##
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ endif::add-copy-button-to-config-props[]

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

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

Expand All @@ -303,7 +303,7 @@ ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_DATASOURCE_DEVSERVICES_INIT_SCRIPT_PATH+++`
endif::add-copy-button-to-env-var[]
--
|string
|list of string
|

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"`]##
Expand Down
55 changes: 55 additions & 0 deletions _generated-doc/main/config/quarkus-devservices-oidc.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
[.configuration-legend]
icon:lock[title=Fixed 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-devservices-oidc_quarkus-oidc-devservices-enabled]] [.property-path]##link:#quarkus-devservices-oidc_quarkus-oidc-devservices-enabled[`quarkus.oidc.devservices.enabled`]##
ifdef::add-copy-button-to-config-props[]
config_property_copy_button:+++quarkus.oidc.devservices.enabled+++[]
endif::add-copy-button-to-config-props[]


[.description]
--
Use OpenID Connect Dev Services instead of Keycloak.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVSERVICES_ENABLED+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OIDC_DEVSERVICES_ENABLED+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`Enabled when Docker and Podman are not available`

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"`]##
ifdef::add-copy-button-to-config-props[]
config_property_copy_button:+++quarkus.oidc.devservices.roles."role-name"+++[]
endif::add-copy-button-to-config-props[]


[.description]
--
A map of roles for OIDC identity provider 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_OIDC_DEVSERVICES_ROLES__ROLE_NAME_+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OIDC_DEVSERVICES_ROLES__ROLE_NAME_+++`
endif::add-copy-button-to-env-var[]
--
|Map<String,List<String>>
|

|===

Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
[.configuration-legend]
icon:lock[title=Fixed 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-devservices-oidc_quarkus-oidc-devservices-enabled]] [.property-path]##link:#quarkus-devservices-oidc_quarkus-oidc-devservices-enabled[`quarkus.oidc.devservices.enabled`]##
ifdef::add-copy-button-to-config-props[]
config_property_copy_button:+++quarkus.oidc.devservices.enabled+++[]
endif::add-copy-button-to-config-props[]


[.description]
--
Use OpenID Connect Dev Services instead of Keycloak.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_DEVSERVICES_ENABLED+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OIDC_DEVSERVICES_ENABLED+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`Enabled when Docker and Podman are not available`

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"`]##
ifdef::add-copy-button-to-config-props[]
config_property_copy_button:+++quarkus.oidc.devservices.roles."role-name"+++[]
endif::add-copy-button-to-config-props[]


[.description]
--
A map of roles for OIDC identity provider 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_OIDC_DEVSERVICES_ROLES__ROLE_NAME_+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OIDC_DEVSERVICES_ROLES__ROLE_NAME_+++`
endif::add-copy-button-to-env-var[]
--
|Map<String,List<String>>
|

|===

Original file line number Diff line number Diff line change
Expand Up @@ -2860,7 +2860,7 @@ endif::add-copy-button-to-config-props[]

[.description]
--
The image pull secret
The image pull secrets.


ifdef::add-copy-button-to-env-var[]
Expand Down Expand Up @@ -4061,7 +4061,7 @@ endif::add-copy-button-to-config-props[]

[.description]
--
The image pull secret
The image pull secrets.


ifdef::add-copy-button-to-env-var[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2860,7 +2860,7 @@ endif::add-copy-button-to-config-props[]

[.description]
--
The image pull secret
The image pull secrets.


ifdef::add-copy-button-to-env-var[]
Expand Down Expand Up @@ -4061,7 +4061,7 @@ endif::add-copy-button-to-config-props[]

[.description]
--
The image pull secret
The image pull secrets.


ifdef::add-copy-button-to-env-var[]
Expand Down Expand Up @@ -7039,9 +7039,9 @@ endif::add-copy-button-to-env-var[]
|int
|`5005`

a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-tasks-init-tasks-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-tasks-init-tasks-enabled[`quarkus.kubernetes.init-tasks."init-tasks".enabled`]##
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-tasks-task-name-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-tasks-task-name-enabled[`quarkus.kubernetes.init-tasks."task-name".enabled`]##
ifdef::add-copy-button-to-config-props[]
config_property_copy_button:+++quarkus.kubernetes.init-tasks."init-tasks".enabled+++[]
config_property_copy_button:+++quarkus.kubernetes.init-tasks."task-name".enabled+++[]
endif::add-copy-button-to-config-props[]


Expand All @@ -7051,36 +7051,57 @@ If true, the init task will be generated. Otherwise, the init task resource gene


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__ENABLED+++[]
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASKS__TASK_NAME__ENABLED+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__ENABLED+++`
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASKS__TASK_NAME__ENABLED+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`true`

a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-tasks-init-tasks-wait-for-container-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-tasks-init-tasks-wait-for-container-image[`quarkus.kubernetes.init-tasks."init-tasks".wait-for-container.image`]##
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus-kubernetes-init-tasks-task-name-wait-for-container-image]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-tasks-task-name-wait-for-container-image[`quarkus.kubernetes.init-tasks."task-name".wait-for-container.image`]##
ifdef::add-copy-button-to-config-props[]
config_property_copy_button:+++quarkus.kubernetes.init-tasks."init-tasks".wait-for-container.image+++[]
config_property_copy_button:+++quarkus.kubernetes.init-tasks."task-name".wait-for-container.image+++[]
endif::add-copy-button-to-config-props[]


[.description]
--
The init task image to use by the init-container.
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_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++[]
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASKS__TASK_NAME__WAIT_FOR_CONTAINER_IMAGE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++`
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASKS__TASK_NAME__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-kubernetes-init-tasks-task-name-wait-for-container-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-tasks-task-name-wait-for-container-image-pull-policy[`quarkus.kubernetes.init-tasks."task-name".wait-for-container.image-pull-policy`]##
ifdef::add-copy-button-to-config-props[]
config_property_copy_button:+++quarkus.kubernetes.init-tasks."task-name".wait-for-container.image-pull-policy+++[]
endif::add-copy-button-to-config-props[]


[.description]
--
Image pull policy.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASKS__TASK_NAME__WAIT_FOR_CONTAINER_IMAGE_PULL_POLICY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASKS__TASK_NAME__WAIT_FOR_CONTAINER_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-kubernetes-init-task-defaults-enabled]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-task-defaults-enabled[`quarkus.kubernetes.init-task-defaults.enabled`]##
ifdef::add-copy-button-to-config-props[]
config_property_copy_button:+++quarkus.kubernetes.init-task-defaults.enabled+++[]
Expand Down Expand Up @@ -7110,7 +7131,7 @@ endif::add-copy-button-to-config-props[]

[.description]
--
The init task image to use by the init-container.
The init task image to use by the init container.


ifdef::add-copy-button-to-env-var[]
Expand All @@ -7123,6 +7144,27 @@ 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-kubernetes-init-task-defaults-wait-for-container-image-pull-policy]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-init-task-defaults-wait-for-container-image-pull-policy[`quarkus.kubernetes.init-task-defaults.wait-for-container.image-pull-policy`]##
ifdef::add-copy-button-to-config-props[]
config_property_copy_button:+++quarkus.kubernetes.init-task-defaults.wait-for-container.image-pull-policy+++[]
endif::add-copy-button-to-config-props[]


[.description]
--
Image pull policy.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE_PULL_POLICY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_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-kubernetes-output-directory]] [.property-path]##link:#quarkus-kubernetes_quarkus-kubernetes-output-directory[`quarkus.kubernetes.output-directory`]##
ifdef::add-copy-button-to-config-props[]
config_property_copy_button:+++quarkus.kubernetes.output-directory+++[]
Expand All @@ -7131,7 +7173,7 @@ endif::add-copy-button-to-config-props[]

[.description]
--
Optionally set directory generated kubernetes resources will be written to. Default is `target/kubernetes`.
Optionally set directory generated Kubernetes resources will be written to. Default is `target/kubernetes`.


ifdef::add-copy-button-to-env-var[]
Expand Down
Loading

0 comments on commit 2cc14ec

Please sign in to comment.