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 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.
38 --arch architecture
41 Set the target architecture for any images which will be built using
44 the specified container. By default, if the container was based on an
45 image, that image's target architecture is kept, otherwise the host's
46 architecture is recorded.
47 --author author
50 Set contact information for the author for any images which will be
53 built using the specified container.
54 --cmd command
57 Set the default command to run for containers based on any images which
60 will be built using the specified container. When used in combination
61 with an entry point, this specifies the default parameters for the
62 entry point.
63 --comment comment
66 Set the image-level comment for any images which will be built using
69 the specified container.
70 Note: this setting is not present in the OCIv1 image format, so it is
73 discarded when writing images using OCIv1 formats.
74 --created-by created
77 Set the description of how the topmost layer was created for any images
80 which will be created using the specified container.
81 --domainname domain
84 Set the domainname to set when running containers based on any images
87 built using the specified container.
88 Note: this setting is not present in the OCIv1 image format, so it is
91 discarded when writing images using OCIv1 formats.
92 --entrypoint "command" | '["command", "arg1", ...]'
95 Set the entry point for containers based on any images which will be
98 built using the specified container. buildah supports two formats for
99 entrypoint. It can be specified as a simple string, or as a array of
100 commands.
101 Note: When the entrypoint is specified as a string, container runtimes
104 will ignore the cmd value of the container image. However if you use
105 the array form, then the cmd will be appended onto the end of the
106 entrypoint cmd and be executed together.
107 --env var=value
110 Add a value (e.g. name=value) to the environment for containers based
113 on any images which will be built using the specified container. Can be
114 used multiple times.
115 --healthcheck command
118 Specify a command which should be run to check if a container is run‐
121 ning correctly.
122 Values can be NONE, "CMD ..." (run the specified command directly), or
125 "CMD-SHELL ..." (run the specified command using the system's shell),
126 or the empty value (remove a previously-set value and related set‐
127 tings).
128 Note: this setting is not present in the OCIv1 image format, so it is
131 discarded when writing images using OCIv1 formats.
132 --healthcheck-interval interval
135 Specify how often the command specified using the --healthcheck option
138 should be run.
139 Note: this setting is not present in the OCIv1 image format, so it is
142 discarded when writing images using OCIv1 formats.
143 --healthcheck-retries count
146 Specify how many times the command specified using the --healthcheck
149 option can fail before the container is considered to be unhealthy.
150 Note: this setting is not present in the OCIv1 image format, so it is
153 discarded when writing images using OCIv1 formats.
154 --healthcheck-start-period interval
157 Specify how much time can elapse after a container has started before a
160 failure to run the command specified using the --healthcheck option
161 should be treated as an indication that the container is failing. Dur‐
162 ing this time period, failures will be attributed to the container not
163 yet having fully started, and will not be counted as errors. After the
164 command succeeds, or the time period has elapsed, failures will be
165 counted as errors.
166 Note: this setting is not present in the OCIv1 image format, so it is
169 discarded when writing images using OCIv1 formats.
170 --healthcheck-timeout interval
173 Specify how long to wait after starting the command specified using the
176 --healthcheck option to wait for the command to return its exit status.
177 If the command has not returned within this time, it should be consid‐
178 ered to have failed.
179 Note: this setting is not present in the OCIv1 image format, so it is
182 discarded when writing images using OCIv1 formats.
183 --history-comment comment
186 Sets a comment on the topmost layer in any images which will be created
189 using the specified container.
190 --hostname host
193 Set the hostname to set when running containers based on any images
196 built using the specified container.
197 Note: this setting is not present in the OCIv1 image format, so it is
200 discarded when writing images using OCIv1 formats.
201 --label label
204 Add an image label (e.g. label=value) to the image configuration of any
207 images which will be built using the specified container. Can be used
208 multiple times.
209 --onbuild onbuild command
212 Add an ONBUILD command to the image. ONBUILD commands are automati‐
215 cally run when images are built based on the image you are creating.
216 Note: this setting is not present in the OCIv1 image format, so it is
219 discarded when writing images using OCIv1 formats.
220 --os operating system
223 Set the target operating system for any images which will be built
226 using the specified container. By default, if the container was based
227 on an image, its OS is kept, otherwise the host's OS's name is
228 recorded.
229 --port port
232 Add a port to expose when running containers based on any images which
235 will be built using the specified container. Can be used multiple
236 times.
237 --shell shell
240 Set the default shell to run inside of the container image. The shell
243 instruction allows the default shell used for the shell form of com‐
244 mands to be overridden. The default shell for Linux containers is
245 "/bin/sh -c".
246 Note: this setting is not present in the OCIv1 image format, so it is
249 discarded when writing images using OCIv1 formats.
250 --stop-signal signal
253 Set default stop signal for container. This signal will be sent when
256 container is stopped, default is SIGINT.
257 --user user[:group]
260 Set the default user to be used when running containers based on this
263 image. The user can be specified as a user name or UID, optionally
264 followed by a group name or GID, separated by a colon (':'). If names
265 are used, the container should include entries for those names in its
266 /etc/passwd and /etc/group files.
267 --volume volume
270 Add a location in the directory tree which should be marked as a volume
273 in any images which will be built using the specified container. Can be
274 used multiple times.
275 --workingdir directory
278 Set the initial working directory for containers based on images which
281 will be built using the specified container.
282
285 buildah config --author='Jane Austen' --workingdir='/etc/mycontainers'
286 containerID
287 buildah config --entrypoint /entrypoint.sh containerID
290 buildah config --entrypoint '[ "/entrypoint.sh", "dev" ]' containerID
293 buildah config --env foo=bar --env PATH=$PATH containerID
296 buildah config --label Name=Mycontainer --label Version=1.0 con‐
299 tainerID
300
303 buildah(1)
304buildah March 2017 buildah-config(1)