Skip to content

Commit 6d04f8f

Browse files
committed
Sync documentation of main branch
1 parent a91f3f1 commit 6d04f8f

16 files changed

+215
-24
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 8 additions & 8 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
@@ -335,7 +335,7 @@ types:
335335
- title: AppCDS
336336
filename: appcds.adoc
337337
summary: This reference guide explains how to enable AppCDS with Quarkus.
338-
categories: "cloud, core"
338+
categories: "core, cloud"
339339
type: guide
340340
url: /guides/appcds
341341
- title: Application Data Caching
@@ -945,7 +945,7 @@ types:
945945
- title: Simplified Hibernate ORM with Panache and Kotlin
946946
filename: hibernate-orm-panache-kotlin.adoc
947947
summary: This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.
948-
categories: "data, alt-languages"
948+
categories: "alt-languages, data"
949949
type: guide
950950
url: /guides/hibernate-orm-panache-kotlin
951951
- title: Simplified Hibernate Reactive with Panache
@@ -963,13 +963,13 @@ types:
963963
- title: Simplified MongoDB with Panache and Kotlin
964964
filename: mongodb-panache-kotlin.adoc
965965
summary: This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.
966-
categories: "data, alt-languages"
966+
categories: "alt-languages, data"
967967
type: guide
968968
url: /guides/mongodb-panache-kotlin
969969
- title: SmallRye Fault Tolerance
970970
filename: smallrye-fault-tolerance.adoc
971971
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
972-
categories: "observability, web"
972+
categories: "web, observability"
973973
type: guide
974974
url: /guides/smallrye-fault-tolerance
975975
- title: SmallRye GraphQL
@@ -1005,7 +1005,7 @@ types:
10051005
- title: Tips for writing native applications
10061006
filename: writing-native-applications-tips.adoc
10071007
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1008-
categories: "writing-extensions, core"
1008+
categories: "core, writing-extensions"
10091009
type: guide
10101010
url: /guides/writing-native-applications-tips
10111011
- title: Update projects to the latest version of Quarkus
@@ -1248,13 +1248,13 @@ types:
12481248
- title: Validation with Hibernate Validator
12491249
filename: validation.adoc
12501250
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
1251-
categories: "data, web"
1251+
categories: "web, data"
12521252
type: guide
12531253
url: /guides/validation
12541254
- title: Writing JSON REST Services
12551255
filename: rest-json.adoc
12561256
summary: JSON is now the lingua franca between microservices.
1257-
categories: "serialization, web"
1257+
categories: "web, serialization"
12581258
type: guide
12591259
url: /guides/rest-json
12601260
- title: Writing REST Services with RESTEasy Reactive
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"boolean","key":".expose","configDoc":"If true, the service will be exposed","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"expose","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".host","configDoc":"The host under which the application is going to be exposed","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".target-port","configDoc":"The target named port. If not provided, it will be deducted from the Service resource ports. Options are: \"http\" and \"https\".","withinAMap":false,"defaultValue":"http","javaDocSiteLink":"","docMapKey":"target-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":".annotations","configDoc":"Custom annotations to add to exposition (route or ingress) resources","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"annotations","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".tls","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.kubernetes.deployment.TLSConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".tls.ca-certificate","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"ca-certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.certificate","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.destination-ca-certificate","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"destination-ca-certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.insecure-edge-termination-policy","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"insecure-edge-termination-policy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.key","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.termination","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"termination","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}]
1+
[{"configDocKey":{"type":"boolean","key":".expose","configDoc":"If true, the service will be exposed","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"expose","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".host","configDoc":"The host under which the application is going to be exposed","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".target-port","configDoc":"The target named port. If not provided, it will be deducted from the Service resource ports. Options are: \"http\" and \"https\".","withinAMap":false,"defaultValue":"http","javaDocSiteLink":"","docMapKey":"target-port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":".annotations","configDoc":"Custom annotations to add to exposition (route or ingress) resources","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"annotations","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".tls","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.kubernetes.deployment.TLSConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".tls.ca-certificate","configDoc":"The cert authority certificate contents.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"ca-certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.certificate","configDoc":"The certificate contents.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.destination-ca-certificate","configDoc":"The contents of the ca certificate of the final destination.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"destination-ca-certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.insecure-edge-termination-policy","configDoc":"The desired behavior for insecure connections to a route.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"insecure-edge-termination-policy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.key","configDoc":"The key file contents.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.termination","configDoc":"The termination type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"termination","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}]
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"string","key":".ca-certificate","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"ca-certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".certificate","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".destination-ca-certificate","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"destination-ca-certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".insecure-edge-termination-policy","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"insecure-edge-termination-policy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".termination","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"termination","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
1+
[{"configDocKey":{"type":"string","key":".ca-certificate","configDoc":"The cert authority certificate contents.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"ca-certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".certificate","configDoc":"The certificate contents.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".destination-ca-certificate","configDoc":"The contents of the ca certificate of the final destination.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"destination-ca-certificate","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".insecure-edge-termination-policy","configDoc":"The desired behavior for insecure connections to a route.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"insecure-edge-termination-policy","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key","configDoc":"The key file contents.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".termination","configDoc":"The termination type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"termination","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.kubernetes.deployment.OpenshiftConfig

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -728,7 +728,7 @@ a| `String propertyName` :: +++<i>No Javadoc found</i>+++
728728
`Type propertyType` :: +++<i>No Javadoc found</i>+++
729729
`String defaultValue` :: +++<i>No Javadoc found</i>+++
730730
731-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/ContextRegistrationPhaseBuildItem.java[`io.quarkus.arc.deployment.ContextRegistrationPhaseBuildItem`, window="_blank"] :: +++Context registration phase can be used to register custom CDI contexts. <p> An extension that needs to produce other build items during the "context registration" phase should use this build item. The build step should produce a or at least inject a for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after .+++
731+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/ContextRegistrationPhaseBuildItem.java[`io.quarkus.arc.deployment.ContextRegistrationPhaseBuildItem`, window="_blank"] :: +++Context registration phase can be used to register custom CDI contexts. <p> An extension that needs to produce other build items during the "context registration" phase should use this build item. The build step should produce a or at least inject a for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after . <p> Typical workflow involves obtaining a via . Note that there is no need to invoke once you are done as it is performed automatically.+++
732732
a| `BeanProcessor beanProcessor` :: +++<i>No Javadoc found</i>+++
733733
`ContextRegistrar.RegistrationContext context` :: +++<i>No Javadoc found</i>+++
734734

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32161,6 +32161,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.ro
3216132161

3216232162
[.description]
3216332163
--
32164+
The cert authority certificate contents.
32165+
3216432166
ifdef::add-copy-button-to-env-var[]
3216532167
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_CA_CERTIFICATE+++[]
3216632168
endif::add-copy-button-to-env-var[]
@@ -32175,6 +32177,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.ro
3217532177

3217632178
[.description]
3217732179
--
32180+
The certificate contents.
32181+
3217832182
ifdef::add-copy-button-to-env-var[]
3217932183
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_CERTIFICATE+++[]
3218032184
endif::add-copy-button-to-env-var[]
@@ -32189,6 +32193,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.ro
3218932193

3219032194
[.description]
3219132195
--
32196+
The contents of the ca certificate of the final destination.
32197+
3219232198
ifdef::add-copy-button-to-env-var[]
3219332199
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_DESTINATION_CA_CERTIFICATE+++[]
3219432200
endif::add-copy-button-to-env-var[]
@@ -32203,6 +32209,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.ro
3220332209

3220432210
[.description]
3220532211
--
32212+
The desired behavior for insecure connections to a route.
32213+
3220632214
ifdef::add-copy-button-to-env-var[]
3220732215
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_INSECURE_EDGE_TERMINATION_POLICY+++[]
3220832216
endif::add-copy-button-to-env-var[]
@@ -32217,6 +32225,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.ro
3221732225

3221832226
[.description]
3221932227
--
32228+
The key file contents.
32229+
3222032230
ifdef::add-copy-button-to-env-var[]
3222132231
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_KEY+++[]
3222232232
endif::add-copy-button-to-env-var[]
@@ -32231,6 +32241,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-kubernetes_quarkus.openshift.ro
3223132241

3223232242
[.description]
3223332243
--
32244+
The termination type.
32245+
3223432246
ifdef::add-copy-button-to-env-var[]
3223532247
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_ROUTE_TLS_TERMINATION+++[]
3223632248
endif::add-copy-button-to-env-var[]

0 commit comments

Comments
 (0)