buildah-ma...st-annotate(1)

✨ buildah-manifest-annotate ✨

hiii bestie 🫶 welcome to the buildah-manifest-annotate page from the General Commands Manual. this is the tool that hypes up your manifest lists and image indexes with extra info. it's giving backstage-pass energy. 💅

---

🌸 NAME 🌸

buildah-manifest-annotate — add and update information about an image or artifact to a manifest list or image index. that's literally the whole job. 🦋

---

🎀 SYNOPSIS 🎀

buildah manifest annotate [options...] listNameOrIndexName
imageManifestDigestOrImageOrArtifactName

okay so you're handing it a list/index name and the digest (or image name, or artifact name) of the thing you wanna annotate. both. always. no skipping. 😤

---

💜 DESCRIPTION 💜

it adds or updates information about an image or artifact that's included in a manifest list or image index.

that's it!! that's the description!! short and iconic, we love a lowkey queen. ✨

---

⭐ RETURN VALUE ⭐

you get back the list image's ID and the digest of the image's manifest. slay. 💖

---

🔥 OPTIONS 🔥

• --annotation annotation=value — sets an annotation on the entry for the image or artifact you picked. but wait 🫢 if you also pass --index, it sets that annotation on the entire image index instead of on one entry. big difference, bestie.
• --arch — overrides the architecture that the list or index records as a requirement for the image. normally this gets pulled automatically from the image's configuration info, so ngl you'll rarely need this one. it's a "just in case" button. 🙈
• --features — specifies the features list that the list or index records as requirements for the image. also rarely used. it's giving background character. 💀
• --index — treats the arguments you pass to --annotation as annotation values to set on the image index itself rather than on an entry inside the image index. it's also implied for --subject, so heads up. 🎀
• --os — overrides the OS that the list or index records as a requirement for the image. just like --arch, it's usually grabbed automatically from the image's configuration info, so you'll rarely need it. 🦋
• --os-features — specifies the OS features list that the list or index records as requirements for the image. once again: rarely used. periodt. 💅
• --os-version — specifies the OS version that the list or index records as a requirement for the image. you guessed it — rarely used. 🌸
• --subject imageName — sets the subject field in the image index, marking that image index as being associated with the specified image in some way. ⚠️ and listen: an image index can only be associated with, at most, one subject. one. singular. don't be greedy. 😭
• --variant — specifies the variant that the list or index records for the image. this one's typically used to tell apart multiple entries that share the same architecture value but expect different versions of its instruction set. very demure, very specific. 👑

---

🌈 EXAMPLE 🌈

first up, overriding arch and variant while pointing at a specific manifest digest:

buildah manifest annotate --arch arm64 --variant v8 mylist:v1.11 sha256:c829b1810d2dbb456e74a695fd3847530c8319e5a95dca623e9f1b1b89020d8b
506d8f4bb54931ea03a7e70173a0ed6302e3fb92dfadb3955ba5c17812e95c51: sha256:c829b1810d2dbb456e74a695fd3847530c8319e5a95dca623e9f1b1b89020d8b

and then the --index + --annotation combo, where the annotation lands on the index itself:

buildah manifest annotate --index --annotation food=yummy mylist:v1.11
506d8f4bb54931ea03a7e70173a0ed6302e3fb92dfadb3955ba5c17812e95c51: sha256:c829b1810d2dbb456e74a695fd3847530c8319e5a95dca623e9f1b1b89020d8b

nope, we did not make up food=yummy. it's literally in the manual. iconic behaviour honestly. 🍓

---

👑 SEE ALSO 👑

go read these too, they're the friend group:

• buildah(1)
• buildah-manifest(1)
• buildah-manifest-create(1)
• buildah-manifest-add(1)
• buildah-manifest-remove(1)
• buildah-manifest-inspect(1)
• buildah-manifest-push(1)
• buildah-rmi(1)

---

aaaand that's the whole page bestie!! 🎉 this one comes from the buildah manual, dated September 2019. go forth and annotate, you absolute main character. 🫶💖✨