1buildah(1) General Commands Manual buildah(1)
2
6 Buildah - A command line tool that facilitates building OCI container
7 images.
8
11 buildah [OPTIONS] COMMAND [ARG...]
12
15 The Buildah package provides a command line tool which can be used to:
16 * Create a working container, either from scratch or using an image as a starting point.
19 * Mount a working container's root filesystem for manipulation.
20 * Unmount a working container's root filesystem.
21 * Use the updated contents of a container's root filesystem as a filesystem layer to create a new image.
22 * Delete a working container or an image.
23 * Rename a local container.
24
28 --debug
29 Print debugging information
32 --help, -h
35 Show help
38 --registries-conf path
41 Pathname of the configuration file which specifies which container reg‐
44 istries should be consulted when completing image names which do not
45 include a registry or domain portion. It is not recommended that this
46 option be used, as the default behavior of using the system-wide con‐
47 figuration (/etc/containers/registries.conf) is most often preferred.
48 --registries-conf-dir path
51 Pathname of the directory which contains configuration snippets which
54 specify registries which should be consulted when completing image
55 names which do not include a registry or domain portion. It is not
56 recommended that this option be used, as the default behavior of using
57 the system-wide configuration (/etc/containers/registries.d) is most
58 often preferred.
59 --root value
62 Storage root dir (default: "/var/lib/containers/storage" for UID 0,
65 "$HOME/.local/share/containers/storage" for other users) Default root
66 dir is configured in /etc/containers/storage.conf
67 --runroot value
70 Storage state dir (default: "/var/run/containers/storage" for UID 0,
73 "/var/run/user/$UID" for other users) Default state dir is configured
74 in /etc/containers/storage.conf
75 --storage-driver value
78 Storage driver. The default storage driver for UID 0 is configured in
81 /etc/containers/storage.conf ($HOME/.config/containers/storage.conf in
82 rootless mode), and is vfs for other users. The STORAGE_DRIVER envi‐
83 ronment variable overrides the default. The --storage-driver specified
84 driver overrides all.
85 Examples: "overlay", "devicemapper", "vfs"
88 Overriding this option will cause the storage-opt settings in /etc/con‐
91 tainers/storage.conf to be ignored. The user must specify additional
92 options via the --storage-opt flag.
93 --storage-opt value
96 Storage driver option, Default storage driver options are configured in
99 /etc/containers/storage.conf ($HOME/.config/containers/storage.conf in
100 rootless mode). The STORAGE_OPTS environment variable overrides the
101 default. The --storage-opt specified options overrides all.
102 --userns-uid-map mapping
105 Specifies UID mappings which should be used to set ownership, at the
108 filesytem level, on the contents of images and containers. Entries in
109 this map take the form of one or more triples of a starting in-con‐
110 tainer UID, a corresponding starting host-level UID, and the number of
111 consecutive IDs which the map entry represents. This option overrides
112 the remap-uids setting in the options section of /etc/containers/stor‐
113 age.conf.
114 --userns-gid-map mapping
117 Specifies GID mappings which should be used to set ownership, at the
120 filesytem level, on the contents of images and containers. Entries in
121 this map take the form of one or more triples of a starting in-con‐
122 tainer GID, a corresponding starting host-level GID, and the number of
123 consecutive IDs which the map entry represents. This option overrides
124 the remap-gids setting in the options section of /etc/containers/stor‐
125 age.conf.
126 --version, -v
129 Print the version
132
135 ┌──────────────────────┬────────────────────────────────┐
136 │Command │ Description │
137 ├──────────────────────┼────────────────────────────────┤
138 │buildah-add(1) │ Add the contents of a file, │
139 │ │ URL, or a directory to the │
140 │ │ container. │
141 ├──────────────────────┼────────────────────────────────┤
142 │buildah-bud(1) │ Build an image using instruc‐ │
143 │ │ tions from Dockerfiles. │
144 ├──────────────────────┼────────────────────────────────┤
145 │buildah-commit(1) │ Create an image from a working │
146 │ │ container. │
147 ├──────────────────────┼────────────────────────────────┤
148 │buildah-config(1) │ Update image configuration │
149 │ │ settings. │
150 ├──────────────────────┼────────────────────────────────┤
151 │buildah-containers(1) │ List the working containers │
152 │ │ and their base images. │
153 ├──────────────────────┼────────────────────────────────┤
154 │buildah-copy(1) │ Copies the contents of a file, │
155 │ │ URL, or directory into a con‐ │
156 │ │ tainer's working directory. │
157 ├──────────────────────┼────────────────────────────────┤
158 │buildah-from(1) │ Creates a new working con‐ │
159 │ │ tainer, either from scratch or │
160 │ │ using a specified image as a │
161 │ │ starting point. │
162 ├──────────────────────┼────────────────────────────────┤
163 │buildah-images(1) │ List images in local storage. │
164 ├──────────────────────┼────────────────────────────────┤
165 │buildah-info(1) │ Display Buildah system infor‐ │
166 │ │ mation. │
167 ├──────────────────────┼────────────────────────────────┤
168 │buildah-inspect(1) │ Inspects the configuration of │
169 │ │ a container or image │
170 ├──────────────────────┼────────────────────────────────┤
171 │buildah-mount(1) │ Mount the working container's │
172 │ │ root filesystem. │
173 ├──────────────────────┼────────────────────────────────┤
174 │buildah-login(1) │ Login to a container registry. │
175 ├──────────────────────┼────────────────────────────────┤
176 │buildah-logout(1) │ Logout of a container registry │
177 ├──────────────────────┼────────────────────────────────┤
178 │buildah-pull(1) │ Pull an image from the speci‐ │
179 │ │ fied location. │
180 ├──────────────────────┼────────────────────────────────┤
181 │buildah-push(1) │ Push an image from local stor‐ │
182 │ │ age to elsewhere. │
183 ├──────────────────────┼────────────────────────────────┤
184 │buildah-rename(1) │ Rename a local container. │
185 ├──────────────────────┼────────────────────────────────┤
186 │buildah-rm(1) │ Removes one or more working │
187 │ │ containers. │
188 ├──────────────────────┼────────────────────────────────┤
189 │buildah-rmi(1) │ Removes one or more images. │
190 ├──────────────────────┼────────────────────────────────┤
191 │buildah-run(1) │ Run a command inside of the │
192 │ │ container. │
193 ├──────────────────────┼────────────────────────────────┤
194 │buildah-tag(1) │ Add an additional name to a │
195 │ │ local image. │
196 ├──────────────────────┼────────────────────────────────┤
197 │buildah-umount(1) │ Unmount a working container's │
198 │ │ root file system. │
199 ├──────────────────────┼────────────────────────────────┤
200 │buildah-unshare(1) │ Launch a command in a user │
201 │ │ namespace with modified ID │
202 │ │ mappings. │
203 ├──────────────────────┼────────────────────────────────┤
204 │buildah-version(1) │ Display the Buildah Version │
205 │ │ Information │
206 ├──────────────────────┼────────────────────────────────┤
207 │storage.conf(5) │ Syntax of Container Storage │
208 │ │ configuration file │
209 └──────────────────────┴────────────────────────────────┘
210
212 storage.conf (/etc/containers/storage.conf)
213 storage.conf is the storage configuration file for all tools using con‐
216 tainers/storage
217 The storage configuration file specifies all of the available container
220 storage options for tools using shared container storage.
221 mounts.conf (/usr/share/containers/mounts.conf and optionally /etc/con‐
224 tainers/mounts.conf)
225 The mounts.conf files specify volume mount directories that are auto‐
228 matically mounted inside containers when executing the buildah run or
229 buildah build-using-dockerfile commands. Container process can then
230 use this content. The volume mount content does not get committed to
231 the final image.
232 Usually these directories are used for passing secrets or credentials
235 required by the package software to access remote package repositories.
236 For example, a mounts.conf with the line
239 "/usr/share/rhel/secrets:/run/secrets", the content of
240 /usr/share/rhel/secrets directory is mounted on /run/secrets inside the
241 container. This mountpoint allows Red Hat Enterprise Linux subscrip‐
242 tions from the host to be used within the container.
243 Note this is not a volume mount. The content of the volumes is copied
246 into container storage, not bind mounted directly from the host.
247 registries.conf (/etc/containers/registries.conf)
250 registries.conf is the configuration file which specifies which con‐
253 tainer registries should be consulted when completing image names which
254 do not include a registry or domain portion.
255 registries.d (/etc/containers/registries.d)
258 Directory which contains configuration snippets which specify reg‐
261 istries which should be consulted when completing image names which do
262 not include a registry or domain portion.
263
266 podman(1), containers-mounts.conf(5), newuidmap(1), newgidmap(1), con‐
267 tainers-registries.conf(5), containers-storage.conf(5)
268
271 December 2017, Originally compiled by Tom Sweeney ⟨tsweeney@redhat.com⟩
272buildah March 2017 buildah(1)