Skip to content

Commit 9ea3d42

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 267a4ea commit 9ea3d42

27 files changed

+15157
-19157
lines changed

‎_data/versioned/main/index/quarkus.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -721,6 +721,7 @@ types:
721721
extensions:
722722
- io.quarkus:quarkus-oidc
723723
- io.quarkus:quarkus-keycloak-authorization
724+
id: security-keycloak-authorization
724725
type: howto
725726
url: /guides/security-keycloak-authorization
726727
- title: Using OpenID Connect (OIDC) multitenancy
@@ -1110,6 +1111,7 @@ types:
11101111
- jwt
11111112
extensions:
11121113
- io.quarkus:quarkus-smallrye-jwt-build
1114+
id: security-jwt-build
11131115
type: guide
11141116
url: /guides/security-jwt-build
11151117
- title: Building Quarkus apps with Quarkus Command Line Interface (CLI)

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

Lines changed: 13404 additions & 14903 deletions
Large diffs are not rendered by default.

‎_generated-doc/main/config/quarkus-container-image-openshift.adoc‎

Lines changed: 324 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,324 @@
1+
[.configuration-legend]
2+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
3+
[.configuration-reference.searchable, cols="80,.^10,.^10"]
4+
|===
5+
6+
h|[.header-title]##Configuration property##
7+
h|Type
8+
h|Default
9+
10+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-build-strategy]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-build-strategy[`quarkus.openshift.build-strategy`]##
11+
ifdef::add-copy-button-to-config-props[]
12+
config_property_copy_button:+++quarkus.openshift.build-strategy+++[]
13+
endif::add-copy-button-to-config-props[]
14+
15+
16+
[.description]
17+
--
18+
The build config strategy to use.
19+
20+
21+
ifdef::add-copy-button-to-env-var[]
22+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_BUILD_STRATEGY+++[]
23+
endif::add-copy-button-to-env-var[]
24+
ifndef::add-copy-button-to-env-var[]
25+
Environment variable: `+++QUARKUS_OPENSHIFT_BUILD_STRATEGY+++`
26+
endif::add-copy-button-to-env-var[]
27+
--
28+
a|`binary`, `docker`
29+
|`binary`
30+
31+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-base-jvm-image]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-base-jvm-image[`quarkus.openshift.base-jvm-image`]##
32+
ifdef::add-copy-button-to-config-props[]
33+
config_property_copy_button:+++quarkus.openshift.base-jvm-image+++[]
34+
endif::add-copy-button-to-config-props[]
35+
36+
37+
[.description]
38+
--
39+
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.20` is used as the default. Otherwise `registry.access.redhat.com/ubi8/openjdk-17:1.20` is used as the default.
40+
41+
42+
ifdef::add-copy-button-to-env-var[]
43+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_BASE_JVM_IMAGE+++[]
44+
endif::add-copy-button-to-env-var[]
45+
ifndef::add-copy-button-to-env-var[]
46+
Environment variable: `+++QUARKUS_OPENSHIFT_BASE_JVM_IMAGE+++`
47+
endif::add-copy-button-to-env-var[]
48+
--
49+
|string
50+
|
51+
52+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-base-native-image]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-base-native-image[`quarkus.openshift.base-native-image`]##
53+
ifdef::add-copy-button-to-config-props[]
54+
config_property_copy_button:+++quarkus.openshift.base-native-image+++[]
55+
endif::add-copy-button-to-config-props[]
56+
57+
58+
[.description]
59+
--
60+
The base image to be used when a container image is being produced for the native binary 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.
61+
62+
63+
ifdef::add-copy-button-to-env-var[]
64+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_BASE_NATIVE_IMAGE+++[]
65+
endif::add-copy-button-to-env-var[]
66+
ifndef::add-copy-button-to-env-var[]
67+
Environment variable: `+++QUARKUS_OPENSHIFT_BASE_NATIVE_IMAGE+++`
68+
endif::add-copy-button-to-env-var[]
69+
--
70+
|string
71+
|`quay.io/quarkus/ubi-quarkus-native-binary-s2i:2.0`
72+
73+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-jvm-dockerfile]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-jvm-dockerfile[`quarkus.openshift.jvm-dockerfile`]##
74+
ifdef::add-copy-button-to-config-props[]
75+
config_property_copy_button:+++quarkus.openshift.jvm-dockerfile+++[]
76+
endif::add-copy-button-to-config-props[]
77+
78+
79+
[.description]
80+
--
81+
The default Dockerfile to use for jvm builds
82+
83+
84+
ifdef::add-copy-button-to-env-var[]
85+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JVM_DOCKERFILE+++[]
86+
endif::add-copy-button-to-env-var[]
87+
ifndef::add-copy-button-to-env-var[]
88+
Environment variable: `+++QUARKUS_OPENSHIFT_JVM_DOCKERFILE+++`
89+
endif::add-copy-button-to-env-var[]
90+
--
91+
|string
92+
|`src/main/docker/Dockerfile.jvm`
93+
94+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-native-dockerfile]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-native-dockerfile[`quarkus.openshift.native-dockerfile`]##
95+
ifdef::add-copy-button-to-config-props[]
96+
config_property_copy_button:+++quarkus.openshift.native-dockerfile+++[]
97+
endif::add-copy-button-to-config-props[]
98+
99+
100+
[.description]
101+
--
102+
The default Dockerfile to use for native builds
103+
104+
105+
ifdef::add-copy-button-to-env-var[]
106+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_NATIVE_DOCKERFILE+++[]
107+
endif::add-copy-button-to-env-var[]
108+
ifndef::add-copy-button-to-env-var[]
109+
Environment variable: `+++QUARKUS_OPENSHIFT_NATIVE_DOCKERFILE+++`
110+
endif::add-copy-button-to-env-var[]
111+
--
112+
|string
113+
|`src/main/docker/Dockerfile.native`
114+
115+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-jvm-arguments]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-jvm-arguments[`quarkus.openshift.jvm-arguments`]##
116+
ifdef::add-copy-button-to-config-props[]
117+
config_property_copy_button:+++quarkus.openshift.jvm-arguments+++[]
118+
endif::add-copy-button-to-config-props[]
119+
120+
121+
[.description]
122+
--
123+
The JVM arguments to pass to the JVM when starting the application
124+
125+
126+
ifdef::add-copy-button-to-env-var[]
127+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JVM_ARGUMENTS+++[]
128+
endif::add-copy-button-to-env-var[]
129+
ifndef::add-copy-button-to-env-var[]
130+
Environment variable: `+++QUARKUS_OPENSHIFT_JVM_ARGUMENTS+++`
131+
endif::add-copy-button-to-env-var[]
132+
--
133+
|list of string
134+
|
135+
136+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-native-arguments]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-native-arguments[`quarkus.openshift.native-arguments`]##
137+
ifdef::add-copy-button-to-config-props[]
138+
config_property_copy_button:+++quarkus.openshift.native-arguments+++[]
139+
endif::add-copy-button-to-config-props[]
140+
141+
142+
[.description]
143+
--
144+
Additional arguments to pass when starting the native application
145+
146+
147+
ifdef::add-copy-button-to-env-var[]
148+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_NATIVE_ARGUMENTS+++[]
149+
endif::add-copy-button-to-env-var[]
150+
ifndef::add-copy-button-to-env-var[]
151+
Environment variable: `+++QUARKUS_OPENSHIFT_NATIVE_ARGUMENTS+++`
152+
endif::add-copy-button-to-env-var[]
153+
--
154+
|list of string
155+
|
156+
157+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-jar-directory]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-jar-directory[`quarkus.openshift.jar-directory`]##
158+
ifdef::add-copy-button-to-config-props[]
159+
config_property_copy_button:+++quarkus.openshift.jar-directory+++[]
160+
endif::add-copy-button-to-config-props[]
161+
162+
163+
[.description]
164+
--
165+
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.
166+
167+
168+
ifdef::add-copy-button-to-env-var[]
169+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JAR_DIRECTORY+++[]
170+
endif::add-copy-button-to-env-var[]
171+
ifndef::add-copy-button-to-env-var[]
172+
Environment variable: `+++QUARKUS_OPENSHIFT_JAR_DIRECTORY+++`
173+
endif::add-copy-button-to-env-var[]
174+
--
175+
|string
176+
|
177+
178+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-jar-file-name]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-jar-file-name[`quarkus.openshift.jar-file-name`]##
179+
ifdef::add-copy-button-to-config-props[]
180+
config_property_copy_button:+++quarkus.openshift.jar-file-name+++[]
181+
endif::add-copy-button-to-config-props[]
182+
183+
184+
[.description]
185+
--
186+
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.
187+
188+
189+
ifdef::add-copy-button-to-env-var[]
190+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_JAR_FILE_NAME+++[]
191+
endif::add-copy-button-to-env-var[]
192+
ifndef::add-copy-button-to-env-var[]
193+
Environment variable: `+++QUARKUS_OPENSHIFT_JAR_FILE_NAME+++`
194+
endif::add-copy-button-to-env-var[]
195+
--
196+
|string
197+
|
198+
199+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-native-binary-directory]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-native-binary-directory[`quarkus.openshift.native-binary-directory`]##
200+
ifdef::add-copy-button-to-config-props[]
201+
config_property_copy_button:+++quarkus.openshift.native-binary-directory+++[]
202+
endif::add-copy-button-to-config-props[]
203+
204+
205+
[.description]
206+
--
207+
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.
208+
209+
210+
ifdef::add-copy-button-to-env-var[]
211+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_NATIVE_BINARY_DIRECTORY+++[]
212+
endif::add-copy-button-to-env-var[]
213+
ifndef::add-copy-button-to-env-var[]
214+
Environment variable: `+++QUARKUS_OPENSHIFT_NATIVE_BINARY_DIRECTORY+++`
215+
endif::add-copy-button-to-env-var[]
216+
--
217+
|string
218+
|
219+
220+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-native-binary-file-name]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-native-binary-file-name[`quarkus.openshift.native-binary-file-name`]##
221+
ifdef::add-copy-button-to-config-props[]
222+
config_property_copy_button:+++quarkus.openshift.native-binary-file-name+++[]
223+
endif::add-copy-button-to-config-props[]
224+
225+
226+
[.description]
227+
--
228+
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.
229+
230+
231+
ifdef::add-copy-button-to-env-var[]
232+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_NATIVE_BINARY_FILE_NAME+++[]
233+
endif::add-copy-button-to-env-var[]
234+
ifndef::add-copy-button-to-env-var[]
235+
Environment variable: `+++QUARKUS_OPENSHIFT_NATIVE_BINARY_FILE_NAME+++`
236+
endif::add-copy-button-to-env-var[]
237+
--
238+
|string
239+
|
240+
241+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-build-timeout]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-build-timeout[`quarkus.openshift.build-timeout`]##
242+
ifdef::add-copy-button-to-config-props[]
243+
config_property_copy_button:+++quarkus.openshift.build-timeout+++[]
244+
endif::add-copy-button-to-config-props[]
245+
246+
247+
[.description]
248+
--
249+
The build timeout.
250+
251+
252+
ifdef::add-copy-button-to-env-var[]
253+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_BUILD_TIMEOUT+++[]
254+
endif::add-copy-button-to-env-var[]
255+
ifndef::add-copy-button-to-env-var[]
256+
Environment variable: `+++QUARKUS_OPENSHIFT_BUILD_TIMEOUT+++`
257+
endif::add-copy-button-to-env-var[]
258+
--
259+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-container-image-openshift_quarkus-openshift[icon:question-circle[title=More information about the Duration format]]
260+
|`PT5M`
261+
262+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-build-log-level]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-build-log-level[`quarkus.openshift.build-log-level`]##
263+
ifdef::add-copy-button-to-config-props[]
264+
config_property_copy_button:+++quarkus.openshift.build-log-level+++[]
265+
endif::add-copy-button-to-config-props[]
266+
267+
268+
[.description]
269+
--
270+
The log level of OpenShift build log.
271+
272+
273+
ifdef::add-copy-button-to-env-var[]
274+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_BUILD_LOG_LEVEL+++[]
275+
endif::add-copy-button-to-env-var[]
276+
ifndef::add-copy-button-to-env-var[]
277+
Environment variable: `+++QUARKUS_OPENSHIFT_BUILD_LOG_LEVEL+++`
278+
endif::add-copy-button-to-env-var[]
279+
--
280+
a|`fatal`, `error`, `warn`, `info`, `debug`, `trace`
281+
|`info`
282+
283+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-openshift_quarkus-openshift-image-push-secret]] [.property-path]##link:#quarkus-container-image-openshift_quarkus-openshift-image-push-secret[`quarkus.openshift.image-push-secret`]##
284+
ifdef::add-copy-button-to-config-props[]
285+
config_property_copy_button:+++quarkus.openshift.image-push-secret+++[]
286+
endif::add-copy-button-to-config-props[]
287+
288+
289+
[.description]
290+
--
291+
The image push secret to use for pushing to external registries. (see: https://cloud.redhat.com/blog/pushing-application-images-to-an-external-registry)
292+
293+
294+
ifdef::add-copy-button-to-env-var[]
295+
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSHIFT_IMAGE_PUSH_SECRET+++[]
296+
endif::add-copy-button-to-env-var[]
297+
ifndef::add-copy-button-to-env-var[]
298+
Environment variable: `+++QUARKUS_OPENSHIFT_IMAGE_PUSH_SECRET+++`
299+
endif::add-copy-button-to-env-var[]
300+
--
301+
|string
302+
|
303+
304+
|===
305+
306+
ifndef::no-duration-note[]
307+
[NOTE]
308+
[id=duration-note-anchor-quarkus-container-image-openshift_quarkus-openshift]
309+
.About the Duration format
310+
====
311+
To write duration values, use the standard `java.time.Duration` format.
312+
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
313+
314+
You can also use a simplified format, starting with a number:
315+
316+
* If the value is only a number, it represents time in seconds.
317+
* If the value is a number followed by `ms`, it represents time in milliseconds.
318+
319+
In other cases, the simplified format is translated to the `java.time.Duration` format for parsing:
320+
321+
* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`.
322+
* If the value is a number followed by `d`, it is prefixed with `P`.
323+
====
324+
endif::no-duration-note[]

0 commit comments

Comments
 (0)