Skip to content

Commit 6158094

Browse files
committed
Sync documentation of main branch
1 parent ae5c865 commit 6158094

30 files changed

+2555
-132
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 24 additions & 18 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
@@ -131,14 +131,14 @@ types:
131131
- title: Authentication mechanisms in Quarkus
132132
filename: security-authentication-mechanisms-concept.adoc
133133
summary: "The Quarkus Security framework supports multiple authentication mechanisms, which you can use to secure your applications."
134-
categories: "security, web"
134+
categories: "web, security"
135135
id: security-authentication-mechanisms-concept
136136
type: concepts
137137
url: /guides/security-authentication-mechanisms-concept
138138
- title: Basic authentication
139139
filename: security-basic-authentication-concept.adoc
140140
summary: HTTP Basic authentication is one of the least resource-demanding techniques that enforce access controls to web resources.
141-
categories: "security, web"
141+
categories: "web, security"
142142
id: security-basic-authentication-concept
143143
type: concepts
144144
url: /guides/security-basic-authentication-concept
@@ -152,21 +152,21 @@ types:
152152
- title: OpenID Connect (OIDC) Bearer authentication
153153
filename: security-oidc-bearer-token-authentication-concept.adoc
154154
summary: Secure HTTP access to Jakarta REST (formerly known as JAX-RS) endpoints in your application with Bearer authentication by using the Quarkus OpenID Connect (OIDC) extension.
155-
categories: "security, web"
155+
categories: "web, security"
156156
id: security-oidc-bearer-token-authentication-concept
157157
type: concepts
158158
url: /guides/security-oidc-bearer-token-authentication-concept
159159
- title: OpenID Connect authorization code flow mechanism for protecting web applications
160160
filename: security-oidc-code-flow-authentication-concept.adoc
161161
summary: "To protect your web applications, you can use the authorization code flow mechanism provided by the Quarkus OpenID Connect (OIDC) extension."
162-
categories: "security, web"
162+
categories: "web, security"
163163
id: security-oidc-code-flow-authentication-concept
164164
type: concepts
165165
url: /guides/security-oidc-code-flow-authentication-concept
166166
- title: Proactive authentication
167167
filename: security-proactive-authentication-concept.adoc
168168
summary: Proactive authentication is enabled in Quarkus by default.
169-
categories: "security, web"
169+
categories: "web, security"
170170
id: security-proactive-authentication-concept
171171
type: concepts
172172
url: /guides/security-proactive-authentication-concept
@@ -201,7 +201,7 @@ types:
201201
- title: Security vulnerability detection and reporting in Quarkus
202202
filename: security-vulnerability-detection-concept.adoc
203203
summary: Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.
204-
categories: "contributing, security"
204+
categories: "security, contributing"
205205
id: security-vulnerability-detection-concept
206206
type: concepts
207207
url: /guides/security-vulnerability-detection-concept
@@ -230,7 +230,7 @@ types:
230230
- title: Building a Native Executable
231231
filename: building-native-image.adoc
232232
summary: Build native executables with GraalVM or Mandrel.
233-
categories: "getting-started, native"
233+
categories: "native, getting-started"
234234
type: tutorial
235235
url: /guides/building-native-image
236236
- title: Collect metrics using Micrometer
@@ -276,7 +276,7 @@ types:
276276
- title: Protect a web application by using OpenID Connect (OIDC) authorization code flow
277277
filename: security-oidc-code-flow-authentication-tutorial.adoc
278278
summary: "With the Quarkus OpenID Connect (OIDC) extension, you can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism."
279-
categories: "security, web"
279+
categories: "web, security"
280280
id: security-oidc-code-flow-authentication-tutorial
281281
type: tutorial
282282
url: /guides/security-oidc-code-flow-authentication-tutorial
@@ -484,7 +484,7 @@ types:
484484
- title: Deploying on OpenShift
485485
filename: deploying-to-openshift.adoc
486486
summary: This guide covers how to deploy a native application on OpenShift.
487-
categories: "native, cloud"
487+
categories: "cloud, native"
488488
id: deploy-openshift
489489
type: guide
490490
url: /guides/deploying-to-openshift
@@ -506,6 +506,12 @@ types:
506506
categories: cloud
507507
type: guide
508508
url: /guides/deploying-to-azure-cloud
509+
- title: Deploying your gRPC Service in Kubernetes
510+
filename: grpc-kubernetes.adoc
511+
summary: This guide explains how to deploy your gRPC services in Quarkus to Kubernetes.
512+
categories: serialization
513+
type: guide
514+
url: /guides/grpc-kubernetes
509515
- title: Dev Services Overview
510516
filename: dev-services.adoc
511517
summary: A list of all extensions that support Dev Services and their configuration options.
@@ -533,7 +539,7 @@ types:
533539
- title: Dev Services for Databases
534540
filename: databases-dev-services.adoc
535541
summary: "When testing or running in dev mode Quarkus can provide you with a zero-config database out of the box, a feature we refer to as Dev Services."
536-
categories: "data, tooling"
542+
categories: "tooling, data"
537543
type: guide
538544
url: /guides/databases-dev-services
539545
- title: Dev Services for Elasticsearch
@@ -745,7 +751,7 @@ types:
745751
- title: Kubernetes extension
746752
filename: deploying-to-kubernetes.adoc
747753
summary: This guide covers how to deploy a native application on Kubernetes.
748-
categories: "native, cloud"
754+
categories: "cloud, native"
749755
id: deploy-kubernetes
750756
type: guide
751757
url: /guides/deploying-to-kubernetes
@@ -954,7 +960,7 @@ types:
954960
- title: Simplified Hibernate ORM with Panache and Kotlin
955961
filename: hibernate-orm-panache-kotlin.adoc
956962
summary: This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.
957-
categories: "data, alt-languages"
963+
categories: "alt-languages, data"
958964
type: guide
959965
url: /guides/hibernate-orm-panache-kotlin
960966
- title: Simplified Hibernate Reactive with Panache
@@ -972,13 +978,13 @@ types:
972978
- title: Simplified MongoDB with Panache and Kotlin
973979
filename: mongodb-panache-kotlin.adoc
974980
summary: This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.
975-
categories: "data, alt-languages"
981+
categories: "alt-languages, data"
976982
type: guide
977983
url: /guides/mongodb-panache-kotlin
978984
- title: SmallRye Fault Tolerance
979985
filename: smallrye-fault-tolerance.adoc
980986
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
981-
categories: "web, observability"
987+
categories: "observability, web"
982988
type: guide
983989
url: /guides/smallrye-fault-tolerance
984990
- title: SmallRye GraphQL
@@ -1151,7 +1157,7 @@ types:
11511157
- title: Using SSL With Native Executables
11521158
filename: native-and-ssl.adoc
11531159
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."
1154-
categories: "core, security, native"
1160+
categories: "core, native, security"
11551161
type: guide
11561162
url: /guides/native-and-ssl
11571163
- title: Using Security with .properties File
@@ -1258,13 +1264,13 @@ types:
12581264
- title: Validation with Hibernate Validator
12591265
filename: validation.adoc
12601266
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
1261-
categories: "data, web"
1267+
categories: "web, data"
12621268
type: guide
12631269
url: /guides/validation
12641270
- title: Writing JSON REST Services
12651271
filename: rest-json.adoc
12661272
summary: JSON is now the lingua franca between microservices.
1267-
categories: "serialization, web"
1273+
categories: "web, serialization"
12681274
type: guide
12691275
url: /guides/rest-json
12701276
- title: Writing REST Services with RESTEasy Reactive

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.kubernetes.deployment.ContainerConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"configDocKey":{"type":"boolean","key":".enabled","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":".image","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}}]
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"java.lang.Integer","key":".http-action-port","configDoc":"The port number to use when configuring the `http get` action. If not configured, the port corresponding to the `httpActionPortName` will be used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"http-action-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".http-action-port-name","configDoc":"The port name for selecting the port of the `HTTP get` action.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"http-action-port-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".http-action-path","configDoc":"The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"http-action-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".exec-action","configDoc":"The command to use for the probe.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"exec-action","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tcp-socket-action","configDoc":"The tcp socket to use for the probe (the format is host:port).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tcp-socket-action","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".grpc-action","configDoc":"The gRPC port to use for the probe (the format is either port or port:service).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"grpc-action","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".initial-delay","configDoc":"The amount of time to wait before starting to probe.","withinAMap":false,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"initial-delay","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".period","configDoc":"The period in which the action should be called.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"period","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".timeout","configDoc":"The amount of time to wait for each action.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".success-threshold","configDoc":"The success threshold to use.","withinAMap":false,"defaultValue":"1","javaDocSiteLink":"","docMapKey":"success-threshold","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".failure-threshold","configDoc":"The failure threshold to use.","withinAMap":false,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"failure-threshold","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
1+
[{"configDocKey":{"type":"java.lang.Integer","key":".http-action-port","configDoc":"The port number to use when configuring the `http get` action. If not configured, the port corresponding to the `httpActionPortName` will be used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"http-action-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".http-action-port-name","configDoc":"The port name for selecting the port of the `HTTP get` action.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"http-action-port-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".http-action-path","configDoc":"The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"http-action-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".exec-action","configDoc":"The command to use for the probe.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"exec-action","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tcp-socket-action","configDoc":"The tcp socket to use for the probe (the format is host:port).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tcp-socket-action","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".grpc-action","configDoc":"The gRPC port to use for the probe (the format is either port or port:service).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"grpc-action","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".grpc-action-enabled","configDoc":"If enabled and `grpc-action` is not provided, it will use the generated service name and the gRPC port.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"grpc-action-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".initial-delay","configDoc":"The amount of time to wait before starting to probe.","withinAMap":false,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"initial-delay","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".period","configDoc":"The period in which the action should be called.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"period","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".timeout","configDoc":"The amount of time to wait for each action.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".success-threshold","configDoc":"The success threshold to use.","withinAMap":false,"defaultValue":"1","javaDocSiteLink":"","docMapKey":"success-threshold","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".failure-threshold","configDoc":"The failure threshold to use.","withinAMap":false,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"failure-threshold","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig

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

0 commit comments

Comments
 (0)