1buildah-config(1) General Commands Manual buildah-config(1)
2
6 buildah-config - Update image configuration settings.
7
10 buildah config [options] container
11
14 Updates one or more of the settings kept for a container.
15
18 --add-history
19 Add an entry to the image's history which will note changes to the set‐
22 tings for --cmd, --entrypoint, --env, --healthcheck, --label,
23 --onbuild, --port, --shell, --stop-signal, --user, --volume, and
24 --workingdir. Defaults to false.
25 Note: You can also override the default value of --add-history by set‐
28 ting the BUILDAH_HISTORY environment variable. export BUILDAH_HIS‐
29 TORY=true
30 --annotation, -a annotation=annotation
33 Add an image annotation (e.g. annotation=annotation) to the image mani‐
36 fest of any images which will be built using the specified container.
37 Can be used multiple times. If annotation has a trailing -, then the
38 annotation is removed from the config.
39 --arch architecture
42 Set the target architecture for any images which will be built using
45 the specified container. By default, if the container was based on an
46 image, that image's target architecture is kept, otherwise the host's
47 architecture is recorded.
48 --author author
51 Set contact information for the author for any images which will be
54 built using the specified container.
55 --cmd command
58 Set the default command to run for containers based on any images which
61 will be built using the specified container. When used in combination
62 with an entry point, this specifies the default parameters for the
63 entry point.
64 --comment comment
67 Set the image-level comment for any images which will be built using
70 the specified container.
71 Note: this setting is not present in the OCIv1 image format, so it is
74 discarded when writing images using OCIv1 formats.
75 --created-by created
78 Set the description of how the topmost layer was created for any images
81 which will be created using the specified container.
82 --domainname domain
85 Set the domainname to set when running containers based on any images
88 built using the specified container.
89 Note: this setting is not present in the OCIv1 image format, so it is
92 discarded when writing images using OCIv1 formats.
93 --entrypoint "command" | '["command", "arg1", ...]'
96 Set the entry point for containers based on any images which will be
99 built using the specified container. buildah supports two formats for
100 entrypoint. It can be specified as a simple string, or as a array of
101 commands.
102 Note: When the entrypoint is specified as a string, container runtimes
105 will ignore the cmd value of the container image. However if you use
106 the array form, then the cmd will be appended onto the end of the
107 entrypoint cmd and be executed together.
108 --env, -e env=value
111 Add a value (e.g. env=value) to the environment for containers based on
114 any images which will be built using the specified container. Can be
115 used multiple times. If env has a trailing -, then the env is removed
116 from the config.
117 --healthcheck command
120 Specify a command which should be run to check if a container is run‐
123 ning correctly.
124 Values can be NONE, "CMD ..." (run the specified command directly), or
127 "CMD-SHELL ..." (run the specified command using the system's shell),
128 or the empty value (remove a previously-set value and related set‐
129 tings).
130 Note: this setting is not present in the OCIv1 image format, so it is
133 discarded when writing images using OCIv1 formats.
134 --healthcheck-interval interval
137 Specify how often the command specified using the --healthcheck option
140 should be run.
141 Note: this setting is not present in the OCIv1 image format, so it is
144 discarded when writing images using OCIv1 formats.
145 --healthcheck-retries count
148 Specify how many times the command specified using the --healthcheck
151 option can fail before the container is considered to be unhealthy.
152 Note: this setting is not present in the OCIv1 image format, so it is
155 discarded when writing images using OCIv1 formats.
156 --healthcheck-start-period interval
159 Specify how much time can elapse after a container has started before a
162 failure to run the command specified using the --healthcheck option
163 should be treated as an indication that the container is failing. Dur‐
164 ing this time period, failures will be attributed to the container not
165 yet having fully started, and will not be counted as errors. After the
166 command succeeds, or the time period has elapsed, failures will be
167 counted as errors.
168 Note: this setting is not present in the OCIv1 image format, so it is
171 discarded when writing images using OCIv1 formats.
172 --healthcheck-timeout interval
175 Specify how long to wait after starting the command specified using the
178 --healthcheck option to wait for the command to return its exit status.
179 If the command has not returned within this time, it should be consid‐
180 ered to have failed.
181 Note: this setting is not present in the OCIv1 image format, so it is
184 discarded when writing images using OCIv1 formats.
185 --history-comment comment
188 Sets a comment on the topmost layer in any images which will be created
191 using the specified container.
192 --hostname host
195 Set the hostname to set when running containers based on any images
198 built using the specified container.
199 Note: this setting is not present in the OCIv1 image format, so it is
202 discarded when writing images using OCIv1 formats.
203 --label, -l label=value
206 Add an image label (e.g. label=value) to the image configuration of any
209 images which will be built using the specified container. Can be used
210 multiple times. If label has a trailing -, then the label is removed
211 from the config.
212 --onbuild onbuild command
215 Add an ONBUILD command to the image. ONBUILD commands are automati‐
218 cally run when images are built based on the image you are creating.
219 Note: this setting is not present in the OCIv1 image format, so it is
222 discarded when writing images using OCIv1 formats.
223 --os operating system
226 Set the target operating system for any images which will be built
229 using the specified container. By default, if the container was based
230 on an image, its OS is kept, otherwise the host's OS's name is
231 recorded.
232 --port, -p port
235 Add a port to expose when running containers based on any images which
238 will be built using the specified container. Can be used multiple
239 times.
240 --shell shell
243 Set the default shell to run inside of the container image. The shell
246 instruction allows the default shell used for the shell form of com‐
247 mands to be overridden. The default shell for Linux containers is
248 "/bin/sh -c".
249 Note: this setting is not present in the OCIv1 image format, so it is
252 discarded when writing images using OCIv1 formats.
253 --stop-signal signal
256 Set default stop signal for container. This signal will be sent when
259 container is stopped, default is SIGINT.
260 --user, -u user[:group]
263 Set the default user to be used when running containers based on this
266 image. The user can be specified as a user name or UID, optionally
267 followed by a group name or GID, separated by a colon (':'). If names
268 are used, the container should include entries for those names in its
269 /etc/passwd and /etc/group files.
270 --volume, -v volume
273 Add a location in the directory tree which should be marked as a volume
276 in any images which will be built using the specified container. Can be
277 used multiple times. If volume has a trailing -, and is already set,
278 then the volume is removed from the config.
279 --workingdir directory
282 Set the initial working directory for containers based on images which
285 will be built using the specified container.
286
289 buildah config --author='Jane Austen' --workingdir='/etc/mycontainers'
290 containerID
291 buildah config --entrypoint /entrypoint.sh containerID
294 buildah config --entrypoint '[ "/entrypoint.sh", "dev" ]' containerID
297 buildah config --env foo=bar --env PATH=$PATH containerID
300 buildah config --env foo- containerID
303 buildah config --label Name=Mycontainer --label Version=1.0 con‐
306 tainerID
307 buildah config --label Name- containerID
310 buildah config --annotation note=myNote containerID
313 buildah config --annotation note-
316 buildah config --volume /usr/myvol containerID
319 buildah config --volume /usr/myvol- containerID
322
325 buildah(1)
326buildah March 2017 buildah-config(1)