Skip to content

Commit 617b269

Browse files
committed
Sync documentation of main branch
1 parent 134cb37 commit 617b269

20 files changed

+285
-68
lines changed

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

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3043,7 +3043,7 @@ endif::add-copy-button-to-config-props[]
30433043

30443044
[.description]
30453045
--
3046-
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi8/openjdk-21-runtime:1.20` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17-runtime:1.20` is used as the default.
3046+
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi9/openjdk-21-runtime:1.21` is used as the default. Otherwise `registry.access.redhat.com/ubi9/openjdk-17-runtime:1.21` is used as the default.
30473047

30483048

30493049
ifdef::add-copy-button-to-env-var[]
@@ -3064,7 +3064,7 @@ endif::add-copy-button-to-config-props[]
30643064

30653065
[.description]
30663066
--
3067-
The base image to be used when a container image is being produced for the native binary build. The default is "quay.io/quarkus/quarkus-micro-image". You can also use "registry.access.redhat.com/ubi8/ubi-minimal" which is a bigger base image, but provide more built-in utilities such as the microdnf package manager.
3067+
The base image to be used when a container image is being produced for the native binary build. The default is "quay.io/quarkus/ubi9-quarkus-micro-image:2.0". You can also use "registry.access.redhat.com/ubi9/ubi-minimal" which is a bigger base image, but provide more built-in utilities such as the microdnf package manager.
30683068

30693069

30703070
ifdef::add-copy-button-to-env-var[]
@@ -3598,7 +3598,7 @@ endif::add-copy-button-to-config-props[]
35983598

35993599
[.description]
36003600
--
3601-
The base image to be used when a container image is being produced for the jar build. The value of this property is used to create an ImageStream for the builder image used in the Openshift build. When it references images already available in the internal Openshift registry, the corresponding streams are used instead. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi8/openjdk-21:1.20` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17:1.20` is used as the default.
3601+
The base image to be used when a container image is being produced for the jar build. The value of this property is used to create an ImageStream for the builder image used in the Openshift build. When it references images already available in the internal Openshift registry, the corresponding streams are used instead. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi9/openjdk-21:1.21` is used as the default. Otherwise `registry.access.redhat.com/ubi9/openjdk-17:1.21` is used as the default.
36023602

36033603

36043604
ifdef::add-copy-button-to-env-var[]
@@ -8179,7 +8179,9 @@ endif::add-copy-button-to-config-props[]
81798179

81808180
[.description]
81818181
--
8182-
Defines the file encoding as in `-Dfile.encoding=...`. Native image runtime uses the host's (i.e. build time) value of `file.encoding` system property. We intentionally default this to UTF-8 to avoid platform specific defaults to be picked up which can then result in inconsistent behavior in the generated native executable.
8182+
Defines the file encoding as in `-Dfile.encoding=...`.
8183+
8184+
Native image runtime uses the host's (i.e. build time) value of `file.encoding` system property. We intentionally default this to UTF-8 to avoid platform specific defaults to be picked up which can then result in inconsistent behavior in the generated native executable.
81838185

81848186

81858187
ifdef::add-copy-button-to-env-var[]
@@ -8498,7 +8500,16 @@ endif::add-copy-button-to-config-props[]
84988500

84998501
[.description]
85008502
--
8501-
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:jdk-21`.
8503+
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/ubi9-quarkus-mandrel-builder-image:jdk-21`.
8504+
8505+
*Note:* Builder images are available using UBI 8 and UBI 9 base images, for example:
8506+
8507+
- UBI 8: `quay.io/quarkus/ubi-quarkus-mandrel-builder-image:jdk-21` (UBI 8)
8508+
- UBI 9: `quay.io/quarkus/ubi9-quarkus-mandrel-builder-image:jdk-21` (UBI 9)
8509+
8510+
8511+
8512+
You need to be aware that if you use a builder image using UBI9 and you plan to build a container, you must ensure that the base image used in the container is also UBI9.
85028513

85038514

85048515
ifdef::add-copy-button-to-env-var[]
@@ -8659,7 +8670,9 @@ endif::add-copy-button-to-config-props[]
86598670

86608671
[.description]
86618672
--
8662-
If errors should be reported at runtime. This is a more relaxed setting, however it is not recommended as it means your application may fail at runtime if an unsupported feature is used by accident. Note that the use of this flag may result in build time failures due to `ClassNotFoundException`s. Reason most likely being that the Quarkus extension already optimized it away or do not actually need it. In such cases you should explicitly add the corresponding dependency providing the missing classes as a dependency to your project.
8673+
If errors should be reported at runtime. This is a more relaxed setting, however it is not recommended as it means your application may fail at runtime if an unsupported feature is used by accident.
8674+
8675+
Note that the use of this flag may result in build time failures due to `ClassNotFoundException`s. Reason most likely being that the Quarkus extension already optimized it away or do not actually need it. In such cases you should explicitly add the corresponding dependency providing the missing classes as a dependency to your project.
86638676

86648677

86658678
ifdef::add-copy-button-to-env-var[]
@@ -8680,7 +8693,11 @@ endif::add-copy-button-to-config-props[]
86808693

86818694
[.description]
86828695
--
8683-
Don't build a native image if it already exists. This is useful if you have already built an image and you want to use Quarkus to deploy it somewhere. Note that this is not able to detect if the existing image is outdated, if you have modified source or config and want a new image you must not use this flag.
8696+
Don't build a native image if it already exists.
8697+
8698+
This is useful if you have already built an image and you want to use Quarkus to deploy it somewhere.
8699+
8700+
Note that this is not able to detect if the existing image is outdated, if you have modified source or config and want a new image you must not use this flag.
86848701

86858702

86868703
ifdef::add-copy-button-to-env-var[]
@@ -8713,6 +8730,8 @@ Example: Given that you have `src/main/resources/ignored.png` and `src/main/reso
87138730
quarkus.native.resources.includes = foo/**,bar/**/*.txt
87148731
```
87158732

8733+
8734+
87168735
the files `src/main/resources/foo/selected.png` and `bar/some.txt` will be included in the native image, while `src/main/resources/ignored.png` will not be included.
87178736

87188737
Supported glob features
@@ -8793,6 +8812,8 @@ quarkus.native.resources.includes = **/*.png
87938812
quarkus.native.resources.excludes = foo/**,**/green.png
87948813
```
87958814

8815+
8816+
87968817
the resource `red.png` will be available in the native image while the resources `foo/green.png` and `bar/blue.png` will not be available in the native image.
87978818

87988819

@@ -8900,7 +8921,9 @@ endif::add-copy-button-to-config-props[]
89008921

89018922
[.description]
89028923
--
8903-
Allows passing extra arguments to the UPX command line (like --brute). The arguments are comma-separated. The exhaustive list of parameters can be found in link:https://github.com/upx/upx/blob/devel/doc/upx.pod[https://github.com/upx/upx/blob/devel/doc/upx.pod].
8924+
Allows passing extra arguments to the UPX command line (like --brute). The arguments are comma-separated.
8925+
8926+
The exhaustive list of parameters can be found in link:https://github.com/upx/upx/blob/devel/doc/upx.pod[https://github.com/upx/upx/blob/devel/doc/upx.pod].
89048927

89058928

89068929
ifdef::add-copy-button-to-env-var[]
@@ -87040,9 +87063,9 @@ endif::add-copy-button-to-env-var[]
8704087063
|Map<String,String>
8704187064
|
8704287065

87043-
a| [[quarkus-smallrye-health_quarkus-smallrye-health-check-check-name-enabled]] [.property-path]##link:#quarkus-smallrye-health_quarkus-smallrye-health-check-check-name-enabled[`quarkus.smallrye-health.check."check-name".enabled`]##
87066+
a| [[quarkus-smallrye-health_quarkus-smallrye-health-check-check-classname-enabled]] [.property-path]##link:#quarkus-smallrye-health_quarkus-smallrye-health-check-check-classname-enabled[`quarkus.smallrye-health.check."check-classname".enabled`]##
8704487067
ifdef::add-copy-button-to-config-props[]
87045-
config_property_copy_button:+++quarkus.smallrye-health.check."check-name".enabled+++[]
87068+
config_property_copy_button:+++quarkus.smallrye-health.check."check-classname".enabled+++[]
8704687069
endif::add-copy-button-to-config-props[]
8704787070

8704887071

@@ -87052,10 +87075,10 @@ Whether the HealthCheck should be enabled.
8705287075

8705387076

8705487077
ifdef::add-copy-button-to-env-var[]
87055-
Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_HEALTH_CHECK__CHECK_NAME__ENABLED+++[]
87078+
Environment variable: env_var_with_copy_button:+++QUARKUS_SMALLRYE_HEALTH_CHECK__CHECK_CLASSNAME__ENABLED+++[]
8705687079
endif::add-copy-button-to-env-var[]
8705787080
ifndef::add-copy-button-to-env-var[]
87058-
Environment variable: `+++QUARKUS_SMALLRYE_HEALTH_CHECK__CHECK_NAME__ENABLED+++`
87081+
Environment variable: `+++QUARKUS_SMALLRYE_HEALTH_CHECK__CHECK_CLASSNAME__ENABLED+++`
8705987082
endif::add-copy-button-to-env-var[]
8706087083
--
8706187084
|boolean

_generated-doc/main/config/quarkus-container-image-jib.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ endif::add-copy-button-to-config-props[]
1515

1616
[.description]
1717
--
18-
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi8/openjdk-21-runtime:1.20` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17-runtime:1.20` is used as the default.
18+
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi9/openjdk-21-runtime:1.21` is used as the default. Otherwise `registry.access.redhat.com/ubi9/openjdk-17-runtime:1.21` is used as the default.
1919

2020

2121
ifdef::add-copy-button-to-env-var[]
@@ -36,7 +36,7 @@ endif::add-copy-button-to-config-props[]
3636

3737
[.description]
3838
--
39-
The base image to be used when a container image is being produced for the native binary build. The default is "quay.io/quarkus/quarkus-micro-image". You can also use "registry.access.redhat.com/ubi8/ubi-minimal" which is a bigger base image, but provide more built-in utilities such as the microdnf package manager.
39+
The base image to be used when a container image is being produced for the native binary build. The default is "quay.io/quarkus/ubi9-quarkus-micro-image:2.0". You can also use "registry.access.redhat.com/ubi9/ubi-minimal" which is a bigger base image, but provide more built-in utilities such as the microdnf package manager.
4040

4141

4242
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-container-image-jib_quarkus.jib.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ endif::add-copy-button-to-config-props[]
1515

1616
[.description]
1717
--
18-
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi8/openjdk-21-runtime:1.20` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17-runtime:1.20` is used as the default.
18+
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi9/openjdk-21-runtime:1.21` is used as the default. Otherwise `registry.access.redhat.com/ubi9/openjdk-17-runtime:1.21` is used as the default.
1919

2020

2121
ifdef::add-copy-button-to-env-var[]
@@ -36,7 +36,7 @@ endif::add-copy-button-to-config-props[]
3636

3737
[.description]
3838
--
39-
The base image to be used when a container image is being produced for the native binary build. The default is "quay.io/quarkus/quarkus-micro-image". You can also use "registry.access.redhat.com/ubi8/ubi-minimal" which is a bigger base image, but provide more built-in utilities such as the microdnf package manager.
39+
The base image to be used when a container image is being produced for the native binary build. The default is "quay.io/quarkus/ubi9-quarkus-micro-image:2.0". You can also use "registry.access.redhat.com/ubi9/ubi-minimal" which is a bigger base image, but provide more built-in utilities such as the microdnf package manager.
4040

4141

4242
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-container-image-openshift.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ endif::add-copy-button-to-config-props[]
3636

3737
[.description]
3838
--
39-
The base image to be used when a container image is being produced for the jar build. The value of this property is used to create an ImageStream for the builder image used in the Openshift build. When it references images already available in the internal Openshift registry, the corresponding streams are used instead. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi8/openjdk-21:1.20` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17:1.20` is used as the default.
39+
The base image to be used when a container image is being produced for the jar build. The value of this property is used to create an ImageStream for the builder image used in the Openshift build. When it references images already available in the internal Openshift registry, the corresponding streams are used instead. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi9/openjdk-21:1.21` is used as the default. Otherwise `registry.access.redhat.com/ubi9/openjdk-17:1.21` is used as the default.
4040

4141

4242
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-container-image-openshift_quarkus.openshift.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ endif::add-copy-button-to-config-props[]
3636

3737
[.description]
3838
--
39-
The base image to be used when a container image is being produced for the jar build. The value of this property is used to create an ImageStream for the builder image used in the Openshift build. When it references images already available in the internal Openshift registry, the corresponding streams are used instead. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi8/openjdk-21:1.20` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17:1.20` is used as the default.
39+
The base image to be used when a container image is being produced for the jar build. The value of this property is used to create an ImageStream for the builder image used in the Openshift build. When it references images already available in the internal Openshift registry, the corresponding streams are used instead. When the application is built against Java 21 or higher, `registry.access.redhat.com/ubi9/openjdk-21:1.21` is used as the default. Otherwise `registry.access.redhat.com/ubi9/openjdk-17:1.21` is used as the default.
4040

4141

4242
ifdef::add-copy-button-to-env-var[]

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

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,9 @@ endif::add-copy-button-to-config-props[]
141141

142142
[.description]
143143
--
144-
Defines the file encoding as in `-Dfile.encoding=...`. Native image runtime uses the host's (i.e. build time) value of `file.encoding` system property. We intentionally default this to UTF-8 to avoid platform specific defaults to be picked up which can then result in inconsistent behavior in the generated native executable.
144+
Defines the file encoding as in `-Dfile.encoding=...`.
145+
146+
Native image runtime uses the host's (i.e. build time) value of `file.encoding` system property. We intentionally default this to UTF-8 to avoid platform specific defaults to be picked up which can then result in inconsistent behavior in the generated native executable.
145147

146148

147149
ifdef::add-copy-button-to-env-var[]
@@ -460,7 +462,16 @@ endif::add-copy-button-to-config-props[]
460462

461463
[.description]
462464
--
463-
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:jdk-21`.
465+
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/ubi9-quarkus-mandrel-builder-image:jdk-21`.
466+
467+
*Note:* Builder images are available using UBI 8 and UBI 9 base images, for example:
468+
469+
- UBI 8: `quay.io/quarkus/ubi-quarkus-mandrel-builder-image:jdk-21` (UBI 8)
470+
- UBI 9: `quay.io/quarkus/ubi9-quarkus-mandrel-builder-image:jdk-21` (UBI 9)
471+
472+
473+
474+
You need to be aware that if you use a builder image using UBI9 and you plan to build a container, you must ensure that the base image used in the container is also UBI9.
464475

465476

466477
ifdef::add-copy-button-to-env-var[]
@@ -621,7 +632,9 @@ endif::add-copy-button-to-config-props[]
621632

622633
[.description]
623634
--
624-
If errors should be reported at runtime. This is a more relaxed setting, however it is not recommended as it means your application may fail at runtime if an unsupported feature is used by accident. Note that the use of this flag may result in build time failures due to `ClassNotFoundException`s. Reason most likely being that the Quarkus extension already optimized it away or do not actually need it. In such cases you should explicitly add the corresponding dependency providing the missing classes as a dependency to your project.
635+
If errors should be reported at runtime. This is a more relaxed setting, however it is not recommended as it means your application may fail at runtime if an unsupported feature is used by accident.
636+
637+
Note that the use of this flag may result in build time failures due to `ClassNotFoundException`s. Reason most likely being that the Quarkus extension already optimized it away or do not actually need it. In such cases you should explicitly add the corresponding dependency providing the missing classes as a dependency to your project.
625638

626639

627640
ifdef::add-copy-button-to-env-var[]
@@ -642,7 +655,11 @@ endif::add-copy-button-to-config-props[]
642655

643656
[.description]
644657
--
645-
Don't build a native image if it already exists. This is useful if you have already built an image and you want to use Quarkus to deploy it somewhere. Note that this is not able to detect if the existing image is outdated, if you have modified source or config and want a new image you must not use this flag.
658+
Don't build a native image if it already exists.
659+
660+
This is useful if you have already built an image and you want to use Quarkus to deploy it somewhere.
661+
662+
Note that this is not able to detect if the existing image is outdated, if you have modified source or config and want a new image you must not use this flag.
646663

647664

648665
ifdef::add-copy-button-to-env-var[]
@@ -675,6 +692,8 @@ Example: Given that you have `src/main/resources/ignored.png` and `src/main/reso
675692
quarkus.native.resources.includes = foo/**,bar/**/*.txt
676693
```
677694

695+
696+
678697
the files `src/main/resources/foo/selected.png` and `bar/some.txt` will be included in the native image, while `src/main/resources/ignored.png` will not be included.
679698

680699
Supported glob features
@@ -755,6 +774,8 @@ quarkus.native.resources.includes = **/*.png
755774
quarkus.native.resources.excludes = foo/**,**/green.png
756775
```
757776

777+
778+
758779
the resource `red.png` will be available in the native image while the resources `foo/green.png` and `bar/blue.png` will not be available in the native image.
759780

760781

@@ -862,7 +883,9 @@ endif::add-copy-button-to-config-props[]
862883

863884
[.description]
864885
--
865-
Allows passing extra arguments to the UPX command line (like --brute). The arguments are comma-separated. The exhaustive list of parameters can be found in link:https://github.com/upx/upx/blob/devel/doc/upx.pod[https://github.com/upx/upx/blob/devel/doc/upx.pod].
886+
Allows passing extra arguments to the UPX command line (like --brute). The arguments are comma-separated.
887+
888+
The exhaustive list of parameters can be found in link:https://github.com/upx/upx/blob/devel/doc/upx.pod[https://github.com/upx/upx/blob/devel/doc/upx.pod].
866889

867890

868891
ifdef::add-copy-button-to-env-var[]

0 commit comments

Comments
 (0)