Skip to content

Commit d19b268

Browse files
committed
Rework build-image-customization table in docs
Collapse parameter name and user property into a single column to give a little more room for the description and default value. Closes gh-25739
1 parent 6ab2df5 commit d19b268

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging-oci-image.adoc

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -107,34 +107,35 @@ The name of the generated image is deduced from project properties.
107107
The `image` parameter allows configuration of the builder and how it should operate on the project.
108108
The following table summarizes the available parameters and their default values:
109109

110+
[cols="1,4,1"]
110111
|===
111-
| Parameter | Description | User property | Default value
112+
| Parameter / (User Property)| Description | Default value
112113

113-
| `builder`
114+
| `builder` +
115+
(`spring-boot.build-image.builder`)
114116
| Name of the Builder image to use.
115-
| `spring-boot.build-image.builder`
116117
| `paketobuildpacks/builder:base`
117118

118-
| `runImage`
119+
| `runImage` +
120+
(`spring-boot.build-image.runImage`)
119121
| Name of the run image to use.
120-
| `spring-boot.build-image.runImage`
121122
| No default value, indicating the run image specified in Builder metadata should be used.
122123

123-
| `name`
124+
| `name` +
125+
(`spring-boot.build-image.imageName`)
124126
| {spring-boot-api}/buildpack/platform/docker/type/ImageReference.html#of-java.lang.String-[Image name] for the generated image.
125-
| `spring-boot.build-image.imageName`
126-
| `docker.io/library/${project.artifactId}:${project.version}`
127+
| `docker.io/library/` +
128+
`${project.artifactId}:${project.version}`
127129

128-
| `pullPolicy`
130+
| `pullPolicy` +
131+
(`spring-boot.build-image.pullPolicy`)
129132
| {spring-boot-api}/buildpack/platform/build/PullPolicy.html[Policy] used to determine when to pull the builder and run images from the registry.
130133
Acceptable values are `ALWAYS`, `NEVER`, and `IF_NOT_PRESENT`.
131-
| `spring-boot.build-image.pullPolicy`
132134
| `ALWAYS`
133135

134136
| `env`
135137
| Environment variables that should be passed to the builder.
136138
|
137-
|
138139

139140
| `buildpacks`
140141
a|Buildpacks that the builder should use when building the image.
@@ -145,7 +146,6 @@ Buildpack references must be in one of the following forms:
145146
* Buildpack in a directory on the file system - `[file://]<path>`
146147
* Buildpack in a gzipped tar (.tgz) file on the file system - `[file://]<path>/<file name>`
147148
* Buildpack in an OCI image - `[docker://]<host>/<repo>[:<tag>][@<digest>]`
148-
|
149149
| None, indicating the builder should use the buildpacks included in it.
150150

151151
| `bindings`
@@ -162,21 +162,19 @@ Where `<options>` can contain:
162162
* `rw` to mount the volume as readable and writable in the container
163163
* `volume-opt=key=value` to specify key-value pairs consisting of an option name and its value
164164
|
165-
|
166165

167-
| `cleanCache`
166+
| `cleanCache` +
167+
(`spring-boot.build-image.cleanCache`)
168168
| Whether to clean the cache before building.
169-
| `spring-boot.build-image.cleanCache`
170169
| `false`
171170

172171
| `verboseLogging`
173172
| Enables verbose logging of builder operations.
174-
|
175173
| `false`
176174

177-
| `publish`
175+
| `publish` +
176+
(`spring-boot.build-image.publish`)
178177
| Whether to publish the generated image to a Docker registry.
179-
| `spring-boot.build-image.publish`
180178
| `false`
181179
|===
182180

0 commit comments

Comments
 (0)