podman README

The project's README from github.com/podman-container-tools/podman. As one markdown file: README.md.

PODMAN logo

Podman: A tool for managing OCI containers and pods

License GitHub release (latest SemVer) Go Report Card OpenSSF Best Practices

LFX Health Score LFX Contributors


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.

Podman releases a new major or minor release 4 times a year, during the second week of February, May, August, and November. Patch releases are more frequent and may occur at any time to get bugfixes out to users. All releases are PGP signed. Public keys of members of the team approved to make releases are located here.

Only the most recent release receives upstream support. Exceptions are sometimes made after a major Podman release, in recognition of the fact that not all users and distributions will be able to quickly migrate to a breaking change release. After the release of Podman 6.0, the Podman maintainers have decided to extend upstream support of the v5.8 series of releases until the 2nd week of June in 2027, one year after the release of Podman 6.0. This support will only include CVE fixes and critical bugfixes.

Overview and scope

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

Roadmap

The future of Podman feature development can be found in its roadmap.

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 [email protected]. 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 [email protected] with the subject subscribe.

Community Meetings

All Podman meetings are open to everyone, free to attend, and hosted via Zoom through the CNCF/Linux Foundation. The full calendar is available on the Podman Container Tools LFX Meetings page. Registering for a meeting sends you an invite for that meeting and all subsequent recurring instances.

Meeting Schedule Format
Podman Community Meeting and its agenda First Tuesday of even-numbered months (Feb, Apr, Jun, Aug, Oct, Dec) at 11:00 a.m. Eastern (UTC-4 summer / UTC-5 winter) ~1 hour — demos, announcements, and community updates
Podman Monday Office Hours and its agenda Every Monday at 10:00 a.m. Eastern (UTC-4 summer / UTC-5 winter) 30 min — technical discussions, open topics
Podman Thursday Office Hours and its agenda Every Thursday at 11:00 a.m. Eastern (UTC-4 summer / UTC-5 winter) 30 min — technical discussions, open topics

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 contributions are welcome.

Out of scope

OCI Projects Plans

Podman uses OCI projects and best of breed libraries for different aspects:

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 Container Images Information on the Podman Container Images found on quay.io.

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 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

podman (podman-container-tools/podman)

Searching Database…

33.1K ·GitHub
这是干什么的?Podman(即 POD MANager)是一个用来管理 OCI 容器和镜像、存储卷以及 pod(即一起管理的一组容器)的工具。它构建在 libpod 之上——libpod 是一个容器生命周期管理库,就包含在同一个代码仓库里。
它是用来替代 Docker 的吗?还是需要先装好 Docker?它是一个独立的、无守护进程的容器引擎:命令行界面与 Docker 兼容(在本地和对远程系统上都适用),但不会运行任何管理守护进程——README 认为这样就带来了更好的安全性和更低的空闲资源占用。
Podman 有没有刻意不做的事情?有两项工作被有意留给了姊妹项目:专门的镜像签名和推送到存储后端(这是 Skopeo 的职责),以及 Kubernetes 的 CRI 接口(由 CRI-O 守护进程负责)。
它能在 Mac 和 Windows 上原生运行吗?还是只支持 Linux?容器只能在 Linux 上原生运行;在 Mac 和 Windows 上,Podman 会通过 podman machine 在它所管理的虚拟机里运行容器。Podman Desktop 则为这三种系统都提供了图形界面。
什么是 pod?pod 是一组共享资源、作为一个整体统一管理的容器。Podman 在管理单个容器的同时也能管理 pod 的完整生命周期,因此相关的容器可以作为一体来运行和清理。
有图形界面吗?有——Podman Desktop 是一个功能完整的图形界面,支持 Linux、Windows 和 Mac 上的 Podman 和 Kubernetes。它覆盖容器的整个生命周期(构建、拉取和推送镜像,管理容器、pod 以及 Kubernetes YAML),并在非 Linux 系统上驱动 podman machine。
What are similar projects?runc, k9s, buildkit, containerd, grype, lima, skopeo, distribution
Size
184.4 MB
Stars
33.1K
Age
8y
Commits · 90 Days