Sync web site with Quarkus documentation

quarkusio · Nov 13, 2024 · 256159c · 256159c
1 parent 2aaddd5
commit 256159c
Show file tree

Hide file tree

Showing 15 changed files with 158 additions and 18 deletions.
diff --git a/_generated-doc/latest/config/quarkus-all-config.adoc b/_generated-doc/latest/config/quarkus-all-config.adoc
@@ -2179,6 +2179,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+++[]
@@ -2194,6 +2196,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+++[]
@@ -2209,6 +2213,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_+++[]
@@ -2224,6 +2230,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+++[]
@@ -2239,6 +2247,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+++[]
@@ -2254,6 +2264,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+++[]
@@ -2269,6 +2281,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+++[]
@@ -3192,6 +3206,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+++[]
@@ -3207,6 +3223,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+++[]
@@ -3222,6 +3240,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_+++[]
@@ -3237,6 +3257,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+++[]
@@ -3252,6 +3274,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+++[]
@@ -3267,6 +3291,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+++[]
@@ -3282,6 +3308,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+++[]
@@ -9046,7 +9074,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-devservices-keycloak_quarkus-ke
 
 [.description]
 --
-Specifies whether to create the default client id `quarkus-app` with a secret `secret`and register them if the `create-realm` property is set to true. For OIDC extension configuration properties `quarkus.oidc.client.id` and `quarkus.oidc.credentials.secret` will be configured. For OIDC Client extension configuration properties `quarkus.oidc-client.client.id` and `quarkus.oidc-client.credentials.secret` will be configured. Set to `false` if clients have to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by `io.quarkus.test.common.QuarkusTestResourceLifecycleManager` or registered dynamically.
+Specifies whether to create the default client id `quarkus-app` with a secret `secret` and register them if the `create-realm` property is set to true. For OIDC extension configuration properties `quarkus.oidc.client.id` and `quarkus.oidc.credentials.secret` will be configured. For OIDC Client extension configuration properties `quarkus.oidc-client.client.id` and `quarkus.oidc-client.credentials.secret` will be configured. Set to `false` if clients have to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by `io.quarkus.test.common.QuarkusTestResourceLifecycleManager` or registered dynamically.
 
 
 ifdef::add-copy-button-to-env-var[]
@@ -51886,6 +51914,8 @@ a| [[quarkus-narayana-jta_quarkus-transaction-manager-object-store-directory]] [
 
 [.description]
 --
+The name of the directory where the transaction logs will be stored when using the `file-system` object store. If the value is not absolute then the directory is relative to the _user.dir_ system property.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_TRANSACTION_MANAGER_OBJECT_STORE_DIRECTORY+++[]
@@ -51901,6 +51931,8 @@ a| [[quarkus-narayana-jta_quarkus-transaction-manager-object-store-type]] [.prop
 
 [.description]
 --
+The type of object store.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_TRANSACTION_MANAGER_OBJECT_STORE_TYPE+++[]
@@ -51916,6 +51948,10 @@ a| [[quarkus-narayana-jta_quarkus-transaction-manager-object-store-datasource]]
 
 [.description]
 --
+The name of the datasource where the transaction logs will be stored when using the `jdbc` object store.
+
+If undefined, it will use the default datasource.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_TRANSACTION_MANAGER_OBJECT_STORE_DATASOURCE+++[]
@@ -51931,6 +51967,8 @@ a| [[quarkus-narayana-jta_quarkus-transaction-manager-object-store-create-table]
 
 [.description]
 --
+Whether to create the table if it does not exist.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_TRANSACTION_MANAGER_OBJECT_STORE_CREATE_TABLE+++[]
@@ -51946,6 +51984,8 @@ a| [[quarkus-narayana-jta_quarkus-transaction-manager-object-store-drop-table]]
 
 [.description]
 --
+Whether to drop the table on startup.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_TRANSACTION_MANAGER_OBJECT_STORE_DROP_TABLE+++[]
@@ -51961,6 +52001,8 @@ a| [[quarkus-narayana-jta_quarkus-transaction-manager-object-store-table-prefix]
 
 [.description]
 --
+The prefix to apply to the table.
+
 
 ifdef::add-copy-button-to-env-var[]
 Environment variable: env_var_with_copy_button:+++QUARKUS_TRANSACTION_MANAGER_OBJECT_STORE_TABLE_PREFIX+++[]

diff --git a/_generated-doc/latest/config/quarkus-container-image-docker.adoc b/_generated-doc/latest/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/latest/config/quarkus-container-image-docker_quarkus.docker.adoc b/_generated-doc/latest/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/latest/config/quarkus-container-image-podman.adoc b/_generated-doc/latest/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+++[]