| KEG(1) | Keg - Image Composition Tool | KEG(1) |
NAME¶
keg - Image Composition Tool
SYNOPSIS¶
keg [options] <source>
DESCRIPTION¶
keg is a tool which helps to create and manage image descriptions suitable for the KIWI appliance builder. While keg can be used to manage a single image definition the tool provides no considerable advantage in such a use case. The primary use case for keg are situations where many image descriptions must be managed and the image descriptions have considerable overlap with respect to content and setup.
keg requires source data called recipes which provides all information necessary for keg to create KIWI image descriptions. See Recipes basics for more information about recipes.
The recipes used for generating SUSE Public Cloud image descriptions can be found in the Public Cloud Keg Recipes repository.
ARGUMENTS¶
source
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: .]
- --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:
- --format-xml
- Format/Update Keg written image description to installed KIWI schema and
write the result description in XML markup
NOTE:
- -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 used to generate a change log from the recipes repository commit log.
- -v, --verbose
- Enable verbose output
- --version
- Print version
EXAMPLE¶
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¶
2023, SUSE - Public Cloud Team
| July 28, 2023 | 2.1.1 |