libpod is a library used to create container pods.
Clone or download
Latest commit af791f3 Sep 21, 2018
Permalink
Failed to load latest commit information.
.copr Change references to cri-o to point at new repository Sep 7, 2018
.github Vendor in latest containers/buildah Sep 18, 2018
.tool packagers need the varlink generated file Apr 24, 2018
cmd/podman Add --mount option for `create` & `run` command Sep 21, 2018
cni docs: fix contrib/cni broken link May 14, 2018
completions/bash Add --mount option for `create` & `run` command Sep 21, 2018
contrib Bump to v0.9.4-dev Sep 21, 2018
docs Add --mount option for `create` & `run` command Sep 21, 2018
hack AppArmor: runtime check if it's enabled on the host Jul 23, 2018
libpod Add --mount option for `create` & `run` command Sep 21, 2018
logo Touch up logo links May 15, 2018
pkg Add --mount option for `create` & `run` command Sep 21, 2018
test Add --mount option for `create` & `run` command Sep 21, 2018
utils Initial checkin from CRI-O repo Nov 1, 2017
vendor Vendor in latest containers/buildah Sep 21, 2018
version Bump to v0.9.4-dev Sep 21, 2018
.gitignore Improve ps handling of container start/stop time Aug 8, 2018
.papr.sh switch projectatomic to containers Aug 16, 2018
.papr.yml Turn on test debugging Aug 31, 2018
.papr_prepare.sh switch projectatomic to containers Aug 16, 2018
.travis.yml Do not 'make all' on Travis for Linux Aug 15, 2018
API.md Updates from reviews Sep 21, 2018
CONTRIBUTING.md switch projectatomic to containers Aug 16, 2018
Dockerfile Vendor in latest containers/buildah Sep 18, 2018
Dockerfile.CentOS Vendor in latest containers/buildah Sep 18, 2018
Dockerfile.Fedora Vendor in latest containers/buildah Sep 18, 2018
Dockerfile.Fedora.openshift Add rpmbuild to the openshift fedora test image Sep 20, 2018
LICENSE Initial commit Nov 1, 2017
Makefile Bump gitvalidation epoch Sep 21, 2018
OWNERS Update OWNERS file to be based on reality Jun 4, 2018
README.md Update release notes for 0.9.3 Sep 21, 2018
RELEASE_NOTES.md Update release notes for 0.9.3 Sep 21, 2018
Vagrantfile Enhancements to papr tests Nov 17, 2017
changelog.txt Bump to v0.9.3 Sep 21, 2018
code-of-conduct.md Initial checkin from CRI-O repo Nov 1, 2017
commands.md Include pod stats and top in commands/completions Aug 23, 2018
crio-umount.conf Initial checkin from CRI-O repo Nov 1, 2017
docker Fix up docker compatibility messages Jul 27, 2018
install.md Added GOPATH/bin to PATH install.md Sep 5, 2018
libpod.conf Add new field to libpod to indicate whether or not to use labelling Sep 20, 2018
seccomp.json Initial checkin from CRI-O repo Nov 1, 2017
transfer.md Change references to cri-o to point at new repository Sep 7, 2018
troubleshooting.md Add notes to check version on problem Sep 13, 2018
vendor.conf Vendor in latest containers/buildah Sep 21, 2018

README.md

PODMAN logo

libpod - library for running OCI-based containers in Pods

Latest Version: 0.9.3

Status: Active Development

What is the scope of this project?

libpod provides a library for applications looking to use the Container Pod concept popularized by Kubernetes. libpod also contains a tool called podman for managing Pods, Containers, and Container Images.

At a high level, the scope of libpod and podman is the following:

  • Support multiple image formats including the existing Docker/OCI image formats.
  • Support for multiple means to download images including trust & image verification.
  • Container image management (managing image layers, overlay filesystems, etc).
  • Full management of container lifecycle
  • Support for pods to manage groups of containers together
  • Resource isolation of containers and pods.

What is not in scope for this project?

  • Signing and pushing images to various image storages. See Skopeo.
  • Container Runtimes daemons for working with Kubernetes CRIs. See CRI-O. We are working to integrate libpod into CRI-O to share containers and backend code with Podman.

OCI Projects Plans

The plan is to use OCI projects and best of breed libraries for different aspects:

  • Runtime: runc (or any OCI compliant runtime) and oci runtime tools to generate the spec
  • Images: Image management using containers/image
  • Storage: Container and image storage is managed by containers/storage
  • Networking: Networking support through use of CNI
  • Builds: Builds are supported via Buildah.
  • Conmon: Conmon is a tool for monitoring OCI runtimes. It is part of the CRI-O package

Podman Information for Developers

Installation notes Information on how to install Podman in your environment.

OCI Hooks Support Information on how Podman configures OCI Hooks to run when launching a container.

Podman API Documentation on the Podman API using Varlink.

Podman Commands A list of the Podman commands with links to their man pages and in many cases videos showing the commands in use.

Podman Troubleshooting Guide A list of common issues and solutions for Podman.

Podman Usage Transfer Useful information for ops and dev transfer as it relates to infrastructure that utilizes Podman. This page includes tables showing Docker commands and their Podman equivalent commands.

Tutorials Tutorials on using Podman.

Release Notes Release notes for recent Podman versions

Contributing Information about contributing to this project.

Current Roadmap

  1. Python frontend for Varlink API
  2. Integrate libpod into CRI-O to replace its existing container management backend
  3. Further work on the podman pod command
  4. Further improvements on rootless containers
  5. In-memory locking to replace file locks

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.