KEG(1)

🎀 KEG(1) — keg, the Image Composition Tool 🎀

bestie, welcome to the KEG(1) manual page for keg, aka the Image Composition Tool. It's giving useful Unix with a cute bow on top, and I'm obsessed. 💖

🌸 NAME 🌸

keg — Image Composition Tool. That's the name, periodt. 💅

✨ SYNOPSIS ✨

keg [options] <source>

🦋 DESCRIPTION 🦋

okay so keg is a tool that helps you create and manage image descriptions suitable for the KIWI appliance builder. Lowkey it can be used to manage a single image definition, but ngl the tool provides no considerable advantage in such a use case. The primary use case — the main character energy — is when you've got many image descriptions to manage, and those image descriptions have considerable overlap with respect to content and setup. 💅

keg requires source data called recipes, and those recipes provide all information necessary for keg to create KIWI image descriptions. For the full rundown, see Recipes basics. 🍓

The recipes used for generating SUSE Public Cloud image descriptions can be found in the Public Cloud Keg Recipes repository. iykyk. ✨

🧚 ARGUMENTS 🧚

• source — Path to image source under RECIPES_ROOT/images. This is the path bestie, don't skip it. 🫶

👑 OPTIONS 👑

• -r RECIPES_ROOT, --recipes-root=RECIPES_ROOT — Root directory of keg recipes. Can be used more than once. Elements from later roots may overwrite earlier one. 🌈
• -d DEST_DIR, --dest-dir=DEST_DIR — Destination directory for generated description [default: .]. Slay, output goes here. 🎀
• --disable-multibuild — Option to disable creation of OBS _multibuild file (for image definitions with multiple profiles). [default: false]
• --disable-root-tar — Option to disable the creation of root.tar.gz in destination directory. If present, an overlay tree will be created instead. [default: false]
• --dump-dict — Dump generated data dictionary to stdout instead of generating an image description. Useful for debugging. 🔥
• -l, --list-recipes — List available images that can be created with the current recipes.
• -f, --force — Force mode (ignore errors, overwrite files).
• --format-yaml — Format/Update Keg written image description to installed KIWI schema and write the result description in YAML markup.
  • NOTE: Currently no translation of comment blocks from the Keg generated KIWI description to the YAML markup will be performed.
• --format-xml — Format/Update Keg written image description to installed KIWI schema and write the result description in XML markup.
  • NOTE: Currently only top-level header comments from the Keg written image description will be preserved into the formatted/updated KIWI XML file. Inline comments will not be preserved.
• -i IMAGE_VERSION, --image-version=IMAGE_VERSION — Set image version.
• -a ARCH — Generate image description for architecture ARCH (can be used multiple times).
• -s, --write-source-info — Write a file per profile containing a list of all used source locations. The files can be used to generate a change log from the recipes repository commit log. 🗂️
• -v, --verbose — Enable verbose output.
• --version — Print version.

🍓 EXAMPLE 🍓

this is literally the example, bestie:

git clone https://github.com/SUSE-Enceladus/keg-recipes.git

keg --recipes-root keg-recipes --dest-dir leap_description leap/jeos/15.2

💌 AUTHOR 💌

public-cloud-dev@susecloud.net

🌈 COPYRIGHT 🌈

2022, SUSE - Public Cloud Team

---

and that's the whole page, bestie! This cutie is version 2.1.1, dated Jan 31, 2025 — mwah 💋✨