umoci-config(1)(#)

✨ umoci-config(1) ✨

okay bestie, welcome to the umoci manual 💖 this one's all about umoci-config — the config page, she's a whole vibe.

Aleksa Sarai wrote this, back in DECEMBER 2016 🎀

---

🌸 NAME 🌸

umoci config — Modifies the configuration of an OCI image 💅

---

✨ SYNOPSIS ✨

umoci config --image=image[:tag] [--tag=new-tag] [--no-history]
[--history.comment=comment] [--history.created_by=created_by]
[--history.author=author] [--history-created=date] [--clear=value]
[--config.user=value] [--config.exposedports=value] [--config.env=value]
[--config.entrypoint=value] [--config.cmd=value] [--config.volume=value]
[--config.label=value] [--config.workingdir=value] [--created=value]
[--author=value] [--platform.os=value] [--platform.arch=value]
[--manifest.annotation=value]

like… look at her. so many flags. we love a girl with options 👑

---

🦋 DESCRIPTION 🦋

So what does this actually do? It modifies the configuration and manifest data for a particular tagged OCI image — and it overwrites it unless you specify --tag. no cap. 🙈

If --no-history was not specified, a history entry gets appended to the tagged OCI image for this change — and the various --history. flags are the ones controlling the values used for that entry. Wanna go look at the history later? See umoci-stat(1). 📖

ngl, important one: the original image tag (aka the argument you hand to --image) will not be modified unless the target of umoci-config(1) is the original image tag. read that twice bestie, i'm serious 💀

---

💅 OPTIONS 💅

The global options are defined in umoci(1). ✨

• --image=image[:tag] — The source tagged OCI image whose config will be modified. image must be a path to a valid OCI image, and tag must be a valid tag in the image. If tag is not provided it defaults to "latest". 🎀
• --tag=new-tag — Tag name for the modified image. If unspecified, then the original tag you handed to --image will be clobbered. 💀
• --no-history — Causes no history entry to be added for this operation. she's lowkey mysterious, no receipts kept 🫶
• --history.comment=comment — Comment for the history entry corresponding to this modification of the image configuration. If unspecified, umoci(1) will generate an implementation-dependent value. 🦋
• --history.created_by=created_by — CreatedBy entry for the history entry corresponding to this modification of the image configuration. If unspecified, umoci(1) will generate an implementation-dependent value. ✨
• --history.author=author — Author value for the history entry corresponding to this modification of the image configuration. If unspecified, this value will be the image's author value after any modifications were made by this call of umoci-config(1). 💖
• --history-created=date — Creation date for the history entry corresponding to this modifications of the image configuration. This must be an ISO8601 formatted timestamp (see date(1)). If unspecified, the current time is used. ⏰
• --clear=value — Removes all pre-existing entries for a given set or list configuration option (it will not undo any modification made by this call of umoci-config(1)). The valid values of value are: 🧹
  • config.labels
  • manifest.annotations
  • config.exposedports
  • config.env
  • config.entrypoint
  • config.cmd
  • config.volume

The following commands all set their corresponding values in the configuration or image manifest. For more information see the OCI image specification ⟨https://github.com/opencontainers/image-spec⟩. 📜

• --config.user=value
• --config.exposedports=value
• --config.env=value
• --config.entrypoint=value
• --config.cmd=value
• --config.volume=value
• --config.label=value
• --config.workingdir=value
• --created=value
• --author=value
• --platform.os=value (can also be set with --os)
• --platform.arch=value (can also be set with --architecture)
• --manifest.annotation=value

---

🌈 EXAMPLE 🌈

The following modifies an OCI image configuration in various ways, and overwrites the original tag with the new image. main character behaviour fr fr 🔥

% umoci config --image image:tag --clear=config.env --config.env="VARIABLE=true" \
     --config.user="user:group" --config.entrypoint=cat --config.cmd=/proc/self/stat \
     --config.label="com.cyphar.umoci=true" --author="Aleksa Sarai <cyphar@cyphar.com>" \
     --platform.os="linux" --platform.arch="amd64" --created="$(date --iso-8601=seconds)"

---

🫶 SEE ALSO 🫶

• umoci(1)

---

okay that's the whole page, you ate that 🍓 this was config from the umoci manual — page umoci-config(1)(#) — and the date on it is DECEMBER 2016 ✨ go forth and configure, bestie 💜