libpod

README

libpod - library for running OCI-based containers in Pods

Status: 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 podman, which allows you to manage Pods, Containers, and Container Images.

At a high level, we expect the scope of libpod/podman to the following functionalities:

• 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)
• Container and POD process lifecycle management
• Resource isolation of containers and PODS.

What is not in scope for this project?

• Building container images. See Buildah
• Signing and pushing images to various image storages. See Skopeo.
• Container Runtimes daemons for working with Kubernetes CRIs See CRI-O.

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

• Runtime: runc (or any OCI runtime-spec implementation) and oci runtime tools
• Images: Image management using containers/image
• Storage: Storage and management of image layers using containers/storage
• Networking: Networking support through use of CNI

libpod is currently in active development.

Commands

Command	Description	Demo
podman(1)	Simple management tool for pods and images
podman-attach(1)	Attach to a running container
podman-build(1)	Build an image using instructions from Dockerfiles
podman-commit(1)	Create new image based on the changed container
podman-cp(1)	Instead of providing a podman cp command, the man page podman-cp describes how to use the podman mount command to have even more flexibility and functionality
podman-create(1)	Create a new container
podman-diff(1)	Inspect changes on a container or image's filesystem
podman-exec(1)	Execute a command in a running container
podman-export(1)	Export container's filesystem contents as a tar archive
podman-history(1)	Shows the history of an image
podman-images(1)	List images in local storage
podman-import(1)	Import a tarball and save it as a filesystem image
podman-info(1)	Display system information
podman-inspect(1)	Display the configuration of a container or image
podman-kill(1)	Kill the main process in one or more running containers
podman-load(1)	Load an image from docker archive or oci
podman-login(1)	Login to a container registry
podman-logout(1)	Logout of a container registry
podman-logs(1)	Display the logs of a container
podman-mount(1)	Mount a working container's root filesystem
podman-pause(1)	Pause one or more running containers
podman-ps(1)	Prints out information about containers
podman-pull(1)	Pull an image from a registry
podman-push(1)	Push an image to a specified destination
podman-rm(1)	Removes one or more containers
podman-rmi(1)	Removes one or more images
podman-save(1)	Saves an image to an archive
podman-start(1)	Starts one or more containers
podman-stats(1)	Display a live stream of one or more containers' resource usage statistics
podman-stop(1)	Stops one or more running containers
podman-tag(1)	Add an additional name to a local image
podman-top(1)	Display the running processes of a container
podman-umount(1)	Unmount a working container's root filesystem
podman-unpause(1)	Unpause one or more running containers
podman-version(1)	Display the version information
podman-wait(1)	Wait on one or more containers to stop and print their exit codes

OCI Hooks Support

PODMAN configures OCI Hooks to run when launching a container

PODMAN Usage Transfer

Useful information for ops and dev transfer as it relates to infrastructure that utilizes PODMAN

Communication

For async communication and long running discussions please use issues and pull requests on the github repo. This will be the best place to discuss design and implementation.

For sync communication we have an IRC channel #PODMAN, on chat.freenode.net, that everyone is welcome to join and chat about development.

Installation Instructions

Current Roadmap

1. Basic pod/container lifecycle, basic image pull (done)
2. Support for tty handling and state management (done)
3. Basic integration with kubelet once client side changes are ready (done)
4. Support for log management, networking integration using CNI, pluggable image/storage management (done)
5. Support for exec/attach (done)