A tool that facilitates building OCI images
Clone or download
vbatts and rh-atomic-bot Makefile: allow packagers to more easily add tags
With the `?=` operator, then `make binary TAGS=...` will clobber, but
this way `make binary BUILDTAGS=foo` will append.

Also, this matches the skopeo `BUILDTAGS`

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>

Closes: #1228
Approved by: giuseppe
Latest commit dd0f4f1 Dec 7, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Request podman version for build issues Sep 25, 2018
bind Move buildah from projecatatomic/buildah to containers/buildah Sep 18, 2018
chroot Allow cgroups to be passed into chroot, read/only Nov 16, 2018
cmd/buildah Wire in a hidden --blob-cache option Dec 4, 2018
contrib Add buildah info command Nov 29, 2018
demos Get rid of dangling whitespace in markdown files Sep 18, 2018
docker Add docker.HealthConfig.StartPeriod Nov 21, 2018
docs Clarify docker.io default in push with docker-daemon Dec 5, 2018
examples Fix wrong order of parameters Mar 12, 2018
hack tests: run conformance test suite in Travis Sep 26, 2018
imagebuildah Handle 'COPY --from' in Dockerfile Dec 7, 2018
logos updating logo reference in README Dec 13, 2017
pkg Inline blobCache.putBlob into blobCacheDestination.PutBlob Dec 7, 2018
tests tests: add containers json test Dec 7, 2018
unshare unshare: support libpod rootless pkg Oct 24, 2018
util Update for sysregistriesv2 API changes Dec 3, 2018
vendor Vendor c/image after merging c/image#536 Dec 7, 2018
.gitignore COPR enablement Feb 10, 2018
.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 Add support for building buildah staticly Nov 20, 2018
CHANGELOG.md Move buildah from projecatatomic/buildah to containers/buildah Sep 18, 2018
CONTRIBUTING.md Move buildah from projecatatomic/buildah to containers/buildah Sep 18, 2018
LICENSE Initial commit Jan 26, 2017
MAINTAINERS Fix becoming a maintainer link Jul 7, 2018
Makefile Makefile: allow packagers to more easily add tags Dec 8, 2018
README.md Complete the instructions for the command Nov 30, 2018
add.go Make sure we log or return every error Oct 7, 2018
btrfs_installed_tag.sh Don't build btrfs if it is not installed Sep 14, 2018
btrfs_tag.sh Suss out build tags, add a missing Travis dep Jan 28, 2017
buildah.go Use a blob cache when we're asked to use one Dec 4, 2018
changelog.txt Bump to v1.5 Nov 22, 2018
commit.go Use a blob cache when we're asked to use one Dec 4, 2018
common.go Update for sysregistriesv2 API changes Dec 3, 2018
config.go Support HEALTHCHECK Nov 21, 2018
delete.go Allow container storage to manage the SELinux labels Oct 21, 2018
developmentplan.md Move buildah from projecatatomic/buildah to containers/buildah Sep 18, 2018
image.go Update for API changes Dec 7, 2018
import.go Move buildah from projecatatomic/buildah to containers/buildah Sep 18, 2018
info.go Add buildah info command Nov 29, 2018
install.md Add support for building buildah staticly Nov 20, 2018
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 Use a blob cache when we're asked to use one Dec 4, 2018
new_test.go Fix: setting the container name to the image Jan 26, 2018
ostree_tag.sh ostree: fix tag for build constraint Oct 30, 2018
pull.go Use a blob cache when we're asked to use one Dec 4, 2018
release.sh Bump to v1.1 Jun 9, 2018
run.go rootless: do not specify --rootless to the OCI runtime Nov 8, 2018
run_linux.go allow buildah cross compile for a darwin target Jul 1, 2018
run_test.go Make sure we log or return every error Oct 7, 2018
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 run: clear default seccomp filter if not enabled Sep 5, 2018
selinux.go run: clear default seccomp filter if not enabled Sep 5, 2018
selinux_tag.sh Auto-set build tags for ostree and selinux Aug 29, 2017
selinux_unsupported.go run: clear default seccomp filter if not enabled Sep 5, 2018
troubleshooting.md Move buildah from projecatatomic/buildah to containers/buildah Sep 18, 2018
unmount.go Make sure we log or return every error Oct 7, 2018
util.go Update for sysregistriesv2 API changes Dec 3, 2018
vendor.conf Vendor c/image after merging c/image#536 Dec 7, 2018

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 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. Buildah’s goal is also to provide a lower level coreutils interface to build images, allowing people to build containers without requiring a Dockerfile. The intent with Buildah is to allow other scripting languages to build container images, without requiring a daemon.

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 (?)