Sync documentation of main branch

quarkusio · Nov 9, 2024 · 9d27cb1 · 9d27cb1
1 parent db90a71
commit 9d27cb1
Show file tree

Hide file tree

Showing 21 changed files with 3,030 additions and 19 deletions.
diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc
diff --git a/_generated-doc/main/config/quarkus-container-image-docker.adoc b/_generated-doc/main/config/quarkus-container-image-docker.adoc
@@ -11,6 +11,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_DOCKERFILE_JVM_PATH+++[]
@@ -26,6 +28,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_DOCKERFILE_NATIVE_PATH+++[]
@@ -41,6 +45,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+Build args passed to docker via `--build-arg`
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_BUILD_ARGS__ARG_NAME_+++[]
@@ -56,6 +62,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+Images to consider as cache sources. Values are passed to `docker build`/`podman build` via the `cache-from` option
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_CACHE_FROM+++[]
@@ -71,6 +79,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+The networking mode for the RUN instructions during build
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_NETWORK+++[]
@@ -86,6 +96,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+Name of binary used to execute the docker/podman commands. This setting can override the global container runtime detection.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_EXECUTABLE_NAME+++[]
@@ -101,6 +113,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+Additional arbitrary arguments passed to the executable when building the container image.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_ADDITIONAL_ARGS+++[]

diff --git a/_generated-doc/main/config/quarkus-container-image-docker_quarkus.docker.adoc b/_generated-doc/main/config/quarkus-container-image-docker_quarkus.docker.adoc
@@ -11,6 +11,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_DOCKERFILE_JVM_PATH+++[]
@@ -26,6 +28,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_DOCKERFILE_NATIVE_PATH+++[]
@@ -41,6 +45,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+Build args passed to docker via `--build-arg`
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_BUILD_ARGS__ARG_NAME_+++[]
@@ -56,6 +62,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+Images to consider as cache sources. Values are passed to `docker build`/`podman build` via the `cache-from` option
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_CACHE_FROM+++[]
@@ -71,6 +79,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+The networking mode for the RUN instructions during build
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_NETWORK+++[]
@@ -86,6 +96,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+Name of binary used to execute the docker/podman commands. This setting can override the global container runtime detection.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_EXECUTABLE_NAME+++[]
@@ -101,6 +113,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus-
 
 [.description]
 --
+Additional arbitrary arguments passed to the executable when building the container image.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_ADDITIONAL_ARGS+++[]

diff --git a/_generated-doc/main/config/quarkus-container-image-podman.adoc b/_generated-doc/main/config/quarkus-container-image-podman.adoc
@@ -11,6 +11,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_DOCKERFILE_JVM_PATH+++[]
@@ -26,6 +28,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_DOCKERFILE_NATIVE_PATH+++[]
@@ -41,6 +45,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+Build args passed to docker via `--build-arg`
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_BUILD_ARGS__ARG_NAME_+++[]
@@ -56,6 +62,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+Images to consider as cache sources. Values are passed to `docker build`/`podman build` via the `cache-from` option
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_CACHE_FROM+++[]
@@ -71,6 +79,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+The networking mode for the RUN instructions during build
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_NETWORK+++[]
@@ -86,6 +96,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+Name of binary used to execute the docker/podman commands. This setting can override the global container runtime detection.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_EXECUTABLE_NAME+++[]
@@ -101,6 +113,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+Additional arbitrary arguments passed to the executable when building the container image.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_ADDITIONAL_ARGS+++[]

diff --git a/_generated-doc/main/config/quarkus-container-image-podman_quarkus.podman.adoc b/_generated-doc/main/config/quarkus-container-image-podman_quarkus.podman.adoc
@@ -11,6 +11,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_DOCKERFILE_JVM_PATH+++[]
@@ -26,6 +28,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_DOCKERFILE_NATIVE_PATH+++[]
@@ -41,6 +45,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+Build args passed to docker via `--build-arg`
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_BUILD_ARGS__ARG_NAME_+++[]
@@ -56,6 +62,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+Images to consider as cache sources. Values are passed to `docker build`/`podman build` via the `cache-from` option
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_CACHE_FROM+++[]
@@ -71,6 +79,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+The networking mode for the RUN instructions during build
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_NETWORK+++[]
@@ -86,6 +96,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+Name of binary used to execute the docker/podman commands. This setting can override the global container runtime detection.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_EXECUTABLE_NAME+++[]
@@ -101,6 +113,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-podman_quarkus-
 
 [.description]
 --
+Additional arbitrary arguments passed to the executable when building the container image.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_PODMAN_ADDITIONAL_ARGS+++[]