Introduction
With the Image Builder tool, you can create customized system images. Image builder automatically handles the setup details for each output type and is therefore easier to use and faster to work with than manual methods of image creation. You can access the Image Builder functionalities by using the command-line interface, or the Web UI interface. With Image Builder, you can create system images that are prepared for deployment, including system images prepared for clouds, and also images optimized for deployment on edge servers.
This user guide refers primarily to the on premises version of Image Builder. While many of the concepts are transferable to the service, at this point please refer to Red Hat's official documentation.
Image Builder terminology
Image Builder uses the following concepts:
Blueprint
A blueprint is a description of a customized system image. It lists the packages and customizations that will be part of the system. You can edit blueprints with customizations and save them as a particular version. When you create a system image from a blueprint, the image is associated with the blueprint in the image builder interface. Create blueprints in the TOML format.
Compose
Composes are individual builds of a system image, based on a specific version of a particular blueprint. Compose as a term refers to the system image, the logs from its creation, inputs, metadata, and the process itself.
Customizations
Customizations are specifications for the image that are not packages. This includes users, groups, and SSH keys.
Image Builder output formats
Image Builder can create images in multiple output formats shown in the following table.
Table 1. Image Builder output formats
Description | CLI name | File extension |
---|---|---|
QEMU Image | qcow2 | .qcow2 |
Disk Archive | tar | .tar |
Amazon Web Services | raw | .raw |
Microsoft Azure | vhd | .vhd |
Google Cloud Platform | gce | .tar.gz |
VMware vSphere | vmdk | .vmdk |
VMware vSphere | ova | .ova |
Openstack | openstack | .qcow2 |
IoT Commit | iot-commit | .tar |
IoT Container | iot-container | .tar |
IoT Installer | iot-installer | .iso |
IoT Raw Image | iot-raw-image | .raw.xz |
IoT Simplified Installer | iot-simplified-installer | .iso |
IoT AMI | iot-ami | .ami |
IoT VMDK | iot-vmdk | .vmdk |
Installer | live-installer | iso |
Oracle Cloud Infrastructure | oci | .qcow2 |
To check the supported types, run the command:
$ composer-cli compose types