Skip to content

Commit ac07bad

Browse files
committed
Sync documentation of main branch
1 parent d272b5f commit ac07bad

File tree

107 files changed

+8275
-141
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+8275
-141
lines changed

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

Lines changed: 3648 additions & 12 deletions
Large diffs are not rendered by default.

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

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -574,6 +574,29 @@ endif::add-copy-button-to-env-var[]
574574
|list of string
575575
|
576576

577+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-enable-vm-inspection]] [.property-path]##link:#quarkus-core_quarkus-native-enable-vm-inspection[[.line-through]#`quarkus.native.enable-vm-inspection`#]##
578+
ifdef::add-copy-button-to-config-props[]
579+
config_property_copy_button:+++quarkus.native.enable-vm-inspection+++[]
580+
endif::add-copy-button-to-config-props[]
581+
582+
583+
[.description]
584+
--
585+
_This property is deprecated: Use `quarkus.native.monitoring` instead._
586+
587+
If the resulting image should allow VM introspection.
588+
589+
590+
ifdef::add-copy-button-to-env-var[]
591+
Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_ENABLE_VM_INSPECTION+++[]
592+
endif::add-copy-button-to-env-var[]
593+
ifndef::add-copy-button-to-env-var[]
594+
Environment variable: `+++QUARKUS_NATIVE_ENABLE_VM_INSPECTION+++`
595+
endif::add-copy-button-to-env-var[]
596+
--
597+
|boolean
598+
|`+++false+++`
599+
577600
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-monitoring]] [.property-path]##link:#quarkus-core_quarkus-native-monitoring[`quarkus.native.monitoring`]##
578601
ifdef::add-copy-button-to-config-props[]
579602
config_property_copy_button:+++quarkus.native.monitoring+++[]
@@ -773,6 +796,46 @@ endif::add-copy-button-to-env-var[]
773796
|list of string
774797
|
775798

799+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-resources-excludes]] [.property-path]##link:#quarkus-core_quarkus-native-resources-excludes[[.line-through]#`quarkus.native.resources.excludes`#]##
800+
ifdef::add-copy-button-to-config-props[]
801+
config_property_copy_button:+++quarkus.native.resources.excludes+++[]
802+
endif::add-copy-button-to-config-props[]
803+
804+
805+
[.description]
806+
--
807+
_This property is deprecated since `3.29`: Excluding resources is not supported in the new reachability-metadata.json file used with Mandrel/GraalVM 25.0 and onwards. Quarkus plans to adopt the use of reachability-metadata.json for Mandrel/GraalVM 23.1 for JDK 21 as well (see https://github.com/quarkusio/quarkus/issues/41016)._
808+
809+
A comma separated list of globs to match resource paths that should *not* be added to the native image.
810+
811+
Use slash (`/`) as a path separator on all platforms. Globs must not start with slash.
812+
813+
Please refer to `includes` for details about the glob syntax.
814+
815+
By default, no resources are excluded.
816+
817+
Example: Given that you have `src/main/resources/red.png` and `src/main/resources/foo/green.png` in your source tree and one of your dependency JARs contains `bar/blue.png` file, with the following configuration
818+
819+
```
820+
quarkus.native.resources.includes = **/*.png
821+
quarkus.native.resources.excludes = foo/**,**/green.png
822+
```
823+
824+
825+
826+
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.
827+
828+
829+
ifdef::add-copy-button-to-env-var[]
830+
Environment variable: env_var_with_copy_button:+++QUARKUS_NATIVE_RESOURCES_EXCLUDES+++[]
831+
endif::add-copy-button-to-env-var[]
832+
ifndef::add-copy-button-to-env-var[]
833+
Environment variable: `+++QUARKUS_NATIVE_RESOURCES_EXCLUDES+++`
834+
endif::add-copy-button-to-env-var[]
835+
--
836+
|list of string
837+
|
838+
776839
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-native-debug-enabled]] [.property-path]##link:#quarkus-core_quarkus-native-debug-enabled[`quarkus.native.debug.enabled`]##
777840
ifdef::add-copy-button-to-config-props[]
778841
config_property_copy_button:+++quarkus.native.debug.enabled+++[]

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,31 @@ endif::add-copy-button-to-env-var[]
3030
|boolean
3131
|
3232

33+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-snapstart-enable]] [.property-path]##link:#quarkus-core_quarkus-snapstart-enable[[.line-through]#`quarkus.snapstart.enable`#]##
34+
ifdef::add-copy-button-to-config-props[]
35+
config_property_copy_button:+++quarkus.snapstart.enable+++[]
36+
endif::add-copy-button-to-config-props[]
37+
38+
39+
[.description]
40+
--
41+
_This property is deprecated since `3.26`: use `quarkus.snapstart.enabled` instead._
42+
43+
Enable/Disable SnapStart integration
44+
45+
Default value is dependent on extensions deployed (i.e. when using AWS Lambda extensions, this will be set to true by default)
46+
47+
48+
ifdef::add-copy-button-to-env-var[]
49+
Environment variable: env_var_with_copy_button:+++QUARKUS_SNAPSTART_ENABLE+++[]
50+
endif::add-copy-button-to-env-var[]
51+
ifndef::add-copy-button-to-env-var[]
52+
Environment variable: `+++QUARKUS_SNAPSTART_ENABLE+++`
53+
endif::add-copy-button-to-env-var[]
54+
--
55+
|boolean
56+
|
57+
3358
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus-snapstart-preload-classes]] [.property-path]##link:#quarkus-core_quarkus-snapstart-preload-classes[`quarkus.snapstart.preload-classes`]##
3459
ifdef::add-copy-button-to-config-props[]
3560
config_property_copy_button:+++quarkus.snapstart.preload-classes+++[]

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,15 @@ The container image name for container-based Dev Service providers.
345345

346346
This has no effect if the provider is not a container-based database, such as H2 or Derby.
347347

348+
Defaults depend on the configured `datasource`:
349+
350+
* DB2: `{db2-image}`
351+
* MariaDB: `{mariadb-image}`
352+
* Microsoft SQL Server: `{mssql-image}`
353+
* MySQL: `{mysql-image}`
354+
* Oracle Express Edition: `{oracle-image}`
355+
* PostgreSQL: `{postgres-image}`
356+
348357
349358
ifdef::add-copy-button-to-env-var[]
350359
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEVSERVICES_IMAGE_NAME+++[]

_generated-doc/main/config/quarkus-datasource_quarkus.datasource.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,15 @@ The container image name for container-based Dev Service providers.
345345

346346
This has no effect if the provider is not a container-based database, such as H2 or Derby.
347347

348+
Defaults depend on the configured `datasource`:
349+
350+
* DB2: `{db2-image}`
351+
* MariaDB: `{mariadb-image}`
352+
* Microsoft SQL Server: `{mssql-image}`
353+
* MySQL: `{mysql-image}`
354+
* Oracle Express Edition: `{oracle-image}`
355+
* PostgreSQL: `{postgres-image}`
356+
348357
349358
ifdef::add-copy-button-to-env-var[]
350359
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEVSERVICES_IMAGE_NAME+++[]

_generated-doc/main/config/quarkus-datasource_quarkus.datasource.devservices.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,15 @@ The container image name for container-based Dev Service providers.
5353

5454
This has no effect if the provider is not a container-based database, such as H2 or Derby.
5555

56+
Defaults depend on the configured `datasource`:
57+
58+
* DB2: `{db2-image}`
59+
* MariaDB: `{mariadb-image}`
60+
* Microsoft SQL Server: `{mssql-image}`
61+
* MySQL: `{mysql-image}`
62+
* Oracle Express Edition: `{oracle-image}`
63+
* PostgreSQL: `{postgres-image}`
64+
5665
5766
ifdef::add-copy-button-to-env-var[]
5867
Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_DEVSERVICES_IMAGE_NAME+++[]

_generated-doc/main/config/quarkus-devservices-keycloak.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++`
4747
endif::add-copy-button-to-env-var[]
4848
--
4949
|string
50-
|
50+
|`{keycloak-image}`
5151

5252
a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]##
5353
ifdef::add-copy-button-to-config-props[]

_generated-doc/main/config/quarkus-devservices-keycloak_quarkus.keycloak.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Environment variable: `+++QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME+++`
4747
endif::add-copy-button-to-env-var[]
4848
--
4949
|string
50-
|
50+
|`{keycloak-image}`
5151

5252
a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image]] [.property-path]##link:#quarkus-devservices-keycloak_quarkus-keycloak-devservices-keycloak-x-image[`quarkus.keycloak.devservices.keycloak-x-image`]##
5353
ifdef::add-copy-button-to-config-props[]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -370,8 +370,8 @@ The Elasticsearch container image to use.
370370

371371
Defaults depend on the configured `distribution`:
372372

373-
* For the `elastic` distribution: {elasticsearch-image}
374-
* For the `opensearch` distribution: {opensearch-image}
373+
* For the `elastic` distribution: `{elasticsearch-image}`
374+
* For the `opensearch` distribution: `{opensearch-image}`
375375
376376
377377
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-elasticsearch-rest-client_quarkus.elasticsearch.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -370,8 +370,8 @@ The Elasticsearch container image to use.
370370

371371
Defaults depend on the configured `distribution`:
372372

373-
* For the `elastic` distribution: {elasticsearch-image}
374-
* For the `opensearch` distribution: {opensearch-image}
373+
* For the `elastic` distribution: `{elasticsearch-image}`
374+
* For the `opensearch` distribution: `{opensearch-image}`
375375
376376
377377
ifdef::add-copy-button-to-env-var[]

0 commit comments

Comments
 (0)