Skip to content

Commit aa18e0b

Browse files
committed
Sync documentation of main branch
1 parent fab1e96 commit aa18e0b

File tree

11 files changed

+177
-11
lines changed

11 files changed

+177
-11
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -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 data sources for Java Database Connectivity (JDBC) and Reactive drivers.
33-
categories: "data, getting-started"
33+
categories: "getting-started, data"
3434
id: datasources
3535
type: reference
3636
url: /guides/datasource
@@ -338,7 +338,7 @@ types:
338338
- title: Your second Quarkus application
339339
filename: getting-started-dev-services.adoc
340340
summary: Discover some of the features that make developing with Quarkus a joyful experience.
341-
categories: "data, getting-started, core"
341+
categories: "getting-started, data, core"
342342
id: getting-started-dev-services-tutorial
343343
type: tutorial
344344
url: /guides/getting-started-dev-services
@@ -528,7 +528,7 @@ types:
528528
- title: Deploying on OpenShift
529529
filename: deploying-to-openshift.adoc
530530
summary: This guide covers how to deploy a native application on OpenShift.
531-
categories: "native, cloud"
531+
categories: "cloud, native"
532532
id: deploy-openshift
533533
type: guide
534534
url: /guides/deploying-to-openshift
@@ -583,7 +583,7 @@ types:
583583
- title: Dev Services for Databases
584584
filename: databases-dev-services.adoc
585585
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."
586-
categories: "data, tooling"
586+
categories: "tooling, data"
587587
type: guide
588588
url: /guides/databases-dev-services
589589
- title: Dev Services for Elasticsearch
@@ -813,7 +813,7 @@ types:
813813
- title: Kubernetes extension
814814
filename: deploying-to-kubernetes.adoc
815815
summary: This guide covers how to deploy a native application on Kubernetes.
816-
categories: "native, cloud"
816+
categories: "cloud, native"
817817
id: deploy-kubernetes
818818
type: guide
819819
url: /guides/deploying-to-kubernetes
@@ -1094,7 +1094,7 @@ types:
10941094
- title: Tips for writing native applications
10951095
filename: writing-native-applications-tips.adoc
10961096
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1097-
categories: "writing-extensions, native, core"
1097+
categories: "native, writing-extensions, core"
10981098
type: guide
10991099
url: /guides/writing-native-applications-tips
11001100
- title: Using Apache Kafka Streams

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.restclient.config.RestClientConfig

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

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.restclient.config.RestClientsConfig

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
@@ -289,7 +289,7 @@ a| None
289289
a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/nativeimage/JPMSExportBuildItem.java[`io.quarkus.deployment.builditem.nativeimage.JPMSExportBuildItem`, window="_blank"] :: +++A build item that indicates that a Java package should be exported using '-J--add-exports' option to become visible to native-image+++
290290
a| `String moduleName` :: +++<i>No Javadoc found</i>+++
291291
`String packageName` :: +++<i>No Javadoc found</i>+++
292-
`GraalVM.Version exportAfter` :: +++<i>No Javadoc found</i>+++
292+
`GraalVM.Version exportSince` :: +++<i>No Javadoc found</i>+++
293293
`GraalVM.Version exportBefore` :: +++<i>No Javadoc found</i>+++
294294
295295
a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/pkg/builditem/JarBuildItem.java[`io.quarkus.deployment.pkg.builditem.JarBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57471,6 +57471,23 @@ endif::add-copy-button-to-env-var[]
5747157471
|
5747257472

5747357473

57474+
a| [[quarkus-rest-client-config_quarkus.rest-client.capture-stacktrace]]`link:#quarkus-rest-client-config_quarkus.rest-client.capture-stacktrace[quarkus.rest-client.capture-stacktrace]`
57475+
57476+
57477+
[.description]
57478+
--
57479+
If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception
57480+
57481+
ifdef::add-copy-button-to-env-var[]
57482+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_CAPTURE_STACKTRACE+++[]
57483+
endif::add-copy-button-to-env-var[]
57484+
ifndef::add-copy-button-to-env-var[]
57485+
Environment variable: `+++QUARKUS_REST_CLIENT_CAPTURE_STACKTRACE+++`
57486+
endif::add-copy-button-to-env-var[]
57487+
--|boolean
57488+
|`true`
57489+
57490+
5747457491
a| [[quarkus-rest-client-config_quarkus.rest-client.-config-key-.multipart.max-chunk-size]]`link:#quarkus-rest-client-config_quarkus.rest-client.-config-key-.multipart.max-chunk-size[quarkus.rest-client."config-key".multipart.max-chunk-size]`
5747557492

5747657493

@@ -57999,6 +58016,23 @@ endif::add-copy-button-to-env-var[]
5799958016
|
5800058017

5800158018

58019+
a| [[quarkus-rest-client-config_quarkus.rest-client.-config-key-.capture-stacktrace]]`link:#quarkus-rest-client-config_quarkus.rest-client.-config-key-.capture-stacktrace[quarkus.rest-client."config-key".capture-stacktrace]`
58020+
58021+
58022+
[.description]
58023+
--
58024+
If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception
58025+
58026+
ifdef::add-copy-button-to-env-var[]
58027+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIG_KEY__CAPTURE_STACKTRACE+++[]
58028+
endif::add-copy-button-to-env-var[]
58029+
ifndef::add-copy-button-to-env-var[]
58030+
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIG_KEY__CAPTURE_STACKTRACE+++`
58031+
endif::add-copy-button-to-env-var[]
58032+
--|boolean
58033+
|
58034+
58035+
5800258036
a| [[quarkus-rest-client-config_quarkus.rest-client.headers-headers]]`link:#quarkus-rest-client-config_quarkus.rest-client.headers-headers[quarkus.rest-client.headers]`
5800358037

5800458038

_generated-doc/main/config/quarkus-rest-client-restclient-config-rest-clients-config.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -544,6 +544,23 @@ endif::add-copy-button-to-env-var[]
544544
|
545545

546546

547+
a| [[quarkus-rest-client-restclient-config-rest-clients-config_quarkus.rest-client.capture-stacktrace]]`link:#quarkus-rest-client-restclient-config-rest-clients-config_quarkus.rest-client.capture-stacktrace[quarkus.rest-client.capture-stacktrace]`
548+
549+
550+
[.description]
551+
--
552+
If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception
553+
554+
ifdef::add-copy-button-to-env-var[]
555+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_CAPTURE_STACKTRACE+++[]
556+
endif::add-copy-button-to-env-var[]
557+
ifndef::add-copy-button-to-env-var[]
558+
Environment variable: `+++QUARKUS_REST_CLIENT_CAPTURE_STACKTRACE+++`
559+
endif::add-copy-button-to-env-var[]
560+
--|boolean
561+
|`true`
562+
563+
547564
a| [[quarkus-rest-client-restclient-config-rest-clients-config_quarkus.rest-client.-config-key-.multipart.max-chunk-size]]`link:#quarkus-rest-client-restclient-config-rest-clients-config_quarkus.rest-client.-config-key-.multipart.max-chunk-size[quarkus.rest-client."config-key".multipart.max-chunk-size]`
548565

549566

@@ -1072,6 +1089,23 @@ endif::add-copy-button-to-env-var[]
10721089
|
10731090

10741091

1092+
a| [[quarkus-rest-client-restclient-config-rest-clients-config_quarkus.rest-client.-config-key-.capture-stacktrace]]`link:#quarkus-rest-client-restclient-config-rest-clients-config_quarkus.rest-client.-config-key-.capture-stacktrace[quarkus.rest-client."config-key".capture-stacktrace]`
1093+
1094+
1095+
[.description]
1096+
--
1097+
If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception
1098+
1099+
ifdef::add-copy-button-to-env-var[]
1100+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIG_KEY__CAPTURE_STACKTRACE+++[]
1101+
endif::add-copy-button-to-env-var[]
1102+
ifndef::add-copy-button-to-env-var[]
1103+
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIG_KEY__CAPTURE_STACKTRACE+++`
1104+
endif::add-copy-button-to-env-var[]
1105+
--|boolean
1106+
|
1107+
1108+
10751109
a| [[quarkus-rest-client-restclient-config-rest-clients-config_quarkus.rest-client.headers-headers]]`link:#quarkus-rest-client-restclient-config-rest-clients-config_quarkus.rest-client.headers-headers[quarkus.rest-client.headers]`
10761110

10771111

_generated-doc/main/config/quarkus-restclient-config-general-config-items.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -594,4 +594,21 @@ endif::add-copy-button-to-env-var[]
594594
--|boolean
595595
|
596596

597+
598+
a| [[quarkus-restclient-config-general-config-items_quarkus.rest-client.-config-key-.capture-stacktrace]]`link:#quarkus-restclient-config-general-config-items_quarkus.rest-client.-config-key-.capture-stacktrace[quarkus.rest-client."config-key".capture-stacktrace]`
599+
600+
601+
[.description]
602+
--
603+
If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception
604+
605+
ifdef::add-copy-button-to-env-var[]
606+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIG_KEY__CAPTURE_STACKTRACE+++[]
607+
endif::add-copy-button-to-env-var[]
608+
ifndef::add-copy-button-to-env-var[]
609+
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIG_KEY__CAPTURE_STACKTRACE+++`
610+
endif::add-copy-button-to-env-var[]
611+
--|boolean
612+
|
613+
597614
|===

_generated-doc/main/config/quarkus-restclient-config-rest-client-config.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -537,4 +537,21 @@ endif::add-copy-button-to-env-var[]
537537
--|boolean
538538
|
539539

540+
541+
a| [[quarkus-restclient-config-rest-client-config_quarkus.rest-client.-config-key-.capture-stacktrace]]`link:#quarkus-restclient-config-rest-client-config_quarkus.rest-client.-config-key-.capture-stacktrace[quarkus.rest-client."config-key".capture-stacktrace]`
542+
543+
544+
[.description]
545+
--
546+
If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception
547+
548+
ifdef::add-copy-button-to-env-var[]
549+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIG_KEY__CAPTURE_STACKTRACE+++[]
550+
endif::add-copy-button-to-env-var[]
551+
ifndef::add-copy-button-to-env-var[]
552+
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIG_KEY__CAPTURE_STACKTRACE+++`
553+
endif::add-copy-button-to-env-var[]
554+
--|boolean
555+
|
556+
540557
|===

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -544,6 +544,23 @@ endif::add-copy-button-to-env-var[]
544544
|
545545

546546

547+
a| [[quarkus-restclient-config_quarkus.rest-client.capture-stacktrace]]`link:#quarkus-restclient-config_quarkus.rest-client.capture-stacktrace[quarkus.rest-client.capture-stacktrace]`
548+
549+
550+
[.description]
551+
--
552+
If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception
553+
554+
ifdef::add-copy-button-to-env-var[]
555+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_CAPTURE_STACKTRACE+++[]
556+
endif::add-copy-button-to-env-var[]
557+
ifndef::add-copy-button-to-env-var[]
558+
Environment variable: `+++QUARKUS_REST_CLIENT_CAPTURE_STACKTRACE+++`
559+
endif::add-copy-button-to-env-var[]
560+
--|boolean
561+
|`true`
562+
563+
547564
a| [[quarkus-restclient-config_quarkus.rest-client.-config-key-.multipart.max-chunk-size]]`link:#quarkus-restclient-config_quarkus.rest-client.-config-key-.multipart.max-chunk-size[quarkus.rest-client."config-key".multipart.max-chunk-size]`
548565

549566

@@ -1072,6 +1089,23 @@ endif::add-copy-button-to-env-var[]
10721089
|
10731090

10741091

1092+
a| [[quarkus-restclient-config_quarkus.rest-client.-config-key-.capture-stacktrace]]`link:#quarkus-restclient-config_quarkus.rest-client.-config-key-.capture-stacktrace[quarkus.rest-client."config-key".capture-stacktrace]`
1093+
1094+
1095+
[.description]
1096+
--
1097+
If `true`, the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception
1098+
1099+
ifdef::add-copy-button-to-env-var[]
1100+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CONFIG_KEY__CAPTURE_STACKTRACE+++[]
1101+
endif::add-copy-button-to-env-var[]
1102+
ifndef::add-copy-button-to-env-var[]
1103+
Environment variable: `+++QUARKUS_REST_CLIENT__CONFIG_KEY__CAPTURE_STACKTRACE+++`
1104+
endif::add-copy-button-to-env-var[]
1105+
--|boolean
1106+
|
1107+
1108+
10751109
a| [[quarkus-restclient-config_quarkus.rest-client.headers-headers]]`link:#quarkus-restclient-config_quarkus.rest-client.headers-headers[quarkus.rest-client.headers]`
10761110

10771111

_versions/main/guides/deploying-to-kubernetes.adoc

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -960,7 +960,25 @@ quarkus.kubernetes.rbac.cluster-role-bindings.my-cluster-role-binding.role-name=
960960
<1> In this example, the cluster role "my-cluster-role" will be generated with the specified policy rules.
961961
<2> The name of the ClusterRole resource to use. Role resources are namespace-based and hence not allowed in ClusterRoleBinding resources.
962962

963-
=== Deploying to Minikube
963+
=== Deploying to local Kubernetes
964+
965+
When deploying to local Kubernetes environments, users often perform minor changes to their manifests that simplify the development process.
966+
The most common changes are:
967+
968+
- Setting `imagePullPolicy` to `IfNotPresent`
969+
- Using `NodePort` as `Service` type
970+
971+
Quarkus provides extensions that among others set these options by default.
972+
Such extensions are:
973+
974+
- quarkus-minikube
975+
- quarkus-kind
976+
977+
If the list of extensions does not match the tool you are using (e.g. Docker Desktop, microk8s etc) then it is suggested to use the `quarkus-minikube` extension.
978+
as its defaults should be reasonable for most environments.
979+
980+
981+
==== Deploying to Minikube
964982

965983
https://github.com/kubernetes/minikube[Minikube] is quite popular when a Kubernetes cluster is needed for development purposes. To make the deployment to Minikube
966984
experience as frictionless as possible, Quarkus provides the `quarkus-minikube` extension. This extension can be added to a project like so:
@@ -1008,7 +1026,7 @@ only. When deploying to production, consider using the vanilla Kubernetes manife
10081026
NOTE: If the assumptions the Minikube extension makes don't fit your workflow, nothing prevents you from using the regular Kubernetes extension to generate Kubernetes manifests
10091027
and apply those to your Minikube cluster.
10101028

1011-
=== Deploying to Kind
1029+
==== Deploying to Kind
10121030
https://kind.sigs.k8s.io/[Kind] is another popular tool used as a Kubernetes cluster for development purposes. To make the deployment to Kind
10131031
experience as frictionless as possible, Quarkus provides the `quarkus-kind` extension. This extension can be added to a project like so:
10141032

0 commit comments

Comments
 (0)