Skip to content

Commit 3dbcc4e

Browse files
committed
Sync documentation of main branch
1 parent 471ea20 commit 3dbcc4e

17 files changed

+314
-79
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ types:
1818
- title: Command Mode Applications
1919
filename: command-mode-reference.adoc
2020
summary: This reference guide explains how to develop command line applications with Quarkus.
21-
categories: "core, command-line"
21+
categories: "command-line, core"
2222
type: reference
2323
url: /guides/command-mode-reference
2424
- title: Configuration Reference Guide
@@ -30,7 +30,7 @@ types:
3030
- title: Configure data sources in Quarkus
3131
filename: datasource.adoc
3232
summary: Use a unified configuration model to define data sources for Java Database Connectivity (JDBC) and Reactive drivers.
33-
categories: "data, getting-started"
33+
categories: "getting-started, data"
3434
id: datasources
3535
type: reference
3636
url: /guides/datasource
@@ -55,7 +55,7 @@ types:
5555
- title: Logging configuration
5656
filename: logging.adoc
5757
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."
58-
categories: "core, getting-started, observability"
58+
categories: "getting-started, core, observability"
5959
id: logging
6060
type: reference
6161
url: /guides/logging
@@ -180,7 +180,7 @@ types:
180180
- title: "Duplicated context, context locals, asynchronous processing and propagation"
181181
filename: duplicated-context.adoc
182182
summary: "When using a traditional, blocking, and synchronous framework, processing of each request is performed in a dedicated thread."
183-
categories: "architecture, core"
183+
categories: "core, architecture"
184184
id: duplicated-context
185185
type: concepts
186186
url: /guides/duplicated-context
@@ -236,7 +236,7 @@ types:
236236
- title: Security vulnerability detection and reporting in Quarkus
237237
filename: security-vulnerability-detection.adoc
238238
summary: Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.
239-
categories: "contributing, security"
239+
categories: "security, contributing"
240240
id: security-vulnerability-detection
241241
type: concepts
242242
url: /guides/security-vulnerability-detection
@@ -338,7 +338,7 @@ types:
338338
- title: Your second Quarkus application
339339
filename: getting-started-dev-services.adoc
340340
summary: Discover some of the features that make developing with Quarkus a joyful experience.
341-
categories: "data, getting-started, core"
341+
categories: "getting-started, data, core"
342342
id: getting-started-dev-services-tutorial
343343
type: tutorial
344344
url: /guides/getting-started-dev-services
@@ -786,6 +786,11 @@ types:
786786
categories: serialization
787787
type: guide
788788
url: /guides/grpc-service-implementation
789+
- title: Initialization tasks
790+
filename: init-tasks.adoc
791+
summary: This reference guide explains how to configure initialization tasks
792+
type: guide
793+
url: /guides/init-tasks
789794
- title: Introduction to Contexts and Dependency Injection (CDI)
790795
filename: cdi.adoc
791796
summary: "Quarkus DI solution is based on the [Jakarta Contexts and Dependency Injection 4.0](https://jakarta.ee/specifications/cdi/4.0/jakarta-cdi-spec-4.0.html) specification."
@@ -1087,14 +1092,14 @@ types:
10871092
- title: Testing Your Application
10881093
filename: getting-started-testing.adoc
10891094
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
1090-
categories: "core, tooling, native"
1095+
categories: "core, native, tooling"
10911096
id: testing
10921097
type: guide
10931098
url: /guides/getting-started-testing
10941099
- title: Tips for writing native applications
10951100
filename: writing-native-applications-tips.adoc
10961101
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1097-
categories: "core, writing-extensions, native"
1102+
categories: "core, native, writing-extensions"
10981103
type: guide
10991104
url: /guides/writing-native-applications-tips
11001105
- title: Using Apache Kafka Streams
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If true, the init task will be generated. Otherwise, the init task resource generation will be skipped.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".wait-for-image","additionalKeys":[],"configDoc":"The init task image to use by the init-container.","withinAMap":false,"defaultValue":"groundnuty/k8s-wait-for:no-root-v1.7","javaDocSiteLink":"","docMapKey":"wait-for-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
1+
[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If true, the init task will be generated. Otherwise, the init task resource generation will be skipped.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".wait-for-container","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.kubernetes.deployment.InitTaskContainerConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".wait-for-container.image","additionalKeys":[],"configDoc":"The init task image to use by the init-container.","withinAMap":false,"defaultValue":"groundnuty/k8s-wait-for:no-root-v1.7","javaDocSiteLink":"","docMapKey":"image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"configDocKey":{"type":"string","key":".image","additionalKeys":[],"configDoc":"The init task image to use by the init-container.","withinAMap":false,"defaultValue":"groundnuty/k8s-wait-for:no-root-v1.7","javaDocSiteLink":"","docMapKey":"image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.kubernetes.deployment.KubernetesConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.kubernetes.deployment.OpenshiftConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28237,18 +28237,18 @@ endif::add-copy-button-to-env-var[]
2823728237
|`true`
2823828238

2823928239

28240-
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.kubernetes.init-task-defaults.wait-for-image]]`link:#quarkus-kubernetes_quarkus.kubernetes.init-task-defaults.wait-for-image[quarkus.kubernetes.init-task-defaults.wait-for-image]`
28240+
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.kubernetes.init-task-defaults.wait-for-container.image]]`link:#quarkus-kubernetes_quarkus.kubernetes.init-task-defaults.wait-for-container.image[quarkus.kubernetes.init-task-defaults.wait-for-container.image]`
2824128241

2824228242

2824328243
[.description]
2824428244
--
2824528245
The init task image to use by the init-container.
2824628246

2824728247
ifdef::add-copy-button-to-env-var[]
28248-
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_WAIT_FOR_IMAGE+++[]
28248+
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE+++[]
2824928249
endif::add-copy-button-to-env-var[]
2825028250
ifndef::add-copy-button-to-env-var[]
28251-
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_WAIT_FOR_IMAGE+++`
28251+
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE+++`
2825228252
endif::add-copy-button-to-env-var[]
2825328253
--|string
2825428254
|`groundnuty/k8s-wait-for:no-root-v1.7`
@@ -31684,18 +31684,18 @@ endif::add-copy-button-to-env-var[]
3168431684
|`true`
3168531685

3168631686

31687-
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.kubernetes.init-tasks.-init-tasks-.wait-for-image]]`link:#quarkus-kubernetes_quarkus.kubernetes.init-tasks.-init-tasks-.wait-for-image[quarkus.kubernetes.init-tasks."init-tasks".wait-for-image]`
31687+
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.kubernetes.init-tasks.-init-tasks-.wait-for-container.image]]`link:#quarkus-kubernetes_quarkus.kubernetes.init-tasks.-init-tasks-.wait-for-container.image[quarkus.kubernetes.init-tasks."init-tasks".wait-for-container.image]`
3168831688

3168931689

3169031690
[.description]
3169131691
--
3169231692
The init task image to use by the init-container.
3169331693

3169431694
ifdef::add-copy-button-to-env-var[]
31695-
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__WAIT_FOR_IMAGE+++[]
31695+
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++[]
3169631696
endif::add-copy-button-to-env-var[]
3169731697
ifndef::add-copy-button-to-env-var[]
31698-
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__WAIT_FOR_IMAGE+++`
31698+
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++`
3169931699
endif::add-copy-button-to-env-var[]
3170031700
--|string
3170131701
|`groundnuty/k8s-wait-for:no-root-v1.7`
@@ -33944,18 +33944,18 @@ endif::add-copy-button-to-env-var[]
3394433944
|`true`
3394533945

3394633946

33947-
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.init-task-defaults.wait-for-image]]`link:#quarkus-kubernetes_quarkus.openshift.init-task-defaults.wait-for-image[quarkus.openshift.init-task-defaults.wait-for-image]`
33947+
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.init-task-defaults.wait-for-container.image]]`link:#quarkus-kubernetes_quarkus.openshift.init-task-defaults.wait-for-container.image[quarkus.openshift.init-task-defaults.wait-for-container.image]`
3394833948

3394933949

3395033950
[.description]
3395133951
--
3395233952
The init task image to use by the init-container.
3395333953

3395433954
ifdef::add-copy-button-to-env-var[]
33955-
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_IMAGE+++[]
33955+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE+++[]
3395633956
endif::add-copy-button-to-env-var[]
3395733957
ifndef::add-copy-button-to-env-var[]
33958-
Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_IMAGE+++`
33958+
Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE+++`
3395933959
endif::add-copy-button-to-env-var[]
3396033960
--|string
3396133961
|`groundnuty/k8s-wait-for:no-root-v1.7`
@@ -37289,18 +37289,18 @@ endif::add-copy-button-to-env-var[]
3728937289
|`true`
3729037290

3729137291

37292-
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.init-tasks.-init-tasks-.wait-for-image]]`link:#quarkus-kubernetes_quarkus.openshift.init-tasks.-init-tasks-.wait-for-image[quarkus.openshift.init-tasks."init-tasks".wait-for-image]`
37292+
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.init-tasks.-init-tasks-.wait-for-container.image]]`link:#quarkus-kubernetes_quarkus.openshift.init-tasks.-init-tasks-.wait-for-container.image[quarkus.openshift.init-tasks."init-tasks".wait-for-container.image]`
3729337293

3729437294

3729537295
[.description]
3729637296
--
3729737297
The init task image to use by the init-container.
3729837298

3729937299
ifdef::add-copy-button-to-env-var[]
37300-
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_IMAGE+++[]
37300+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++[]
3730137301
endif::add-copy-button-to-env-var[]
3730237302
ifndef::add-copy-button-to-env-var[]
37303-
Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_IMAGE+++`
37303+
Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++`
3730437304
endif::add-copy-button-to-env-var[]
3730537305
--|string
3730637306
|`groundnuty/k8s-wait-for:no-root-v1.7`

_generated-doc/main/config/quarkus-kubernetes-config-group-init-task-config.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,18 @@ endif::add-copy-button-to-env-var[]
2727
|`true`
2828

2929

30-
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-config-group-init-task-config_quarkus.kubernetes.init-task-defaults.wait-for-image]]`link:#quarkus-kubernetes-config-group-init-task-config_quarkus.kubernetes.init-task-defaults.wait-for-image[quarkus.kubernetes.init-task-defaults.wait-for-image]`
30+
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-config-group-init-task-config_quarkus.kubernetes.init-task-defaults.wait-for-container.image]]`link:#quarkus-kubernetes-config-group-init-task-config_quarkus.kubernetes.init-task-defaults.wait-for-container.image[quarkus.kubernetes.init-task-defaults.wait-for-container.image]`
3131

3232

3333
[.description]
3434
--
3535
The init task image to use by the init-container.
3636

3737
ifdef::add-copy-button-to-env-var[]
38-
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_WAIT_FOR_IMAGE+++[]
38+
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE+++[]
3939
endif::add-copy-button-to-env-var[]
4040
ifndef::add-copy-button-to-env-var[]
41-
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_WAIT_FOR_IMAGE+++`
41+
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE+++`
4242
endif::add-copy-button-to-env-var[]
4343
--|string
4444
|`groundnuty/k8s-wait-for:no-root-v1.7`
@@ -61,18 +61,18 @@ endif::add-copy-button-to-env-var[]
6161
|`true`
6262

6363

64-
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-config-group-init-task-config_quarkus.kubernetes.init-tasks.-init-tasks-.wait-for-image]]`link:#quarkus-kubernetes-config-group-init-task-config_quarkus.kubernetes.init-tasks.-init-tasks-.wait-for-image[quarkus.kubernetes.init-tasks."init-tasks".wait-for-image]`
64+
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-config-group-init-task-config_quarkus.kubernetes.init-tasks.-init-tasks-.wait-for-container.image]]`link:#quarkus-kubernetes-config-group-init-task-config_quarkus.kubernetes.init-tasks.-init-tasks-.wait-for-container.image[quarkus.kubernetes.init-tasks."init-tasks".wait-for-container.image]`
6565

6666

6767
[.description]
6868
--
6969
The init task image to use by the init-container.
7070

7171
ifdef::add-copy-button-to-env-var[]
72-
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__WAIT_FOR_IMAGE+++[]
72+
Environment variable: env_var_with_copy_button:+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++[]
7373
endif::add-copy-button-to-env-var[]
7474
ifndef::add-copy-button-to-env-var[]
75-
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__WAIT_FOR_IMAGE+++`
75+
Environment variable: `+++QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++`
7676
endif::add-copy-button-to-env-var[]
7777
--|string
7878
|`groundnuty/k8s-wait-for:no-root-v1.7`
@@ -95,18 +95,18 @@ endif::add-copy-button-to-env-var[]
9595
|`true`
9696

9797

98-
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-config-group-init-task-config_quarkus.openshift.init-task-defaults.wait-for-image]]`link:#quarkus-kubernetes-config-group-init-task-config_quarkus.openshift.init-task-defaults.wait-for-image[quarkus.openshift.init-task-defaults.wait-for-image]`
98+
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-config-group-init-task-config_quarkus.openshift.init-task-defaults.wait-for-container.image]]`link:#quarkus-kubernetes-config-group-init-task-config_quarkus.openshift.init-task-defaults.wait-for-container.image[quarkus.openshift.init-task-defaults.wait-for-container.image]`
9999

100100

101101
[.description]
102102
--
103103
The init task image to use by the init-container.
104104

105105
ifdef::add-copy-button-to-env-var[]
106-
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_IMAGE+++[]
106+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE+++[]
107107
endif::add-copy-button-to-env-var[]
108108
ifndef::add-copy-button-to-env-var[]
109-
Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_IMAGE+++`
109+
Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE+++`
110110
endif::add-copy-button-to-env-var[]
111111
--|string
112112
|`groundnuty/k8s-wait-for:no-root-v1.7`
@@ -129,18 +129,18 @@ endif::add-copy-button-to-env-var[]
129129
|`true`
130130

131131

132-
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-config-group-init-task-config_quarkus.openshift.init-tasks.-init-tasks-.wait-for-image]]`link:#quarkus-kubernetes-config-group-init-task-config_quarkus.openshift.init-tasks.-init-tasks-.wait-for-image[quarkus.openshift.init-tasks."init-tasks".wait-for-image]`
132+
a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes-config-group-init-task-config_quarkus.openshift.init-tasks.-init-tasks-.wait-for-container.image]]`link:#quarkus-kubernetes-config-group-init-task-config_quarkus.openshift.init-tasks.-init-tasks-.wait-for-container.image[quarkus.openshift.init-tasks."init-tasks".wait-for-container.image]`
133133

134134

135135
[.description]
136136
--
137137
The init task image to use by the init-container.
138138

139139
ifdef::add-copy-button-to-env-var[]
140-
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_IMAGE+++[]
140+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++[]
141141
endif::add-copy-button-to-env-var[]
142142
ifndef::add-copy-button-to-env-var[]
143-
Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_IMAGE+++`
143+
Environment variable: `+++QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE+++`
144144
endif::add-copy-button-to-env-var[]
145145
--|string
146146
|`groundnuty/k8s-wait-for:no-root-v1.7`

0 commit comments

Comments
 (0)