summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorValentin Rothberg <rothberg@redhat.com>2019-02-25 11:38:23 +0100
committerValentin Rothberg <rothberg@redhat.com>2019-02-25 18:26:00 +0100
commit5d9c34d97c40cfa4202ab9729f74ab728ba61b7e (patch)
tree59e511a77264253f8db0b66270d175b0f7c659f6
parent73cfb9f127b0991c3faac9ff1fafed8d65355e4b (diff)
downloadpodman-5d9c34d97c40cfa4202ab9729f74ab728ba61b7e.tar.gz
podman-5d9c34d97c40cfa4202ab9729f74ab728ba61b7e.tar.bz2
podman-5d9c34d97c40cfa4202ab9729f74ab728ba61b7e.zip
README.md: rephrase Buildah description
Rephrase the description of Buildah to make some core attributes (e.g., rootless, Dockerfile-less build, etc.) more obvious. Addresses: [#1349 (comment)](https://github.com/containers/buildah/issues/1349#issuecomment-466096550) Cherry-pick-from: https://github.com/containers/buildah/pull/1362 Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
-rw-r--r--README.md31
1 files changed, 18 insertions, 13 deletions
diff --git a/README.md b/README.md
index 52324c860..08c584c72 100644
--- a/README.md
+++ b/README.md
@@ -83,18 +83,23 @@ Information about contributing to this project.
## 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](https://github.com)
-with [Buildah](https://buildah.io) [(GitHub)](https://github.com/containers/buildah) and
-[Podman](https://podman.io) [(GitHub)](https://github.com/containers/libpod). Both Buildah and Podman are
-command line tools that work on OCI images and containers. The two projects
-differentiate in their specialization.
+Buildah and Podman are two complementary open-source projects that are
+available on most Linux platforms and both projects reside at
+[GitHub.com](https://github.com) with Buildah
+[here](https://github.com/containers/buildah) and Podman
+[here](https://github.com/containers/libpod). 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. 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.
+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
@@ -103,12 +108,12 @@ 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
+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 cannot 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
familiar container cli commands. For more details, see the
[Container Tools Guide](https://github.com/containers/buildah/tree/master/docs/containertools).