podman-auto-update(1)

πŸ“¦
version 6.1.4 Β· 6 versions
, in alpine 3.24, arch rolling, centos-stream 10, centos-stream 9, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu resolute, ubuntu stonking

✨ podman-auto-update β€” bestie edition ✨

okay so this is the podman-auto-update manual page from the General Commands Manual, and babes, it is literally about letting your containers update THEMSELVES. no cap. πŸ¦‹


🌸 NAME 🌸

podman-auto-update β€” auto update containers according to their auto-update policy πŸ’…


πŸŽ€ SYNOPSIS πŸŽ€

podman auto-update [options]

✨ DESCRIPTION ✨

So podman auto-update pulls down new container images and restarts containers that are configured for auto updates. That's it, that's the whole vibe. πŸ’–

But here's the thing bestie β€” to even use auto updates, the container or Kubernetes workloads must run inside a systemd unit. After an image updates successfully, the containers using that image get updated by restarting the systemd units they run in. Wanna know how to run Podman under systemd? Go read podman-systemd.unit(5). go go go πŸƒβ€β™€οΈ

To configure a container for auto updates, it has to be created with the io.containers.autoupdate label, or the AutoUpdate field in podman-systemd.unit(5), set to one of these two values:

  • registry β€” If the label is present and set to registry, Podman reaches out to the corresponding registry to check if the image has been updated. The label image is an alternative to registry maintained for backwards compatibility. An image counts as updated if the digest in the local storage is different than the one of the remote image. If an image must be updated, Podman pulls it down and restarts the systemd unit executing the container. Lowkey important: the registry policy requires a fully-qualified image reference (e.g., quay.io/podman/stable:latest) to be used to create the container. This enforcement is necessary to know which image to actually check and pull. If an image ID was used, Podman would not know which image to check/pull anymore. πŸ’€
  • local β€” If the autoupdate label is set to local, Podman compares the image digest of the container to the one in the local container storage. If they differ, the local image is considered to be newer and the systemd unit gets restarted. slay ✨

🧚 Auto Updates and Kubernetes YAML 🧚

Podman supports auto updates for Kubernetes workloads too, bestie. The auto-update policy can be configured directly via podman-systemd.unit(5) or inside the Kubernetes YAML with these Podman-specific annotations:

  • io.containers.autoupdate: "registry|local" β€” applies the auto-update policy to all containers
  • io.containers.autoupdate/$container: "registry|local" β€” applies the auto-update policy to $container only
  • io.containers.sdnotify: "conmon|container" β€” applies the sdnotify policy to all containers
  • io.containers.sdnotify/$container: "conmon|container" β€” applies the sdnotify policy to $container only

By default, the autoupdate policy is set to "disabled", and the sdnotify policy is set to "conmon". periodt πŸ’…

🌈 Systemd Unit and Timer 🌈

Podman ships with a podman-auto-update.service systemd unit. This unit is triggered daily at midnight by the podman-auto-update.timer systemd timer. ⏰ The timer can be altered for custom time-based updates if you want. The unit can further be invoked by other systemd units (e.g., via the dependency tree) or manually via systemctl start podman-auto-update.service. main character energy fr fr πŸ‘‘


πŸ’… OPTIONS πŸ’…

  • --authfile=path β€” Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json on Linux, and $HOME/.config/containers/auth.json on Windows/macOS. The file is created by podman login. If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using docker login.

Note: There is also the option to override the default path of the authentication file by setting the REGISTRY_AUTH_FILE environment variable. This can be done with export REGISTRY_AUTH_FILE=path.

Alternatively, the io.containers.autoupdate.authfile container label can be configured. In that case, Podman will use the specified label's value instead. 🫢

  • --dry-run β€” Check for the availability of new images but do not perform any pull operation or restart any service or container. The UPDATED field indicates the availability of a new image with "pending". no notes, iconic πŸ™ˆ
  • --format=format β€” Change the default output format. This can be of a supported type like 'json' or a Go template. Valid placeholders for the Go template are listed below:
    • .Container β€” ID and name of the container
    • .ContainerID β€” ID of the container
    • .ContainerName β€” Name of the container
    • .Image β€” Name of the image
    • .Policy β€” Auto-update policy of the container
    • .Unit β€” Name of the systemd unit
    • .Updated β€” Update status: true,false,failed,pending
  • --rollback β€” If restarting a systemd unit after updating the image has failed, rollback to using the previous image and restart the unit another time. Default is true.
Note that detecting if a systemd unit has failed is best done by the container sending the READY message via SDNOTIFY. This way, restarting the unit waits until having received the message or a timeout kicked in. Without that, restarting the systemd unit may succeed even if the container has failed shortly after. 😭

For a container to send the READY message via SDNOTIFY it must be created with the --sdnotify=container option (see podman-run(1)). The application running inside the container can then execute systemd-notify --ready when ready, or use the sdnotify bindings of the specific programming language (e.g., sd_notify(3)). 🧚

  • --tls-verify β€” Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, TLS verification is used. If set to false, TLS verification is not used. If not specified, TLS verification is used unless the target registry is listed as an insecure registry in containers-registries.conf(5). πŸ”₯

πŸ“ EXAMPLES πŸ“

Create a Quadlet file configured for auto updates:

$ cat ~/.config/containers/systemd/sleep.container
[Container]
Image=registry.fedoraproject.org/fedora:latest
Exec=sleep infinity
AutoUpdate=registry

Generate a systemd service from the Quadlet file by reloading the systemd user daemon:

$ systemctl --user daemon-reload

Start the systemd service and make sure the container is running:

$ systemctl --user start sleep.service
$ podman ps
CONTAINER ID  IMAGE                                     COMMAND         CREATED        STATUS        PORTS       NAMES
f8e4759798d4  registry.fedoraproject.org/fedora:latest  sleep infinity  2 seconds ago  Up 2 seconds              systemd-sleep

Check if a new image is available via --dry-run:

$ podman auto-update --dry-run --format "{{.Image}} {{.Updated}}"
registry.fedoraproject.org/fedora:latest   pending

Update the service:

$ podman auto-update
UNIT           CONTAINER                     IMAGE                                     POLICY      UPDATED
sleep.service  f8e4759798d4 (systemd-sleep)  registry.fedoraproject.org/fedora:latest  registry    true

πŸ‘€ SEE ALSO πŸ‘€

podman(1), podman-generate-systemd(1), podman-run(1), podman-systemd.unit(5), sd_notify(3), systemd.unit(5)


okay that's the whole page bestie, you ate that πŸ’– this was podman-auto-update(1) from the General Commands Manual, and the source/version + date at the bottom say podman-auto-update(1) β€” go forth and let your containers update themselves, mwah 🫢✨

πŸ“¦ where this page comes from