Skip to content

Commit 0a022b3

Browse files
committed
Sync documentation of main branch
1 parent 82dd46b commit 0a022b3

File tree

98 files changed

+481
-226
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+481
-226
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 28 additions & 23 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
@@ -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
@@ -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"
58+
categories: "core, getting-started"
5959
id: logging
6060
type: reference
6161
url: /guides/logging
@@ -152,21 +152,21 @@ types:
152152
- title: Authentication mechanisms in Quarkus
153153
filename: security-authentication-mechanisms.adoc
154154
summary: "The Quarkus Security framework supports multiple authentication mechanisms, which you can use to secure your applications."
155-
categories: "security, web"
155+
categories: "web, security"
156156
id: security-authentication-mechanisms
157157
type: concepts
158158
url: /guides/security-authentication-mechanisms
159159
- title: Basic authentication
160160
filename: security-basic-authentication.adoc
161161
summary: HTTP Basic authentication is one of the least resource-demanding techniques that enforce access controls to web resources.
162-
categories: "security, web"
162+
categories: "web, security"
163163
id: security-basic-authentication
164164
type: concepts
165165
url: /guides/security-basic-authentication
166166
- title: "Duplicated context, context locals, asynchronous processing and propagation"
167167
filename: duplicated-context.adoc
168168
summary: "When using a traditional, blocking, and synchronous framework, processing of each request is performed in a dedicated thread."
169-
categories: "core, architecture"
169+
categories: "architecture, core"
170170
id: duplicated-context
171171
type: concepts
172172
url: /guides/duplicated-context
@@ -180,21 +180,21 @@ types:
180180
- title: OpenID Connect (OIDC) Bearer token authentication
181181
filename: security-oidc-bearer-token-authentication.adoc
182182
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.
183-
categories: "security, web"
183+
categories: "web, security"
184184
id: security-oidc-bearer-token-authentication
185185
type: concepts
186186
url: /guides/security-oidc-bearer-token-authentication
187187
- title: OpenID Connect authorization code flow mechanism for protecting web applications
188188
filename: security-oidc-code-flow-authentication.adoc
189189
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."
190-
categories: "security, web"
190+
categories: "web, security"
191191
id: security-oidc-code-flow-authentication
192192
type: concepts
193193
url: /guides/security-oidc-code-flow-authentication
194194
- title: Proactive authentication
195195
filename: security-proactive-authentication.adoc
196196
summary: Proactive authentication is enabled in Quarkus by default.
197-
categories: "security, web"
197+
categories: "web, security"
198198
id: security-proactive-authentication
199199
type: concepts
200200
url: /guides/security-proactive-authentication
@@ -252,7 +252,7 @@ types:
252252
- title: Building a Native Executable
253253
filename: building-native-image.adoc
254254
summary: Build native executables with GraalVM or Mandrel.
255-
categories: "getting-started, native"
255+
categories: "native, getting-started"
256256
type: tutorial
257257
url: /guides/building-native-image
258258
- title: Collect metrics using Micrometer
@@ -291,7 +291,7 @@ types:
291291
- title: Protect a web application by using OpenID Connect (OIDC) authorization code flow
292292
filename: security-oidc-code-flow-authentication-tutorial.adoc
293293
summary: "With the Quarkus OpenID Connect (OIDC) extension, you can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism."
294-
categories: "security, web"
294+
categories: "web, security"
295295
id: security-oidc-code-flow-authentication-tutorial
296296
type: tutorial
297297
url: /guides/security-oidc-code-flow-authentication-tutorial
@@ -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
@@ -366,7 +366,7 @@ types:
366366
- title: AppCDS
367367
filename: appcds.adoc
368368
summary: This reference guide explains how to enable AppCDS with Quarkus.
369-
categories: "core, cloud"
369+
categories: "cloud, core"
370370
type: guide
371371
url: /guides/appcds
372372
- title: Application Data Caching
@@ -504,7 +504,7 @@ types:
504504
- title: Deploying on OpenShift
505505
filename: deploying-to-openshift.adoc
506506
summary: This guide covers how to deploy a native application on OpenShift.
507-
categories: "native, cloud"
507+
categories: "cloud, native"
508508
id: deploy-openshift
509509
type: guide
510510
url: /guides/deploying-to-openshift
@@ -788,7 +788,7 @@ types:
788788
- title: Kubernetes extension
789789
filename: deploying-to-kubernetes.adoc
790790
summary: This guide covers how to deploy a native application on Kubernetes.
791-
categories: "native, cloud"
791+
categories: "cloud, native"
792792
id: deploy-kubernetes
793793
type: guide
794794
url: /guides/deploying-to-kubernetes
@@ -914,6 +914,11 @@ types:
914914
id: security-jpa
915915
type: guide
916916
url: /guides/security-jpa
917+
- title: Quarkus Virtual Thread support for gRPC services
918+
filename: grpc-virtual-threads.adoc
919+
summary: This guide explains how to benefit from Java virtual threads when implementing a gRPC service.
920+
type: guide
921+
url: /guides/grpc-virtual-threads
917922
- title: Quarkus Virtual Thread support with Reactive Messaging
918923
filename: messaging-virtual-threads.adoc
919924
summary: This guide explains how to benefit from Java virtual threads when writing message processing applications in Quarkus.
@@ -922,14 +927,14 @@ types:
922927
- title: Quarkus and Gradle
923928
filename: gradle-tooling.adoc
924929
summary: Develop and build your Quarkus application with Gradle
925-
categories: "tooling, native"
930+
categories: "native, tooling"
926931
id: gradle-tooling
927932
type: guide
928933
url: /guides/gradle-tooling
929934
- title: Quarkus and Maven
930935
filename: maven-tooling.adoc
931936
summary: Develop and build your Quarkus application with Maven
932-
categories: "tooling, native"
937+
categories: "native, tooling"
933938
id: maven-tooling
934939
type: guide
935940
url: /guides/maven-tooling
@@ -1003,7 +1008,7 @@ types:
10031008
- title: Simplified Hibernate ORM with Panache and Kotlin
10041009
filename: hibernate-orm-panache-kotlin.adoc
10051010
summary: This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.
1006-
categories: "alt-languages, data"
1011+
categories: "data, alt-languages"
10071012
type: guide
10081013
url: /guides/hibernate-orm-panache-kotlin
10091014
- title: Simplified Hibernate Reactive with Panache
@@ -1021,7 +1026,7 @@ types:
10211026
- title: Simplified MongoDB with Panache and Kotlin
10221027
filename: mongodb-panache-kotlin.adoc
10231028
summary: This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.
1024-
categories: "alt-languages, data"
1029+
categories: "data, alt-languages"
10251030
type: guide
10261031
url: /guides/mongodb-panache-kotlin
10271032
- title: SmallRye Fault Tolerance
@@ -1057,14 +1062,14 @@ types:
10571062
- title: Testing Your Application
10581063
filename: getting-started-testing.adoc
10591064
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
1060-
categories: "core, tooling, native"
1065+
categories: "native, tooling, core"
10611066
id: testing
10621067
type: guide
10631068
url: /guides/getting-started-testing
10641069
- title: Tips for writing native applications
10651070
filename: writing-native-applications-tips.adoc
10661071
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1067-
categories: "core, writing-extensions, native"
1072+
categories: "writing-extensions, native, core"
10681073
type: guide
10691074
url: /guides/writing-native-applications-tips
10701075
- title: Using Apache Kafka Streams
@@ -1193,7 +1198,7 @@ types:
11931198
- title: Using SSL With Native Executables
11941199
filename: native-and-ssl.adoc
11951200
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."
1196-
categories: "core, security, native"
1201+
categories: "native, security, core"
11971202
type: guide
11981203
url: /guides/native-and-ssl
11991204
- title: Using Security with .properties File
@@ -1306,7 +1311,7 @@ types:
13061311
- title: Validation with Hibernate Validator
13071312
filename: validation.adoc
13081313
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
1309-
categories: "data, web"
1314+
categories: "web, data"
13101315
type: guide
13111316
url: /guides/validation
13121317
- title: Writing JSON REST Services

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.deployment.pkg.NativeConfig

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

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -981,6 +981,7 @@ a| `String interceptorClass` :: +++<i>No Javadoc found</i>+++
981981
a| https://github.com/quarkusio/quarkus/blob/main/extensions/grpc/deployment/src/main/java/io/quarkus/grpc/deployment/BindableServiceBuildItem.java[`io.quarkus.grpc.deployment.BindableServiceBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
982982
a| `DotName serviceClass` :: +++<i>No Javadoc found</i>+++
983983
`List blockingMethods` :: +++<i>No Javadoc found</i>+++
984+
`List virtualMethods` :: +++<i>No Javadoc found</i>+++
984985
985986
a| https://github.com/quarkusio/quarkus/blob/main/extensions/grpc/deployment/src/main/java/io/quarkus/grpc/deployment/DelegatingGrpcBeanBuildItem.java[`io.quarkus.grpc.deployment.DelegatingGrpcBeanBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
986987
a| `ClassInfo generatedBean` :: +++<i>No Javadoc found</i>+++
@@ -2312,6 +2313,15 @@ a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployme
23122313
a| `GACT artifactKey` :: +++<i>No Javadoc found</i>+++
23132314
`String path` :: +++<i>No Javadoc found</i>+++
23142315
2316+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment/src/main/java/io/quarkus/vertx/http/deployment/EagerSecurityInterceptorBuildItem.java[`io.quarkus.vertx.http.deployment.EagerSecurityInterceptorBuildItem`, window="_blank"] :: +++Bears collected security interceptors per method candidate. Methods are candidates because not each of them must be finally resolved to endpoint and invoked. <p> This build item should be consumed by every extension that run s before CDI interceptors when proactive auth is disabled.+++
2317+
a| `List methodCandidates` :: +++<i>No Javadoc found</i>+++
2318+
`Map methodCandidateToSecurityInterceptor` :: +++<i>No Javadoc found</i>+++
2319+
2320+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment/src/main/java/io/quarkus/vertx/http/deployment/EagerSecurityInterceptorCandidateBuildItem.java[`io.quarkus.vertx.http.deployment.EagerSecurityInterceptorCandidateBuildItem`, window="_blank"] :: +++Vert.X route handlers run before REST layer can't determine which endpoint is going to be invoked, what are endpoint annotations etc. Therefore, security setting that requires knowledge of invoked method (initial intention is to provide this with RESTEasy Reactive resources, however the principle is applicable to other stacks as well) and needs to be run prior to any security check should use this build item. The build item is only required for stacks that do not run security checks via CDI interceptors, as there, you can simply use interceptor with higher priority.+++
2321+
a| `MethodInfo methodInfo` :: +++<i>No Javadoc found</i>+++
2322+
`RuntimeValue descriptionRuntimeValue` :: +++<i>No Javadoc found</i>+++
2323+
`Consumer securityInterceptor` :: +++<i>No Javadoc found</i>+++
2324+
23152325
a| https://github.com/quarkusio/quarkus/blob/main/extensions/vertx-http/deployment/src/main/java/io/quarkus/devui/deployment/ExtensionsBuildItem.java[`io.quarkus.devui.deployment.ExtensionsBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
23162326
a| `List activeExtensions` :: +++<i>No Javadoc found</i>+++
23172327
`List inactiveExtensions` :: +++<i>No Javadoc found</i>+++

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68297,6 +68297,23 @@ endif::add-copy-button-to-env-var[]
6829768297
|
6829868298

6829968299

68300+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.native.pie]]`link:#quarkus-core_quarkus.native.pie[quarkus.native.pie]`
68301+
68302+
68303+
[.description]
68304+
--
68305+
Explicit configuration option to generate a native Position Independent Executable (PIE) for Linux. If the system supports PIE generation, the default behaviour is to disable it for link:https://www.redhat.com/en/blog/position-independent-executable-pie-performance[performance reasons]. However, some systems can only run position-independent executables, so this option enables the generation of such native executables.
68306+
68307+
ifdef::add-copy-button-to-env-var[]
68308+
Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_PIE+++[]
68309+
endif::add-copy-button-to-env-var[]
68310+
ifndef::add-copy-button-to-env-var[]
68311+
Environment variable: `+++QUARKUS_NATIVE_PIE+++`
68312+
endif::add-copy-button-to-env-var[]
68313+
--|boolean
68314+
|
68315+
68316+
6830068317
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.native.remote-container-build]]`link:#quarkus-core_quarkus.native.remote-container-build[quarkus.native.remote-container-build]`
6830168318

6830268319

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1220,6 +1220,23 @@ endif::add-copy-button-to-env-var[]
12201220
|
12211221

12221222

1223+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.native.pie]]`link:#quarkus-core_quarkus.native.pie[quarkus.native.pie]`
1224+
1225+
1226+
[.description]
1227+
--
1228+
Explicit configuration option to generate a native Position Independent Executable (PIE) for Linux. If the system supports PIE generation, the default behaviour is to disable it for link:https://www.redhat.com/en/blog/position-independent-executable-pie-performance[performance reasons]. However, some systems can only run position-independent executables, so this option enables the generation of such native executables.
1229+
1230+
ifdef::add-copy-button-to-env-var[]
1231+
Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_PIE+++[]
1232+
endif::add-copy-button-to-env-var[]
1233+
ifndef::add-copy-button-to-env-var[]
1234+
Environment variable: `+++QUARKUS_NATIVE_PIE+++`
1235+
endif::add-copy-button-to-env-var[]
1236+
--|boolean
1237+
|
1238+
1239+
12231240
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.native.remote-container-build]]`link:#quarkus-core_quarkus.native.remote-container-build[quarkus.native.remote-container-build]`
12241241

12251242

_generated-doc/main/config/quarkus-native-pkg-native-config.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,23 @@ endif::add-copy-button-to-env-var[]
284284
|
285285

286286

287+
a|icon:lock[title=Fixed at build time] [[quarkus-native-pkg-native-config_quarkus.native.pie]]`link:#quarkus-native-pkg-native-config_quarkus.native.pie[quarkus.native.pie]`
288+
289+
290+
[.description]
291+
--
292+
Explicit configuration option to generate a native Position Independent Executable (PIE) for Linux. If the system supports PIE generation, the default behaviour is to disable it for link:https://www.redhat.com/en/blog/position-independent-executable-pie-performance[performance reasons]. However, some systems can only run position-independent executables, so this option enables the generation of such native executables.
293+
294+
ifdef::add-copy-button-to-env-var[]
295+
Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_PIE+++[]
296+
endif::add-copy-button-to-env-var[]
297+
ifndef::add-copy-button-to-env-var[]
298+
Environment variable: `+++QUARKUS_NATIVE_PIE+++`
299+
endif::add-copy-button-to-env-var[]
300+
--|boolean
301+
|
302+
303+
287304
a|icon:lock[title=Fixed at build time] [[quarkus-native-pkg-native-config_quarkus.native.remote-container-build]]`link:#quarkus-native-pkg-native-config_quarkus.native.remote-container-build[quarkus.native.remote-container-build]`
288305

289306

_versions/main/guides/_attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
:keycloak-docker-image: quay.io/keycloak/keycloak:22.0.1
2121
:jandex-version: 3.1.2
2222
:jandex-gradle-plugin.version: 1.0.0
23-
:kotlin-version: 1.8.22
23+
:kotlin-version: 1.9.0
2424
:grpc-version: 1.56.1
2525
:protoc-version: 3.22.0
2626
:gcf-invoker-version: 1.3.0

_versions/main/guides/amqp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ However, you can go right to the completed example.
4747

4848
Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].
4949

50-
The solution is located in the `amqp-quickstart` {quickstarts-tree-url}/amqp-quickstart[directory].
50+
The solution is located in the `amqp-quickstart` link:{quickstarts-tree-url}/amqp-quickstart[directory].
5151

5252
== Creating the Maven Project
5353

_versions/main/guides/ansible.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes.adoc[]
66

77
Let’s see how to build and deploy a Quarkus app using https://docs.ansible.com/ansible/latest/index.html[Ansible]. We’ll see how we can automate the entire process, from the code checkout to the application compilation using Maven and then its deployment and start of the service, as a https://systemd.io/[systemd service], on the target system using Ansible and its collection for Quarkus.
88

9-
The first part, the application code checkout, compilation and packaging on the Ansible (where Ansible runs). We’ll use the getting-started sample application provided in its {quickstarts-tree-url}/getting-started[Quarkus QuickStarts directory] as a base for this tutorial. We’ll also leverage the https://galaxy.ansible.com/middleware_automation/quarkus[Quarkus collection] for Ansible, an extension for Ansible that alleviates the boilerplate required and to quickly build and deploy a Quarkus using Ansible.
9+
The first part, the application code checkout, compilation and packaging on the Ansible (where Ansible runs). We’ll use the getting-started sample application provided in its link:{quickstarts-tree-url}/getting-started[Quarkus QuickStarts directory] as a base for this tutorial. We’ll also leverage the https://galaxy.ansible.com/middleware_automation/quarkus[Quarkus collection] for Ansible, an extension for Ansible that alleviates the boilerplate required and to quickly build and deploy a Quarkus using Ansible.
1010

1111
== Prerequisites
1212

_versions/main/guides/cache.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ However, you can go right to the completed example.
3939

4040
Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive].
4141

42-
The solution is located in the `cache-quickstart` {quickstarts-tree-url}/cache-quickstart[directory].
42+
The solution is located in the `cache-quickstart` link:{quickstarts-tree-url}/cache-quickstart[directory].
4343

4444
== Creating the Maven project
4545

0 commit comments

Comments
 (0)