Podman: A tool for managing OCI containers and pods.
 
 
 
 
 
 
Go to file
openshift-merge-bot[bot] e4719cb7cd
Merge pull request #21788 from containers/renovate/github.com-klauspost-compress-1.x
Update module github.com/klauspost/compress to v1.17.7
2024-02-23 11:06:36 +00:00
.fmf [CI:BUILD] Packit: run cockpit-podman tests in PRs 2023-08-24 18:29:44 +02:00
.github Remove gitleaks scanning 2024-02-09 10:09:42 -05:00
cmd Merge pull request #21517 from jakecorrenti/fix-qemu-todos 2024-02-22 21:21:50 +00:00
cni docs: make CNI removal explicit 2023-11-06 10:45:59 +01:00
completions update completion scripts for cobra v1.8.0 2023-11-06 15:27:07 +01:00
contrib Merge pull request #21639 from cevich/require_build 2024-02-22 21:05:08 +00:00
dependencies/analyses ginkgo: restructure install work flow 2022-11-25 14:41:43 +01:00
docker Handle DOCKER_HOST environment for podman-docker package 2024-02-12 16:05:38 -05:00
docs Merge pull request #21517 from jakecorrenti/fix-qemu-todos 2024-02-22 21:21:50 +00:00
hack Fix Lint on Windows and enable the job 2024-02-20 08:06:18 -05:00
libpod libpod/events: remove duplicated Details ID field 2024-02-22 13:37:27 +01:00
logo logo: correct light source reflection 2019-11-03 09:24:12 +00:00
pkg Merge pull request #21517 from jakecorrenti/fix-qemu-todos 2024-02-22 21:21:50 +00:00
plans [CI:BUILD] Packit: Enable failure notifications for cockpit tests 2023-09-20 08:42:36 +02:00
rpm Handle DOCKER_HOST environment for podman-docker package 2024-02-12 16:05:38 -05:00
test Merge pull request #21793 from mtrmac/allow-zstd-config 2024-02-22 22:02:55 +00:00
utils Run codespell on code 2024-01-28 07:30:52 -05:00
vendor Merge pull request #21788 from containers/renovate/github.com-klauspost-compress-1.x 2024-02-23 11:06:36 +00:00
version Bump to v5.0.0-dev 2024-02-08 09:35:39 -05:00
.cirrus.yml Merge pull request #21639 from cevich/require_build 2024-02-22 21:05:08 +00:00
.dockerignore Cirrus: Fix gate image & false-positive exits 2020-03-02 08:50:54 -05:00
.gitignore Add Japanese locale and translation of index 2023-08-31 13:53:48 +09:00
.golangci.yml [CI:DOCS] Update dependency golangci/golangci-lint to v1.56.1 2024-02-13 11:02:56 +01:00
.packit.sh [CI:BUILD] Packit: show SHORT_SHA in `podman --version` for COPR builds 2023-09-22 10:18:44 -04:00
.packit.yaml [skip-ci] Packit: Update downstream task targets 2024-02-19 19:28:57 +05:30
.pre-commit-config.yaml Quadlet - fix trailing whitespaces handling 2024-01-02 12:26:44 +02:00
.readthedocs.yaml [CI:DOCS]rtd: implement v2 build file 2023-10-11 14:35:32 -05:00
CODE-OF-CONDUCT.md Fix docs links due to branch rename 2021-06-10 11:30:41 -04:00
CONTRIBUTING.md GHA: Add workflow to lock closed issues/PRs 2023-08-22 13:30:03 -04:00
DISTRO_PACKAGE.md [CI:DOCS] DISTRO_PACKAGE.md: List the packaging changes for v4 2022-03-07 11:34:05 -05:00
DOWNLOADS.md Fix artifacts script after removal of msitools msi build 2023-07-26 20:29:26 -05:00
ISSUE-EOL-POLICY.md End-of-Life policy for github issues 2023-11-01 08:31:28 -06:00
LICENSE Globally replace http:// with https:// 2021-08-27 06:14:46 -04:00
Makefile Build with CNI support on FreeBSD 2024-02-20 12:57:45 +00:00
OWNERS [CI:DOCS]Periodic update to OWNERS file 2024-01-08 14:00:37 -05:00
README.md Readme updates for Podman 2024-02-13 11:34:58 -05:00
RELEASE_NOTES.md Add v4.8, v4.9 to release notes 2024-02-08 09:35:39 -05:00
RELEASE_PROCESS.md Test PR, add a inconsequential period to docs 2024-02-14 14:47:39 -05:00
SECURITY.md SECURITY.md: fix the project name 2022-01-18 17:06:42 -08:00
Vagrantfile Enhancements to papr tests 2017-11-17 02:07:18 +00:00
build_osx.md docs/build_osx.md: Describe external gvproxy 2024-01-02 13:31:30 -05:00
build_windows.md docs: fix typos 2024-01-04 12:10:11 +02:00
commands-demo.md chore: remove unused link 2024-01-03 09:29:58 +08:00
commands.md docs: update the podman logo 2022-08-07 09:11:53 +08:00
go.mod Merge pull request #21788 from containers/renovate/github.com-klauspost-compress-1.x 2024-02-23 11:06:36 +00:00
go.sum Merge pull request #21788 from containers/renovate/github.com-klauspost-compress-1.x 2024-02-23 11:06:36 +00:00
install.md update website link for install instructions 2020-12-06 21:38:10 -06:00
pyproject.toml Refactor docker-py compatibility tests 2022-03-01 09:06:52 -07:00
rootless.md Wording 2023-04-23 18:07:09 +00:00
transfer.md [CI:DOCS] podman-mount: s/umount/unmount/ 2022-12-15 12:30:40 +01:00
troubleshooting.md Added an additional troubleshooting problem and solution 2023-08-29 09:41:38 -04:00
winmake.ps1 Bump Go module to v5 2024-02-08 09:35:39 -05:00

README.md

PODMAN logo

Podman: A tool for managing OCI containers and pods

License GitHub release (latest SemVer) Go Report Card


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 runs containers on Linux, but can also be used on Mac and Windows systems using a Podman-managed virtual machine. 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.

All releases are GPG signed. Public keys of members of the team approved to make releases are located here.

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.
  • Full management of container networking, using Netavark.
  • 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, which can both run containers locally and on remote systems.
  • 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.
  • Support for running on Windows and Mac via virtual machines run by podman machine.

Roadmap

  1. Further improvements to podman machine to better support Podman Desktop and other developer usecases.
  2. Support for conmon-rs, which will improve container logging.
  3. Support for the BuildKit API.
  4. Performance and stability improvements.
  5. Reductions to the size of the Podman binary.

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 Podman's channels.

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.

Podman Desktop

Podman Desktop provides a local development environment for Podman and Kubernetes on Linux, Windows, and Mac machines. It is a full-featured desktop UI frontend for Podman which uses the podman machine backend on non-Linux operating systems to run containers. It supports full container lifecycle management (building, pulling, and pushing images, creating and managing containers, creating and managing pods, and working with Kubernetes YAML). The project develops on GitHub and contributors are welcome.

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

Podman uses 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 Netavark and Aardvark. Rootless networking is handled via slirp4netns.
  • 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. Buildahs 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 Hello

$ podman run quay.io/podman/hello
Trying to pull quay.io/podman/hello:latest...
Getting image source signatures
Copying blob a6b3126f3807 done
Copying config 25c667d086 done
Writing manifest to image destination
Storing signatures
!... Hello Podman World ...!

         .--"--.
       / -     - \
      / (O)   (O) \
   ~~~| -=(,Y,)=- |
    .---. /`  \   |~~
 ~/  o  o \~~~~.----. ~~
  | =(X)= |~  / (O (O) \
   ~~~~~~~  ~| =(Y_)=-  |
  ~~~~    ~~~|   U      |~~

Project:   https://github.com/containers/podman
Website:   https://podman.io
Documents: https://docs.podman.io
Twitter:   @Podman_io