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.

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.
  3. Create a RHEL for Edge image. You can create the following images:

    • RHEL for Edge Commit image.
    • RHEL for Edge Container image.
    • RHEL for Edge Installer image.
  4. 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 your 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 8 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.

    The image builder dashboard opens in the right pane. 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 optionally, a description for the blueprint that you want to create.
  3. Click Create.

    The image builder dashboard lists the blueprints that you created.

4.3. Creating a RHEL for Edge Commit image using image builder in RHEL web console

The “RHEL for Edge Commit (.tar)” image type contains a full operating system, but it is not directly bootable. To boot the 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.

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 wizard, perform the following steps:

    1. On the Image output page, from the Image output type dropdown list, select “RHEL for Edge Commit (.tar)” for network-based deployment.
    2. From the OSTree page, enter:

      1. Repository URL: specify the URL to the OSTree repository of the commit to embed in the image. For example, http://10.0.2.2:8080/repository/.
      2. Parent commit: specify a previous commit, or leave it empty if you do not have a commit at this time.
      3. In the Ref textbox, specify a reference path for where your commit is going to be created. By default, the web console specifies rhel/8/$ARCH/edge. The "$ARCH" value is determined by the host machine. Click Next.
  3. From the Customization page page:

    1. On the System page:

      1. Enter a hostname. If you leave the field empty, the system determines the hostname. Click Next.
    2. On the Users page, click Add user.

      1. Enter a user name, and a password.
      2. Optional: enter a SSH key, and check the Server administrator field. Click Next.
    3. On the Packages page:

      1. From the Available packages search field, enter the package you want to add.

        1. Click the > button to select one package.
        2. Optional: click the >> button to select all the packages. Click Next.
    4. On the Review page, check the customizations. Click Save blueprint.
  4. Click Create.

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

    Note

    The image creation process takes up to 20 minutes to complete.

Verification

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

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

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

Additional resources

4.4. Creating a RHEL for Edge Container image using image builder in RHEL web console

You can create RHEL for Edge images 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.

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.

Procedure

  1. On the image builder dashboard, for the blueprint that you have created for RHEL for Edge Container 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 wizard, perform the following steps:

    1. On the Image output page, from the Image output type dropdown list, select “RHEL for Edge Container (.tar)” for network-based deployment.
    2. From the OSTree page, enter:

      1. Repository URL: specify the URL to the OSTree repository of the commit to embed in the image. For example, http://10.0.2.2:8080/repository/.
      2. Parent commit: specify a previous commit, or leave it empty if you do not have a commit at this time.
      3. In the Ref textbox, specify a reference path for where your commit is going to be created. By default, the web console specifies rhel/8/$ARCH/edge. The "$ARCH" value is determined by the host machine. Click Next.
  3. From the Customization page page:

    1. On the System page:

      1. Enter a hostname. If you leave the field empty, the system determines the hostname. Click Next.
    2. On the Users page, click Add user.

      1. Enter a user name, and a password.
      2. Optional: enter a SSH key, and check the Server administrator field. Click Next.
    3. On the Packages page:

      1. From the Available packages search field, enter the package you want to add.

        1. Click the > button to select one package.
        2. Optional: click the >> button to select all the packages. Click Next.
    4. On the Review page, check the customizations. Click Save blueprint.
  4. Click Create.

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

    Note

    The image creation process takes up to 20 minutes to complete.

Verification

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

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

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

Additional resources

4.5. 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

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 wizard, perform the following steps:
  3. On the Image output page, from the Image output type dropdown list, select RHEL for Edge Installer (.iso) image .

    1. From the OSTree page, enter:

      1. Repository URL: specify the URL to the OSTree repository of the commit to embed in the image. For example, http://10.0.2.2:8080/repository/.
      2. In the Ref textbox, specify a reference path for where your commit is going to be created. By default, the web console specifies rhel/8/$ARCH/edge. The "$ARCH" value is determined by the host machine. Click Next.
  4. From the Customization page page:

    1. On the System page:

      1. Enter a hostname. If you leave the field empty, the system determines the hostname. Click Next.
    2. On the Users page, click Add user.

      1. Enter a user name, and a password.
      2. Optional: enter a SSH key, and check the Server administrator field. Click Next.
    3. On the Packages page:

      1. From the Available packages search field, enter the package you want to add.

        1. Click the > button to select one package.
        2. Optional: click the >> button to select all the packages. Click Next.
    4. On the Review page, check the customizations. Click Save blueprint.
  5. Click Create.

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

    Note

    The image creation process takes up to 20 minutes to complete.

Verification

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

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

After the image creation process is complete, you can download the resulting RHEL for Edge Installer (.iso) image.

  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.

    1. Click Create.

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

    2. To check the RHEL for Edge Installer image creation progress:
  5. Click the blueprint name from the breadcrumbs.
  6. Click the Images tab.

    Note

    The image creation process takes up to 20 minutes to complete. To cancel 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.6. Downloading a RHEL for Edge image

After you successfully create the RHEL for Edge image by using image builder, download the image on the local host.

Procedure

To download an image:

  1. From the More Options menu, click Download.

    The image builder tool 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.7. Additional resources