summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTomSweeneyRedHat <tsweeney@redhat.com>2018-09-13 19:08:43 -0400
committerTomSweeneyRedHat <tsweeney@redhat.com>2018-09-13 19:09:56 -0400
commit4310e5ccc2b94b357ad6876007af991ae5d8ffd7 (patch)
tree44d0875306fcc32386e398489da18c7a9027fa52 /README.md
parente2137cd009376af0f66855221bd2605bd3297104 (diff)
downloadpodman-4310e5ccc2b94b357ad6876007af991ae5d8ffd7.tar.gz
podman-4310e5ccc2b94b357ad6876007af991ae5d8ffd7.tar.bz2
podman-4310e5ccc2b94b357ad6876007af991ae5d8ffd7.zip
Add Buildah Podman relationship to README.md
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 34 insertions, 2 deletions
diff --git a/README.md b/README.md
index 63996caa4..b5580b6ce 100644
--- a/README.md
+++ b/README.md
@@ -64,7 +64,7 @@ Release notes for recent Podman versions
**[Contributing](CONTRIBUTING.md)**
Information about contributing to this project.
-### Current Roadmap
+## Current Roadmap
1. Varlink API for Podman
1. Integrate libpod into CRI-O to replace its existing container management backend
@@ -72,4 +72,36 @@ Information about contributing to this project.
1. Rootless containers
1. Support for cleaning up containers via post-run hooks
-[spec-hooks]: https://github.com/opencontainers/runtime-spec/blob/v1.0.1/config.md#posix-platform-hooks
+[spec-hooks]: https://github.com/opencontainers/runtime-spec/blob/v2.0.1/config.md#posix-platform-hooks
+
+## 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 [here](https://github.com/projectatomic/buildah) and
+Podman [here](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 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](https://github.com/projectatomic/buildah/tree/master/docs/containertools).