Skip to content

Commit ff27d43

Browse files
committed
Sync documentation of main branch
1 parent 0e976fc commit ff27d43

23 files changed

+221
-72
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 19 additions & 19 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: "web, security"
8+
categories: "security, web"
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: "web, security"
134+
categories: "security, web"
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: "web, security"
141+
categories: "security, web"
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: "web, security"
155+
categories: "security, web"
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: "web, security"
162+
categories: "security, web"
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: "web, security"
169+
categories: "security, web"
170170
id: security-proactive-authentication-concept
171171
type: concepts
172172
url: /guides/security-proactive-authentication-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: "native, getting-started"
233+
categories: "getting-started, native"
234234
type: tutorial
235235
url: /guides/building-native-image
236236
- title: Collect metrics using Micrometer
@@ -243,7 +243,7 @@ types:
243243
- title: Configure data sources in Quarkus
244244
filename: datasource.adoc
245245
summary: Use a unified configuration model to define datasources for Java Database Connectivity (JDBC) and Reactive drivers.
246-
categories: "reactive, getting-started, data"
246+
categories: "getting-started, data, reactive"
247247
id: datasources
248248
type: tutorial
249249
url: /guides/datasource
@@ -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: "web, security"
279+
categories: "security, web"
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
@@ -726,7 +726,7 @@ types:
726726
url: /guides/grpc-service-implementation
727727
- title: Introduction to Contexts and Dependency Injection (CDI)
728728
filename: cdi.adoc
729-
summary: "Quarkus DI solution is based on the [Contexts and Dependency Injection for Java 2.0](https://docs.jboss.org/cdi/spec/2.0/cdi-spec) specification."
729+
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."
730730
categories: core
731731
type: guide
732732
url: /guides/cdi
@@ -751,7 +751,7 @@ types:
751751
- title: Kubernetes extension
752752
filename: deploying-to-kubernetes.adoc
753753
summary: This guide covers how to deploy a native application on Kubernetes.
754-
categories: "native, cloud"
754+
categories: "cloud, native"
755755
id: deploy-kubernetes
756756
type: guide
757757
url: /guides/deploying-to-kubernetes
@@ -879,14 +879,14 @@ types:
879879
- title: Quarkus and Gradle
880880
filename: gradle-tooling.adoc
881881
summary: Develop and build your Quarkus application with Gradle
882-
categories: "native, tooling"
882+
categories: "tooling, native"
883883
id: gradle-tooling
884884
type: guide
885885
url: /guides/gradle-tooling
886886
- title: Quarkus and Maven
887887
filename: maven-tooling.adoc
888888
summary: Develop and build your Quarkus application with Maven
889-
categories: "native, tooling"
889+
categories: "tooling, native"
890890
id: maven-tooling
891891
type: guide
892892
url: /guides/maven-tooling
@@ -984,7 +984,7 @@ types:
984984
- title: SmallRye Fault Tolerance
985985
filename: smallrye-fault-tolerance.adoc
986986
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
987-
categories: "web, observability"
987+
categories: "observability, web"
988988
type: guide
989989
url: /guides/smallrye-fault-tolerance
990990
- title: SmallRye GraphQL
@@ -1014,14 +1014,14 @@ types:
10141014
- title: Testing Your Application
10151015
filename: getting-started-testing.adoc
10161016
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
1017-
categories: "core, native, tooling"
1017+
categories: "core, tooling, native"
10181018
id: testing
10191019
type: guide
10201020
url: /guides/getting-started-testing
10211021
- title: Tips for writing native applications
10221022
filename: writing-native-applications-tips.adoc
10231023
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1024-
categories: "writing-extensions, core, native"
1024+
categories: "core, writing-extensions, native"
10251025
type: guide
10261026
url: /guides/writing-native-applications-tips
10271027
- title: Update projects to the latest version of Quarkus
@@ -1157,7 +1157,7 @@ types:
11571157
- title: Using SSL With Native Executables
11581158
filename: native-and-ssl.adoc
11591159
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."
1160-
categories: "core, native, security"
1160+
categories: "core, security, native"
11611161
type: guide
11621162
url: /guides/native-and-ssl
11631163
- title: Using Security with .properties File
@@ -1264,7 +1264,7 @@ types:
12641264
- title: Validation with Hibernate Validator
12651265
filename: validation.adoc
12661266
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
1267-
categories: "web, data"
1267+
categories: "data, web"
12681268
type: guide
12691269
url: /guides/validation
12701270
- title: Writing JSON REST Services
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"configDocKey":{"type":"string","key":"","configDoc":"The docker image to use to do the image build. It can be one of `graalvm`, `mandrel`, or the full image path, e.g. `quay.io/quarkus/ubi-quarkus-mandrel-builder-image:22.3-java17`.","withinAMap":false,"defaultValue":"mandrel","javaDocSiteLink":"","docMapKey":"image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.deployment.pkg.NativeConfig.ImagePullStrategy","key":".pull","configDoc":"The strategy for pulling the builder image during the build. \nDefaults to 'always', which will always pull the most up-to-date image; useful to keep up with fixes when a (floating) tag is updated. \nUse 'missing' to only pull if there is no image locally; useful on development environments where building with out-of-date images is acceptable and bandwidth may be limited. \nUse 'never' to fail the build if there is no image locally.","withinAMap":false,"defaultValue":"always","javaDocSiteLink":"","docMapKey":"pull","configPhase":"BUILD_TIME","acceptedValues":["`always`","`missing`","`never`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}}]
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"java.lang.Boolean","key":".enabled","configDoc":"If Dev Services for AMQP has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For AMQP, Dev Services starts a broker unless `amqp-host` or `amqp-port` are set or if all the Reactive Messaging AMQP channel are configured with `host` or `port`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","configDoc":"Optional fixed port the dev service will listen to. \nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".image-name","configDoc":"The image to use. Note that only ActiveMQ Artemis images are supported. Specifically, the image repository must end with `artemiscloud/activemq-artemis-broker`. Check https://quay.io/repository/artemiscloud/activemq-artemis-broker to find the available versions.","withinAMap":false,"defaultValue":"quay.io/artemiscloud/activemq-artemis-broker:1.0.11","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".extra-args","configDoc":"The value of the `AMQ_EXTRA_ARGS` environment variable to pass to the container.","withinAMap":false,"defaultValue":"--no-autotune --mapped --no-fsync --relax-jolokia --http-host 0.0.0.0","javaDocSiteLink":"","docMapKey":"extra-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","configDoc":"Indicates if the AMQP broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for AMQP starts a new container. \nThe discovery uses the `quarkus-dev-service-amqp` label. The value is configured using the `service-name` property. \nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".service-name","configDoc":"The value of the `quarkus-dev-service-aqmp` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for AMQP looks for a container with the `quarkus-dev-service-amqp` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-amqp` label set to the specified value. \nThis property is used when you need multiple shared AMQP brokers.","withinAMap":false,"defaultValue":"amqp","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
1+
[{"configDocKey":{"type":"java.lang.Boolean","key":".enabled","configDoc":"If Dev Services for AMQP has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For AMQP, Dev Services starts a broker unless `amqp-host` or `amqp-port` are set or if all the Reactive Messaging AMQP channel are configured with `host` or `port`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","configDoc":"Optional fixed port the dev service will listen to. \nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".image-name","configDoc":"The image to use. Note that only ActiveMQ Artemis images are supported. Specifically, the image repository must end with `artemiscloud/activemq-artemis-broker`. Check the link:https://quay.io/repository/artemiscloud/activemq-artemis-broker[activemq-artemis-broker on Quay page] to find the available versions.","withinAMap":false,"defaultValue":"quay.io/artemiscloud/activemq-artemis-broker:1.0.18","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".extra-args","configDoc":"The value of the `AMQ_EXTRA_ARGS` environment variable to pass to the container.","withinAMap":false,"defaultValue":"--no-autotune --mapped --no-fsync --relax-jolokia --http-host 0.0.0.0","javaDocSiteLink":"","docMapKey":"extra-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","configDoc":"Indicates if the AMQP broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for AMQP starts a new container. \nThe discovery uses the `quarkus-dev-service-amqp` label. The value is configured using the `service-name` property. \nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".service-name","configDoc":"The value of the `quarkus-dev-service-aqmp` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for AMQP looks for a container with the `quarkus-dev-service-amqp` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-amqp` label set to the specified value. \nThis property is used when you need multiple shared AMQP brokers.","withinAMap":false,"defaultValue":"amqp","javaDocSiteLink":"","docMapKey":"service-name","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.deployment.pkg.NativeConfig

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

0 commit comments

Comments
 (0)