Podman: A tool for managing OCI containers and pods.
Find a file
Valentin Rothberg 9416e2d784 Makefile: add changelog target
Maintaining a changelog for each new version or release of Podman helps
users to quickly skim for new changes.  Add a `make changelog` target to
facilitate creating a new log.

There are two env variables to control the base and target commit for
the new log.  The output gets prepended to the changelog.txt file, which
is a textfile in following format:
- Changelog for $(CHANGELOG_TARGET) (ISO-8601 DATE):
  * Commit subject
  * Commit subject...

Notice that the list of commit subjects excludes merge commits, and can
be manually modified after generation if needed.

`CHANGELOG_BASE=v0.3.2 CHANGELOG_TARGET=v0.3.3 make changelog` would
generate the following shortened output to the changelog.txt file:

Changelog for v0.3.3 (2018-03-17):
  * Bump to v0.3.3
  * Fix build after c/image changes
  * Update containers/image
  * Fix E2E tests
  * Address review comments
  * Fix E2E tests
  * Add restart to main podman manpage
  * Add podman restart to podman bash completions and commands

Signed-off-by: Valentin Rothberg <vrothberg@suse.com>
2018-03-21 13:44:35 +01:00
.copr copr outdir 2018-02-28 19:43:55 -06:00
.github Add podman info to the issue template 2018-03-06 20:46:59 +00:00
.tool Disable interfacer linter 2018-01-16 14:58:06 +00:00
cmd/podman Image library stage 4 - create and commit 2018-03-20 16:20:12 +00:00
cni Enable port bindings 2018-01-20 18:51:21 +00:00
completions/bash Merge pull request #447 from mheon/sig_proxy 2018-03-16 10:34:32 -04:00
contrib/spec Bump release to v0.3.4-dev 2018-03-16 11:05:16 -04:00
docs Merge pull request #447 from mheon/sig_proxy 2018-03-16 10:34:32 -04:00
hack Add fix_gofmt target 2017-12-13 20:52:51 +00:00
libpod Image library stage 4 - create and commit 2018-03-20 16:20:12 +00:00
logo Initial checkin from CRI-O repo 2017-11-01 11:24:59 -04:00
pkg Stage3 Image Library 2018-03-14 20:21:31 +00:00
test Image library stage 4 - create and commit 2018-03-20 16:20:12 +00:00
utils Initial checkin from CRI-O repo 2017-11-01 11:24:59 -04:00
vendor Update containers/image 2018-03-16 14:35:07 +00:00
version Bump release to v0.3.4-dev 2018-03-16 11:05:16 -04:00
.gitignore Remove crio.conf references from manpages 2018-03-12 14:38:41 +00:00
.papr.sh Update test-related makefile targets 2018-03-08 08:54:32 +00:00
.papr.yml Address review comments 2018-02-24 09:15:47 +00:00
.papr_prepare.sh Run podman inside a podman container 2018-02-16 18:35:54 +00:00
.travis.yml Image Resolution Stage 1 2018-03-08 19:31:31 +00:00
changelog.txt Makefile: add changelog target 2018-03-21 13:44:35 +01:00
code-of-conduct.md Initial checkin from CRI-O repo 2017-11-01 11:24:59 -04:00
commands.md Add 'podman restart' asciinema 2018-03-17 10:06:11 +00:00
CONTRIBUTING.md Ran spell checker through all man pages 2018-01-29 15:21:34 +00:00
crio-umount.conf Initial checkin from CRI-O repo 2017-11-01 11:24:59 -04:00
docker Add support for mimicing docker CLI 2018-01-18 07:01:48 -05:00
Dockerfile Honor ENTRYPOINT in image 2018-02-11 10:21:46 +00:00
Dockerfile.CentOS Honor ENTRYPOINT in image 2018-02-11 10:21:46 +00:00
Dockerfile.Fedora Honor ENTRYPOINT in image 2018-02-11 10:21:46 +00:00
hooks.md Ran spell checker through all man pages 2018-01-29 15:21:34 +00:00
install.md Touch up tutorial location and install reqs 2018-02-15 19:51:46 +00:00
libpod.conf Add new default location for conmon 2018-03-14 14:54:43 +00:00
LICENSE Initial commit 2017-11-01 11:01:27 -04:00
Makefile Makefile: add changelog target 2018-03-21 13:44:35 +01:00
OWNERS Update OWNERS. Remove unused version code 2017-11-01 13:49:21 -04:00
README.md Touch up tutorial location and install reqs 2018-02-15 19:51:46 +00:00
seccomp.json Initial checkin from CRI-O repo 2017-11-01 11:24:59 -04:00
transfer.md Add 'podman restart' command 2018-03-16 13:55:49 +00:00
Vagrantfile Enhancements to papr tests 2017-11-17 02:07:18 +00:00
vendor.conf Update containers/image 2018-03-16 14:35:07 +00:00

PODMAN logo

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

At a high level, we expect the scope of libpod/podman to be 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).
  • 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.

OCI Projects Plans

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
  • Conmon: conmon Conmon is a tool for monitoring OCI runtimes. 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 Commands A list of the Podman commands with links to their man pages and in many cases videos showing the commands in use.

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 the Podman utility.

Communication with Fellow Developers

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.

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)