Red Hat Summit Red Hat SummitSuporteConsoleDesenvolvedoresComeçar um testeContato

Este conteúdo não está disponível no idioma selecionado.

Chapter 3. Creating blueprints and blueprint images

An image blueprint is a persistent definition of the required image customizations. that enables you to create multiple builds from it, without having to configure the blueprint for each image build. You can edit, rebuild, delete, and save a blueprint to keep rebuilding images from it. You can define and manage, by editing or deleting a blueprint, and to keep rebuilding it, removing the need to configure the build each time. When you rebuild a blueprint, all targets specified in the blueprint are rebuilt. The blueprint groups the images that were built from it, so that you can have access to all the related images when dealing with large amounts of images.

The blueprints are persistent and you can manage their customizations. Even if the resulting builds, and images from those builds have different content versions, the customizations stored in that blueprint are always applied across all builds resulting from this blueprint.

When creating an image from the blueprint, unless you define a name to the image, it takes the name of the parent blueprint.

3.1. Creating a blueprint
Copiar o link

You can create a blueprint with a name, specify the packages that you want to install and define other customizations. You can build images from this blueprint, and the resulting images have all customizations that you specified in this blueprint.

Prerequisites

Procedure

  1. Access the Hybrid Cloud Console, and navigate to Inventory Image Builder. The Lightspeed Images dashboard appears. For details on how to access the Red Hat Hybrid Cloud Console, see Getting started with the Red Hat Hybrid Cloud Console.
  2. Click Create image blueprint. The wizard for the blueprint creation opens.

  3. On the Image output page, select the following options and click Next:

    1. From the Release list, select the release that you want to use.

      Important

      The image builder builds the latest minor version of the selected release.

    2. From the Architecture list, select the architecture that you want to use.
    3. From the Select target environments option, select the environments that you want to use.

  4. On the Optional steps page, you can further configure your image with additional customizations. For a complete list, see Optional blueprint customizations.

    To finish creating your image blueprint, click Review and finish to proceed to the Review step.

  5. On the Details page, the blueprint name is prefilled in the <distribution>-<architecture>-<datetimeString> format. You can enter a name for the blueprint, and the system checks for validity and duplicity against already existing blueprint names. Click Next.

  6. On the Review page, verify the image details about the image creation and from the Create blueprint drop-down menu, select one of the following options:

    Create blueprint
    Create the blueprint and save the customizations for your blueprint.
    Create blueprint and build image(s)

    Create the blueprint, save the customizations for your blueprint and build images for the target environment or environments that you choose.

    The system verifies the build manifest of the image. After it reaches 100%, the image appears in the build queue.

    Lightspeed Images service starts to compose a RHEL image for the selected architecture. After the image build is ready, you can see the images related to the parent blueprint in the Images dashboard.

3.2. Optional blueprint customizations
Copiar o link

To optimize runtime configuration of your image, you can customize and pre-configure your blueprint with optional settings.

For example, you can customize the following settings:

  • Automatically register your system.
  • Apply your custom compliance policies.
  • Configure the file system and partitioning.
  • Pre-install additional packages from your custom repositories.
  • Add your custom action script for the initial boot of the image.

The additional customizations help you to create your ready to deploy images with all the settings already in place.

Expand
Table 3.1. Optional customizations
CustomizationOptions

Register

Organization ID
Copy your Organization ID to use it during activation key with command line registration.
Automatically register and enable advanced capabilities
This default option automatically populates the activation key, which you choose in the Activation key field. While the activation key is loading, the Next button gets temporarily disabled.
Register later
Select this option to register your system after you launch the image.
Register to a Satellite or Capsule
To register your system, enter the registration command into the Satellite registration command field, and provide the Certificate authority (CA). For more details on how to register a system with Satellite, see Registering a host.

Security

Enable FIPS mode
Toggle this option to enable FIPS 140-2 compliant cryptographic algorithms.
Use a custom compliance policy
Select this option to set up your custom policy from the drop-down menu. The images you build with the image builder will automatically appear under the SCAP policy of the system. You must have an existing set of policies to choose from. See Creating new SCAP policies on how to create your policy. If you have not yet created your set of policies, click Manage Red Hat Lightspeed compliance to create the policy, and refresh the Console to see the policy that you created under the Lightspeed compliance drop-down menu. The system is attached to the customized policy. After you create the image, the system will show up under the compliance system. Note, that this option is available only in the Preview mode.
Use a default OpenSCAP profile
Select this option to set up a default OpenSCAP profile from the drop-down menu.

File system configuration

Use automatic partitioning
Select this option to enable the automatic partitioning for your image.
Manually configure partitions
Select this option to manually configure the file system for your image. Note, if you select the Bare metal as your target environment, you must configure the file system manually during the installation process.

Repeatable build

Disable repeatable build
The image uses the latest state of the repository. Choose this option to let the images have the latest content from the repositories.
Enable repeatable build
The image selects a specific date of snapshot creation. Select this option to let the images have the static state of the repository based on a date you specify.
Use a content template
The image is built with the content template that you specify. Select this option if you plan to centrally manage your systems patching. For details about content templates, see Managing content templates. If you choose to register the system to Lightspeed, it will be automatically associated with the template at the registration time. Note, this option is available only in the Preview mode.

Custom repositories

Select the custom repository to add it to your image.

Additional packages

Search and select additional packages to pre-install them to your image.

Users

In the Username field add a user, and optionally, assign a password, SSH key, groups, and an Admin role to this user. To add more users, click Add a user and provide information for those users.

Timezone

Timezone
From the drop-down menu, select a timezone for your image.
NTP servers
Add the desired NTP server to your image by adding address to the field and click +. You can add multiple NTP servers.

Locale

Languages
From the drop-down menu, select the language for your image. For example: “es_NI.UTF-8”.
Keyboard
From the drop-down menu, select the keyboard layout for your image. For example: “amiga-us”.

Hostname

Select a custom host name for your image in the Hostname field.

Kernel

Name
From the drop-down menu, select the package for the kernel to use in the image.
Append
This option allows you to configure the kernel booting. Fill in the kernel arguments into the Append filed and click +.

Firewall

Ports
Add the port numbers that you want the firewall to manage into the Ports field and click +.
Enabled service
Add the services that are enabled with the firewall to the Enabled services field and click +.
Disabled services
Add the services that are disabled with the firewall to the Disabled services field and click +.

Systemd services

Enabled services
Add the systemd service that you want to enable on your system to the field and click +. You can add multiple systemd services.
Disabled services
Add the systemd service that you want to disable on your system to the field and click +. You can add multiple systemd services.
Masked services

Add the systemd service that you want to disable permanently on your system to the field and click +. You can add multiple systemd services.

For more information about systemd services, see Managing systemd.

Ansible Automation Platform

Ansible Callback URL
Provide a provisioning callback URL for the job template that you want to execute at the launch of your image. To generate the link, you must select the Provisioning Callbacks in your Ansible Automation Platform. For more details about job templates, see Creating a job template.
Host Config Key
Provide a host config key for the job template. You can copy it from the Host config key on the job template page in your Ansible Automation Platform.
Certificate Authority (CA) for Ansible Controller

Upload a Certificate Authority (CA) for Ansible Controller.

For more details about playbooks in Ansible Automation Platform, see Playbooks in Ansible Automation Platform.

First boot configuration

Add your custom script that is executed during the first boot of the image. It is useful when you want to enable your custom services or run an Ansible playbook at the boot time of the image.

Browse
Include a file with an action script.
Start from scratch
Write your action script in the </> SHELL field.

You must start your script with a shebang, for example the #!/bin/sh for Bash shell. The first boot feature supports Python, Bash and YAML syntax.

3.3. Insights compliance integration in Insights image builder
Copiar o link

With Insights image builder, you can select base profiles. Each profile comes with a predetermined set of rules that are applied to the image. You cannot change the base profile rules.

You can tailor the compliance policies by creating a policy and decide which rules to apply to your image. When you select a compliance policy, Insights Image Builder adds information about the packages and services that are included and enabled to meet the policy requirements.

When you apply a compliance policy in Image Builder, the tool automatically selects and enables the specific packages and system services required to meet that compliance policy.

To apply a compliance policy, your system must already be online and registered with a RHEL subscription with a compliance policy to be able to create compliance policies.

Insights Images always builds for the latest minor version of an operating system, but compliance policies are version-specific, leading to issues if a policy does not have a definition for the latest minor version.

3.4. Creating and applying a compliance policy to a custom image
Copiar o link

Build a custom image that includes a predefined OpenSCAP compliance policy by using Insights image builder.

Prerequisites

  • You have a RHEL subscription.
  • You must have a system online and registered to be able to create compliance policies.

Procedure

  1. Create a compliance policy:

    1. Access Hybrid Cloud Console Insights, and navigate to Security Compliance SCAP Policies.
    2. Create the new compliance policy based on the systems you have registered. For more details, see Creating new compliance policies.
    3. Optional: Select or deselect rules, based on your requirements.

  2. Create a blueprint in the Hybrid Cloud Console Insights by following the Creating a blueprint procedure.

    1. On the Compliance step you can choose either from an Insights Compliance Policy or OpenSCAP profiles. If you have no Insights compliance policies defined, you are prompted for the OpenSCAP profiles by default.

  3. To apply the Compliance Policy that you created, navigate to the Content section and select OpenSCAP compliance.

    1. From the dropdown menu, select the policy you created.

      Insights image builder automatically adds required packages and enables services in the blueprint configuration.

  4. Complete the steps for any optional customizations for your image. See Optional blueprint customizations.
  5. Review the blueprint details and start to build your image.

Troubleshooting

  • Fixing a failing build related to a version mismatch:

    You might encounter a warning message that the build has failed because a definition for the OS minor version could not be found in the compliance policy. This happens because the selected compliance policy was created for an older OS minor version, for example, RHEL-9.4 and lacks support for the latest minor version, for example, RHEL-9.6 that Image Builder is trying to build.

    To work around this issue, follow the steps:

    • Ensure that your registered system is running the exact latest minor version of the target system.
    • Access the Compliance service and edit the policy that you want to use.
    • Update the Compliance policy by attaching your running system.

  • Fixing errors related to blueprint:

    If you remove packages marked as required by OpenSCAP, an error pop-up appears with a "fix errors automatically" button that re-adds those packages.

    • Click the button to update the blueprint.

3.5. Editing an existing blueprint
Copiar o link

You can edit a blueprint. For example, to include an extra package. After you finish the blueprint editing, all the images related to the parent blueprint are rebuilt and updated with the new package.

Prerequisites

  • You have created a blueprint.

Procedure

  1. Access the Hybrid Cloud Console, and navigate to Inventory Image Builder. The Lightspeed Images dashboard appears. For details on how to access the Red Hat Hybrid Cloud Console, see Getting started with the Red Hat Hybrid Cloud Console.
  2. Search for the blueprint that you want to edit. You can use the Search field to search for the blueprint name.
  3. Click the blueprint that you want to edit.
  4. Click Edit blueprint. You are redirected to the Review page.
  5. From the navigation menu, select the section that you want to edit.
  6. After making the changes, click the Review page.

  7. Click Save changes to the blueprint.

    The images related to the parent blueprint that you modified will be rebuilt and updated with the new changes.

3.6. Rebuilding an existing blueprint
Copiar o link

Every time that you edit your blueprint, it creates a new version of that blueprint. It also impacts the images that are related to that blueprint, making them out of sync with the blueprint. To fix this, and ensure that you have the least updates available on your parent blueprint and the related images, you can edit your blueprint and rebuild it with the latest updates. This action updates all the packages specified in the blueprint and rebuild the related images with the updated packages.

Prerequisites

  • You have created a blueprint.

Procedure

  1. Access the Hybrid Cloud Console, and navigate to Inventory Images. The Lightspeed Images dashboard appears. For details on how to access the Red Hat Hybrid Cloud Console, see Getting started with the Red Hat Hybrid Cloud Console.
  2. Search for the blueprint that you want to edit. You can use the Search field to search for the blueprint name.
  3. Click the blueprint that you want to edit.
  4. Click Edit blueprint. You are redirected to the Review page.

  5. Make the changes to the blueprint and select one of the options:

    Save
    Save the customizations for your blueprint.
    Save and build image
    Save the customizations for your blueprint and build images from the target environments that you chose.

3.7. Importing a blueprint
Copiar o link

You can import a blueprint from an external source to the Hybrid Cloud Console.

Important

The Import feature is only available in the Preview mode.

Prerequisites

  • You have created a blueprint in the JSON format.

Procedure

  1. Access the Hybrid Cloud Console, and navigate to Inventory Image Builder. The Lightspeed Images dashboard appears. For details on how to access the Red Hat Hybrid Cloud Console, see Getting started with the Red Hat Hybrid Cloud Console.
  2. Click Import. The Import pipeline window opens.

  3. Optional: To add custom repositories from the blueprint to your repositories, select the Import missing custom repositories after file upload checkbox.

    Warning

    If the blueprint contains missing repositories, the images that you create from this blueprint might not work as expected.

  4. Upload the blueprint that you want to import either drag and drop or by selecting the file from your local storage.
  5. Click Review and finish.

3.8. Downloading a blueprint
Copiar o link

You can export a blueprint that you created in the Hybrid Cloud Console by downloading it in the JSON format.

Important

The ability to download a blueprint is only available in the "Preview" mode.

Prerequisites

  • You have created a blueprint.

Procedure

  1. Access the Hybrid Cloud Console, and navigate to Inventory Image Builder. The Lightspeed Images dashboard appears. For details on how to access the Red Hat Hybrid Cloud Console, see Getting started with the Red Hat Hybrid Cloud Console.
  2. Search for the blueprint that you want to download. You can use the Search field to search for the blueprint name.
  3. Click the blueprint that you want to download.

  4. From the More options menu, select the "Download blueprint" option.

    The blueprint is saved as a file in the .json format to the local storage that you define in your web browser.

3.9. Deleting a blueprint
Copiar o link

If you no longer need a blueprint, you can delete it. All the images related to this blueprint will also be deleted.

Prerequisites

  • You have created a blueprint.

Procedure

  1. Access the Hybrid Cloud Console, and navigate to Inventory Image Builder. The Lightspeed Images dashboard appears. For details on how to access the Red Hat Hybrid Cloud Console, see Getting started with the Red Hat Hybrid Cloud Console.
  2. Search for the blueprint that you want to delete. You can use the Search field to search for the blueprint name.
  3. Click the blueprint that you want to delete.
  4. From the More options menu, select the "Delete blueprint" option.
  5. Confirm the deletion by clicking Delete.
Red Hat logoGithubredditYoutubeTwitter

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Ajudamos os usuários da Red Hat a inovar e atingir seus objetivos com nossos produtos e serviços com conteúdo em que podem confiar. Explore nossas atualizações recentes.

Tornando o open source mais inclusivo

A Red Hat está comprometida em substituir a linguagem problemática em nosso código, documentação e propriedades da web. Para mais detalhes veja o Blog da Red Hat.

Sobre a Red Hat

Fornecemos soluções robustas que facilitam o trabalho das empresas em plataformas e ambientes, desde o data center principal até a borda da rede.

Theme

© 2026 Red HatVoltar ao topo