Merge pull request #2424 from vrothberg/update-buildah-description

[skip-ci] README.md: rephrase Buildah description
This commit is contained in:
OpenShift Merge Robot
2019-02-25 20:23:03 +01:00
committed by GitHub

View File

@ -83,18 +83,23 @@ Information about contributing to this project.
## Buildah and Podman relationship ## Buildah and Podman relationship
Buildah and Podman are two complementary Open-source projects that are available on Buildah and Podman are two complementary open-source projects that are
most Linux platforms and both projects reside at [GitHub.com](https://github.com) available on most Linux platforms and both projects reside at
with [Buildah](https://buildah.io) [(GitHub)](https://github.com/containers/buildah) and [GitHub.com](https://github.com) with Buildah
[Podman](https://podman.io) [(GitHub)](https://github.com/containers/libpod). Both Buildah and Podman are [here](https://github.com/containers/buildah) and Podman
command line tools that work on OCI images and containers. The two projects [here](https://github.com/containers/libpod). Both, Buildah and Podman are
differentiate in their specialization. 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 Buildah specializes in building OCI images. Buildah's commands replicate all
of the commands that are found in a Dockerfile. Buildahs goal is also to of the commands that are found in a Dockerfile. This allows building images
provide a lower level coreutils interface to build images, allowing people to build with and without Dockerfiles while not requiring any root privileges.
containers without requiring a Dockerfile. The intent with Buildah is to allow other Buildahs ultimate goal is to provide a lower-level coreutils interface to
scripting languages to build container images, without requiring a daemon. 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 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 OCI images, such as pulling and tagging. It also allows you to create, run, and maintain those containers
@ -108,7 +113,7 @@ to be added back to the container image. An easy way to think of it is the
command emulates the `docker run` command in functionality. Because of this and their underlying 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. 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 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 you to manage and maintain those images and containers in a production environment using
familiar container cli commands. For more details, see the familiar container cli commands. For more details, see the
[Container Tools Guide](https://github.com/containers/buildah/tree/master/docs/containertools). [Container Tools Guide](https://github.com/containers/buildah/tree/master/docs/containertools).