Skip to content

Commit 66bd23d

Browse files
committed
Sync documentation of main branch
1 parent 7319ceb commit 66bd23d

File tree

5 files changed

+423
-234
lines changed

5 files changed

+423
-234
lines changed

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

Lines changed: 141 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -2558,6 +2558,48 @@ endif::add-copy-button-to-env-var[]
25582558
|string
25592559
|
25602560

2561+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-lifecycle-image]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-lifecycle-image[`quarkus.buildpack.lifecycle-image`]##
2562+
ifdef::add-copy-button-to-config-props[]
2563+
config_property_copy_button:+++quarkus.buildpack.lifecycle-image+++[]
2564+
endif::add-copy-button-to-config-props[]
2565+
2566+
2567+
[.description]
2568+
--
2569+
The lifecycle image to use when building the project This is optional, but can be used to override the lifecycle present within a builder image.
2570+
2571+
2572+
ifdef::add-copy-button-to-env-var[]
2573+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_LIFECYCLE_IMAGE+++[]
2574+
endif::add-copy-button-to-env-var[]
2575+
ifndef::add-copy-button-to-env-var[]
2576+
Environment variable: `+++QUARKUS_BUILDPACK_LIFECYCLE_IMAGE+++`
2577+
endif::add-copy-button-to-env-var[]
2578+
--
2579+
|string
2580+
|
2581+
2582+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-platform-level]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-platform-level[`quarkus.buildpack.platform-level`]##
2583+
ifdef::add-copy-button-to-config-props[]
2584+
config_property_copy_button:+++quarkus.buildpack.platform-level+++[]
2585+
endif::add-copy-button-to-config-props[]
2586+
2587+
2588+
[.description]
2589+
--
2590+
The platform level to force for the build. Normally the platform level is determined from the intersection of the builder image supported levels, and the platform implementation supported levels. Sometimes it can be beneficial to force the platform to a particular version to force behavior during the build.
2591+
2592+
2593+
ifdef::add-copy-button-to-env-var[]
2594+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_PLATFORM_LEVEL+++[]
2595+
endif::add-copy-button-to-env-var[]
2596+
ifndef::add-copy-button-to-env-var[]
2597+
Environment variable: `+++QUARKUS_BUILDPACK_PLATFORM_LEVEL+++`
2598+
endif::add-copy-button-to-env-var[]
2599+
--
2600+
|string
2601+
|
2602+
25612603
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-trust-builder-image]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-trust-builder-image[`quarkus.buildpack.trust-builder-image`]##
25622604
ifdef::add-copy-button-to-config-props[]
25632605
config_property_copy_button:+++quarkus.buildpack.trust-builder-image+++[]
@@ -2566,7 +2608,7 @@ endif::add-copy-button-to-config-props[]
25662608

25672609
[.description]
25682610
--
2569-
Should the builder image be 'trusted' (use creator lifecycle)
2611+
Should the builder image be 'trusted' ? Trusted builders are allowed to attempt to use the `creator` lifecycle, which runs all the build phases within a single container. This is only possible for builders that do not use extensions. Running all phases in one container exposes some phases to information they may not see normally with a container-per-phase.
25702612

25712613

25722614
ifdef::add-copy-button-to-env-var[]
@@ -2600,6 +2642,69 @@ endif::add-copy-button-to-env-var[]
26002642
|Map<String,String>
26012643
|
26022644

2645+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-registry-user-registry-host]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-registry-user-registry-host[`quarkus.buildpack.registry-user."registry-host"`]##
2646+
ifdef::add-copy-button-to-config-props[]
2647+
config_property_copy_button:+++quarkus.buildpack.registry-user."registry-host"+++[]
2648+
endif::add-copy-button-to-config-props[]
2649+
2650+
2651+
[.description]
2652+
--
2653+
Usernames to use with registry hosts
2654+
2655+
2656+
ifdef::add-copy-button-to-env-var[]
2657+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_REGISTRY_USER__REGISTRY_HOST_+++[]
2658+
endif::add-copy-button-to-env-var[]
2659+
ifndef::add-copy-button-to-env-var[]
2660+
Environment variable: `+++QUARKUS_BUILDPACK_REGISTRY_USER__REGISTRY_HOST_+++`
2661+
endif::add-copy-button-to-env-var[]
2662+
--
2663+
|Map<String,String>
2664+
|
2665+
2666+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-registry-password-registry-host]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-registry-password-registry-host[`quarkus.buildpack.registry-password."registry-host"`]##
2667+
ifdef::add-copy-button-to-config-props[]
2668+
config_property_copy_button:+++quarkus.buildpack.registry-password."registry-host"+++[]
2669+
endif::add-copy-button-to-config-props[]
2670+
2671+
2672+
[.description]
2673+
--
2674+
Passwords to use with registry hosts
2675+
2676+
2677+
ifdef::add-copy-button-to-env-var[]
2678+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_REGISTRY_PASSWORD__REGISTRY_HOST_+++[]
2679+
endif::add-copy-button-to-env-var[]
2680+
ifndef::add-copy-button-to-env-var[]
2681+
Environment variable: `+++QUARKUS_BUILDPACK_REGISTRY_PASSWORD__REGISTRY_HOST_+++`
2682+
endif::add-copy-button-to-env-var[]
2683+
--
2684+
|Map<String,String>
2685+
|
2686+
2687+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-registry-token-registry-host]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-registry-token-registry-host[`quarkus.buildpack.registry-token."registry-host"`]##
2688+
ifdef::add-copy-button-to-config-props[]
2689+
config_property_copy_button:+++quarkus.buildpack.registry-token."registry-host"+++[]
2690+
endif::add-copy-button-to-config-props[]
2691+
2692+
2693+
[.description]
2694+
--
2695+
Tokens to use with registry hosts
2696+
2697+
2698+
ifdef::add-copy-button-to-env-var[]
2699+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_REGISTRY_TOKEN__REGISTRY_HOST_+++[]
2700+
endif::add-copy-button-to-env-var[]
2701+
ifndef::add-copy-button-to-env-var[]
2702+
Environment variable: `+++QUARKUS_BUILDPACK_REGISTRY_TOKEN__REGISTRY_HOST_+++`
2703+
endif::add-copy-button-to-env-var[]
2704+
--
2705+
|Map<String,String>
2706+
|
2707+
26032708
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-run-image]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-run-image[`quarkus.buildpack.run-image`]##
26042709
ifdef::add-copy-button-to-config-props[]
26052710
config_property_copy_button:+++quarkus.buildpack.run-image+++[]
@@ -2608,7 +2713,7 @@ endif::add-copy-button-to-config-props[]
26082713

26092714
[.description]
26102715
--
2611-
The buildpacks run image to use when building the project When not supplied, the run image is determined by the builder image.
2716+
The buildpacks run image to use when building the project When not supplied, the run image is determined by the builder image. If extensions are used by the builder image, they may override the run image.
26122717

26132718

26142719
ifdef::add-copy-button-to-env-var[]
@@ -2692,7 +2797,7 @@ endif::add-copy-button-to-config-props[]
26922797

26932798
[.description]
26942799
--
2695-
DOCKER_HOST value to use. If not set, the env var DOCKER_HOST is used, if that is not set the platform will look for 'npipe:///./pipe/docker_engine' for windows, and `unix:///var/run/docker.sock' then `unix:///var/run/podman.sock` then `unix:///var/run/user//podman/podman.sock` for linux
2800+
DOCKER_HOST value to use. This value is normally auto-determined, and is available for override if needed. If not set, the env var DOCKER_HOST is used, if that is not set the platform will test if `podman` is available on the path, if so, it will use podman to configure the appropriate values. If `podman` is not on the path, docker is assumed, and per-platform defaults for docker are used.
26962801

26972802

26982803
ifdef::add-copy-button-to-env-var[]
@@ -2705,6 +2810,27 @@ endif::add-copy-button-to-env-var[]
27052810
|string
27062811
|
27072812

2813+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-docker-socket]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-docker-socket[`quarkus.buildpack.docker-socket`]##
2814+
ifdef::add-copy-button-to-config-props[]
2815+
config_property_copy_button:+++quarkus.buildpack.docker-socket+++[]
2816+
endif::add-copy-button-to-config-props[]
2817+
2818+
2819+
[.description]
2820+
--
2821+
Path to the Docker socket to use. This value is normally auto-determined, and is available for override if needed. The path to the socket can vary, especially when the docker/podman daemon is running inside a VM, if useDaemon mode is true, then this path must refer to the path that can be used to mount the socket inside a container, so may refer to the path to the socket in the VM rather than the host.
2822+
2823+
2824+
ifdef::add-copy-button-to-env-var[]
2825+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_DOCKER_SOCKET+++[]
2826+
endif::add-copy-button-to-env-var[]
2827+
ifndef::add-copy-button-to-env-var[]
2828+
Environment variable: `+++QUARKUS_BUILDPACK_DOCKER_SOCKET+++`
2829+
endif::add-copy-button-to-env-var[]
2830+
--
2831+
|string
2832+
|
2833+
27082834
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-use-daemon]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-use-daemon[`quarkus.buildpack.use-daemon`]##
27092835
ifdef::add-copy-button-to-config-props[]
27102836
config_property_copy_button:+++quarkus.buildpack.use-daemon+++[]
@@ -2713,7 +2839,7 @@ endif::add-copy-button-to-config-props[]
27132839

27142840
[.description]
27152841
--
2716-
use Daemon mode? Defaults to 'true'
2842+
use Daemon mode? Should the buildpack build have the docker socket mounted into the build container(s). If this is false, then the image will be built directly as layers in a remote registry, this will probably require registry credentials to be passed. Defaults to 'true'
27172843

27182844

27192845
ifdef::add-copy-button-to-env-var[]
@@ -2734,7 +2860,7 @@ endif::add-copy-button-to-config-props[]
27342860

27352861
[.description]
27362862
--
2737-
Use specified docker network during build
2863+
Use specified docker network during build This can be handy when building against a locally hosted docker registry, where you will require the build containers to be part of the 'host' network to enable them to access the local registry.
27382864

27392865

27402866
ifdef::add-copy-button-to-env-var[]
@@ -2755,7 +2881,7 @@ endif::add-copy-button-to-config-props[]
27552881

27562882
[.description]
27572883
--
2758-
Log level to use. Defaults to 'info'
2884+
Log level to use. The log level to use when executing the build phases in containers. Defaults to 'info', supported values are 'info', 'warn' and 'debug'
27592885

27602886

27612887
ifdef::add-copy-button-to-env-var[]
@@ -2768,47 +2894,26 @@ endif::add-copy-button-to-env-var[]
27682894
|string
27692895
|`info`
27702896

2771-
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-base-registry-username]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-base-registry-username[`quarkus.buildpack.base-registry-username`]##
2897+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-get-use-timestamps]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-get-use-timestamps[`quarkus.buildpack.get-use-timestamps`]##
27722898
ifdef::add-copy-button-to-config-props[]
2773-
config_property_copy_button:+++quarkus.buildpack.base-registry-username+++[]
2899+
config_property_copy_button:+++quarkus.buildpack.get-use-timestamps+++[]
27742900
endif::add-copy-button-to-config-props[]
27752901

27762902

27772903
[.description]
27782904
--
2779-
The username to use to authenticate with the registry used to pull the base JVM image
2905+
Should the container log information include timestamps?
27802906

27812907

27822908
ifdef::add-copy-button-to-env-var[]
2783-
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_BASE_REGISTRY_USERNAME+++[]
2909+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_GET_USE_TIMESTAMPS+++[]
27842910
endif::add-copy-button-to-env-var[]
27852911
ifndef::add-copy-button-to-env-var[]
2786-
Environment variable: `+++QUARKUS_BUILDPACK_BASE_REGISTRY_USERNAME+++`
2912+
Environment variable: `+++QUARKUS_BUILDPACK_GET_USE_TIMESTAMPS+++`
27872913
endif::add-copy-button-to-env-var[]
27882914
--
2789-
|string
2790-
|
2791-
2792-
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-base-registry-password]] [.property-path]##link:#quarkus-container-image-buildpack_quarkus-buildpack-base-registry-password[`quarkus.buildpack.base-registry-password`]##
2793-
ifdef::add-copy-button-to-config-props[]
2794-
config_property_copy_button:+++quarkus.buildpack.base-registry-password+++[]
2795-
endif::add-copy-button-to-config-props[]
2796-
2797-
2798-
[.description]
2799-
--
2800-
The password to use to authenticate with the registry used to pull the base JVM image
2801-
2802-
2803-
ifdef::add-copy-button-to-env-var[]
2804-
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_BASE_REGISTRY_PASSWORD+++[]
2805-
endif::add-copy-button-to-env-var[]
2806-
ifndef::add-copy-button-to-env-var[]
2807-
Environment variable: `+++QUARKUS_BUILDPACK_BASE_REGISTRY_PASSWORD+++`
2808-
endif::add-copy-button-to-env-var[]
2809-
--
2810-
|string
2811-
|
2915+
|boolean
2916+
|`true`
28122917

28132918

28142919
h|[.extension-name]##Container Image - Docker##
@@ -65079,30 +65184,9 @@ ifndef::add-copy-button-to-env-var[]
6507965184
Environment variable: `+++QUARKUS_MONGODB_REACTIVE_TRANSPORT+++`
6508065185
endif::add-copy-button-to-env-var[]
6508165186
--
65082-
a|tooltip:netty[Uses a Netty-based transport re-using the existing Netty event loops.], tooltip:mongo[With a reactive driver it uses an async transport backed by a driver-managed thread pool, while with a blocking driver it uses a blocking transport.]
65187+
a|tooltip:netty[Uses a Netty-based transport re-using the existing Netty event loops.], tooltip:mongo[With a reactive driver it uses an async transport backed by a driver-managed thread pool.]
6508365188
|tooltip:netty[Uses a Netty-based transport re-using the existing Netty event loops.]
6508465189

65085-
a| [[quarkus-mongodb-client_quarkus-mongodb-blocking-transport]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-blocking-transport[`quarkus.mongodb.blocking-transport`]##
65086-
ifdef::add-copy-button-to-config-props[]
65087-
config_property_copy_button:+++quarkus.mongodb.blocking-transport+++[]
65088-
endif::add-copy-button-to-config-props[]
65089-
65090-
65091-
[.description]
65092-
--
65093-
Configures the blocking transport.
65094-
65095-
65096-
ifdef::add-copy-button-to-env-var[]
65097-
Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_BLOCKING_TRANSPORT+++[]
65098-
endif::add-copy-button-to-env-var[]
65099-
ifndef::add-copy-button-to-env-var[]
65100-
Environment variable: `+++QUARKUS_MONGODB_BLOCKING_TRANSPORT+++`
65101-
endif::add-copy-button-to-env-var[]
65102-
--
65103-
a|tooltip:netty[Uses a Netty-based transport re-using the existing Netty event loops.], tooltip:mongo[With a reactive driver it uses an async transport backed by a driver-managed thread pool, while with a blocking driver it uses a blocking transport.]
65104-
|tooltip:mongo[With a reactive driver it uses an async transport backed by a driver-managed thread pool, while with a blocking driver it uses a blocking transport.]
65105-
6510665190
a| [[quarkus-mongodb-client_quarkus-mongodb-dns-server-host]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-dns-server-host[`quarkus.mongodb.dns.server-host`]##
6510765191
ifdef::add-copy-button-to-config-props[]
6510865192
config_property_copy_button:+++quarkus.mongodb.dns.server-host+++[]
@@ -65697,30 +65781,9 @@ ifndef::add-copy-button-to-env-var[]
6569765781
Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__REACTIVE_TRANSPORT+++`
6569865782
endif::add-copy-button-to-env-var[]
6569965783
--
65700-
a|tooltip:netty[Uses a Netty-based transport re-using the existing Netty event loops.], tooltip:mongo[With a reactive driver it uses an async transport backed by a driver-managed thread pool, while with a blocking driver it uses a blocking transport.]
65784+
a|tooltip:netty[Uses a Netty-based transport re-using the existing Netty event loops.], tooltip:mongo[With a reactive driver it uses an async transport backed by a driver-managed thread pool.]
6570165785
|tooltip:netty[Uses a Netty-based transport re-using the existing Netty event loops.]
6570265786

65703-
a| [[quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-blocking-transport]] [.property-path]##link:#quarkus-mongodb-client_quarkus-mongodb-mongo-client-configs-blocking-transport[`quarkus.mongodb."mongo-client-configs".blocking-transport`]##
65704-
ifdef::add-copy-button-to-config-props[]
65705-
config_property_copy_button:+++quarkus.mongodb."mongo-client-configs".blocking-transport+++[]
65706-
endif::add-copy-button-to-config-props[]
65707-
65708-
65709-
[.description]
65710-
--
65711-
Configures the blocking transport.
65712-
65713-
65714-
ifdef::add-copy-button-to-env-var[]
65715-
Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__BLOCKING_TRANSPORT+++[]
65716-
endif::add-copy-button-to-env-var[]
65717-
ifndef::add-copy-button-to-env-var[]
65718-
Environment variable: `+++QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__BLOCKING_TRANSPORT+++`
65719-
endif::add-copy-button-to-env-var[]
65720-
--
65721-
a|tooltip:netty[Uses a Netty-based transport re-using the existing Netty event loops.], tooltip:mongo[With a reactive driver it uses an async transport backed by a driver-managed thread pool, while with a blocking driver it uses a blocking transport.]
65722-
|tooltip:mongo[With a reactive driver it uses an async transport backed by a driver-managed thread pool, while with a blocking driver it uses a blocking transport.]
65723-
6572465787
h|[[quarkus-mongodb-client_section_quarkus-mongodb-devservices]] [.section-name.section-level0]##link:#quarkus-mongodb-client_section_quarkus-mongodb-devservices[Dev Services]##
6572565788
h|Type
6572665789
h|Default

0 commit comments

Comments
 (0)