Skip to content

Commit d675050

Browse files
committed
Sync documentation of main branch
1 parent 8f4eaa2 commit d675050

11 files changed

+1284
-716
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ types:
55
- title: Authorization of web endpoints
66
filename: security-authorize-web-endpoints-reference.adoc
77
summary: Quarkus has an integrated pluggable web security layer.
8-
categories: "security, web"
8+
categories: "web, security"
99
id: security-authorize-web-endpoints-reference
1010
type: reference
1111
url: /guides/security-authorize-web-endpoints-reference
@@ -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
@@ -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: "getting-started, core, observability"
58+
categories: "getting-started, observability, core"
5959
id: logging
6060
type: reference
6161
url: /guides/logging
@@ -159,28 +159,28 @@ types:
159159
- title: Authentication mechanisms in Quarkus
160160
filename: security-authentication-mechanisms.adoc
161161
summary: "The Quarkus Security framework supports multiple authentication mechanisms, which you can use to secure your applications."
162-
categories: "security, web"
162+
categories: "web, security"
163163
id: security-authentication-mechanisms
164164
type: concepts
165165
url: /guides/security-authentication-mechanisms
166166
- title: Basic authentication
167167
filename: security-basic-authentication.adoc
168168
summary: HTTP Basic authentication is one of the least resource-demanding techniques that enforce access controls to web resources.
169-
categories: "security, web"
169+
categories: "web, security"
170170
id: security-basic-authentication
171171
type: concepts
172172
url: /guides/security-basic-authentication
173173
- title: Configuring Well-Known OpenID Connect Providers
174174
filename: security-openid-connect-providers.adoc
175175
summary: This document explains how to configure well-known social OIDC and OAuth2 providers.
176-
categories: "security, web"
176+
categories: "web, security"
177177
id: security-openid-connect-providers
178178
type: concepts
179179
url: /guides/security-openid-connect-providers
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: "core, architecture"
183+
categories: "architecture, core"
184184
id: duplicated-context
185185
type: concepts
186186
url: /guides/duplicated-context
@@ -194,21 +194,21 @@ types:
194194
- title: OpenID Connect (OIDC) Bearer token authentication
195195
filename: security-oidc-bearer-token-authentication.adoc
196196
summary: Secure HTTP access to Jakarta REST (formerly known as JAX-RS) endpoints in your application with Bearer token authentication by using the Quarkus OpenID Connect (OIDC) extension.
197-
categories: "security, web"
197+
categories: "web, security"
198198
id: security-oidc-bearer-token-authentication
199199
type: concepts
200200
url: /guides/security-oidc-bearer-token-authentication
201201
- title: OpenID Connect authorization code flow mechanism for protecting web applications
202202
filename: security-oidc-code-flow-authentication.adoc
203203
summary: "To protect your web applications, you can use the industry-standard OpenID Connect (OIDC) Authorization Code Flow mechanism provided by the Quarkus OIDC extension."
204-
categories: "security, web"
204+
categories: "web, security"
205205
id: security-oidc-code-flow-authentication
206206
type: concepts
207207
url: /guides/security-oidc-code-flow-authentication
208208
- title: Proactive authentication
209209
filename: security-proactive-authentication.adoc
210210
summary: Proactive authentication is enabled in Quarkus by default.
211-
categories: "security, web"
211+
categories: "web, security"
212212
id: security-proactive-authentication
213213
type: concepts
214214
url: /guides/security-proactive-authentication
@@ -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: "security, contributing"
239+
categories: "contributing, security"
240240
id: security-vulnerability-detection
241241
type: concepts
242242
url: /guides/security-vulnerability-detection
@@ -265,7 +265,7 @@ types:
265265
- title: Use virtual threads in REST applications
266266
filename: resteasy-reactive-virtual-threads.adoc
267267
summary: How to use virtual threads in a REST application
268-
categories: "core, web"
268+
categories: "web, core"
269269
id: resteasy-reactive-virtual-threads
270270
type: howto
271271
url: /guides/resteasy-reactive-virtual-threads
@@ -312,7 +312,7 @@ types:
312312
- title: Protect a web application by using OpenID Connect (OIDC) authorization code flow
313313
filename: security-oidc-code-flow-authentication-tutorial.adoc
314314
summary: "With the Quarkus OpenID Connect (OIDC) extension, you can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism."
315-
categories: "security, web"
315+
categories: "web, security"
316316
id: security-oidc-code-flow-authentication-tutorial
317317
type: tutorial
318318
url: /guides/security-oidc-code-flow-authentication-tutorial
@@ -394,7 +394,7 @@ types:
394394
- title: AppCDS
395395
filename: appcds.adoc
396396
summary: This reference guide explains how to enable AppCDS with Quarkus.
397-
categories: "core, cloud"
397+
categories: "cloud, core"
398398
type: guide
399399
url: /guides/appcds
400400
- title: Application Data Caching
@@ -957,14 +957,14 @@ types:
957957
- title: Quarkus and Gradle
958958
filename: gradle-tooling.adoc
959959
summary: Develop and build your Quarkus application with Gradle
960-
categories: "tooling, native"
960+
categories: "native, tooling"
961961
id: gradle-tooling
962962
type: guide
963963
url: /guides/gradle-tooling
964964
- title: Quarkus and Maven
965965
filename: maven-tooling.adoc
966966
summary: Develop and build your Quarkus application with Maven
967-
categories: "tooling, native"
967+
categories: "native, tooling"
968968
id: maven-tooling
969969
type: guide
970970
url: /guides/maven-tooling
@@ -1062,7 +1062,7 @@ types:
10621062
- title: SmallRye Fault Tolerance
10631063
filename: smallrye-fault-tolerance.adoc
10641064
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
1065-
categories: "observability, web"
1065+
categories: "web, observability"
10661066
type: guide
10671067
url: /guides/smallrye-fault-tolerance
10681068
- title: SmallRye GraphQL
@@ -1092,14 +1092,14 @@ types:
10921092
- title: Testing Your Application
10931093
filename: getting-started-testing.adoc
10941094
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
1095-
categories: "core, native, tooling"
1095+
categories: "native, core, tooling"
10961096
id: testing
10971097
type: guide
10981098
url: /guides/getting-started-testing
10991099
- title: Tips for writing native applications
11001100
filename: writing-native-applications-tips.adoc
11011101
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1102-
categories: "core, native, writing-extensions"
1102+
categories: "writing-extensions, native, core"
11031103
type: guide
11041104
url: /guides/writing-native-applications-tips
11051105
- title: Using Apache Kafka Streams
@@ -1228,7 +1228,7 @@ types:
12281228
- title: Using SSL With Native Executables
12291229
filename: native-and-ssl.adoc
12301230
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."
1231-
categories: "core, native, security"
1231+
categories: "native, core, security"
12321232
type: guide
12331233
url: /guides/native-and-ssl
12341234
- title: Using Security with .properties File
@@ -1341,13 +1341,13 @@ types:
13411341
- title: Validation with Hibernate Validator
13421342
filename: validation.adoc
13431343
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
1344-
categories: "data, web"
1344+
categories: "web, data"
13451345
type: guide
13461346
url: /guides/validation
13471347
- title: Writing JSON REST Services
13481348
filename: rest-json.adoc
13491349
summary: JSON is now the lingua franca between microservices.
1350-
categories: "serialization, web"
1350+
categories: "web, serialization"
13511351
type: guide
13521352
url: /guides/rest-json
13531353
- title: Writing REST Services with RESTEasy Reactive

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

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

7777

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

8080

8181
[.description]
8282
--
83-
true to quit exit right after the initialization. The option is not meant be used directly by users.
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_INIT_AND_EXIT+++[]
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_INIT_AND_EXIT+++`
91+
Environment variable: `+++QUARKUS_ARGS+++`
9092
endif::add-copy-button-to-env-var[]
91-
--|boolean
92-
|`false`
93+
--|string
94+
|
9395

9496

95-
a| [[quarkus-core_quarkus.args]]`link:#quarkus-core_quarkus.args[quarkus.args]`
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-
The arguments passed to the command line.
101-
102-
We don't make it a list as the args are separated by a space, not a comma.
102+
true to quit exit right after the initialization. The option is not meant be used directly by users.
103103

104104
ifdef::add-copy-button-to-env-var[]
105-
Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[]
105+
Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[]
106106
endif::add-copy-button-to-env-var[]
107107
ifndef::add-copy-button-to-env-var[]
108-
Environment variable: `+++QUARKUS_ARGS+++`
108+
Environment variable: `+++QUARKUS_INIT_AND_EXIT+++`
109109
endif::add-copy-button-to-env-var[]
110-
--|string
111-
|
110+
--|boolean
111+
|`false`
112112

113113

114114
a| [[quarkus-core_quarkus.profile]]`link:#quarkus-core_quarkus.profile[quarkus.profile]`

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

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,4 +324,84 @@ endif::add-copy-button-to-env-var[]
324324
--|boolean
325325
|`false`
326326

327+
328+
a| [[quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.username]]`link:#quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.username[quarkus.datasource.username]`
329+
330+
`link:#quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.username[quarkus.datasource."datasource-name".username]`
331+
332+
333+
[.description]
334+
--
335+
The datasource username
336+
337+
ifdef::add-copy-button-to-env-var[]
338+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_USERNAME+++[]
339+
endif::add-copy-button-to-env-var[]
340+
ifndef::add-copy-button-to-env-var[]
341+
Environment variable: `+++QUARKUS_DATASOURCE_USERNAME+++`
342+
endif::add-copy-button-to-env-var[]
343+
--|string
344+
|
345+
346+
347+
a| [[quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.password]]`link:#quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.password[quarkus.datasource.password]`
348+
349+
`link:#quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.password[quarkus.datasource."datasource-name".password]`
350+
351+
352+
[.description]
353+
--
354+
The datasource password
355+
356+
ifdef::add-copy-button-to-env-var[]
357+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_PASSWORD+++[]
358+
endif::add-copy-button-to-env-var[]
359+
ifndef::add-copy-button-to-env-var[]
360+
Environment variable: `+++QUARKUS_DATASOURCE_PASSWORD+++`
361+
endif::add-copy-button-to-env-var[]
362+
--|string
363+
|
364+
365+
366+
a| [[quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.credentials-provider]]`link:#quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.credentials-provider[quarkus.datasource.credentials-provider]`
367+
368+
`link:#quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.credentials-provider[quarkus.datasource."datasource-name".credentials-provider]`
369+
370+
371+
[.description]
372+
--
373+
The credentials provider name
374+
375+
ifdef::add-copy-button-to-env-var[]
376+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_CREDENTIALS_PROVIDER+++[]
377+
endif::add-copy-button-to-env-var[]
378+
ifndef::add-copy-button-to-env-var[]
379+
Environment variable: `+++QUARKUS_DATASOURCE_CREDENTIALS_PROVIDER+++`
380+
endif::add-copy-button-to-env-var[]
381+
--|string
382+
|
383+
384+
385+
a| [[quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.credentials-provider-name]]`link:#quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.credentials-provider-name[quarkus.datasource.credentials-provider-name]`
386+
387+
`link:#quarkus-datasource-config-group-data-source-build-time-config_quarkus.datasource.credentials-provider-name[quarkus.datasource."datasource-name".credentials-provider-name]`
388+
389+
390+
[.description]
391+
--
392+
The credentials provider bean name.
393+
394+
This is a bean name (as in `@Named`) of a bean that implements `CredentialsProvider`. It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.
395+
396+
For Vault, the credentials provider bean name is `vault-credentials-provider`.
397+
398+
ifdef::add-copy-button-to-env-var[]
399+
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_CREDENTIALS_PROVIDER_NAME+++[]
400+
endif::add-copy-button-to-env-var[]
401+
ifndef::add-copy-button-to-env-var[]
402+
Environment variable: `+++QUARKUS_DATASOURCE_CREDENTIALS_PROVIDER_NAME+++`
403+
endif::add-copy-button-to-env-var[]
404+
--|string
405+
|
406+
327407
|===

0 commit comments

Comments
 (0)