Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed May 11, 2024
1 parent 6151c66 commit 81e950e
Show file tree
Hide file tree
Showing 21 changed files with 310 additions and 25 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"io.quarkus.container.image.openshift.deployment.BuildStrategy","key":"quarkus.s2i.build-strategy","additionalKeys":[],"configDoc":"The build config strategy to use.","withinAMap":false,"defaultValue":"binary","javaDocSiteLink":"","docMapKey":"build-strategy","configPhase":"BUILD_TIME","acceptedValues":["`binary`","`docker`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BUILD_STRATEGY","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.s2i.base-jvm-image","additionalKeys":[],"configDoc":"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:1.18` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17:1.18` is used as the default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"base-jvm-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BASE_JVM_IMAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.base-native-image","additionalKeys":[],"configDoc":"The base image to be used when a container image is being produced for the native binary build","withinAMap":false,"defaultValue":"quay.io/quarkus/ubi-quarkus-native-binary-s2i:2.0","javaDocSiteLink":"","docMapKey":"base-native-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BASE_NATIVE_IMAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.jvm-arguments","additionalKeys":[],"configDoc":"The JVM arguments to pass to the JVM when starting the application","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jvm-arguments","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_JVM_ARGUMENTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.native-arguments","additionalKeys":[],"configDoc":"Additional arguments to pass when starting the native application","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"native-arguments","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_NATIVE_ARGUMENTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.jar-directory","additionalKeys":[],"configDoc":"The directory where the jar is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non default image is used.","withinAMap":false,"defaultValue":"/deployments/target/","javaDocSiteLink":"","docMapKey":"jar-directory","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_JAR_DIRECTORY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.jar-file-name","additionalKeys":[],"configDoc":"The resulting filename of the jar in the S2I image. This option may be used if the selected S2I image uses a fixed name for the jar.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jar-file-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_JAR_FILE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.native-binary-directory","additionalKeys":[],"configDoc":"The directory where the native binary is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non-default image is used.","withinAMap":false,"defaultValue":"/home/quarkus/","javaDocSiteLink":"","docMapKey":"native-binary-directory","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_NATIVE_BINARY_DIRECTORY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.native-binary-file-name","additionalKeys":[],"configDoc":"The resulting filename of the native binary in the S2I image. This option may be used if the selected S2I image uses a fixed name for the native binary.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"native-binary-file-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_NATIVE_BINARY_FILE_NAME","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.s2i.build-timeout","additionalKeys":[],"configDoc":"The build timeout.","withinAMap":false,"defaultValue":"PT5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"build-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BUILD_TIMEOUT","enum":false}}]
[{"configDocKey":{"type":"io.quarkus.container.image.openshift.deployment.BuildStrategy","key":"quarkus.s2i.build-strategy","additionalKeys":[],"configDoc":"The build config strategy to use.","withinAMap":false,"defaultValue":"binary","javaDocSiteLink":"","docMapKey":"build-strategy","configPhase":"BUILD_TIME","acceptedValues":["`binary`","`docker`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BUILD_STRATEGY","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.s2i.base-jvm-image","additionalKeys":[],"configDoc":"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:1.19` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17:1.19` is used as the default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"base-jvm-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BASE_JVM_IMAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.base-native-image","additionalKeys":[],"configDoc":"The base image to be used when a container image is being produced for the native binary build","withinAMap":false,"defaultValue":"quay.io/quarkus/ubi-quarkus-native-binary-s2i:2.0","javaDocSiteLink":"","docMapKey":"base-native-image","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BASE_NATIVE_IMAGE","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.jvm-arguments","additionalKeys":[],"configDoc":"The JVM arguments to pass to the JVM when starting the application","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jvm-arguments","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_JVM_ARGUMENTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.native-arguments","additionalKeys":[],"configDoc":"Additional arguments to pass when starting the native application","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"native-arguments","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_NATIVE_ARGUMENTS","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.jar-directory","additionalKeys":[],"configDoc":"The directory where the jar is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non default image is used.","withinAMap":false,"defaultValue":"/deployments/target/","javaDocSiteLink":"","docMapKey":"jar-directory","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_JAR_DIRECTORY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.jar-file-name","additionalKeys":[],"configDoc":"The resulting filename of the jar in the S2I image. This option may be used if the selected S2I image uses a fixed name for the jar.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jar-file-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_JAR_FILE_NAME","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.native-binary-directory","additionalKeys":[],"configDoc":"The directory where the native binary is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non-default image is used.","withinAMap":false,"defaultValue":"/home/quarkus/","javaDocSiteLink":"","docMapKey":"native-binary-directory","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_NATIVE_BINARY_DIRECTORY","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.s2i.native-binary-file-name","additionalKeys":[],"configDoc":"The resulting filename of the native binary in the S2I image. This option may be used if the selected S2I image uses a fixed name for the native binary.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"native-binary-file-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_NATIVE_BINARY_FILE_NAME","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.s2i.build-timeout","additionalKeys":[],"configDoc":"The build timeout.","withinAMap":false,"defaultValue":"PT5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"build-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.s2i","since":null,"environmentVariable":"QUARKUS_S2I_BUILD_TIMEOUT","enum":false}}]

Large diffs are not rendered by default.

48 changes: 45 additions & 3 deletions _generated-doc/main/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3274,7 +3274,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-jib_quarkus-jib

[.description]
--
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.18` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17-runtime:1.18` is used as the default.
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.19` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17-runtime:1.19` is used as the default.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_JIB_BASE_JVM_IMAGE+++[]
Expand Down Expand Up @@ -3724,7 +3724,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quark

[.description]
--
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.18` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17:1.18` is used as the default.
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.19` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17:1.19` is used as the default.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_BASE_JVM_IMAGE+++[]
Expand Down Expand Up @@ -3965,7 +3965,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quark

[.description]
--
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:1.18` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17:1.18` is used as the default.
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:1.19` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17:1.19` is used as the default.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_S2I_BASE_JVM_IMAGE+++[]
Expand Down Expand Up @@ -46993,6 +46993,27 @@ endif::add-copy-button-to-env-var[]
|


a| [[quarkus-oidc_quarkus-oidc-authentication-session-expired-path]]`link:#quarkus-oidc_quarkus-oidc-authentication-session-expired-path[quarkus.oidc.authentication.session-expired-path]`


[.description]
--
Relative path to the public endpoint which an authenticated user is redirected to when the session has expired.

When the OIDC session has expired and the session can not be refreshed, a user is redirected to the OIDC provider to re-authenticate. The user experience may not be ideal in this case as it may not be obvious to the authenticated user why an authentication challenge is returned.

Set this property if you would like the user whose session has expired be redirected to a public application specific page instead, which can inform that the session has expired and advise the user to re-authenticated by following a link to the secured initial entry page.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_SESSION_EXPIRED_PATH+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_SESSION_EXPIRED_PATH+++`
endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-oidc_quarkus-oidc-authentication-verify-access-token]]`link:#quarkus-oidc_quarkus-oidc-authentication-verify-access-token[quarkus.oidc.authentication.verify-access-token]`


Expand Down Expand Up @@ -49645,6 +49666,27 @@ endif::add-copy-button-to-env-var[]
|


a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-session-expired-path]]`link:#quarkus-oidc_quarkus-oidc-tenant-authentication-session-expired-path[quarkus.oidc."tenant".authentication.session-expired-path]`


[.description]
--
Relative path to the public endpoint which an authenticated user is redirected to when the session has expired.

When the OIDC session has expired and the session can not be refreshed, a user is redirected to the OIDC provider to re-authenticate. The user experience may not be ideal in this case as it may not be obvious to the authenticated user why an authentication challenge is returned.

Set this property if you would like the user whose session has expired be redirected to a public application specific page instead, which can inform that the session has expired and advise the user to re-authenticated by following a link to the secured initial entry page.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_EXPIRED_PATH+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_EXPIRED_PATH+++`
endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-oidc_quarkus-oidc-tenant-authentication-verify-access-token]]`link:#quarkus-oidc_quarkus-oidc-tenant-authentication-verify-access-token[quarkus.oidc."tenant".authentication.verify-access-token]`


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-jib_quarkus-jib

[.description]
--
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.18` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17-runtime:1.18` is used as the default.
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.19` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17-runtime:1.19` is used as the default.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_JIB_BASE_JVM_IMAGE+++[]
Expand Down
Loading

0 comments on commit 81e950e

Please sign in to comment.