3.7.  Supported Image Customizations


A number of image customizations are supported in blueprints. In order to make use of these options, you need to initially configure them in the blueprint and then use the command push to import the modified blueprint to Image Builder.

Note

These customizations are not currently supported in the accompanying `cockpit-composer` GUI.
Set the image host name
Copy to Clipboard Toggle word wrap
[customizations]
hostname = "baseimage"
User specifications for the resulting system image
Copy to Clipboard Toggle word wrap
[[customizations.user]]
name = "USER-NAME"
description = "USER-DESCRIPTION"
password = "PASSWORD-HASH"
key = "PUBLIC-SSH-KEY"
home = /home"/USER-NAME/"
shell = "/usr/bin/bash"
groups = ["users", "wheel"]
uid = NUMBER
gid = NUMBER
Only the user name is required, you can leave out any other lines.
Replace PASSWORD-HASH with the actual password hash. To generate the hash, use a command such as:
Copy to Clipboard Toggle word wrap
$ python3 -c 'import crypt,getpass;pw=getpass.getpass();print(crypt.crypt(pw) if (pw==getpass.getpass("Confirm: ")) else exit())'

Important

To generate the hash, you must have the python3 package on your system. Use the following command to install the package:
Copy to Clipboard Toggle word wrap
# yum install python3
Replace PUBLIC-SSH-KEY with the actual public key.
Repeat this block for every user you want to include.
Group specifications for the resulting system image
Copy to Clipboard Toggle word wrap
[[customizations.group]]
name = "GROUP-NAME"
gid = NUMBER
Repeat this block for every group you want to include.
Set an existing user's ssh key
Copy to Clipboard Toggle word wrap
[[customizations.sshkey]]
user = "root"
key = "PUBLIC-SSH-KEY"

Note

This option is only applicable for existing users. To create a user and set an ssh key, use the User specifications for the resulting system image customization.
Append a kernel boot parameter option to the defaults
Copy to Clipboard Toggle word wrap
[[customizations.kernel]]
append = "KERNEL-OPTION"
Set the image host name
Copy to Clipboard Toggle word wrap
[customizations]
hostname = "BASE-IMAGE"
Add a group for the resulting system image
Copy to Clipboard Toggle word wrap
[[customizations.group]]
name = "USER-NAME"
gid = NUMBER
Only the name is required and GID is optional.
Set the timezone and the Network Time Protocol (NTP) servers for the resulting system image
Copy to Clipboard Toggle word wrap
[customizations.timezone]
timezone = "TIMEZONE"
ntpservers = NTP-SERVER
If you do not set a timezone, the system uses Universal Time, Coordinated (UTC) as default. Setting NTP servers is optional.
Set the locale settings for the resulting system image
Copy to Clipboard Toggle word wrap
[customizations.locale]
language = "[LANGUAGE]"
keyboard = "KEYBOARD"
Setting both language and keyboard options is mandatory. You can add multiple languages. The first language you add will be the primary language and the other languages will be secondary.
Set the firewall for the resulting system image
Copy to Clipboard Toggle word wrap
[customizations.firewall]
port = "[PORTS]"
You can use the numeric ports, or theirs names from the `/etc/services` file to enable or disable lists.
Set which services to enable during the boot time
Copy to Clipboard Toggle word wrap
[customizations.services]
enabled = "[SERVICES]"
disabled = "[SERVICES]"
You can control which services to enable during the boot time. Some image types already have services enabled or disabled so that the image works correctly and this setup cannot be overridden.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat, Inc.