Skip to content
A tool that facilitates building OCI images
Branch: master
Clone or download
rhatdan and rh-atomic-bot Do not create empty mounts.conf file
We want to use the shared /usr/share/containers/mounts.conf by default.

Currently the tools create an empty mounts.conf file which causes RHEL
subscriptions to not work.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #1422
Approved by: TomSweeneyRedHat
Latest commit ea48aa8 Mar 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
bind Move buildah from projecatatomic/buildah to containers/buildah Sep 18, 2018
chroot
cmd/buildah
contrib
demos
docker
docs
examples escape shell variables in README example Mar 18, 2019
hack add hack/tree_status.sh script Feb 20, 2019
imagebuildah
logos
pkg
tests fix bug to not separate each --label value with comma Mar 20, 2019
unshare
util
vendor onsi/gomeage add missing files Mar 12, 2019
.gitignore
.papr.sh Add support for building buildah staticly Nov 20, 2018
.papr.yml Change gofmt so it runs on all but 1.10 Oct 18, 2018
.travis.yml Travis: execute make vendor and hack/tree_status.sh Feb 20, 2019
CHANGELOG.md Update CHANGELOG.md with the past changes Feb 26, 2019
CONTRIBUTING.md
LICENSE Initial commit Jan 26, 2017
MAINTAINERS Fix becoming a maintainer link Jul 7, 2018
Makefile make vendor: always fetch the latest vndr Feb 20, 2019
README.md
add.go
btrfs_installed_tag.sh
btrfs_tag.sh Suss out build tags, add a missing Travis dep Jan 28, 2017
buildah.go Allow rootless users to use the cache directory in homedir Mar 14, 2019
changelog.txt Bump to v1.7.1 Feb 26, 2019
commit.go
common.go Allow rootless users to use the cache directory in homedir Mar 14, 2019
config.go Add options for empty-layer history entries Jan 21, 2019
delete.go Allow container storage to manage the SELinux labels Oct 21, 2018
developmentplan.md
image.go
import.go Allow rootless users to use the cache directory in homedir Mar 14, 2019
info.go Add buildah info command Nov 29, 2018
install.md add sample registries.conf to docs Mar 18, 2019
libdm_tag.sh Refine the libdm_no_deferred_remove tag check Feb 2, 2017
mount.go Make sure we log or return every error Oct 7, 2018
new.go
new_test.go Fix: setting the container name to the image Jan 26, 2018
ostree_tag.sh
pull.go Remove mistaken code that got merged in other PR Mar 18, 2019
release.sh
run.go
run_linux.go allow buildah cross compile for a darwin target Jul 1, 2018
run_test.go Prepend a comment to files setup in container Mar 9, 2019
run_unsupport.go allow buildah cross compile for a darwin target Jul 1, 2018
seccomp.go run: clear default seccomp filter if not enabled Sep 5, 2018
seccomp_unsupported.go
selinux.go
selinux_tag.sh
selinux_unsupported.go run: clear default seccomp filter if not enabled Sep 5, 2018
troubleshooting.md
unmount.go
util.go Move tar commands into containers/storage Feb 1, 2019
vendor.conf vendor latest openshift/imagebuilder Mar 12, 2019

README.md

buildah logo

Buildah - a tool that facilitates building Open Container Initiative (OCI) container images

Go Report Card Travis

The Buildah package provides a command line tool that can be used to

  • create a working container, either from scratch or using an image as a starting point
  • create an image, either from a working container or via the instructions in a Dockerfile
  • images can be built in either the OCI image format or the traditional upstream docker image format
  • mount a working container's root filesystem for manipulation
  • unmount a working container's root filesystem
  • use the updated contents of a container's root filesystem as a filesystem layer to create a new image
  • delete a working container or an image
  • rename a local container

Buildah Information for Developers

For blogs, release announcements and more, please checkout the buildah.io website!

Buildah Demos

Changelog

Contributing

Development Plan

Installation notes

Troubleshooting Guide

Tutorials

Buildah and Podman relationship

Buildah and Podman are two complementary open-source projects that are available on most Linux platforms and both projects reside at GitHub.com with Buildah here and Podman here. Both, Buildah and Podman are command line tools that work on Open Container Initiative (OCI) images and containers. The two projects differentiate in their specialization.

Buildah specializes in building OCI images. Buildah's commands replicate all of the commands that are found in a Dockerfile. This allows building images with and without Dockerfiles while not requiring any root privileges. Buildah’s ultimate goal is to provide a lower-level coreutils interface to build images. The flexibility of building images without Dockerfiles allows for the integration of other scripting languages into the build process. Buildah follows a simple fork-exec model and does not run as a daemon but it is based on a comprehensive API in golang, which can be vendored into other tools.

Podman specializes in all of the commands and functions that help you to maintain and modify OCI images, such as pulling and tagging. It also allows you to create, run, and maintain those containers created from those images.

A major difference between Podman and Buildah is their concept of a container. Podman allows users to create "traditional containers" where the intent of these containers is to be long lived. While Buildah containers are really just created to allow content to be added back to the container image. An easy way to think of it is the buildah run command emulates the RUN command in a Dockerfile while the podman run command emulates the docker run command in functionality. Because of this and their underlying storage differences, you can not see Podman containers from within Buildah or vice versa.

In short, Buildah is an efficient way to create OCI images while Podman allows you to manage and maintain those images and containers in a production environment using familiar container cli commands. For more details, see the Container Tools Guide.

Example

From ./examples/lighttpd.sh:

$ cat > lighttpd.sh <<"EOF"
#!/bin/bash -x

ctr1=$(buildah from "${1:-fedora}")

## Get all updates and install our minimal httpd server
buildah run "$ctr1" -- dnf update -y
buildah run "$ctr1" -- dnf install -y lighttpd

## Include some buildtime annotations
buildah config --annotation "com.example.build.host=$(uname -n)" "$ctr1"

## Run our server and expose the port
buildah config --cmd "/usr/sbin/lighttpd -D -f /etc/lighttpd/lighttpd.conf" "$ctr1"
buildah config --port 80 "$ctr1"

## Commit this container to an image name
buildah commit "$ctr1" "${2:-$USER/lighttpd}"
EOF

$ chmod +x lighttpd.sh
$ sudo ./lighttpd.sh

Commands

Command Description
buildah-add(1) Add the contents of a file, URL, or a directory to the container.
buildah-bud(1) Build an image using instructions from Dockerfiles.
buildah-commit(1) Create an image from a working container.
buildah-config(1) Update image configuration settings.
buildah-containers(1) List the working containers and their base images.
buildah-copy(1) Copies the contents of a file, URL, or directory into a container's working directory.
buildah-from(1) Creates a new working container, either from scratch or using a specified image as a starting point.
buildah-images(1) List images in local storage.
buildah-info(1) Display Buildah system information.
buildah-inspect(1) Inspects the configuration of a container or image.
buildah-mount(1) Mount the working container's root filesystem.
buildah-pull(1) Pull an image from the specified location.
buildah-push(1) Push an image from local storage to elsewhere.
buildah-rename(1) Rename a local container.
buildah-rm(1) Removes one or more working containers.
buildah-rmi(1) Removes one or more images.
buildah-run(1) Run a command inside of the container.
buildah-tag(1) Add an additional name to a local image.
buildah-umount(1) Unmount a working container's root file system.
buildah-unshare(1) Launch a command in a user namespace with modified ID mappings.
buildah-version(1) Display the Buildah Version Information

Future goals include:

  • more CI tests
  • additional CLI commands (?)
You can’t perform that action at this time.