README
¶
libpod - library for running OCI-based containers in Pods
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.
Contributing Information about contributing to this project.
Current Roadmap
- Varlink API for Podman
- Integrate libpod into CRI-O to replace its existing container management backend
- Pod commands for Podman
- Rootless containers
- Support for cleaning up containers via post-run hooks
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
podman
command
nolint most of these validate and parse functions have been taken from projectatomic/docker and modified for cri-o
|
nolint most of these validate and parse functions have been taken from projectatomic/docker and modified for cri-o |
|
podman/varlink
Generated with github.com/varlink/go/cmd/varlink-go-interface-generator
|
Generated with github.com/varlink/go/cmd/varlink-go-interface-generator |
|
varlink
command
|
|
|
pkg
|
|
|
hooks
Package hooks implements hook configuration and handling for CRI-O and libpod.
|
Package hooks implements hook configuration and handling for CRI-O and libpod. |
|
hooks/0.1.0
Package hook is the 0.1.0 hook configuration structure.
|
Package hook is the 0.1.0 hook configuration structure. |
|
hooks/1.0.0
Package hook is the 1.0.0 hook configuration structure.
|
Package hook is the 1.0.0 hook configuration structure. |
|
registrar
Package registrar provides name registration.
|
Package registrar provides name registration. |
|
test
|
|
|
bin2img
command
|
|
|
checkseccomp
command
|
|
|
copyimg
command
|
|