You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
OpenShift Merge Robot 4dc52f61cc
Merge pull request #10316 from containers/dependabot/go_modules/github.com/containers/storage-1.30.3
1 day ago
.copr Switch all references to github.com/containers/libpod -> podman 10 months ago
.github Fix variable reference typo. in multi-arch image action 2 weeks ago
cmd/podman Add host.serviceIsRemote to podman info results 3 days ago
cni Switch references from libpod.conf to containers.conf 10 months ago
completions Fixes from make codespell 3 weeks ago
contrib fix incorrect log driver in podman container image 2 days ago
dependencies [NO TESTS NEEDED] Update linter 3 months ago
docs Add host.serviceIsRemote to podman info results 3 days ago
hack [CI:DOCS] hack/bats - new helper for running system tests 2 days ago
libpod Merge pull request #10300 from jwhonce/issues/10289 1 day ago
logo logo: correct light source reflection 2 years ago
nix Update nix pin with `make nixpkgs` 2 days ago
pkg Merge pull request #10324 from containers/uncompressing 1 day ago
test Merge pull request #10294 from Luap99/system-upgrade-tests 1 day ago
utils Improvements for machine 2 months ago
vendor Merge pull request #10316 from containers/dependabot/go_modules/github.com/containers/storage-1.30.3 1 day ago
version Bump to v3.2.0-dev 2 months ago
.cirrus.yml CI: run rootless tests under ubuntu 1 week ago
.dockerignore Cirrus: Fix gate image & false-positive exits 1 year ago
.gitignore Overhaul Makefile binary and release worflows 1 month ago
.golangci.yml Enable more golangci-lint linters 3 months ago
.pre-commit-config.yaml [NO TESTS NEEDED] Bump pre-commit-hooks version 2 months ago
.ubuntu_prepare.sh Add ability for ubuntu to be tested 3 years ago
CODE-OF-CONDUCT.md [CI:DOCS] Update project name in Code of Conduct 4 months ago
CONTRIBUTING.md CI: smoke test: insist on adding tests on PRs 4 months ago
Containerfile-testvol Add tests for volume plugins 4 months ago
LICENSE Initial commit 4 years ago
Makefile Add documentation on short-names 7 days ago
OWNERS Add saschagrunert and zhangguanzhang to OWNERS 5 months ago
README.md Update main branch to reflect the release of v3.1.0 1 month ago
RELEASE_NOTES.md Update release notes to indicate CVE fix 1 month ago
RELEASE_PROCESS.md Fixes from make codespell 3 weeks ago
SECURITY.md [CI:DOCS] Add Security Policy 1 year ago
Vagrantfile Enhancements to papr tests 4 years ago
build_osx.md [CI:DOCS]build instructions for macOS 3 months ago
changelog.txt Bump to v3.2.0-rc1 1 week ago
commands-demo.md Implement Secrets 3 months ago
commands.md commands: rename file and add likns to readthedocs 1 year ago
docker docker: Double quote array expansions to avoid re-splitting elements 3 years ago
go.mod Merge pull request #10316 from containers/dependabot/go_modules/github.com/containers/storage-1.30.3 1 day ago
go.sum Merge pull request #10316 from containers/dependabot/go_modules/github.com/containers/storage-1.30.3 1 day ago
install.md update website link for install instructions 5 months ago
rootless.md Spelling 5 months ago
transfer.md Apply suggestions from code review 8 months ago
troubleshooting.md Fix troubleshooting documentation on handling sublemental groups. 1 week ago

README.md

PODMAN logo

Podman: A tool for managing OCI containers and pods

Podman (the POD MANager) is a tool for managing containers and images, volumes mounted into those containers, and pods made from groups of containers. Podman is based on libpod, a library for container lifecycle management that is also contained in this repository. The libpod library provides APIs for managing containers, pods, container images, and volumes.

  • Latest Version: 3.1.0

    • Latest Remote client for Windows
    • Latest Remote client for MacOs
    • Latest Static Remote client for Linux
  • Continuous Integration: Build Status

  • GoDoc: GoDoc

Overview and scope

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

  • Support for multiple container image formats, including OCI and Docker images.
  • Full management of those images, including pulling from various sources (including trust and verification), creating (built via Containerfile or Dockerfile or committed from a container), and pushing to registries and other storage backends.
  • Full management of container lifecycle, including creation (both from an image and from an exploded root filesystem), running, checkpointing and restoring (via CRIU), and removal.
  • Support for pods, groups of containers that share resources and are managed together.
  • Support for running containers and pods without root or other elevated privileges.
  • Resource isolation of containers and pods.
  • Support for a Docker-compatible CLI interface.
  • No manager daemon, for improved security and lower resource utilization at idle.
  • Support for a REST API providing both a Docker-compatible interface and an improved interface exposing advanced Podman functionality.
  • In the future, integration with CRI-O to share containers and backend code.

Podman presently only supports running containers on Linux. However, we are building a remote client which can run on Windows and OS X and manage Podman containers on a Linux system via the REST API using SSH tunneling.

Roadmap

  1. Further improvements to the REST API, with a focus on bugfixes and implementing missing functionality
  2. Integrate libpod into CRI-O to replace its existing container management backend
  3. Improvements on rootless containers, with a focus on improving the user experience and exposing presently-unavailable features when possible

Communications

If you think you've identified a security issue in the project, please DO NOT report the issue publicly via the GitHub issue tracker, mailing list, or IRC. Instead, send an email with as many details as possible to security@lists.podman.io. This is a private mailing list for the core maintainers.

For general questions and discussion, please use the IRC #podman channel on irc.freenode.net.

For discussions around issues/bugs and features, you can use the GitHub issues and PRs tracking system.

There is also a mailing list at lists.podman.io. You can subscribe by sending a message to podman-join@lists.podman.io with the subject subscribe.

Rootless

Podman can be easily run as a normal user, without requiring a setuid binary. When run without root, Podman containers use user namespaces to set root in the container to the user running Podman. Rootless Podman runs locked-down containers with no privileges that the user running the container does not have. Some of these restrictions can be lifted (via --privileged, for example), but rootless containers will never have more privileges than the user that launched them. If you run Podman as your user and mount in /etc/passwd from the host, you still won't be able to change it, since your user doesn't have permission to do so.

Almost all normal Podman functionality is available, though there are some shortcomings. Any recent Podman release should be able to run rootless without any additional configuration, though your operating system may require some additional configuration detailed in the install guide.

A little configuration by an administrator is required before rootless Podman can be used, the necessary setup is documented here.

Out of scope

  • Specialized signing and pushing of images to various storage backends. See Skopeo for those tasks.
  • Support for the Kubernetes CRI interface for container management. The CRI-O daemon specializes in that.

OCI Projects Plans

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

  • Runtime: We use the OCI runtime tools to generate OCI runtime configurations that can be used with any OCI-compliant runtime, like crun and runc.
  • Images: Image management uses the containers/image library.
  • 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, used by both Podman and CRI-O.
  • Seccomp: A unified Seccomp policy for Podman, Buildah, and CRI-O.

Podman Information for Developers

For blogs, release announcements and more, please checkout the podman.io website!

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 REST API.

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.

Remote Client A brief how-to on using the Podman remote-client.

Basic Setup and Use of Podman in a Rootless environment A tutorial showing the setup and configuration necessary to run Rootless Podman.

Release Notes Release notes for recent Podman versions.

Contributing Information about contributing to this project.

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 Open Container Initiative (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. This allows building images with and without Dockerfiles while not requiring any root privileges. Buildah’s ultimate goal is to provide a lower-level coreutils interface to build images. The flexibility of building images without Dockerfiles allows for the integration of other scripting languages into the build process. Buildah follows a simple fork-exec model and does not run as a daemon but it is based on a comprehensive API in golang, which can be vendored into other tools.

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. For building container images via Dockerfiles, Podman uses Buildah's golang API and can be installed independently from Buildah.

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.

Podman formerly offered a Varlink-based API for remote management of containers. However, this API was replaced by the REST API. Varlink support has been removed as of the 3.0 release. For more details, you can see this blog.

Static Binary Builds

The Cirrus CI integration within this repository contains a static_build job which produces a static Podman binary for testing purposes. Please note that this binary is not officially supported with respect to feature-completeness and functionality and should be only used for testing.