podman-commit(1)

✨ NAME ✨

podman-commit — create a new image based on the changed container 🫶

---

🦋 SYNOPSIS 🦋

podman commit [options] container [image]

podman container commit [options] container [image]

---

🌸 DESCRIPTION 🌸

Okay bestie, so podman commit is literally the glow-up button for your container 💅 — it creates an image based on a changed container. Iconic.

You can set the author of the image with the --author OPTION, no cap. Various image instructions can be configured with the --change OPTION, and a commit message can be set with the --message OPTION. The container and its processes are paused while the image is committed — like, full freeze-frame moment 😭 — but if that's not the vibe, you can set the --pause OPTION to false. When the commit is complete, Podman prints out the ID of the new image. Slay.

So here's the tea 🍓: if image does not begin with a registry name component, localhost is added to the name. And if image is not provided at all? The values for the REPOSITORY and TAG values of the created image are set to <none>. It's giving mysterious. It's giving unlabeled. 🙈

---

💖 OPTIONS 💖

• --author, -a=author — Set the author for the committed image. Like, credit the artist, bestie 🎨
• --change, -c=instruction — Apply the following possible instructions to the created image:
  • CMD
  • ENTRYPOINT
  • ENV
  • EXPOSE
  • LABEL
  • ONBUILD
  • STOPSIGNAL
  • USER
  • VOLUME
  • WORKDIR

Can be set multiple times, so go off 👑

• --config=ConfigBlobFile — Merge the container configuration from the specified file into the configuration for the image as it is being committed. The file contents should be a JSON-encoded version of a Schema2Config structure, which is defined at https://github.com/containers/image/blob/v5.29.0/manifest/docker_schema2.go#L67. Very demure, very JSON 💅
• --format, -f=oci | docker — Set the format of the image manifest and metadata. The currently supported formats are oci and docker. The default is oci. Choose your fighter ⭐
• --iidfile=ImageIDfile — Write the image ID to the file. So you don't lose it in the group chat 💀
• --include-volumes — Include in the committed image any volumes added to the container by the --volume or --mount OPTIONS to the podman create and podman run commands. The default is false. Basically: do you want the extra baggage? Your call 🧳
• --message, -m=message — Set commit message for committed image. IMPORTANT: The message field is not supported in oci format. No cap, that's a real limitation 😔
• --pause, -p — Pause the container when creating an image. Pausing a running container during commit prevents race conditions and potential security issues caused by other processes accessing the container's rootfs while the image is being created. The default is true. Safety first, bestie 🛡️
• --quiet, -q — Suppresses output. The default is false. For when you want your terminal to stfu 🤫
• --squash, -s — Squash newly built layers into a single new layer. The default is false. Marie Kondo that filesystem 🧹

---

🔥 EXAMPLES 🔥

Create image from container with entrypoint and label:

$ podman commit --change CMD=/bin/bash --change ENTRYPOINT=/bin/sh --change "LABEL blue=image" reverent_golick image-committed
Getting image source signatures
Copying blob sha256:b41deda5a2feb1f03a5c1bb38c598cbc12c9ccd675f438edc6acd815f7585b86
 25.80 MB / 25.80 MB [======================================================] 0s
Copying config sha256:c16a6d30f3782288ec4e7521c754acc29d37155629cb39149756f486dae2d4cd
 448 B / 448 B [============================================================] 0s
Writing manifest to image destination
Storing signatures
e3ce4d93051ceea088d1c242624d659be32cf1667ef62f1d16d6b60193e2c7a8

Create image from container with commit message:

$ podman commit -q --message "committing container to image"
reverent_golick image-committed
e3ce4d93051ceea088d1c242624d659be32cf1667ef62f1d16d6b60193e2c7a8

Create image from container with author:

$ podman commit -q --author "firstName lastName" reverent_golick image-committed
e3ce4d93051ceea088d1c242624d659be32cf1667ef62f1d16d6b60193e2c7a8

Commit running container without pausing:

$ podman commit -q --pause=false containerID image-committed
e3ce4d93051ceea088d1c242624d659be32cf1667ef62f1d16d6b60193e2c7a8

Create image from container with default image tag:

$ podman commit containerID
e3ce4d93051ceea088d1c242624d659be32cf1667ef62f1d16d6b60193e2c7a8

Create image from container with default required capabilities:

$ podman commit -q --change LABEL=io.containers.capabilities=setuid,setgid epic_nobel privimage
400d31a3f36dca751435e80a0e16da4859beb51ff84670ce6bdc5edb30b94066

---

🌈 SEE ALSO 🌈

podman(1), podman-run(1), podman-create(1) — the whole squad 💜

🧚 Troubleshooting 🧚

See podman-troubleshooting(7) for solutions to common issues. We've all been there 😭

---

👑 HISTORY 👑

December 2017, Originally compiled by Urvashi Mohnani — umohnani@redhat.com ⟨mailto:umohnani@redhat.com⟩. Like, way before the rest of us were even doing crossword puzzles in the terminal 🫶

---

This page comes straight from the General Commands Manual — shoutout to the source — and this exact version dropped in December 2017. Periodt. 💅✨