Skip to content

Commit e365077

Browse files
committed
Sync documentation of main branch
1 parent 7e8b715 commit e365077

File tree

24 files changed

+2356
-3397
lines changed

24 files changed

+2356
-3397
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 9 additions & 9 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: "command-line, core"
21+
categories: "core, command-line"
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 datasources for Java Database Connectivity (JDBC) and Reactive drivers.
33-
categories: "getting-started, data"
33+
categories: "data, getting-started"
3434
id: datasources
3535
type: reference
3636
url: /guides/datasource
@@ -304,7 +304,7 @@ types:
304304
- title: Secure a Quarkus application with Basic authentication and Jakarta Persistence
305305
filename: security-basic-authentication-tutorial.adoc
306306
summary: Secure your Quarkus application endpoints by combining the built-in Quarkus Basic authentication with the Jakarta Persistence identity provider to enable role-based access control (RBAC).
307-
categories: "getting-started, security"
307+
categories: "security, getting-started"
308308
id: security-basic-authentication-tutorial
309309
type: tutorial
310310
url: /guides/security-basic-authentication-tutorial
@@ -998,7 +998,7 @@ types:
998998
- title: Simplified Hibernate ORM with Panache and Kotlin
999999
filename: hibernate-orm-panache-kotlin.adoc
10001000
summary: This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.
1001-
categories: "alt-languages, data"
1001+
categories: "data, alt-languages"
10021002
type: guide
10031003
url: /guides/hibernate-orm-panache-kotlin
10041004
- title: Simplified Hibernate Reactive with Panache
@@ -1016,13 +1016,13 @@ types:
10161016
- title: Simplified MongoDB with Panache and Kotlin
10171017
filename: mongodb-panache-kotlin.adoc
10181018
summary: This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.
1019-
categories: "alt-languages, data"
1019+
categories: "data, alt-languages"
10201020
type: guide
10211021
url: /guides/mongodb-panache-kotlin
10221022
- title: SmallRye Fault Tolerance
10231023
filename: smallrye-fault-tolerance.adoc
10241024
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
1025-
categories: "observability, web"
1025+
categories: "web, observability"
10261026
type: guide
10271027
url: /guides/smallrye-fault-tolerance
10281028
- title: SmallRye GraphQL
@@ -1059,7 +1059,7 @@ types:
10591059
- title: Tips for writing native applications
10601060
filename: writing-native-applications-tips.adoc
10611061
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1062-
categories: "core, writing-extensions, native"
1062+
categories: "writing-extensions, core, native"
10631063
type: guide
10641064
url: /guides/writing-native-applications-tips
10651065
- title: Using Apache Kafka Streams
@@ -1188,7 +1188,7 @@ types:
11881188
- title: Using SSL With Native Executables
11891189
filename: native-and-ssl.adoc
11901190
summary: "In this guide, we will discuss how you can get your native images to support SSL, as native images don't support it out of the box."
1191-
categories: "core, security, native"
1191+
categories: "security, core, native"
11921192
type: guide
11931193
url: /guides/native-and-ssl
11941194
- title: Using Security with .properties File
@@ -1307,7 +1307,7 @@ types:
13071307
- title: Writing JSON REST Services
13081308
filename: rest-json.adoc
13091309
summary: JSON is now the lingua franca between microservices.
1310-
categories: "serialization, web"
1310+
categories: "web, serialization"
13111311
type: guide
13121312
url: /guides/rest-json
13131313
- title: Writing REST Services with RESTEasy Reactive

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.vertx.http.runtime.HttpConfiguration

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

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7176,6 +7176,23 @@ endif::add-copy-button-to-env-var[]
71767176
|required icon:exclamation-circle[title=Configuration property is required]
71777177

71787178

7179+
a| [[quarkus-vertx-http_quarkus.http.test-host]]`link:#quarkus-vertx-http_quarkus.http.test-host[quarkus.http.test-host]`
7180+
7181+
7182+
[.description]
7183+
--
7184+
Used when `QuarkusIntegrationTest` is meant to execute against an application that is already running and listening on the host specified by this property.
7185+
7186+
ifdef::add-copy-button-to-env-var[]
7187+
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_TEST_HOST+++[]
7188+
endif::add-copy-button-to-env-var[]
7189+
ifndef::add-copy-button-to-env-var[]
7190+
Environment variable: `+++QUARKUS_HTTP_TEST_HOST+++`
7191+
endif::add-copy-button-to-env-var[]
7192+
--|string
7193+
|
7194+
7195+
71797196
a| [[quarkus-vertx-http_quarkus.http.host-enabled]]`link:#quarkus-vertx-http_quarkus.http.host-enabled[quarkus.http.host-enabled]`
71807197

71817198

@@ -7227,6 +7244,23 @@ endif::add-copy-button-to-env-var[]
72277244
|`8444`
72287245

72297246

7247+
a| [[quarkus-vertx-http_quarkus.http.test-ssl-enabled]]`link:#quarkus-vertx-http_quarkus.http.test-ssl-enabled[quarkus.http.test-ssl-enabled]`
7248+
7249+
7250+
[.description]
7251+
--
7252+
Used when `QuarkusIntegrationTest` is meant to execute against an application that is already running to configure the test to use SSL.
7253+
7254+
ifdef::add-copy-button-to-env-var[]
7255+
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_TEST_SSL_ENABLED+++[]
7256+
endif::add-copy-button-to-env-var[]
7257+
ifndef::add-copy-button-to-env-var[]
7258+
Environment variable: `+++QUARKUS_HTTP_TEST_SSL_ENABLED+++`
7259+
endif::add-copy-button-to-env-var[]
7260+
--|boolean
7261+
|
7262+
7263+
72307264
a| [[quarkus-vertx-http_quarkus.http.insecure-requests]]`link:#quarkus-vertx-http_quarkus.http.insecure-requests[quarkus.http.insecure-requests]`
72317265

72327266

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

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -75,110 +75,110 @@ endif::add-copy-button-to-env-var[]
7575
|`Build system locale`
7676

7777

78-
a| [[quarkus-core_quarkus.profile]]`link:#quarkus-core_quarkus.profile[quarkus.profile]`
78+
a| [[quarkus-core_quarkus.args]]`link:#quarkus-core_quarkus.args[quarkus.args]`
7979

8080

8181
[.description]
8282
--
83-
Profile that will be active when Quarkus launches.
83+
The arguments passed to the command line.
84+
85+
We don't make it a list as the args are separated by a space, not a comma.
8486

8587
ifdef::add-copy-button-to-env-var[]
86-
Environment variable: env_var_with_copy_button:+++QUARKUS_PROFILE+++[]
88+
Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[]
8789
endif::add-copy-button-to-env-var[]
8890
ifndef::add-copy-button-to-env-var[]
89-
Environment variable: `+++QUARKUS_PROFILE+++`
91+
Environment variable: `+++QUARKUS_ARGS+++`
9092
endif::add-copy-button-to-env-var[]
9193
--|string
92-
|`prod`
94+
|
9395

9496

95-
a| [[quarkus-core_quarkus.config.profile.parent]]`link:#quarkus-core_quarkus.config.profile.parent[quarkus.config.profile.parent]`
97+
a| [[quarkus-core_quarkus.init-and-exit]]`link:#quarkus-core_quarkus.init-and-exit[quarkus.init-and-exit]`
9698

9799

98100
[.description]
99101
--
100-
Accepts a single configuration profile name. If a configuration property cannot be found in the current active profile, the config performs the same lookup in the profile set by this configuration.
102+
true to quit exit right after the initialization. The option is not meant be used directly by users.
101103

102104
ifdef::add-copy-button-to-env-var[]
103-
Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_PROFILE_PARENT+++[]
105+
Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[]
104106
endif::add-copy-button-to-env-var[]
105107
ifndef::add-copy-button-to-env-var[]
106-
Environment variable: `+++QUARKUS_CONFIG_PROFILE_PARENT+++`
108+
Environment variable: `+++QUARKUS_INIT_AND_EXIT+++`
107109
endif::add-copy-button-to-env-var[]
108-
--|string
109-
|
110+
--|boolean
111+
|`false`
110112

111113

112-
a| [[quarkus-core_quarkus.config.locations]]`link:#quarkus-core_quarkus.config.locations[quarkus.config.locations]`
114+
a| [[quarkus-core_quarkus.profile]]`link:#quarkus-core_quarkus.profile[quarkus.profile]`
113115

114116

115117
[.description]
116118
--
117-
Additional config locations to be loaded with the Config. The configuration support multiple locations separated by a comma and each must represent a valid `java.net.URI`.
119+
Profile that will be active when Quarkus launches.
118120

119121
ifdef::add-copy-button-to-env-var[]
120-
Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_LOCATIONS+++[]
122+
Environment variable: env_var_with_copy_button:+++QUARKUS_PROFILE+++[]
121123
endif::add-copy-button-to-env-var[]
122124
ifndef::add-copy-button-to-env-var[]
123-
Environment variable: `+++QUARKUS_CONFIG_LOCATIONS+++`
125+
Environment variable: `+++QUARKUS_PROFILE+++`
124126
endif::add-copy-button-to-env-var[]
125-
--|list of link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI]
126-
127-
|
127+
--|string
128+
|`prod`
128129

129130

130-
a| [[quarkus-core_quarkus.uuid]]`link:#quarkus-core_quarkus.uuid[quarkus.uuid]`
131+
a| [[quarkus-core_quarkus.config.profile.parent]]`link:#quarkus-core_quarkus.config.profile.parent[quarkus.config.profile.parent]`
131132

132133

133134
[.description]
134135
--
135-
A property that allows accessing a generated UUID. It generates that UUID at startup time. So it changes between two starts including in dev mode. +
136-
Access this generated UUID using expressions: `$++{++quarkus.uuid++}++`.
136+
Accepts a single configuration profile name. If a configuration property cannot be found in the current active profile, the config performs the same lookup in the profile set by this configuration.
137137

138138
ifdef::add-copy-button-to-env-var[]
139-
Environment variable: env_var_with_copy_button:+++QUARKUS_UUID+++[]
139+
Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_PROFILE_PARENT+++[]
140140
endif::add-copy-button-to-env-var[]
141141
ifndef::add-copy-button-to-env-var[]
142-
Environment variable: `+++QUARKUS_UUID+++`
142+
Environment variable: `+++QUARKUS_CONFIG_PROFILE_PARENT+++`
143143
endif::add-copy-button-to-env-var[]
144144
--|string
145145
|
146146

147147

148-
a| [[quarkus-core_quarkus.args]]`link:#quarkus-core_quarkus.args[quarkus.args]`
148+
a| [[quarkus-core_quarkus.config.locations]]`link:#quarkus-core_quarkus.config.locations[quarkus.config.locations]`
149149

150150

151151
[.description]
152152
--
153-
The arguments passed to the command line.
154-
155-
We don't make it a list as the args are separated by a space, not a comma.
153+
Additional config locations to be loaded with the Config. The configuration support multiple locations separated by a comma and each must represent a valid `java.net.URI`.
156154

157155
ifdef::add-copy-button-to-env-var[]
158-
Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[]
156+
Environment variable: env_var_with_copy_button:+++QUARKUS_CONFIG_LOCATIONS+++[]
159157
endif::add-copy-button-to-env-var[]
160158
ifndef::add-copy-button-to-env-var[]
161-
Environment variable: `+++QUARKUS_ARGS+++`
159+
Environment variable: `+++QUARKUS_CONFIG_LOCATIONS+++`
162160
endif::add-copy-button-to-env-var[]
163-
--|string
161+
--|list of link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI]
162+
164163
|
165164

166165

167-
a| [[quarkus-core_quarkus.init-and-exit]]`link:#quarkus-core_quarkus.init-and-exit[quarkus.init-and-exit]`
166+
a| [[quarkus-core_quarkus.uuid]]`link:#quarkus-core_quarkus.uuid[quarkus.uuid]`
168167

169168

170169
[.description]
171170
--
172-
true to quit exit right after the initialization. The option is not meant be used directly by users.
171+
A property that allows accessing a generated UUID. It generates that UUID at startup time. So it changes between two starts including in dev mode. +
172+
Access this generated UUID using expressions: `$++{++quarkus.uuid++}++`.
173173

174174
ifdef::add-copy-button-to-env-var[]
175-
Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[]
175+
Environment variable: env_var_with_copy_button:+++QUARKUS_UUID+++[]
176176
endif::add-copy-button-to-env-var[]
177177
ifndef::add-copy-button-to-env-var[]
178-
Environment variable: `+++QUARKUS_INIT_AND_EXIT+++`
178+
Environment variable: `+++QUARKUS_UUID+++`
179179
endif::add-copy-button-to-env-var[]
180-
--|boolean
181-
|`false`
180+
--|string
181+
|
182182

183183

184184
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.analytics.disabled]]`link:#quarkus-core_quarkus.analytics.disabled[quarkus.analytics.disabled]`

_generated-doc/main/config/quarkus-datasource-config-group-data-source-build-time-config.adoc

Lines changed: 0 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -584,76 +584,4 @@ endif::add-copy-button-to-env-var[]
584584
--|boolean
585585
|`false`
586586

587-
588-
a| [[quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.-datasource-name-.username]]`link:#quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.-datasource-name-.username[quarkus.datasource."datasource-name".username]`
589-
590-
591-
[.description]
592-
--
593-
The datasource username
594-
595-
ifdef::add-copy-button-to-env-var[]
596-
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__USERNAME+++[]
597-
endif::add-copy-button-to-env-var[]
598-
ifndef::add-copy-button-to-env-var[]
599-
Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__USERNAME+++`
600-
endif::add-copy-button-to-env-var[]
601-
--|string
602-
|
603-
604-
605-
a| [[quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.-datasource-name-.password]]`link:#quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.-datasource-name-.password[quarkus.datasource."datasource-name".password]`
606-
607-
608-
[.description]
609-
--
610-
The datasource password
611-
612-
ifdef::add-copy-button-to-env-var[]
613-
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__PASSWORD+++[]
614-
endif::add-copy-button-to-env-var[]
615-
ifndef::add-copy-button-to-env-var[]
616-
Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__PASSWORD+++`
617-
endif::add-copy-button-to-env-var[]
618-
--|string
619-
|
620-
621-
622-
a| [[quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.-datasource-name-.credentials-provider]]`link:#quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.-datasource-name-.credentials-provider[quarkus.datasource."datasource-name".credentials-provider]`
623-
624-
625-
[.description]
626-
--
627-
The credentials provider name
628-
629-
ifdef::add-copy-button-to-env-var[]
630-
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__CREDENTIALS_PROVIDER+++[]
631-
endif::add-copy-button-to-env-var[]
632-
ifndef::add-copy-button-to-env-var[]
633-
Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__CREDENTIALS_PROVIDER+++`
634-
endif::add-copy-button-to-env-var[]
635-
--|string
636-
|
637-
638-
639-
a| [[quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.-datasource-name-.credentials-provider-name]]`link:#quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.-datasource-name-.credentials-provider-name[quarkus.datasource."datasource-name".credentials-provider-name]`
640-
641-
642-
[.description]
643-
--
644-
The credentials provider bean name.
645-
646-
It is the `&++#++64;Named` value of the credentials provider bean. It is used to discriminate if multiple CredentialsProvider beans are available.
647-
648-
For Vault it is: vault-credentials-provider. Not necessary if there is only one credentials provider available.
649-
650-
ifdef::add-copy-button-to-env-var[]
651-
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__CREDENTIALS_PROVIDER_NAME+++[]
652-
endif::add-copy-button-to-env-var[]
653-
ifndef::add-copy-button-to-env-var[]
654-
Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__CREDENTIALS_PROVIDER_NAME+++`
655-
endif::add-copy-button-to-env-var[]
656-
--|string
657-
|
658-
659587
|===

0 commit comments

Comments
 (0)