Skip to content

Latest commit

 

History

History
125 lines (92 loc) · 6.8 KB

README.md

File metadata and controls

125 lines (92 loc) · 6.8 KB

podman binaries and container images GitHub workflow badge

This project provides alpine-based podman container images and statically linked (rootless) podman binaries for linux/amd64 and linux/arm64/v8 machines along with its dependencies (without systemd support):

CNI has been replaced as the default. See also: Podman Networking Docs

Container image

The following image tags are supported:

Tag Description
latest, <VERSION> podman with both rootless and rootful dependencies: runc, conmon, fuse-overlayfs, slirp4netns, netavark, CNI plugins, catatonit.
minimal, <VERSION>-minimal podman, crun, fuse-overlayfs and conmon binaries, configured to use the host's existing namespaces (low isolation level).
remote, <VERSION>-remote the podman remote binary.

By default containers run with user root. However, in a standard configuration, podman user (uid/gid 1000) may be utilized. The subuid/gid mapping is configured with the image (described within the binary installation section below).

Please note that, when running non-remote podman within a docker container, the docker container will need --privileged flag.

Container usage example

Run podman in docker:

docker run --privileged -u podman:podman ghcr.io/trentapple/podman:minimal docker run alpine:latest echo hello from nested container

docker is linked to podman within the container to support applications that may rely on the docker command.

Binary installation on a host

If using an arm64 (aarch64) machine (e.g. a Raspberry Pi) then substitute "amd64" with "arm64" in the commands below to ensure the installation is compatible with your machine's architecture.

Download the statically linked binaries of podman and its dependencies:

curl -fsSL -o podman-linux-amd64.tar.gz https://github.com/trentapple/podman-static/releases/latest/download/podman-linux-amd64.tar.gz

Verify the archive's signature (optional, but recommended):

curl -fsSL -o podman-linux-amd64.tar.gz.asc https://github.com/trentapple/podman-static/releases/latest/download/podman-linux-amd64.tar.gz.asc
gpg --keyserver hkps://keyserver.ubuntu.com --recv-keys F21FFB49829AC71EEDC6AD1E7D6456922DAE0D70
gpg --batch --verify podman-linux-amd64.tar.gz.asc podman-linux-amd64.tar.gz

It is possible for this to fail due to desync/unavailable key servers. If that is the case then please retry.

Download a specific version:

VERSION=<VERSION>
curl -fsSL -o podman-linux-amd64.tar.gz https://github.com/trentapple/podman-static/releases/download/$VERSION/podman-linux-amd64.tar.gz

Install the binaries and configuration on your host after you've inspected the archive:

tar -xzf podman-linux-amd64.tar.gz
sudo cp -r podman-linux-amd64/usr podman-linux-amd64/etc /

If you have docker installed on the same host it might be broken until you remove the newly installed /usr/local/bin/runc binary since older docker versions are not compatible with the latest runc version provided here while podman is also compatible with the older runc version that comes e.g. with docker 1.19 on Ubuntu.

To install podman on a host without having any root privileges, you need to copy the binaries and configuration into your home directory and adjust the binary paths within the configuration correspondingly. For more information see podman's rootless installation instructions.

Host configuration

The following binaries should be installed on your host:

  • iptables
  • nsenter
  • uidmap (for rootless mode)

nftables (with or without optional iptables-nft wrapper)

In order to run rootless containers that use multiple uids/gids you may want to set up a uid/gid mapping for your user on your host:

sudo sh -c "echo $(id -un):100000:200000 >> /etc/subuid"
sudo sh -c "echo $(id -gn):100000:200000 >> /etc/subgid"

Please esure you only successfully run these mapping commands one time. If you run them multiple times you will have extra mappings that will not be used and the system may not operate as expected.

For support applications / scripts that rely on the docker command one quick option is to link podman as follows:

sudo ln -s /usr/local/bin/podman /usr/local/bin/docker

There is also an equivalent docker socket that can be used by podman for applications that leverage the docker API.

Before updating binaries on your host please terminate all corresponding processes.

Restart containers on boot

To restart containers with restart-policy=always on boot, enable the podman-restart systemd service:

systemctl enable podman-restart

Binary usage example

podman run alpine:latest echo hello from podman

Default persistent storage location

The default storage location depends on the user (may vary based on STORAGE_DRIVER environment variable or --storage-driver flag)

  • root: For root storage is located at /var/lib/containers/storage.

  • rootless: For an unprivileged user storage is located at ~/.local/share/containers/storage.

  • Default configuration (depending on if CONTAINERS_CONF environment variable or --config flag is set)

    • rootless: ~/.config/containers/contains.conf (user-specific)
    • root: /etc/containers/containers.conf (system-wide)

Local build & test

make images test