Menu Close

Chapter 2. Setting up Image Builder

Use Image Builder to create your customized RHEL for Edge images. After you install Image Builder on a RHEL system, Image Builder is available as an application in RHEL web console. You can also access Image Builder through a command line interface in the composer-cli tool.


It is recommended to install Image Builder on a virtual machine.

In the environment where you want to install Image Builder, ensure that you first meet the system requirements and then install it.

2.1. Image Builder system requirements

The environment where Image Builder runs, for example a virtual machine, must meet the requirements that are listed in the following table.

Table 2.1. Image Builder system requirements


Minimal Required Value

System type

A dedicated virtual machine


2 cores


4 GiB

Disk space

20 GiB

Access privileges

Administrator level (root)


Connectivity to Internet

2.2. Installing Image Builder

To install Image Builder on a dedicated virtual machine, follow these steps:


  • The virtual machine is created and is powered on.
  • You have installed RHEL and you have subscribed to RHSM or Red Hat Satellite.


  1. Install the following packages on the virtual machine.

    • osbuild-composer
    • composer-cli
    • cockpit-composer
    • Bash-completion
    # dnf install osbuild-composer composer-cli cockpit-composer bash-completion

    Image Builder is installed as an application in RHEL web console.

  2. Reboot the virtual machine
  3. Enable Image Builder.

    # systemctl enable osbuild-composer.socket --now
    # systemctl enable cockpit.socket --now

    The osbuild-composer and cockpit services start automatically on first access.

  4. Configure the system firewall to allow access to the web console:

    # firewall-cmd --add-service=cockpit && firewall-cmd --add-service=cockpit --permanent
  5. Load the shell configuration script so that the autocomplete feature for the composer-cli command starts working immediately without reboot:

    $ source  /etc/bash_completion.d/composer-cli

    Your system must be subscribed to RHSM. After register your system, you can start restart the running osbuild-composer service:

    # systemctl restart osbuild-composer

Additional resources