Menu Close

Chapter 4. Composing a RHEL for Edge image using Image Builder in RHEL web console

Use Image Builder to create a custom RHEL for Edge image (OSTree commit).

To access Image Builder and to create your custom RHEL for Edge image, you can either use the RHEL web console interface or the command-line interface. This section provides information about accessing Image Builder and creating RHEL for Edge images using the RHEL web console.

You can compose RHEL for Edge images using Image Builder in RHEL web console by performing the following high-level steps:

  1. Access Image Builder in RHEL web console
  2. Create a blueprint for RHEL for Edge image. You can create the following blueprints:

    • Blueprint with customizations for "RHEL for Edge Commit (.tar)" or "RHEL for Edge Container (.tar)" images
    • Blueprint for "RHEL for Edge Installer (.iso)" images
  3. Create a user account for the RHEL for Edge image blueprint
  4. Create a RHEL for Edge image. You can create the following images:

    • Creating a RHEL for Edge Commit image using Image Builder in RHEL web console
    • Creating a RHEL for Edge Container image using Image Builder in RHEL web console
    • Creating a RHEL for Edge Installer image using Image Builder in RHEL web console
  5. Download the RHEL for Edge image

4.1. Accessing Image Builder in the RHEL web console

To access Image Builder in RHEL web console, ensure that you have met the following prerequisites and then follow the procedure.

Prerequisites

  • You have installed a RHEL system.
  • You have administrative rights on the system.
  • You have subscribed the RHEL system to Red Hat Subscription Manager (RHSM) or to Red Hat Satellite server.
  • The system is powered on and accessible over network.
  • You have installed Image Builder on the system.

Procedure

  1. On the RHEL system, access https://localhost:9090/ in a web browser.
  2. For more information about how to remotely access Image Builder, see Managing systems using the RHEL 9 web console document.
  3. Log in to the web console using an administrative user account.
  4. On the web console, in the left hand menu, click Apps.
  5. Click Image Builder.
  6. The Image Builder dashboard opens in the right pane.
  7. You can now proceed to create a blueprint for the RHEL for Edge images.

4.2. Creating a blueprint for the RHEL for Edge Commit image using Image Builder in RHEL web console

To create a blueprint for the RHEL for Edge Commit image using Image Builder in RHEL web console, ensure that you have met the following prerequisites and then follow the procedure.

Prerequisites

  • On a RHEL system, you have opened the Image Builder dashboard.

Procedure

  1. On the Image Builder dashboard, click Create Blueprint.

    The Create Blueprint dialogue box opens.

  2. Specify a name and description for the blueprint that you want to create.
  3. Click Create.

    The dashboard displays a list of available components.

    Note

    Your system must be subscribed to RHSM, otherwise, the list of available components appears as “Loading”.

  4. To search for a specific component, enter the component name in the Filter By Name text box, and press Enter. The Component Details pane displays the component details and its dependent components.

    You can select the required version. The web console selects the latest version by default.

  5. In the Components Details pane, click Add.

    If you want to remove a component from the blueprint, in the Available Components pane, click - against the component name.

  6. Click Commit to save the blueprint.

    The dialog box with the blueprint summary opens.

  7. Click Commit.
  8. From the breadcrumbs, click Back to Blueprints.

    The Image Builder dashboard lists the blueprints that you created.

4.3. Creating a blueprint for the RHEL for Edge Container image using Image Builder in RHEL web console

To create a blueprint for the RHEL for Edge Container image using Image Builder in RHEL web console, ensure that you have met the following prerequisites and then follow the procedure.

Prerequisites

  • On a RHEL system, you have opened the Image Builder dashboard.

Procedure

  1. On the Image Builder dashboard, click Create Blueprint.

    A Create Blueprint dialogue box opens.

  2. Specify a name and description for the blueprint that you want to create.
  3. Click Create.

    The dashboard displays a list of available components.

    Note

    Your system must be subscribed to RHSM, otherwise, the list of available components appears as “Loading”.

  4. To search for a specific component, enter the component name in the Filter By Name text box, and press Enter. The Component Details pane displays the component details and its dependent components.

    You can select the required version. The web console selects the latest version by default.

  5. In the Components Details pane, click Add.

    If you want to remove a component from the blueprint, in the Available Components pane, click - against the component name.

  6. Click Commit to save the blueprint.

    A dialog box with the blueprint summary opens.

  7. Click Commit.
  8. From the breadcrumbs, click Back to Blueprints.

    The Image Builder dashboard lists the blueprints that you created.

4.4. Creating a blueprint for the RHEL for Edge Installer image using Image Builder in RHEL web console

The blueprint to create a “RHEL for Edge Installer (.iso)” image now supports specify user accounts. It that creates a user on the system at installation time.

To create a blueprint for the RHEL for Edge Installer image using Image Builder in RHEL web console, ensure that you have met the following prerequisites and then follow the procedure.

Prerequisites

  • On a RHEL system, you have opened the Image Builder dashboard.

Procedure

  1. On the Image Builder dashboard, click Create Blueprint.

    The Create Blueprint dialogue box opens.

  2. Specify a name and description for the blueprint that you want to create.
  3. Click Create.
  4. From the breadcrumbs, click Back to Blueprints.

    The Image Builder dashboard lists the blueprints that you created.

4.5. Adding a source to RHEL for Edge image blueprint

By default, the appstream and baseos dnf official sources are available. You can use the sources defined in Image Builder, dnf repository, mirrorlist and metalink, to include the RPMs packages from custom third parties repositories and you can add them to blueprints. These sources are global and therefore available to all blueprints.

The System sources repositories are set up locally on your computer and cannot be disabled or removed from Image Builder. You can add additional custom sources and thus be able to access other contents than the System sources available on your system. Any RPM repository that is accessible from the host system is valid as a source. It is not possible to disable a System Source.

Perform the following steps to add a Source to your blueprints.

Prerequisites

  • You have opened the Image Builder interface of the RHEL web console in a browser.

Procedure

  1. Click the ⫶ Manage Sources button in the upper right corner.

    A pop-up window appears with the available sources, their names and descriptions.

  2. On the right side of the pop-up window, click the Add Source button.
  3. Add the desired Source name, the Source path, and the Source Type.

    Optionally, check the boxes related to the Security field.

    1. SSL Certificate - to verify a repository’s identity and enable an encrypted connection.
    2. GPG Key - to validate signatures of RPM packages available in this repository.
  4. Click Add Source. The screen shows the available sources window and lists the source you have added.

    As a result, the new System source is available for use or any changes that you may want to make.

4.6. Creating an administrative user account for a RHEL for Edge image blueprint

The RHEL for Edge images you create using Image Builder have the root account locked and no other accounts included. Image Builder enables you to create a user account with password for a RHEL for Edge blueprint so that you can log in to the RHEL for Edge image created from the blueprint. For the administrative user account you can either have a password-based access or an SSH-key based access.

Note

For Network-based installation that uses kickstart, you can also create a user account with Kickstart.

Prerequisites

  • You have created an SSH key that you can use for the user account to be created.
  • You have accessed the Image Builder dashboard in the RHEL web console.
  • You have created a blueprint for RHEL for Edge image.

Procedure

  1. On the Image Builder dashboard, find the blueprint for RHEL for Edge image.

    To search a required blueprint, specify the blueprint name in the Filter by Name text box and then press Enter.

  2. Click the blueprint name.

    Image Builder displays the blueprint details.

  3. On the Customizations tab, click Create User Account.
  4. On the Create User Account dialogue box, specify the required details and a password for the user account.

    For password-based access, specify a password for the user account.

    For SSH-based access, specify an SSH key for the user account.

Note

Ensure that you select the Server administrator check box, if you want to provide administrators rights to the user account you are creating.

Image Builder creates a specified user account and displays the details.

You can create additional user accounts, if required.

4.7. Creating a RHEL for Edge Commit image image using Image Builder in RHEL web console

You can create RHEL for Edge Commit images for network-based deployment by selecting “RHEL for Edge Commit (.tar)”. The “RHEL for Edge Commit (.tar)” commit image type is not directly bootable, even though it contains a full operating system. To boot commit image type, you must deploy it in a running container.

To create a RHEL for Edge Commit image using Image Builder in RHEL web console, follow the steps:

Prerequisites

  • On a RHEL system, you have accessed the Image Builder dashboard.
  • You have created a blueprint for RHEL for Edge Commit image.

Procedure

  1. On the Image Builder dashboard, for the blueprint that you have created for RHEL for Edge Commit image, click Create Image.

    To search for a specific blueprint, enter the blueprint name in the Filter By Name text box, and then press Enter.

  2. On the Create Image window, perform the following steps:
  3. From the Type dropdown list, select “RHEL for Edge Commit (.tar)” for network-based deployment.
  4. In the Repository URL textbox, specify the URL to the OSTree repository of the commit to embed in the image. For example, http://10.0.2.2:8080/repository/.
  5. In the Parent commit textbox, specify a previous commit, or leave it empty; if you do not have a commit at this time.

    Note

    Using the Repository URL and Parent commit arguments together results in errors.

  6. In the Ref textbox, specify a reference path for where your commit is going to be created. By default, the web console specifies rhel/9/$ARCH/edge. The "$ARCH" value is determined by the host machine.
  7. Click Create.

    Image Builder starts to create a RHEL for Edge Commit image for the blueprint that you created.

  8. To check the RHEL for Edge Commit image creation progress:

    1. Click the blueprint name from the breadcrumbs.
    2. Click the Images tab.

      Note

      The image creation process takes up to 20 minutes to complete. To abort the image creation process, click Stop from the More Options menu.

      After the image creation process is complete, you can download the resulting “RHEL for Edge Commit (.tar)” image.

Additional resources

4.8. Creating a RHEL for Edge Container image using Image Builder in RHEL web console

You can create RHEL for Edge images for non-network-based deployment by selecting “RHEL for Edge Container (.tar)”. The RHEL for Edge Container (.tar) image type creates an OSTree commit and embeds it into an OCI container with a web server. When the container is started, the web server serves the commit as an OSTree repository.

The following describes how to build a boot ISO which installs an OSTree-based system using the "“RHEL for Edge Container (.tar)” in combination with the "RHEL for Edge Installer" image types. The workflow has the same result as the Building OSTree Image guide with the new image types automating some of the steps.

Follow the steps in this procedure to create a RHEL for Edge Container image using Image Builder in RHEL web console.

Prerequisites

  • On a RHEL system, you have accessed the Image Builder dashboard.
  • You have created a blueprint for RHEL for Edge Container image.

Procedure

  1. On the Image Builder dashboard, for the blueprint that you have created for RHEL for Edge image, click Create Image. To search for a specific blueprint, enter the blueprint name in the Filter By Name text box, and then press Enter.
  2. On the Create Image window, perform the following steps:
  3. Select “RHEL for Edge Container (.tar)”, from the Type dropdown list,.
  4. In the Repository URL textbox, specify the URL to the OSTree repository of the commit to embed in the image. For example, http://10.0.2.2:8080/repository/.
  5. In the Parent commit textbox, specify a previous commit, or leave it empty; if you do not have a commit at this time.
  6. In the Ref textbox, specify a reference path for where your commit is going to be created. By default, the web console specifies rhel/9/$ARCH/edge. The "$ARCH" value is determined by the host machine.
  7. Click Create.

    Image Builder starts to create a RHEL for Edge Container image for the blueprint that you created.

  8. To check the RHEL for Edge Container image creation progress:

    1. Click the blueprint name from the breadcrumbs.
    2. Click the Images tab.

      Note

      The image creation process takes up to 20 minutes to complete. To abort the image creation process, click Stop from the More Options menu.

After the image creation process is complete, you can download the resulting “RHEL for Edge Container (.tar)” image.

Additional resources

4.9. Creating a RHEL for Edge Installer image using Image Builder in RHEL web console

You can create RHEL for Edge Installer images for non-network-based deployment by selecting “RHEL for Edge Installer (.iso)”. The RHEL for Edge Installer (.iso) image type pulls the OSTree commit repository from the running container served by the RHEL for Edge Container (.tar) and creates an installable boot ISO image with a kickstart file that is configured to use the embedded OSTree commit.

Follow the steps in this procedure to create a RHEL for Edge image using Image Builder in RHEL web console.

Prerequisites

  • On a RHEL system, you have accessed the Image Builder dashboard.
  • You created a blueprint for RHEL for Edge Installer image.
  • You created a RHEL for Edge Container image and loaded it into a running container.

Procedure

  1. On the Image Builder dashboard, for the blueprint that you have created for RHEL for Edge Installer image, click Create Image.

    To search for a specific blueprint, enter the blueprint name in the Filter By Name text box, and then press Enter.

  2. On the Create Image window, perform the following steps:

    1. From the Type dropdown list, select “RHEL for Edge Installer (.iso)”.
    2. In the Repository URL textbox, specify the URL to the running container OSTree repository of the commit to embed in the image. For example, http://10.0.2.2:8080/repository/.
    3. The Parent commit textbox, you can specify a previous commit, or leave it empty; if you do not have a commit at this time.
    4. In the Ref textbox, the reference path must match the Ref from the RHEL for Edge Container image compose.
  3. Click Create.

    Image Builder starts to create a RHEL for Edge Installer image for the blueprint that you created.

  4. To check the RHEL for Edge Installer image creation progress:

    1. Click the blueprint name from the breadcrumbs.
    2. Click the Images tab.

      Note

      The image creation process takes up to 20 minutes to complete. To abort the image creation process, click Stop from the More Options menu.

After the image creation process is complete, you can download the resulting RHEL for Edge Installer (.iso) image and boot the ISO image into a device.

Additional resources

4.10. Downloading a RHEL for Edge image

After Image Builder successfully creates the RHEL for Edge image, download the image on the local host.

Procedure

To download an image:

  1. From the More Options menu, click Download.

    The Image Builder downloads the file at your default download location.

The downloaded file consists of a .tar file with an OSTree repository for RHEL for Edge Commit and RHEL for Edge Container images, or a .iso file for RHEL for Edge Installer images, with an OSTree repository. This repository contains the commit and a json file which contains information metadata about the repository content.

4.11. Additional resources