Chapter 5. Creating system images by using RHEL image builder web console interface
RHEL image builder is a tool for creating custom system images. To control RHEL image builder and create your custom system images, you can use the web console interface.
5.1. Accessing the RHEL image builder dashboard in the RHEL web console Copy linkLink copied to clipboard!
With the cockpit-composer plugin for the RHEL web console, you can manage image builder blueprints and composes using a graphical interface.
Prerequisites
- You must have root access to the system.
- You installed RHEL image builder.
-
You installed the
cockpit-composerpackage.
Procedure
-
On the host, open
https://<_localhost_>:9090/in a web browser. - Log in to the web console as the root user.
To display the RHEL image builder controls, click the button, in the upper-left corner of the window.
The RHEL image builder dashboard opens, listing existing blueprints, if any.
5.2. Creating a blueprint in the web console interface Copy linkLink copied to clipboard!
Before creating your customized RHEL system image, you must create a blueprint. All customizations are optional.
+ NOTE: These blueprint customizations are available for Red Hat Enterprise Linux 9.2 or later versions and Red Hat Enterprise Linux 8.8 or later versions. .Prerequisites
- You have opened the RHEL image builder app from the web console in a browser. See Accessing RHEL image builder GUI in the RHEL web console.
Procedure
Click Create Blueprint in the upper-right corner.
The Images dialog box opens.
On the
Image outputpage, complete the following steps:-
Choose the
Releaseversion and theArchitecture. - Select the target environment or target environments.
- Click Next.
-
Choose the
Optional: On the
File system configurationpage, selectUse automatic partitioningorManually configure partitionsfor your image file system. To manually configure the partitions, complete the following steps:- Click the Manually configure partitions button.
From the dropdown menu, provide details to configure the partitions:
For the
Mount pointfield, select one of the following mount point type options:-
/app -
/boot -
/data -
/home -
/opt -
/srv -
/tmp -
/usr /varYou can also add an additional path to the
Mount point. For example, if you select/varas the mount point and add/tmpas an additional path, the result is/var/tmp. Depending on the mount point type you choose, the file system type changes toxfs.
-
For the
Minimum size partitionfield of the file system, enter the needed minimum partition size. In theMinimum sizedropdown menu, you can use common size units such asGB,MB, orKB. The default unit isGB.Minimum sizemeans that RHEL image builder can still increase the partition sizes if they are too small to create a working image.
To add more partitions, click the Add partition button. If you see the "Duplicate partitions: Only one partition at each mount point can be created." error message, you can fix it by performing one of the following actions:
- Click the Remove button to remove the duplicated partition.
- Choose a new mount point for the partition you want to create.
- After you finish the partitioning configuration, click Next.
Optional: On the
Additional packagespage, complete the following steps:-
In the
Available packagessearch, enter the package name. -
Click the button to move it to the
Chosen packagesfield. - Repeat the previous steps to search and include as many packages as you want.
- Click Next.
-
In the
Optional: On the
Userspage, add users:- Click Add user.
-
Enter a
Username, aPassword, and anSSH key. You can also mark the user as a privileged user by clicking theAdministratorcheckbox. - Click Next
Optional: On the
Timezonepage, set the time zone:On the
Timezonefield, enter the time zone you want to add to your system image. For example, add the following time zone format: "US/Eastern".If you do not set a time zone, the system uses Universal Time Coordinated (UTC) as the default.
-
Enter the
NTPservers. - Click Next.
Optional: On the
Localepage, complete the following steps:-
In the
Languagessearch field, enter the locale identifier you want to add to your system image. For example: "us". -
In the
Keyboardsearch field, enter the locale identifier you want to add to your system image. For example: ["en_US.UTF-8"]. - Click Next.
-
In the
-
Optional: On the
Hostnamepage, add a hostname, then click Next: Optional: On the
Kernelpage, complete the following steps:- Enter the kernel name.
- Add the kernel command-line arguments.
- Click Next.
Optional: On the
Firewallpage, complete the following steps:-
Enter the
portnumbers. - Add the firewall services you want to enable or disable.
- Click Next.
-
Enter the
Optional: On the
Systemd servicespage, add the services that you want to enable or disable:- Enter the service names you want to enable or disable, separating them with a comma, a space, or by pressing Enter.
- Click Next.
On the
Detailspage, complete the following steps:- Enter the name of the blueprint and, optionally, its description.
- Click Next.
On the
Reviewpage, review the blueprint details and choose one of the options from the dropdown menu:- Click Create blueprint.
Click Create blueprint and build image(s).
The RHEL image builder view opens, listing the existing blueprints.
5.3. Importing a blueprint in the RHEL image builder web console interface Copy linkLink copied to clipboard!
You can import and use an already existing blueprint. The system automatically resolves all the dependencies.
Prerequisites
- You have opened the RHEL image builder app from the web console in a browser.
- You have a blueprint that you want to import to use in the RHEL image builder web console interface.
Procedure
-
On the RHEL image builder dashboard, click . The
Import blueprintwizard opens. -
From the
Uploadfield, either drag or upload an existing blueprint. This blueprint can be in eitherTOMLorJSONformat. - Click . The dashboard lists the blueprint you imported.
Verification
When you click the blueprint you imported, you have access to a dashboard with all the customizations for the blueprint that you imported.
To verify the packages that have been selected for the imported blueprint, navigate to the
Packagestab.- To list all the package dependencies, click . The list is searchable and can be ordered.
Next steps
Optional: To modify any customization:
-
From the
Customizationsdashboard, click the customization you want to make a change. Optionally, you can click to navigate to all the available customization options.
-
From the
5.4. Exporting a blueprint from the RHEL image builder web console interface Copy linkLink copied to clipboard!
You can export a blueprint to use the customizations in another system. You can export the blueprint in the TOML or in the JSON format. Both formats work on the CLI and also in the API interface.
Prerequisites
- You have opened the RHEL image builder app from the web console in a browser.
- You have a blueprint that you want to export.
Procedure
- On the image builder dashboard, select the blueprint you want to export.
-
Click
Export blueprint. TheExport blueprintwizard opens. Click the button to download the blueprint as a file or click the button to copy the blueprint to the clipboard.
- Optional: Click the button to copy the blueprint.
Verification
- Open the exported blueprint in a text editor to inspect and review it.
5.5. Creating a system image by using RHEL image builder in the web console interface Copy linkLink copied to clipboard!
You can create a customized RHEL system image from a blueprint by completing the following steps.
Prerequisites
- You opened the RHEL image builder app from the web console in a browser.
- You created a blueprint.
Procedure
- In the RHEL image builder dashboard, click the blueprint tab.
- On the blueprint table, find the blueprint you want to build an image.
- On the right side of the chosen blueprint, click . The Create image dialog wizard opens.
On the Image output page, complete the following steps:
- From the Select a blueprint list, select the image type you want.
From the Image output type list, select the image output type you want.
Depending on the image type you select, you need to add further details.
- Click .
On the Review page, review the details about the image creation and click .
The image build starts and takes up to 20 minutes to complete.
Verification
After the image finishes building, you can:
Download the image.
- On the RHEL image builder dashboard, click the Node options (⫶) menu and select Download image.
Download the logs of the image to inspect the elements and verify if any issue is found.
- On the RHEL image builder dashboard, click the Node options (⫶) menu and select Download logs.