Skip to content

Commit cbc38c7

Browse files
committed
Sync documentation of main branch
1 parent 47d1e17 commit cbc38c7

File tree

7 files changed

+231
-105
lines changed

7 files changed

+231
-105
lines changed

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

Lines changed: 55 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2039,13 +2039,13 @@ Environment variable: `+++QUARKUS_BUILDPACK_JVM_BUILDER_IMAGE+++`
20392039
endif::add-copy-button-to-env-var[]
20402040
--
20412041
|string
2042-
|
2042+
|`paketocommunity/builder-ubi-base:latest`
20432043

20442044
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-native-builder-image]] [.property-path]##`quarkus.buildpack.native-builder-image`##
20452045

20462046
[.description]
20472047
--
2048-
The buildpacks builder image to use when building the project in jvm mode.
2048+
The buildpacks builder image to use when building the project in native mode.
20492049

20502050

20512051
ifdef::add-copy-button-to-env-var[]
@@ -2058,6 +2058,23 @@ endif::add-copy-button-to-env-var[]
20582058
|string
20592059
|
20602060

2061+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-trust-builder-image]] [.property-path]##`quarkus.buildpack.trust-builder-image`##
2062+
2063+
[.description]
2064+
--
2065+
Should the builder image be 'trusted' (use creator lifecycle)
2066+
2067+
2068+
ifdef::add-copy-button-to-env-var[]
2069+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_TRUST_BUILDER_IMAGE+++[]
2070+
endif::add-copy-button-to-env-var[]
2071+
ifndef::add-copy-button-to-env-var[]
2072+
Environment variable: `+++QUARKUS_BUILDPACK_TRUST_BUILDER_IMAGE+++`
2073+
endif::add-copy-button-to-env-var[]
2074+
--
2075+
|boolean
2076+
|
2077+
20612078
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-builder-env-environment-variable-name]] [.property-path]##`quarkus.buildpack.builder-env."environment-variable-name"`##
20622079

20632080
[.description]
@@ -2096,7 +2113,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quark
20962113

20972114
[.description]
20982115
--
2099-
Max pull timeout for builder/run images, in seconds
2116+
Initial pull timeout for builder/run images, in seconds
21002117

21012118

21022119
ifdef::add-copy-button-to-env-var[]
@@ -2109,11 +2126,45 @@ endif::add-copy-button-to-env-var[]
21092126
|int
21102127
|`300`
21112128

2129+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-pull-timeout-increase-seconds]] [.property-path]##`quarkus.buildpack.pull-timeout-increase-seconds`##
2130+
2131+
[.description]
2132+
--
2133+
Increase pull timeout for builder/run images after failure, in seconds
2134+
2135+
2136+
ifdef::add-copy-button-to-env-var[]
2137+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_PULL_TIMEOUT_INCREASE_SECONDS+++[]
2138+
endif::add-copy-button-to-env-var[]
2139+
ifndef::add-copy-button-to-env-var[]
2140+
Environment variable: `+++QUARKUS_BUILDPACK_PULL_TIMEOUT_INCREASE_SECONDS+++`
2141+
endif::add-copy-button-to-env-var[]
2142+
--
2143+
|int
2144+
|`15`
2145+
2146+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-pull-retry-count]] [.property-path]##`quarkus.buildpack.pull-retry-count`##
2147+
2148+
[.description]
2149+
--
2150+
How many times to retry an image pull after a failure
2151+
2152+
2153+
ifdef::add-copy-button-to-env-var[]
2154+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_PULL_RETRY_COUNT+++[]
2155+
endif::add-copy-button-to-env-var[]
2156+
ifndef::add-copy-button-to-env-var[]
2157+
Environment variable: `+++QUARKUS_BUILDPACK_PULL_RETRY_COUNT+++`
2158+
endif::add-copy-button-to-env-var[]
2159+
--
2160+
|int
2161+
|`3`
2162+
21122163
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-docker-host]] [.property-path]##`quarkus.buildpack.docker-host`##
21132164

21142165
[.description]
21152166
--
2116-
DOCKER_HOST value to use. If not set, the env var DOCKER_HOST is used, if that is not set the value `unix:///var/run/docker.sock' (or 'npipe:///./pipe/docker_engine' for windows) is used.
2167+
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
21172168

21182169

21192170
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-container-image-buildpack.adoc

Lines changed: 55 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ Environment variable: `+++QUARKUS_BUILDPACK_JVM_BUILDER_IMAGE+++`
2323
endif::add-copy-button-to-env-var[]
2424
--
2525
|string
26-
|
26+
|`paketocommunity/builder-ubi-base:latest`
2727

2828
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-native-builder-image]] [.property-path]##`quarkus.buildpack.native-builder-image`##
2929

3030
[.description]
3131
--
32-
The buildpacks builder image to use when building the project in jvm mode.
32+
The buildpacks builder image to use when building the project in native mode.
3333

3434

3535
ifdef::add-copy-button-to-env-var[]
@@ -42,6 +42,23 @@ endif::add-copy-button-to-env-var[]
4242
|string
4343
|
4444

45+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-trust-builder-image]] [.property-path]##`quarkus.buildpack.trust-builder-image`##
46+
47+
[.description]
48+
--
49+
Should the builder image be 'trusted' (use creator lifecycle)
50+
51+
52+
ifdef::add-copy-button-to-env-var[]
53+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_TRUST_BUILDER_IMAGE+++[]
54+
endif::add-copy-button-to-env-var[]
55+
ifndef::add-copy-button-to-env-var[]
56+
Environment variable: `+++QUARKUS_BUILDPACK_TRUST_BUILDER_IMAGE+++`
57+
endif::add-copy-button-to-env-var[]
58+
--
59+
|boolean
60+
|
61+
4562
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-builder-env-environment-variable-name]] [.property-path]##`quarkus.buildpack.builder-env."environment-variable-name"`##
4663

4764
[.description]
@@ -80,7 +97,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quark
8097

8198
[.description]
8299
--
83-
Max pull timeout for builder/run images, in seconds
100+
Initial pull timeout for builder/run images, in seconds
84101

85102

86103
ifdef::add-copy-button-to-env-var[]
@@ -93,11 +110,45 @@ endif::add-copy-button-to-env-var[]
93110
|int
94111
|`300`
95112

113+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-pull-timeout-increase-seconds]] [.property-path]##`quarkus.buildpack.pull-timeout-increase-seconds`##
114+
115+
[.description]
116+
--
117+
Increase pull timeout for builder/run images after failure, in seconds
118+
119+
120+
ifdef::add-copy-button-to-env-var[]
121+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_PULL_TIMEOUT_INCREASE_SECONDS+++[]
122+
endif::add-copy-button-to-env-var[]
123+
ifndef::add-copy-button-to-env-var[]
124+
Environment variable: `+++QUARKUS_BUILDPACK_PULL_TIMEOUT_INCREASE_SECONDS+++`
125+
endif::add-copy-button-to-env-var[]
126+
--
127+
|int
128+
|`15`
129+
130+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-pull-retry-count]] [.property-path]##`quarkus.buildpack.pull-retry-count`##
131+
132+
[.description]
133+
--
134+
How many times to retry an image pull after a failure
135+
136+
137+
ifdef::add-copy-button-to-env-var[]
138+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_PULL_RETRY_COUNT+++[]
139+
endif::add-copy-button-to-env-var[]
140+
ifndef::add-copy-button-to-env-var[]
141+
Environment variable: `+++QUARKUS_BUILDPACK_PULL_RETRY_COUNT+++`
142+
endif::add-copy-button-to-env-var[]
143+
--
144+
|int
145+
|`3`
146+
96147
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-docker-host]] [.property-path]##`quarkus.buildpack.docker-host`##
97148

98149
[.description]
99150
--
100-
DOCKER_HOST value to use. If not set, the env var DOCKER_HOST is used, if that is not set the value `unix:///var/run/docker.sock' (or 'npipe:///./pipe/docker_engine' for windows) is used.
151+
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
101152

102153

103154
ifdef::add-copy-button-to-env-var[]

_generated-doc/main/config/quarkus-container-image-buildpack_quarkus.buildpack.adoc

Lines changed: 55 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ Environment variable: `+++QUARKUS_BUILDPACK_JVM_BUILDER_IMAGE+++`
2323
endif::add-copy-button-to-env-var[]
2424
--
2525
|string
26-
|
26+
|`paketocommunity/builder-ubi-base:latest`
2727

2828
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-native-builder-image]] [.property-path]##`quarkus.buildpack.native-builder-image`##
2929

3030
[.description]
3131
--
32-
The buildpacks builder image to use when building the project in jvm mode.
32+
The buildpacks builder image to use when building the project in native mode.
3333

3434

3535
ifdef::add-copy-button-to-env-var[]
@@ -42,6 +42,23 @@ endif::add-copy-button-to-env-var[]
4242
|string
4343
|
4444

45+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-trust-builder-image]] [.property-path]##`quarkus.buildpack.trust-builder-image`##
46+
47+
[.description]
48+
--
49+
Should the builder image be 'trusted' (use creator lifecycle)
50+
51+
52+
ifdef::add-copy-button-to-env-var[]
53+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_TRUST_BUILDER_IMAGE+++[]
54+
endif::add-copy-button-to-env-var[]
55+
ifndef::add-copy-button-to-env-var[]
56+
Environment variable: `+++QUARKUS_BUILDPACK_TRUST_BUILDER_IMAGE+++`
57+
endif::add-copy-button-to-env-var[]
58+
--
59+
|boolean
60+
|
61+
4562
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-builder-env-environment-variable-name]] [.property-path]##`quarkus.buildpack.builder-env."environment-variable-name"`##
4663

4764
[.description]
@@ -80,7 +97,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quark
8097

8198
[.description]
8299
--
83-
Max pull timeout for builder/run images, in seconds
100+
Initial pull timeout for builder/run images, in seconds
84101

85102

86103
ifdef::add-copy-button-to-env-var[]
@@ -93,11 +110,45 @@ endif::add-copy-button-to-env-var[]
93110
|int
94111
|`300`
95112

113+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-pull-timeout-increase-seconds]] [.property-path]##`quarkus.buildpack.pull-timeout-increase-seconds`##
114+
115+
[.description]
116+
--
117+
Increase pull timeout for builder/run images after failure, in seconds
118+
119+
120+
ifdef::add-copy-button-to-env-var[]
121+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_PULL_TIMEOUT_INCREASE_SECONDS+++[]
122+
endif::add-copy-button-to-env-var[]
123+
ifndef::add-copy-button-to-env-var[]
124+
Environment variable: `+++QUARKUS_BUILDPACK_PULL_TIMEOUT_INCREASE_SECONDS+++`
125+
endif::add-copy-button-to-env-var[]
126+
--
127+
|int
128+
|`15`
129+
130+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-pull-retry-count]] [.property-path]##`quarkus.buildpack.pull-retry-count`##
131+
132+
[.description]
133+
--
134+
How many times to retry an image pull after a failure
135+
136+
137+
ifdef::add-copy-button-to-env-var[]
138+
Environment variable: env_var_with_copy_button:+++QUARKUS_BUILDPACK_PULL_RETRY_COUNT+++[]
139+
endif::add-copy-button-to-env-var[]
140+
ifndef::add-copy-button-to-env-var[]
141+
Environment variable: `+++QUARKUS_BUILDPACK_PULL_RETRY_COUNT+++`
142+
endif::add-copy-button-to-env-var[]
143+
--
144+
|int
145+
|`3`
146+
96147
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-buildpack_quarkus-buildpack-docker-host]] [.property-path]##`quarkus.buildpack.docker-host`##
97148

98149
[.description]
99150
--
100-
DOCKER_HOST value to use. If not set, the env var DOCKER_HOST is used, if that is not set the value `unix:///var/run/docker.sock' (or 'npipe:///./pipe/docker_engine' for windows) is used.
151+
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
101152

102153

103154
ifdef::add-copy-button-to-env-var[]

0 commit comments

Comments
 (0)