Provisioning Hosts

Set the first booting device as boot configuration with network.

Set the second booting device as boot from hard drive. Foreman manages TFTP boot configuration files so hosts can be easily provisioned just by rebooting.

Set the first booting device as boot configuration with network.

Depending on the EFI firmware type and configuration, the OS installer typically configures the OS boot loader as the first entry.

To reboot into installer again, use efibootmgr utility to switch back to boot from network.

You create a host and select a domain and subnet. Foreman requests an available IP address from the DHCP Smart Proxy server that is associated with the subnet or from the PostgreSQL database in Foreman. Foreman loads this IP address into the IP address field in the Create Host window. When you complete all the options for the new host, submit the new host request.

Depending on the configuration specifications of the host and its domain and subnet, Foreman creates the following settings:

The host is configured to boot from the network as the first device and HDD as the second device.

The new host requests a DHCP reservation from the DHCP server.

The DHCP server responds to the reservation request and returns TFTP next-server and filename options.

The host requests the boot loader and menu from the TFTP server according to the PXELoader setting.

A boot loader is returned over TFTP.

The boot loader fetches configuration for the host through its provisioning interface MAC address.

The boot loader fetches the operating system installer kernel, init RAM disk, and boot parameters.

The installer requests the provisioning template from Foreman.

Foreman renders the provision template and returns the result to the host.

The installer performs installation of the operating system.

The PXE configuration files revert to a local boot template.

The host reboots.

The new host requests a DHCP reservation from the DHCP server.

The DHCP server responds to the reservation request and returns TFTP next-server and filename options.

The host requests the bootloader and menu from the TFTP server according to the PXELoader setting.

A boot loader is returned over TFTP.

The boot loader fetches the configuration for the host through its provision interface MAC address.

The boot loader initiates boot from the local drive.

If you configured the host to use any Puppet classes, the host configures itself using the modules.

The host is configured to boot from the network as the first device and HDD as the second device.

The new host requests a DHCP reservation from the DHCP server.

The DHCP server responds to the reservation request and returns TFTP next-server and filename options.

The host requests the boot loader and menu from the TFTP server according to the PXELoader setting.

A boot loader is returned over TFTP.

The boot loader fetches the configuration settings for the host through its provisioning interface MAC address.

For BIOS hosts:

For EFI hosts:

If the host is unknown to Foreman, a default bootloader configuration is provided. When Discovery service is enabled, it boots into discovery, otherwise it boots from HDD.

Click Any Organization and select the organization.

Click Any Location and select the location to use.

In the Foreman web UI, navigate to Hosts > Operating systems and click New Operating system.

In the Name field, enter a name to represent the operating system entry.

In the Major field, enter the number that corresponds to the major version of the operating system.

In the Minor field, enter the number that corresponds to the minor version of the operating system.

In the Description field, enter a description of the operating system.

From the Family list, select the operating system’s family.

From the Root Password Hash list, select the encoding method for the root password.

From the Architectures list, select the architectures that the operating system uses.

Click the Partition table tab and select the possible partition tables that apply to this operating system.

Click the Installation Media tab and enter the information for the installation media source. For more information, see Adding Installation Media to Foreman.

Click the Templates tab and select a PXELinux template, a Provisioning template, and a Finish template for your operating system to use. You can select other templates, for example an iPXE template, if you plan to use iPXE for provisioning.

Click Submit to save your provisioning template.

In the Foreman web UI, navigate to Hosts > Operating Systems.

Click Create Operating System to create an operating system entry for Debian.

Enter Debian 11 as Name for the operating system. Choose a name as reported by Ansible, Puppet, or Salt as fact.

Set the Major Version to 11.

Set the Minor Version to 5.

Set the Release Name to bullseye for Debian 11.

On the Partition Table tab, select the Preseed partition table.

On the Templates tab, select the Preseed Finish template as Finish template, the Preseed template as Provisioning Template, and the Preseed PXELinux template as PXELinux template.

Click Submit to save the operating system entry for Debian.

In the Foreman web UI, navigate to Hosts > Operating Systems.

Click Create Operating System to create an operating system entry for Ubuntu.

Enter Ubuntu 20.04 as Name for the operating system. Choose a name as reported by Ansible, Puppet, or Salt as fact.

Set the Major Version to 20.04.

Set the Minor Version to 5.

Set the Release Name to focal for Ubuntu 20.04.

On the Partition Table tab, select the Preseed partition table.

On the Templates tab, select the Preseed Finish template as Finish template, the Preseed template as Provisioning Template, and the Preseed PXELinux template as PXELinux template.

Click Submit to save the operating system entry for Ubuntu.

On Foreman server, run the following Bash script:

PARTID=$(hammer --csv partition-table list | grep "Kickstart default," | cut -d, -f1)
PXEID=$(hammer --csv template list --per-page=1000 | grep "Kickstart default PXELinux" | cut -d, -f1)
SATID=$(hammer --csv template list --per-page=1000 | grep "provision" | grep ",Kickstart default" | cut -d, -f1)

for i in $(hammer --no-headers --csv os list | awk -F, {'print $1'})
do
   hammer partition-table add-operatingsystem --id="${PARTID}" --operatingsystem-id="${i}"
   hammer template add-operatingsystem --id="${PXEID}" --operatingsystem-id="${i}"
   hammer os set-default-template --id="${i}" --config-template-id=${PXEID}
   hammer os add-config-template --id="${i}" --config-template-id=${SATID}
   hammer os set-default-template --id="${i}" --config-template-id=${SATID}
done

Display information about the updated operating system to verify that the operating system is updated correctly:

# hammer os info --id 1

In the Foreman web UI, navigate to Hosts > Architectures and click Create Architecture.

In the Name field, enter a name for the architecture.

From the Operating Systems list, select an operating system. If none are available, you can create and assign them under Hosts > Operating Systems.

Click Submit.

In the Foreman web UI, navigate to Hosts > Hardware Models and click Create Model.

In the Name field, enter a name for the hardware model.

Optionally, in the Hardware Model and Vendor Class fields, you can enter corresponding information for your system.

In the Info field, enter a description of the hardware model.

Click Submit to save your hardware model.

Add the synchronized kickstart repository that you want to use to the existing Content View, or create a new Content View and add the kickstart repository.

Publish a new version of the Content View where the kickstart repository is added and promote it to a required lifecycle environment. For more information, see Managing Content Views in the Content Management Guide.

When you create a host, in the Operating System tab, for Media Selection, select the Synced Content checkbox.

In the Foreman web UI, navigate to Hosts > Installation Media and click Create Medium.

In the Name field, enter a name to represent the installation media entry.

In the Path enter the URL that contains the installation tree. You can use following variables in the path to represent multiple different system architectures and versions:

From the Operating system family list, select the distribution or family of the installation medium. For example, CentOS and Fedora are in the Red Hat family. Debian and Ubuntu belong to the Debian family.

Click the Organizations and Locations tabs, to change the provisioning context. Foreman server adds the installation medium to the set provisioning context.

Click Submit to save your installation medium.

In the Foreman web UI, navigate to Hosts > Installation Media.

Click Create Medium to create an installation medium entry.

Enter a Name for the installation medium.

Set the Path to the upstream URL http://ftp.debian.org/debian/.

Set the Operating System Family to Debian.

Click Submit to save the installation medium to Foreman.

In the Foreman web UI, navigate to Hosts > Partition Tables and click Create Partition Table.

In the Name field, enter a name for the partition table.

Select the Default checkbox if you want to set the template to automatically associate with new organizations or locations.

Select the Snippet checkbox if you want to identify the template as a reusable snippet for other partition tables.

From the Operating System Family list, select the distribution or family of the partitioning layout. For example, Red Hat Enterprise Linux, CentOS, and Fedora are in the Red Hat family.

In the Template editor field, enter the layout for the disk partition. For example:

zerombr
clearpart --all --initlabel
autopart

In the Audit Comment field, add a summary of changes to the partition layout.

Click the Organizations and Locations tabs to add any other provisioning contexts that you want to associate with the partition table. Foreman adds the partition table to the current provisioning context.

Click Submit to save your partition table.

Before you create a partition table with the CLI, create a plain text file that contains the partition layout. This example uses the ~/my-partition file.

Create the installation medium using the hammer partition-table create command:

# hammer partition-table create \
--file "path/to/my_partition_table" \
--locations "My_Location" \
--name "My Partition Table" \
--organizations "My_Organization" \
--os-family "My_OS_Family" \
--snippet false

In the Foreman web UI, navigate to Hosts > Provisioning Templates and click Create Template.

In the Name field, enter a name for the provisioning template.

Fill in the rest of the fields as required. The Help tab provides information about the template syntax and details the available functions, variables, and methods that can be called on different types of objects within the template.

Before you create a template with the CLI, create a plain text file that contains the template. This example uses the ~/my-template file.

Create the template using the hammer template create command and specify the type with the --type option:

# hammer template create --name "My Provisioning Template" \
--file ~/my-template --type provision --organizations "My_Organization" \
--locations "My_Location"

In the Foreman web UI, navigate to Hosts > Provisioning Templates and search for the template that you want to use.

Click Clone to duplicate the template.

In the Name field, enter a name for the provisioning template.

Select the Default checkbox to set the template to associate automatically with new organizations or locations.

In the Template editor field, enter the body of the provisioning template. You can also use the Template file browser to upload a template file.

In the Audit Comment field, enter a summary of changes to the provisioning template for auditing purposes.

Click the Type tab and if your template is a snippet, select the Snippet checkbox. A snippet is not a standalone provisioning template, but a part of a provisioning template that can be inserted into other provisioning templates.

From the Type list, select the type of the template. For example, Provisioning template.

Click the Association tab and from the Applicable Operating Systems list, select the names of the operating systems that you want to associate with the provisioning template.

Optionally, click Add combination and select a host group from the Host Group list or an environment from the Environment list to associate provisioning template with the host groups and environments.

Click the Organizations and Locations tabs to add any additional contexts to the template.

Click Submit to save your provisioning template.

In the Foreman web UI, navigate to Infrastructure > Compute Profiles and click Create Compute Profile.

In the Name field, enter a name for the profile.

Click Submit. A new window opens with the name of the compute profile.

In the new window, click the name of each compute resource and edit the attributes you want to set for this compute profile.

Generate an encrypted password:

# python -c 'import crypt,getpass;pw=getpass.getpass(); print(crypt.crypt(pw)) if (pw==getpass.getpass("Confirm: ")) else exit()'

Copy the password for later use.

In the Foreman web UI, navigate to Administer > Settings.

On the Settings page, select the Provisioning tab.

In the Name column, navigate to Root password, and click Click to edit.

Paste the encrypted password, and click Save.

On the VM host system, configure the firewall to allow VNC service on ports 5900 to 5930:

In the Foreman web UI, navigate to Infrastructure > Compute Resources and select the name of a compute resource.

In the Virtual Machines tab, select the name of a VM host. Ensure the machine is powered on and then select Console.

In the Foreman web UI, navigate to Administer > Settings and select the Facts tab.

To filter out all interfaces starting with specific names, for example, blu, add blu* to the Ignore interfaces with matching identifier option.

To prevent databases from storing facts related to interfaces starting with specific names, for example, blu, add blu* to the Exclude pattern for facts stored in Foreman option.

To remove facts from the database, enter the following command:

# foreman-rake facts:clean

To remove interfaces from the database, enter the following command:

# foreman-rake interfaces:clean

To preview the DHCP records that are going to be added to the DHCP server, enter the following command:

# foreman-rake orchestration:dhcp:add_missing subnet_name=NAME

If you are satisfied by the preview changes in the previous step, apply them by entering the above command with the perform=1 argument:

# foreman-rake orchestration:dhcp:add_missing subnet_name=NAME perform=1

To keep DHCP records in Foreman and in the DHCP server synchronized, you can remove unwanted DHCP records from the DHCP server. Note that Foreman assumes that all managed DHCP servers do not contain third-party records, therefore, this step might delete those unexpected records. To preview what records are going to be removed from the DHCP server, enter the following command:

# foreman-rake orchestration:dhcp:remove_offending subnet_name=NAME

If you are satisfied by the preview changes in the previous step, apply them by entering the above command with the perform=1 argument:

# foreman-rake orchestration:dhcp:remove_offending subnet_name=NAME perform=1

Enter the foreman-installer command to configure the required network services:

# foreman-installer --foreman-proxy-dhcp true \
--foreman-proxy-dhcp-gateway "192.168.140.1" \
--foreman-proxy-dhcp-interface "eth1" \
--foreman-proxy-dhcp-managed true \
--foreman-proxy-dhcp-nameservers "192.168.140.2" \
--foreman-proxy-dhcp-range "192.168.140.10 192.168.140.110" \
--foreman-proxy-dhcp-server "192.168.140.2" \
--foreman-proxy-dns true \
--foreman-proxy-dns-forwarders "8.8.8.8; 8.8.4.4" \
--foreman-proxy-dns-interface "eth1" \
--foreman-proxy-dns-managed true \
--foreman-proxy-dns-reverse "140.168.192.in-addr.arpa" \
--foreman-proxy-dns-server "127.0.0.1" \
--foreman-proxy-dns-zone "example.com" \
--foreman-proxy-tftp true \
--foreman-proxy-tftp-managed true

Find Smart Proxy server that you configure:

# hammer proxy list

Refresh features of Smart Proxy server to view the changes:

# hammer proxy refresh-features --name "foreman.example.com"

Verify the services configured on Smart Proxy server:

# hammer proxy info --name "foreman.example.com"

In the Foreman web UI, navigate to Infrastructure > Domains and click Create Domain.

In the DNS Domain field, enter the full DNS domain name.

In the Fullname field, enter the plain text name of the domain.

Click the Parameters tab and configure any domain level parameters to apply to hosts attached to this domain. For example, user defined Boolean or string parameters to use in templates.

Click Add Parameter and fill in the Name and Value fields.

Click the Locations tab, and add the location where the domain resides.

Click the Organizations tab, and add the organization that the domain belongs to.

Click Submit to save the changes.

In the Foreman web UI, navigate to Infrastructure > Subnets, and in the Subnets window, click Create Subnet.

In the Name field, enter a name for the subnet.

In the Description field, enter a description for the subnet.

In the Network address field, enter the network address for the subnet.

In the Network prefix field, enter the network prefix for the subnet.

In the Network mask field, enter the network mask for the subnet.

In the Gateway address field, enter the external gateway for the subnet.

In the Primary DNS server field, enter a primary DNS for the subnet.

In the Secondary DNS server, enter a secondary DNS for the subnet.

From the IPAM list, select the method that you want to use for IP address management (IPAM). For more information about IPAM, see Configuring Networking.

Enter the information for the IPAM method that you select.

If you use the remote execution plugin, click the Remote Execution tab and select the Smart Proxy that controls the remote execution.

Click the Domains tab and select the domains that apply to this subnet.

Click the Smart Proxies tab and select the Smart Proxy that applies to each service in the subnet, including DHCP, TFTP, and reverse DNS services.

Click the Parameters tab and configure any subnet level parameters to apply to hosts attached to this subnet. For example, user defined Boolean or string parameters to use in templates.

Click the Locations tab and select the locations that use this Smart Proxy.

Click the Organizations tab and select the organizations that use this Smart Proxy.

Click Submit to save the subnet information.

On Smart Proxy, enter the following command:

# foreman-installer --enable-foreman-proxy-plugin-dhcp-infoblox \
--foreman-proxy-dhcp true \
--foreman-proxy-dhcp-managed false \
--foreman-proxy-dhcp-provider infoblox \
--foreman-proxy-dhcp-server infoblox.example.com \
--foreman-proxy-plugin-dhcp-infoblox-dns-view default \
--foreman-proxy-plugin-dhcp-infoblox-network-view default \
--foreman-proxy-plugin-dhcp-infoblox-password infoblox \
--foreman-proxy-plugin-dhcp-infoblox-record-type fixedaddress \
--foreman-proxy-plugin-dhcp-infoblox-username admin

In the Foreman web UI, navigate to Infrastructure > Smart Proxies and select the Smart Proxy with the Infoblox DHCP module and click Refresh.

Ensure that the dhcp features are listed.

For all domains managed through Infoblox, ensure that the DNS Smart Proxy is set for that domain. To verify, in the Foreman web UI, navigate to Infrastructure > Domains, and inspect the settings of each domain.

For all subnets managed through Infoblox, ensure that DHCP Smart Proxy and Reverse DNS Smart Proxy is set. To verify, in the Foreman web UI, navigate to Infrastructure > Subnets, and inspect the settings of each subnet.

On Smart Proxy, enter the following command to configure the Infoblox module:

# foreman-installer --enable-foreman-proxy-plugin-dns-infoblox \
--foreman-proxy-dns true \
--foreman-proxy-dns-provider infoblox \
--foreman-proxy-plugin-dns-infoblox-dns-server infoblox.example.com \
--foreman-proxy-plugin-dns-infoblox-dns-view default \
--foreman-proxy-plugin-dns-infoblox-password infoblox \
--foreman-proxy-plugin-dns-infoblox-username admin

In the Foreman web UI, navigate to Infrastructure > Smart Proxies and select the Smart Proxy with the Infoblox DNS module and click Refresh.

Ensure that the dns features are listed.

Virtual machine starts

iPXE retrieves the network credentials, including an HTTP URL, using DHCP

iPXE loads the iPXE bootstrap template from Foreman server or Smart Proxy

iPXE loads the iPXE template with MAC as a URL parameter from Foreman server or Smart Proxy

iPXE loads the kernel and initial RAM disk of the installer

In the Foreman web UI, navigate to Hosts > Provisioning Templates, enter Kickstart default iPXE and click Search.

Optional: If you want to change the template, click Clone, enter a unique name, and click Submit.

Click the name of the template you want to use.

If you clone the template, you can make changes you require on the Template tab.

Click the Association tab, and select the operating systems that your host uses.

Click the Locations tab, and add the location where the host resides.

Click the Organizations tab, and add the organization that the host belongs to.

Click Submit to save the changes.

In the Foreman web UI, navigate to Hosts > Operating systems and select the operating system of your host.

Click the Templates tab.

From the iPXE Template list, select the template you want to use.

Click Submit to save the changes.

In the Foreman web UI, navigate to Hosts > All Hosts.

In the Hosts page, select the host that you want to use.

Select the Operating System tab.

Set PXE Loader to iPXE Embedded.

Select the Templates tab.

From the iPXE template list, select Review to verify that the Kickstart default iPXE template is the correct template.

Set the HTTP URL.

Host powers on

PXE driver retrieves the network credentials using DHCP

PXE driver retrieves the PXELinux firmware pxelinux.0 using TFTP

PXELinux searches for the configuration file on the TFTP server

PXELinux chainloads iPXE ipxe.lkrn or undionly-ipxe.0

iPXE retrieves the network credentials, including an HTTP URL, using DHCP again

iPXE chainloads the iPXE template from the template Smart Proxy

iPXE loads the kernel and initial RAM disk of the installer

In the Foreman web UI, navigate to Hosts > Provisioning Templates.

Enter PXELinux chain iPXE to use ipxe.lkrn or, for BIOS systems, enter PXELinux chain iPXE UNDI to use undionly-ipxe.0, and click Search.

Optional: If you want to change the template, click Clone, enter a unique name, and click Submit.

Click the name of the template you want to use.

If you clone the template, you can make changes you require on the Template tab.

Click the Association tab, and select the operating systems that your host uses.

Click the Locations tab, and add the location where the host resides.

Click the Organizations tab, and add the organization that the host belongs to.

Click Submit to save the changes.

In the Provisioning Templates page, enter Kickstart default iPXE into the search field and click Search.

Optional: If you want to change the template, click Clone, enter a unique name, and click Submit.

Click the name of the template you want to use.

If you clone the template, you can make changes you require on the Template tab.

Click the Association tab, and associate the template with the operating system that your host uses.

Click the Locations tab, and add the location where the host resides.

Click the Organizations tab, and add the organization that the host belongs to.

Click Submit to save the changes.

In the Foreman web UI, navigate to Hosts > Operating systems and select the operating system of your host.

Click the Templates tab.

From the PXELinux template list, select the template you want to use.

From the iPXE template list, select the template you want to use.

Click Submit to save the changes.

In the Foreman web UI, navigate to Configure > Host Groups, and select the host group you want to configure.

Select the Operating System tab.

Select the Architecture and Operating system.

Set PXE Loader to PXELinux BIOS to chainboot iPXE via PXELinux, or to iPXE Chain BIOS to load undionly-ipxe.0 directly.

Set the HTTP URL.

In the Foreman web UI, navigate to Administer > Settings, and click the Provisioning tab.

Find the Token duration option and click the edit icon and edit the duration, or enter 0 to disable token generation. If token generation is disabled, an attacker can spoof client IP address and download OS installer recipe from Foreman server, including the encrypted root password.

In the Foreman web UI, navigate to Hosts > Create Host.

In the Name field, enter a name for the host.

Click the Organization and Location tabs and change the context to match your requirements.

From the Host Group list, select a host group that you want to use to populate the form.

Click the Interface tab, and on the host’s interface, click Edit.

Verify that the fields are populated with values. Note in particular:

In the MAC address field, enter a MAC address for the host. This ensures the identification of the host during the PXE boot process.

Ensure that Foreman server automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.

Click OK to save. To add another interface, click Add Interface. You can select only one interface for Provision and Primary.

Click the Operating System tab, and verify that all fields contain values. Confirm each aspect of the operating system.

Optional: Click Resolve in Provisioning template to check the new host can identify the right provisioning templates to use.

Click Submit to save the host details.

Create the host with the hammer host create command:

# hammer host create --name "My_Unattended_Host" --organization "My_Organization" \
--location "My_Location" --hostgroup "My_Host_Group" --mac "aa:aa:aa:aa:aa:aa" \
--build true --enabled true --managed true

Ensure the network interface options are set using the hammer host interface update command:

# hammer host interface update --host "test1" --managed true \
--primary true --provision true

In the Foreman web UI, navigate to Hosts > Create Host.

In the Name field, enter a name that you want to become the provisioned system’s host name.

Click the Organization and Location tabs and change the context to match your requirements.

From the Host Group list, select a host group that you want to use to populate the form.

Click the Interface tab, and on the host’s interface, click Edit.

Verify that the fields are populated with values. Note in particular:

In the MAC address field, enter a MAC address for the host.

Ensure that Foreman server automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.

Click the Operating System tab, and verify that all fields contain values. Confirm each aspect of the operating system.

Click Resolve in Provisioning Templates to check the new host can identify the right provisioning templates to use.

Click Submit to save the host details. This creates a host entry and the host details page appears.

Download the boot disk from Foreman server.

Write the ISO to a USB storage device using the dd utility or livecd-tools if required.

When you start the host and boot from the ISO or the USB storage device, the host connects to Foreman server and starts installing operating system from its kickstart tree.

Create the host using the hammer host create command.

# hammer host create --name "My_Host_Name" --organization "My_Organization" \
--location "My_Location" --hostgroup "My_Host_Group" --mac "aa:aa:aa:aa:aa:aa" \
--build true --enabled true --managed true

Ensure that your network interface options are set using the hammer host interface update command.

# hammer host interface update --host "My_Host_Name" --managed true \
--primary true --provision true

Download the boot disk from Foreman server using the hammer bootdisk command:

Write the ISO to a USB storage device using the dd utility or livecd-tools if required.

When you start the physical host and boot from the ISO or the USB storage device, the host connects to Foreman server and starts installing operating system from its kickstart tree.

Enable foreman-proxy-http, foreman-proxy-httpboot, and foreman-proxy-tftp features.

# foreman-installer --scenario foreman \
--foreman-proxy-http true \
--foreman-proxy-httpboot true \
--foreman-proxy-tftp true

In the Foreman web UI, navigate to Hosts > Create Host.

In the Name field, enter a name for the host.

Click the Organization and Location tabs and change the context to match your requirements.

From the Host Group list, select a host group that you want to use to populate the form.

Click the Interface tab, and on the host’s interface, click Edit.

Verify that the fields are populated with values. Note in particular:

In the MAC address field, enter a MAC address of the host’s provisioning interface. This ensures the identification of the host during the PXE boot process.

Ensure that Foreman server automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.

Click OK to save. To add another interface, click Add Interface. You can select only one interface for Provision and Primary.

Click the Operating System tab, and verify that all fields contain values. Confirm each aspect of the operating system.

From the PXE Loader list, select Grub2 UEFI HTTP.

Optional: Click Resolve in Provisioning template to check the new host can identify the right provisioning templates to use.

Click Submit to save the host details.

Set the host to boot in UEFI mode from network.

Start the host.

From the boot menu, select Kickstart default PXEGrub2.

Enable foreman-proxy-http, foreman-proxy-httpboot, and foreman-proxy-tftp true features:

# foreman-installer --scenario foreman \
--foreman-proxy-http true \
--foreman-proxy-httpboot true \
--foreman-proxy-tftp true

Create the host with the hammer host create command.

# hammer host create --name "My_Host" \
--build true \
--enabled true \
--hostgroup "My_Host_Group" \
--location "My_Location" \
--mac "aa:aa:aa:aa:aa:aa" \
--managed true \
--organization "My_Organization" \
--pxe-loader "Grub2 UEFI HTTP"

Ensure the network interface options are set using the hammer host interface update command:

# hammer host interface update \
--host "My_Host" \
--managed true \
--primary true \
--provision true

Set the host to boot in UEFI mode from network.

Start the host.

From the boot menu, select Kickstart default PXEGrub2.

In the Foreman web UI, navigate to Hosts > Provisioning Templates.

Create a provisioning template, or clone and edit an existing template. For more information, see Creating Provisioning Templates.

In the template, click the Template tab.

In the Template editor field, add the create_users snippet to the %post section:

<%= snippet('create_users') %>

Select the Default checkbox.

Click the Association tab.

From the Application Operating Systems list, select an operating system.

Click Submit to save the provisioning template.

Create a host that is associated with the provisioning template or rebuild a host using the OS associated with the modified template. For more information, see Creating a Host in the Managing Hosts guide.

Enter the following commands on Smart Proxy server:

# foreman-installer \
--enable-foreman-proxy-plugin-discovery \
--foreman-proxy-plugin-discovery-install-images=true

If a discovered host uses a subnet defined in Foreman, the host uses the first organization and location associated with the subnet.

If the discovery_organization or discovery_location fact values are set, the discovered host uses these fact values as an organization and location. To set these fact values, navigate to Administer > Settings > Discovered, and add these facts to the Default organization and Default location fields. Ensure that the discovered host’s subnet also belongs to the organization and location set by the fact, otherwise Foreman refuses to set it for security reasons.

If none of the previous conditions exists, Foreman assigns the first Organization and Location ordered by name.

In the Foreman web UI, navigate to Administer > Settings and click the Provisioning tab.

For the Default PXE global template entry, in the Value column, enter discovery.

In the Foreman web UI, navigate to Hosts > Discovered host. Select the host you want to use and click Provision to the right of the list.

Select from one of the two following options:

Verify that the fields are populated with values. Note in particular:

Ensure that Foreman server automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.

Click the Operating System tab, and verify that all fields contain values. Confirm each aspect of the operating system.

Click Resolve in Provisioning template to check the new host can identify the right provisioning templates to use. The host must resolve to the following provisioning templates:

Click Submit to save the host details.

Identify the discovered host to use for provisioning:

# hammer discovery list

Select a host and provision it using a host group. Set a new host name with the --new-name option:

# hammer discovery provision \
--build true \
--enabled true \
--hostgroup "My_Host_Group" \
--location "My_Location" \
--managed true \
--name "My_Host_Name" \
--new-name "My_New_Host_Name" \
--organization "My_Organization"

In the Foreman web UI, navigate to Configure > Discovery rules, and select Create Rule.

In the Name field, enter a name for the rule.

In the Search field, enter the rules to determine whether to provision a host. This field provides suggestions for values you enter and allows operators for multiple rules. For example: cpu_count > 8.

From the Host Group list, select the host group to use as a template for this host.

In the Hostname field, enter the pattern to determine host names for multiple hosts. This uses the same ERB syntax that provisioning templates use. The host name can use the @host attribute for host-specific values and the rand macro for a random number or the sequence_hostgroup_param_next macro for incrementing the value. For more information about provisioning templates, see Provisioning Templates and the API documentation.

In the Hosts limit field, enter the maximum number of hosts that you can provision with the rule. Enter 0 for unlimited.

In the Priority field, enter a number to set the precedence the rule has over other rules. Rules with lower values have a higher priority.

From the Enabled list, select whether you want to enable the rule.

To set a different provisioning context for the rule, click the Organizations and Locations tabs and select the contexts you want to use.

Click Submit to save your rule.

In the Foreman web UI, navigate to Hosts > Discovered Host and select one of the following two options:

Create the rule with the hammer discovery-rule create command:

# hammer discovery-rule create \
--enabled true \
--hostgroup "My_Host_Group" \
--hostname "hypervisor-<%= rand(99999) %>" \
--hosts-limit 5 \
--name "My_Hypervisor" \
--priority 5 \
--search "cpu_count  > 8"

Automatically provision a host with the hammer discovery auto-provision command:

# hammer discovery auto-provision --name "macabcdef123456"

Copy this media to either a CD, DVD, or a USB stick. For example, to copy to a USB stick at /dev/sdb:

# dd bs=4M \
if=/usr/share/foreman-discovery-image/foreman-discovery-image-3.4.4-5.iso \
of=/dev/sdb

Insert the Discovery boot media into a bare metal host, start the host, and boot from the media. The Discovery Image displays an option for either Manual network setup or Discovery with DHCP:

After entering these details, select Next.

If you select Discovery with DHCP, the Discovery image requests only the primary network interface that connects to Foreman server. It attempts to automatically configure the network interface using a DHCP server, such as one that a Smart Proxy server provides.

After the primary interface configuration, the Discovery image requests the Server URL, which is the URL of Foreman server or Smart Proxy server offering the Discovery service. For example, to use the integrated Smart Proxy on Foreman server, use the following URL:

https://foreman.example.com:8443

Set the Connection type to Proxy, then select Next.

Optional: The Discovery image also provides a set of fields to input Custom facts for the Facter tool to relay back to Foreman server. These are entered in a name-value format. Provide any custom facts you require and select Confirm to continue.

Open the /usr/share/foreman-discovery-image/foreman-discovery-image.ks file for editing:

# vim /usr/share/foreman-discovery-image/foreman-discovery-image.ks

Replace the repo lines in the kickstart file with the repository URLs:

Run the livecd-creator tool:

# livecd-creator \
--cache=var/cache/build-fdi \
--compression-type=xz \
--config /usr/share/foreman-discovery-image/foreman-discovery-image.ks \
--fslabel fdi \
--title="My_Discovery_Image" \
--tmpdir /var/tmp

Verify that your fdi.iso file is created:

# ls -h *.iso

To extract the initial ramdisk and kernel files from the .iso file over a network, enter the following command:

# discovery-iso-to-pxe fdi.iso

Create a directory to store your boot files:

# mkdir /var/lib/tftpboot/boot/myimage

Copy the initrd0.img and vmlinuz0 files to your new directory.

Edit the KERNEL and APPEND entries in the /var/lib/tftpboot/pxelinux.cfg file to add the information about your own initial ramdisk and kernel files.

To convert the .iso file to an .iso hybrid file for PXE provisioning, enter the following command:

# isohybrid --partok fdi.iso

# isohybrid --partok --uefi fdi.iso

To add md5 checksum to the .iso file so it can pass installation media validation tests in Foreman, enter the following command:

# implantisomd5 fdi.iso

Create the following directory structure:

.
├── autostart.d
│   └── 01_zip.sh
├── bin
│   └── ntpdate
├── facts
│   └── test.rb
└── lib
    ├── libcrypto.so.1.0.0
    └── ruby
        └── test.rb

After creating the directory structure, create a .zip file archive with the following command:

# zip -r my_extension.zip .

To inform the Discovery image of the extensions it must use, place your zip files on your TFTP server with the Discovery image, and then update the APPEND line of the PXELinux template with the fdi.zips option where the paths are relative to the TFTP root. For example, if you have two archives at $TFTP/zip1.zip and $TFTP/boot/zip2.zip, use the following syntax:

fdi.zips=zip1.zip,boot/zip2.zip

On Foreman server, switch to the foreman user:

# su foreman -s /bin/bash

Generate the key pair:

$ ssh-keygen

Copy the public key to the KVM server:

$ ssh-copy-id root@kvm.example.com

Exit the bash shell for the foreman user:

$ exit

Install the libvirt-client package:

# apt-get install libvirt-client

Use the following command to test the connection to the KVM server:

# su foreman -s /bin/bash -c 'virsh -c qemu+ssh://root@kvm.example.com/system list'

In the Foreman web UI, navigate to Infrastructure > Compute Resources and click Create Compute Resource.

In the Name field, enter a name for the new compute resource.

From the Provider list, select Libvirt.

In the Description field, enter a description for the compute resource.

In the URL field, enter the connection URL to the KVM server. For example:

 qemu+ssh://root@kvm.example.com/system

From the Display type list, select either VNC or Spice.

Optional: To secure console access for new hosts with a randomly generated password, select the Set a randomly generated password on the display connection checkbox. You can retrieve the password for the VNC console to access the guest virtual machine console from the output of the following command executed on the KVM server:

# virsh edit your_VM_name
<graphics type='vnc' port='-1' autoport='yes' listen='0.0.0.0' passwd='your_randomly_generated_password'>

Click Test Connection to ensure that Foreman server connects to the KVM server without fault.

Verify that the Locations and Organizations tabs are automatically set to your current context. If you want, add additional contexts to these tabs.

Click Submit to save the KVM connection.

In the Foreman web UI, navigate to Infrastructure > Compute Resources and click the name of the KVM connection.

Click Create Image.

In the Name field, enter a name for the image.

From the Operating System list, select the base operating system of the image.

From the Architecture list, select the operating system architecture.

In the Username field, enter the SSH user name for image access. This is normally the root user.

In the Password field, enter the SSH password for image access.

In the Image path field, enter the full path that points to the image on the KVM server. For example:

 /var/lib/libvirt/images/TestImage.qcow2

Optional: Select the User Data checkbox if the image supports user data input, such as cloud-init data.

Click Submit to save the image details.

In the Foreman web UI, navigate to Infrastructure > Compute Profiles.

In the Compute Profiles window, click the name of an existing compute profile, or click Create Compute Profile, enter a Name, and click Submit.

Click the name of the KVM compute resource.

In the CPUs field, enter the number of CPUs to allocate to the new host.

In the Memory field, enter the amount of memory to allocate to the new host.

From the Image list, select the image to use if performing image-based provisioning.

From the Network Interfaces list, select the network parameters for the host’s network interface. You can create multiple network interfaces. However, at least one interface must point to a Smart Proxy-managed network.

In the Storage area, enter the storage parameters for the host. You can create multiple volumes for the host.

Click Submit to save the settings to the compute profile.

To create a compute profile, enter the following command:

# hammer compute-profile create --name "Libvirt CP"

To add the values for the compute profile, enter the following command:

# hammer compute-profile values create --compute-profile "Libvirt CP" \
--compute-resource "My_KVM_Server" \
--interface "compute_type=network,compute_model=virtio,compute_network=examplenetwork" \
--volume "pool_name=default,capacity=20G,format_type=qcow2" \
--compute-attributes "cpus=1,memory=1073741824"

In the Foreman web UI, navigate to Hosts > Create Host.

In the Name field, enter a name for the host.

Click the Organization and Location tabs to ensure that the provisioning context is automatically set to the current context.

From the Host Group list, select the host group that you want to use to populate the form.

From the Deploy on list, select the KVM connection.

From the Compute Profile list, select a profile to use to automatically populate virtual machine settings.

Click the Interface tab and click Edit on the host’s interface.

Verify that the fields are automatically populated, particularly the following items:

Click the Operating System tab, and confirm that all fields automatically contain values.

Select the Provisioning Method that you want to use:

Click Resolve in Provisioning templates to check the new host can identify the right provisioning templates to use.

Click the Virtual Machine tab and confirm that these settings are populated with details from the host group and compute profile. Modify these settings to suit your needs.

Click Submit to save the host entry.

In the Foreman web UI, navigate to Infrastructure > Compute Resources and click Create Compute Resource.

In the Name field, enter a name for the new compute resource.

From the Provider list, select oVirt.

In the Description field, enter a description for the compute resource.

In the URL field, enter the connection URL for the oVirt Engine’s API in the following form: https://ovirt.example.com/ovirt-engine/api/v4.

In the User field, enter the name of a user with permissions to access oVirt Engine’s resources.

In the Password field, enter the password of the user.

Click Load Datacenters to populate the Datacenter list with data centers from your oVirt environment.

From the Datacenter list, select a data center.

From the Quota ID list, select a quota to limit resources available to Foreman.

In the X509 Certification Authorities field, enter the certificate authority for SSL/TLS access. Alternatively, if you leave the field blank, a self-signed certificate is generated on the first API request by the server.

Click the Locations tab and select the location you want to use.

Click the Organizations tab and select the organization you want to use.

Click Submit to save the compute resource.

In oVirt, create a virtual machine to use for image-based provisioning in Foreman.

On the virtual machine, install cloud-init:

apt-get install cloud-init

To the /etc/cloud/cloud.cfg file, add the following information:

datasource_list: ["NoCloud", "ConfigDrive"]

In oVirt, create an image from this virtual machine.

In the Foreman web UI, navigate to Infrastructure > Compute Resources and click the name of the oVirt connection.

Click Create Image.

In the Name field, enter a name for the image.

From the Operating System list, select the base operating system of the image.

From the Architecture list, select the operating system architecture.

In the Username field, enter the SSH user name for image access. This is normally the root user.

In the Password field, enter the SSH password for image access.

From the Image list, select an image from the oVirt compute resource.

Optional: Select the User Data checkbox if the image supports user data input, such as cloud-init data.

Click Submit to save the image details.

In the Foreman web UI, navigate to Hosts > Provisioning Templates, and click Create Template.

In the Name field, enter a name for the template.

In the Editor field, enter the following template details:

<%#
kind: user_data
name: Cloud-init
-%>
#cloud-config
hostname: <%= @host.shortname %>

<%# Allow user to specify additional SSH key as host parameter -%>
<% if @host.params['sshkey'].present? || @host.params['remote_execution_ssh_keys'].present? -%>
ssh_authorized_keys:
<% if @host.params['sshkey'].present? -%>
  - <%= @host.params['sshkey'] %>
<% end -%>
<% if @host.params['remote_execution_ssh_keys'].present? -%>
<% @host.params['remote_execution_ssh_keys'].each do |key| -%>
  - <%= key %>
<% end -%>
<% end -%>
<% end -%>
runcmd:
  - |
    #!/bin/bash
<%= indent 4 do
    snippet 'subscription_manager_registration'
end %>
<% if @host.info['parameters']['realm'] && @host.realm && @host.realm.realm_type == 'Red Hat Identity Management' -%>
  <%= indent 4 do
    snippet 'freeipa_register'
  end %>
<% end -%>
<% unless @host.operatingsystem.atomic? -%>
    # update all the base packages from the updates repository
    yum -t -y -e 0 update
<% end -%>
<%
    # safemode renderer does not support unary negation
    non_atomic = @host.operatingsystem.atomic? ? false : true
    pm_set = @host.puppetmaster.empty? ? false : true
    puppet_enabled = non_atomic && (pm_set || @host.params['force-puppet'])
%>
<% if puppet_enabled %>
    yum install -y puppet
    cat > /etc/puppet/puppet.conf << EOF
  <%= indent 4 do
    snippet 'puppet.conf'
  end %>
    EOF
    # Setup puppet to run on system reboot
    /sbin/chkconfig --level 345 puppet on

    /usr/bin/puppet agent --config /etc/puppet/puppet.conf --onetime --tags no_such_tag <%= @host.puppetmaster.blank? ? '' : "--server #{@host.puppetmaster}" %> --no-daemonize
    /sbin/service puppet start
<% end -%>
phone_home:
 url: <%= foreman_url('built') %>
 post: []
 tries: 10pp

Click the Type tab and from the Type list, select User data template.

Click the Association tab, and from the Applicable Operating Systems list, select the operating system that you want associate with the template.

Click the Locations tab, and from the Locations list, select the location that you want to associate with the template.

Click the Organizations tab, and from the Organization list, select the organization that you want to associate with the template.

Click Submit.

In the Foreman web UI, navigate to Hosts > Operating Systems, and select the operating system you want to associate with the template.

Click the Templates tab, and from the User data template list, select the name of the new template.

Click Submit.

In the Foreman web UI, navigate to Infrastructure > Compute Profiles.

In the Compute Profiles window, click the name of an existing compute profile, or click Create Compute Profile, enter a Name, and click Submit.

Click the name of the oVirt compute resource.

From the Cluster list, select the target host cluster in the oVirt environment.

From the Template list, select the oVirt template to use for the Cores and Memory settings.

In the Cores field, enter the number of CPU cores to allocate to the new host.

In the Memory field, enter the amount of memory to allocate to the new host.

From the Image list, select image to use for image-based provisioning.

In the Network Interfaces area, enter the network parameters for the host’s network interface. You can create multiple network interfaces. However, at least one interface must point to a Smart Proxy-managed network. For each network interface, enter the following details:

In the Storage area, enter the storage parameters for the host. You can create multiple volumes for the host. For each volume, enter the following details:

Click Submit to save the compute profile.

To create a compute profile, enter the following command:

# hammer compute-profile create --name "oVirt CP"

To set the values for the compute profile, enter the following command:

# hammer compute-profile values create --compute-profile "oVirt CP" \
--compute-resource "My_oVirt" \
--interface "compute_interface=Interface_Type,compute_name=eth0,compute_network=satnetwork" \
--volume "size_gb=20G,storage_domain=Data,bootable=true" \
--compute-attributes "cluster=Default,cores=1,memory=1073741824,start=true""

In the Foreman web UI, navigate to Hosts > Create Host.

In the Name field, enter a name for the host.

Click the Organization and Location tabs to ensure that the provisioning context is automatically set to the current context.

From the Host Group list, select the host group that you want to use to populate the form.

From the Deploy on list, select the oVirt connection.

From the Compute Profile list, select a profile to use to automatically populate virtual machine settings.

Click the Interface tab and click Edit on the host’s interface.

Verify that the fields are automatically populated, particularly the following items:

Click the Operating System tab, and confirm that all fields automatically contain values.

Select the Provisioning Method that you want to use:

Click Resolve in Provisioning templates to check the new host can identify the right provisioning templates to use.

Click the Virtual Machine tab and confirm that these settings are populated with details from the host group and compute profile. Modify these settings to suit your needs.

Click Submit to save the host entry.

Install the VMware compute resource provider on your Foreman server:

# foreman-installer --enable-foreman-compute-vmware

Optional: In the Foreman web UI, navigate to Administer > About and select the compute resources tab to verify the installation of the VMware plugin.

In the Foreman web UI, navigate to Infrastructure > Compute Resources, and in the Compute Resources window, click Create Compute Resource.

In the Name field, enter a name for the resource.

From the Provider list, select VMware.

In the Description field, enter a description for the resource.

In the VCenter/Server field, enter the IP address or host name of the vCenter server.

In the User field, enter the user name with permission to access the vCenter’s resources.

In the Password field, enter the password for the user.

Click Load Datacenters to populate the list of data centers from your VMware vSphere environment.

From the Datacenter list, select a specific data center to manage from this list.

In the Fingerprint field, ensure that this field is populated with the fingerprint from the data center.

From the Display Type list, select a console type, for example, VNC or VMRC. Note that VNC consoles are unsupported on VMware ESXi 6.5 and later.

Optional: In the VNC Console Passwords field, select the Set a randomly generated password on the display connection checkbox to secure console access for new hosts with a randomly generated password. You can retrieve the password for the VNC console to access guest virtual machine console from the libvirtd host from the output of the following command:

# virsh edit your_VM_name
<graphics type='vnc' port='-1' autoport='yes' listen='0.0.0.0' passwd='your_randomly_generated_password'>

From the Enable Caching list, you can select whether to enable caching of compute resources. For more information, see Caching of Compute Resources.

Click the Locations and Organizations tabs and verify that the values are automatically set to your current context. You can also add additional contexts.

Click Submit to save the connection.

In the Foreman web UI, navigate to Infrastructure > Compute Resources.

Select your Vmware compute resource.

Click Create Image.

In the Name field, enter a name for the image.

From the Operating System list, select the base operating system of the image.

From the Architecture list, select the operating system architecture.

In the Username field, enter the SSH user name for image access. By default, this is set to root.

If your image supports user data input such as cloud-init data, click the User data checkbox.

Optional: In the Password field, enter the SSH password to access the image.

From the Image list, select an image from VMware.

Click Submit to save the image details.

In the Foreman web UI, navigate to Infrastructure > Compute Profiles.

Select a compute profile.

Select a Vmware compute resource.

In the CPUs field, enter the number of CPUs to allocate to the host.

In the Cores per socket field, enter the number of cores to allocate to each CPU.

In the Memory field, enter the amount of memory in MiB to allocate to the host.

In the Firmware checkbox, select either BIOS or UEFI as firmware for the host. By default, this is set to automatic.

In the Cluster list, select the name of the target host cluster on the VMware environment.

From the Resource pool list, select an available resource allocations for the host.

In the Folder list, select the folder to organize the host.

From the Guest OS list, select the operating system you want to use in VMware vSphere.

From the Virtual H/W version list, select the underlying VMware hardware abstraction to use for virtual machines.

If you want to add more memory while the virtual machine is powered on, select the Memory hot add checkbox.

If you want to add more CPUs while the virtual machine is powered on, select the CPU hot add checkbox.

If you want to add a CD-ROM drive, select the CD-ROM drive checkbox.

From the Boot order list, define the order in which the virtual machines tried to boot.

Optional: In the Annotation Notes field, enter an arbitrary description.

If you use image-based provisioning, select the image from the Image list.

From the SCSI controller list, select the disk access method for the host.

If you want to use eager zero thick provisioning, select the Eager zero checkbox. By default, the disk uses lazy zero thick provisioning.

From the Network Interfaces list, select the network parameters for the host’s network interface. At least one interface must point to a Smart Proxy-managed network.

Optional: Click Add Interface to create another network interfaces.

Click Submit to save the compute profile.

Create a compute profile:

# hammer compute-profile create --name "My_Compute_Profile"

Set VMware details to a compute profile:

# hammer compute-profile values create \
--compute-attributes "cpus=1,corespersocket=2,memory_mb=1024,cluster=MyCluster,path=MyVMs,start=true" \
--compute-profile "My_Compute_Profile" \
--compute-resource "My_VMware" \
--interface "compute_type=VirtualE1000,compute_network=mynetwork \
--volume "size_gb=20G,datastore=Data,name=myharddisk,thin=true"

In the Foreman web UI, navigate to Hosts > Create Host.

In the Name field, enter a host name.

Click the Organization and Location tabs to ensure that the provisioning context is automatically set to the current context.

From the Host Group list, select the host group that you want to use to populate the form.

From the Deploy on list, select the VMware vSphere connection.

From the Compute Profile list, select a profile to use to automatically populate virtual machine-based settings.

Click the Interface tab and click Edit on the host’s interface.

Verify that the fields are automatically populated with values. Note in particular:

Ensure that the MAC address field is blank. The VMware vSphere server assigns one to the host.

Verify that the Managed, Primary, and Provision options are automatically selected for the first interface on the host. If not, select them.

In the interface window, review the VMware vSphere-specific fields that are populated with settings from our compute profile. Modify these settings to suit your needs.

Click the Operating System tab, and confirm that all fields automatically contain values.

Select the Provisioning Method that you want:

Click Resolve in Provisioning templates to check the new host can identify the right provisioning templates to use.

Click the Virtual Machine tab and confirm that these settings are populated with details from the host group and compute profile. Modify these settings to suit your requirements.

Click Submit to provision your host on VMware.

In the Foreman web UI, navigate to Hosts > Templates > Provisioning Templates.

Search for the CloudInit default template and click its name.

Click the Association tab.

Select all operating systems to which the template applies and click Submit.

Repeat the steps above for the UserData open-vm-tools template.

Navigate to Hosts > Provisioning Setup > Operating Systems.

Select the operating system that you want to use for provisioning.

Click the Templates tab.

From the Cloud-init template list, select CloudInit default.

From the User data template list, select UserData open-vm-tools.

Click Submit to save the changes.

On the virtual machine that you use to create the image, install the cloud-init, open-vm-tools, and perl packages:

# yum -y install cloud-init open-vm-tools perl

Disable network configuration by cloud-init:

# cat << EOM > /etc/cloud/cloud.cfg.d/01_network.cfg
network:
  config: disabled
EOM

Configure cloud-init to fetch data from Foreman:

# cat << EOM > /etc/cloud/cloud.cfg.d/10_datasource.cfg
datasource_list: [NoCloud]
datasource:
  NoCloud:
    seedfrom: https://foreman.example.com/userdata/
EOM

Configure modules to use in cloud-init:

# cat << EOM > /etc/cloud/cloud.cfg
cloud_init_modules:
 - bootcmd
 - ssh

cloud_config_modules:
 - runcmd

cloud_final_modules:
 - scripts-per-once
 - scripts-per-boot
 - scripts-per-instance
 - scripts-user
 - phone-home

system_info:
  distro: rhel
  paths:
    cloud_dir: /var/lib/cloud
    templates_dir: /etc/cloud/templates
  ssh_svcname: sshd
EOM

Enable the CA certificates for the image:

# update-ca-trust enable

Copy the CA certificate from the Apache configuration to /etc/pki/ca-trust/source/anchors/cloud-init-ca.crt.

Update the record of certificates:

# update-ca-trust extract

Clean the image:

# systemctl stop rsyslog
# systemctl stop auditd
# package-cleanup --oldkernels --count=1
# apt-get clean all

Reduce logspace, remove old logs, and truncate logs:

# logrotate -f /etc/logrotate.conf
# rm -f /var/log/*-???????? /var/log/*.gz
# rm -f /var/log/dmesg.old
# rm -rf /var/log/anaconda
# cat /dev/null > /var/log/audit/audit.log
# cat /dev/null > /var/log/wtmp
# cat /dev/null > /var/log/lastlog
# cat /dev/null > /var/log/grubby

Remove udev hardware rules:

# rm -f /etc/udev/rules.d/70*

Remove the ifcfg scripts related to existing network configurations:

# rm -f /etc/sysconfig/network-scripts/ifcfg-ens*
# rm -f /etc/sysconfig/network-scripts/ifcfg-eth*

Remove the SSH host keys:

# rm -f /etc/ssh/ssh_host_*

Remove root user’s SSH history:

# rm -rf ~root/.ssh/known_hosts

Remove root user’s shell history:

# rm -f ~root/.bash_history
# unset HISTFILE

Create an image from this virtual machine.

Add your image to Foreman.

In the Foreman web UI, navigate to Infrastructure > Compute Resources.

Select your VMware provider.

On the Virtual Machines tab, click Delete from the Actions menu. This deletes the virtual machine from the VMware compute resource while retaining any associated hosts within Foreman. If you want to delete the orphaned host, navigate to Hosts > All Hosts and delete the host manually.

In the Foreman web UI, navigate to Infrastructure > Compute Resources.

Select your VMware compute resource.

On the Virtual Machines tab, click Import as managed Host or Import as unmanaged Host from the Actions menu. The following page looks identical to creating a host with the compute resource being already selected. For more information, see Creating a Host in Foreman in Managing Hosts.

Click Submit to import the virtual machine into Foreman.

Enter the following foreman-installer command to enable the KubeVirt plugin for Foreman:

# foreman-installer --enable-foreman-plugin-kubevirt

Generate a bearer token to use for HTTP and HTTPs authentication. On the KubeVirt server, list the secrets that contain tokens:

# kubectl get secrets

List the token for your secret:

# kubectl get secrets YOUR_SECRET -o jsonpath='{.data.token}' | base64 -d | xargs

In the Foreman web UI, navigate to Infrastructure > Compute Resources, and click Create Compute Resource.

In the Name field, enter a name for the new compute resource.

From the Provider list, select KubeVirt.

In the Description field, enter a description for the compute resource.

In the Hostname field, enter the FQDN, hostname, or IP address of the KubeVirt server that you want to use.

In the API Port field, enter the port number that you want to use for provisioning requests from Foreman to KubeVirt.

In the Namespace field, enter the user name of the KubeVirt virtual cluster that you want to use.

In the Token field, enter the bearer token for HTTP and HTTPs authentication.

Optional: In the X509 Certification Authorities field, enter a certificate to enable client certificate authentication for API server calls.

In the Foreman web UI, navigate to Infrastructure > Compute Resources.

Click Create Compute Resource.

In the Name field, enter a name for the new compute resource.

From the Provider list, select RHEL OpenStack Platform.

Optional: In the Description field, enter a description for the compute resource.

In the URL field, enter the URL for the OpenStack Authentication keystone service’s API at the tokens resource, such as http://openstack.example.com:5000/v2.0/tokens or http://openstack.example.com:5000/v3/auth/tokens.

In the Username and Password fields, enter the user authentication for Foreman to access the environment.

Optional: In the Project (Tenant) name field, enter the name of your tenant (v2) or project (v3) for Foreman server to manage.

In the User domain field, enter the user domain for v3 authentication.

In the Project domain name field, enter the project domain name for v3 authentication.

In the Project domain ID field, enter the project domain ID for v3 authentication.

Optional: Select Allow external network as main network to use external networks as primary networks for hosts.

Optional: Click Test Connection to verify that Foreman can connect to your compute resource.

Click the Locations and Organizations tabs and verify that the location and organization that you want to use are set to your current context. Add any additional contexts that you want to these tabs.

Click Submit to save the OpenStack connection.

In the Foreman web UI, navigate to Infrastructure > Compute Resources and click the name of the OpenStack connection.

Click Create Image.

In the Name field, enter a name for the image.

From the Operating System list, select the base operating system of the image.

From the Architecture list, select the operating system architecture.

In the Username field, enter the SSH user name for image access. This is normally the root user.

In the Password field, enter the SSH password for image access.

From the Image list, select an image from the OpenStack compute resource.

Optional: Select the User Data checkbox if the image supports user data input, such as cloud-init data.

Click Submit to save the image details.

In the Foreman web UI, navigate to Infrastructure > Compute Profiles.

In the Compute Profiles window, click the name of an existing compute profile, or click Create Compute Profile, enter a Name, and click Submit.

Click the name of the OpenStack compute resource.

From the Flavor list, select the hardware profile on OpenStack to use for the host.

From the Availability zone list, select the target cluster to use within the OpenStack environment.

From the Image list, select the image to use for image-based provisioning.

From the Tenant list, select the tenant or project for the OpenStack instance.

From the Security Group list, select the cloud-based access rules for ports and IP addresses.

From the Internal network, select the private networks for the host to join.

From the Floating IP network, select the external networks for the host to join and assign a floating IP address.

From the Boot from volume, select whether a volume is created from the image. If not selected, the instance boots the image directly.

In the New boot volume size (GB) field, enter the size, in GB, of the new boot volume.

Click Submit to save the compute profile.

In the Foreman web UI, navigate to Hosts > Create Host.

In the Name field, enter a name for the host.

Click the Organization and Location tabs to ensure that the provisioning context is automatically set to the current context.

From the Host Group list, select the host group that you want to use to populate the form.

From the Deploy on list, select the OpenStack connection.

From the Compute Profile list, select a profile to use to automatically populate virtual machine settings.

From the Lifecycle Environment list, select the environment.

Click the Interfaces tab and click Edit on the host’s interface.

Verify that the fields are automatically populated, particularly the following items:

Click the Operating System tab, and confirm that all fields automatically contain values.

If you want to change the image that populates automatically from your compute profile, from the Images list, select a different image to base the new host’s root volume on.

Click Resolve in Provisioning templates to check the new host can identify the right provisioning templates to use.

Click the Virtual Machine tab and confirm that these settings are populated with details from the host group and compute profile. Modify these settings to suit your needs.

Click Submit to save the host entry.

Install the EC2 compute resource provider on your Foreman server:

# foreman-installer --enable-foreman-compute-ec2

Optional: In the Foreman web UI, navigate to Administer > About and select the compute resources tab to verify the installation of the Amazon EC2 plugin.

In the Foreman web UI, navigate to Infrastructure > Compute Resources and in the Compute Resources window, click Create Compute Resource.

In the Name field, enter a name to identify the Amazon EC2 compute resource.

From the Provider list, select EC2.

In the Description field, enter information that helps distinguish the resource for future use.

Optional: From the HTTP proxy list, select an HTTP proxy to connect to external API services. You must add HTTP proxies to Foreman before you can select a proxy from this list. For more information, see Using an HTTP Proxy with Compute Resources.

In the Access Key and Secret Key fields, enter the access keys for your Amazon EC2 account. For more information, see Managing Access Keys for your AWS Account on the Amazon documentation website.

Optional: Click the Load Regions button to populate the Regions list.

From the Region list, select the Amazon EC2 region or data center to use.

Click the Locations tab and ensure that the location you want to use is selected, or add a different location.

Click the Organizations tab and ensure that the organization you want to use is selected, or add a different organization.

Click Submit to save the Amazon EC2 connection.

Select the new compute resource and then click the SSH keys tab, and click Download to save a copy of the SSH keys to use for SSH authentication. Until BZ1793138 is resolved, you can download a copy of the SSH keys only immediately after creating the Amazon EC2 compute resource. If you require SSH keys at a later stage, follow the procedure in Connecting to an Amazon EC2 instance using SSH.

In the Foreman web UI, navigate to Infrastructure > HTTP Proxies, and select New HTTP Proxy.

In the Name field, enter a name for the HTTP proxy.

In the URL field, enter the URL for the HTTP proxy, including the port number.

Optional: Enter a username and password to authenticate to the HTTP proxy, if your HTTP proxy requires authentication.

Click Test Connection to ensure that you can connect to the HTTP proxy from Foreman.

Click the Locations tab and add a location.

Click the Organization tab and add an organization.

Click Submit.

In the Foreman web UI, navigate to Infrastructure > Compute Resources.

Select your Amazon EC2 provider.

Click Create Image.

In the Foreman web UI, navigate to Infrastructure > Compute Resources and select an Amazon EC2 connection.

Click the Images tab, and then click Create Image.

In the Name field, enter a name to identify the image for future use.

From the Operating System list, select the operating system that corresponds with the image you want to add.

From the Architecture list, select the operating system’s architecture.

In the Username field, enter the SSH user name for image access. This is normally the root user.

In the Password field, enter the SSH password for image access.

In the Image ID field, enter the Amazon Machine Image (AMI) ID for the image. This is usually in the following format: ami-xxxxxxxx.

Optional: Select the User Data checkbox if the images support user data input, such as cloud-init data. If you enable user data, the Finish scripts are automatically disabled. This also applies in reverse: if you enable the Finish scripts, this disables user data.

Optional: In the IAM role field, enter the Amazon security role used for creating the image.

Click Submit to save the image details.

In the Foreman web UI, navigate to Infrastructure > Compute Profiles and click the name of your profile, then click an EC2 connection.

From the Flavor list, select the hardware profile on EC2 to use for the host.

From the Image list, select the image to use for image-based provisioning.

From the Availability zone list, select the target cluster to use within the chosen EC2 region.

From the Subnet list, add the subnet for the EC2 instance. If you have a VPC for provisioning new hosts, use its subnet.

From the Security Groups list, select the cloud-based access rules for ports and IP addresses to apply to the host.

From the Managed IP list, select either a Public IP or a Private IP.

Click Submit to save the compute profile.

In the Foreman web UI, navigate to Hosts > Create Host.

In the Name field, enter a name for the host.

From the Host Group list, you can select a host group to populate most of the new host’s fields.

From the Deploy on list, select the EC2 connection.

From the Compute Profile list, select a profile to use to automatically populate virtual machine-based settings.

Click the Interface tab, and then click Edit on the host’s interface, and verify that the fields are populated with values. Leave the Mac Address field blank. Foreman server automatically selects and IP address and the Managed, Primary, and Provision options for the first interface on the host.

Click the Operating System tab and confirm that all fields are populated with values.

Click the Virtual Machine tab and confirm that all fields are populated with values.

Click Submit to save your changes.

To locate the compute resource list, on your Foreman server base system, enter the following command, and note the ID of the compute resource that you want to use:

# hammer compute-resource list

Switch user to the postgres user:

# su - postgres

Initiate the postgres shell:

$ psql

Connect to the Foreman database as the user postgres:

# postgres=# \c foreman

Select the secret from key_pairs where compute_resource_id = 3:

# select secret from key_pairs where compute_resource_id = 3; secret

Copy the key from after -----BEGIN RSA PRIVATE KEY----- until -----END RSA PRIVATE KEY-----.

Create a .pem file and paste your key into the file:

# vim Keyname.pem

Ensure that you restrict access to the .pem file:

# chmod 600 Keyname.pem

To connect to the Amazon EC2 instance, enter the following command:

ssh -i Keyname.pem   ec2-user@example.aws.com

In the Foreman web UI, navigate to Hosts > Provisioning Templates.

In the Provisioning Templates page, enter Kickstart default finish into the search field and click Search.

On the Kickstart default finish template, select Clone.

In the Name field, enter a unique name for the template.

In the template, prefix each command that requires root privileges with sudo, except for yum or equivalent commands, or add the following line to run the entire template as the sudo user:

sudo -s << EOS
_Template_ _Body_
EOS

Click the Association tab, and associate the template with a Red Hat Enterprise Linux operating system that you want to use.

Click the Locations tab, and add the the location where the host resides.

Click the Organizations tab, and add the organization that the host belongs to.

Make any additional customizations or changes that you require, then click Submit to save your template.

In the Foreman web UI, navigate to Hosts > Operating systems and select the operating system that you want for your host.

Click the Templates tab, and from the Finish Template list, select your finish template.

In the Foreman web UI, navigate to Hosts > Create Host and enter the information about the host that you want to create.

Click the Parameters tab and navigate to Host parameters.

If you have the Remote Execution plugin installed, in Host parameters, click the Add Parameter button two times to add two new parameter fields. If you use the Katello plugin, add a third parameter field. Add the following parameters:

Click Submit to save the changes.

In the Foreman web UI, navigate to Infrastructure > Compute Resources.

Select your Amazon EC2 provider.

On the Virtual Machines tab, click Delete from the Actions menu. This deletes the virtual machine from the Amazon EC2 compute resource while retaining any associated hosts within Foreman. If you want to delete an orphaned host, navigate to Hosts > All Hosts and delete the host manually.

Uninstall the EC2 compute resource provider from your Foreman server:

# yum remove -y foreman-ec2
# foreman-installer --no-enable-foreman-compute-ec2

Optional: In the Foreman web UI, navigate to Administer > About and select the Available Providers tab to verify the removal of the Amazon EC2 plugin.

Install the Google GCE compute resource provider on your Foreman server:

# foreman-installer --enable-foreman-compute-gce

Optional: In the Foreman web UI, navigate to Administer > About and select the Compute Resources tab to verify the installation of the Google GCE plugin.

In Google GCE, generate a service account key in JSON format.

Copy the file from your local machine to Foreman server:

# scp gce_key.json root@foreman.example.com:/usr/share/foreman/gce_key.json

On Foreman server, change the owner for your service account key to the foreman user:

# chown foreman /usr/share/foreman/gce_key.json

On Foreman server, configure permissions for your service account key to ensure that the file is readable:

# chmod 0600 /usr/share/foreman/gce_key.json

On Foreman server, restore SELinux context for your service account key:

# restorecon -vv /usr/share/foreman/gce_key.json

In the Foreman web UI, navigate to Infrastructure > Compute Resources and click Create Compute Resource.

In the Name field, enter a name for the compute resource.

From the Provider list, select Google.

Optional: In the Description field, enter a description for the resource.

In the Google Project ID field, enter the project ID.

In the Client Email field, enter the client email.

In the Certificate Path field, enter the path to the service account key. For example, /usr/share/foreman/gce_key.json.

Click Load Zones to populate the list of zones from your GCE environment.

From the Zone list, select the GCE zone to use.

Click Submit.

In Google GCE, generate a service account key in JSON format.

Copy the file from your local machine to Foreman server:

# scp gce_key.json root@foreman.example.com:/usr/share/foreman/gce_key.json

On Foreman server, change the owner for your service account key to the foreman user:

# chown foreman /usr/share/foreman/gce_key.json

On Foreman server, configure permissions for your service account key to ensure that the file is readable:

# chmod 0600 /usr/share/foreman/gce_key.json

On Foreman server, restore SELinux context for your service account key:

# restorecon -vv /usr/share/foreman/gce_key.json

Use the hammer compute-resource create command to add a GCE compute resource to Foreman:

# hammer compute-resource create \
--email "My_GCE_Email" \
--key-path "Path_To_My_GCE_Key.json" \
--name "My_GCE_Compute_Resource" \
--project "My_GCE_Project_ID" \
--provider "gce" \
--zone "My_Zone"

In the Foreman web UI, navigate to Infrastructure > Compute Resources and click the name of the Google Compute Engine connection.

Click Create Image.

In the Name field, enter a name for the image.

From the Operating System list, select the base operating system of the image.

From the Architecture list, select the operating system architecture.

In the Username field, enter the SSH user name for image access. Specify a user other than root, because the root user cannot connect to a GCE instance using SSH keys. The username must begin with a letter and consist of lowercase letters and numbers.

From the Image list, select an image from the Google Compute Engine compute resource.

Optional: Select the User Data checkbox if the image supports user data input, such as cloud-init data.

Click Submit to save the image details.

In the Foreman web UI, navigate to Infrastructure > Compute Profiles.

In the Compute Profiles window, click the name of an existing compute profile, or click Create Compute Profile, enter a Name, and click Submit.

Click the name of the GCE compute resource.

From the Machine Type list, select the machine type to use for provisioning.

From the Image list, select the image to use for provisioning.

From the Network list, select the Google GCE network to use for provisioning.

Optional: Select the Associate Ephemeral External IP checkbox to assign a dynamic ephemeral IP address that Foreman uses to communicate with the host. This public IP address changes when you reboot the host. If you need a permanent IP address, reserve a static public IP address on Google GCE and attach it to the host.

In the Size (GB) field, enter the size of the storage to create on the host.

Click Submit to save the compute profile.

Create a compute profile to use with the Google GCE compute resource:

# hammer compute-profile create --name My_GCE_Compute_Profile

Add GCE details to the compute profile:

# hammer compute-profile values create \
--compute-attributes "machine_type=f1-micro,associate_external_ip=true,network=default" \
--compute-profile "My_GCE_Compute_Profile" \
--compute-resource "My_GCE_Compute_Resource" \
--volume "size_gb=20"

In the Foreman web UI, navigate to Hosts > Create Host.

In the Name field, enter a name for the host.

Click the Organization and Location tabs to ensure that the provisioning context is automatically set to the current context.

From the Host Group list, select the host group that you want to use to populate the form.

From the Deploy on list, select the Google Compute Engine connection.

From the Compute Profile list, select a profile to use to automatically populate virtual machine settings.

From the Lifecycle Environment list, select the environment.

Click the Interfaces tab and click Edit on the host’s interface.

Verify that the fields are automatically populated, particularly the following items:

Click the Operating System tab, and confirm that all fields automatically contain values.

Click Resolve in Provisioning templates to check the new host can identify the right provisioning templates to use.

Click the Virtual Machine tab and confirm that these settings are populated with details from the host group and compute profile. Modify these settings to suit your needs.

Click Submit to save the host entry.

In the Foreman web UI, navigate to Infrastructure > Compute Resources.

Select your Google GCE provider.

On the Virtual Machines tab, click Delete from the Actions menu. This deletes the virtual machine from the Google GCE compute resource while retaining any associated hosts within Foreman. If you want to delete the orphaned host, navigate to Hosts > All Hosts and delete the host manually.

Uninstall the GCE compute resource provider from your Foreman server:

# yum remove -y foreman-gce
# foreman-installer --no-enable-foreman-compute-gce

Optional: In the Foreman web UI, navigate to Administer > About and select the Available Providers tab to verify the removal of the Google GCE plugin.

In the Foreman web UI, navigate to Infrastructure > Compute Resources and click Create Compute Resource.

In the Name field, enter a name for the compute resource.

From the Provider list, select Azure Resource Manager.

Optional: In the Description field, enter a description for the resource.

By default, the Cloud is set to Public/Standard. Azure Government Cloud supports the following regions:

In the Client ID field, enter your Application or client ID.

In the Client Secret field, enter your client secret.

In the Subscription ID field, enter your subscription ID.

In the Tenant ID field, enter your Directory or tenant ID.

Click Load Regions. This tests if your connection to Azure Resource Manager is successful and loads the regions available in your subscription.

From the Azure Region list, select the Azure region to use.

Click Submit.

In the Foreman web UI, navigate to Infrastructure > Compute Resources and click the name of the Microsoft Azure Resource Manager connection.

Click Create Image.

In the Name field, enter a name for the image.

From the Operating System list, select the base operating system of the image.

From the Architecture list, select the operating system architecture.

In the Username field, enter the SSH user name for image access. You cannot use the root user.

Optional: In the Password field, enter a password to authenticate with.

In the Azure Image Name field, enter an image name in the format prefix://UUID.

Optional: Select the User Data checkbox if the image supports user data input, such as cloud-init data.

Click Submit to save the image details.

In the Foreman web UI, navigate to Infrastructure > Compute Profiles.

In the Compute Profiles window, click the name of an existing compute profile, or click Create Compute Profile, enter a Name, and click Submit.

Click the name of the Azure compute resource.

From the Resource group list, select the resource group to provision to.

From the VM Size list, select a size of a virtual machine to provision.

From the Platform list, select Linux.

In the Username field, enter a user name to authenticate with. Note that the username that you enter for compute profile must be the same that you use when creating an image.

To authenticate the user, use one of the following options:

Optional: If you want the virtual machine to use a premium virtual machine disk, select the Premium OS Disk checkbox.

From the OS Disk Caching list, select the disc caching setting.

Optional: In the Custom Script Command field, enter commands to perform on the virtual machine when the virtual machine is provisioned.

Optional: If you want to run custom scripts when provisioning finishes, in the Comma separated file URIs field, enter comma-separated file URIs of scripts to use. The scripts must contain sudo at the beginning because Foreman downloads files to the /var/lib/waagent/custom-script/download/0/ directory on the host and scripts require sudo privileges to be executed.

Optional: You can add a NVIDIA Driver by selecting the NVIDIA driver / CUDA checkbox. For more information, refer to the following Microsoft Azure documentation:

Optional: If you want to create an additional volume on the VM, click the Add Volume button, enter the Size in GB and select the Data Disk Caching method.

Click Add Interface.

From the Azure Subnet list, select the Azure subnet to provision to.

From the Public IP list, select the public IP setting.

Optional: If you want the virtual machine to use a static private IP, select the Static Private IP checkbox.

Click Submit.

Create a compute profile to use with the Azure Resource Manager compute resource:

# hammer compute-profile create --name compute_profile_name

Add Azure details to the compute profile. With the username setting, enter the SSH user name for image access. Note that the username that you enter for compute profile must be the same that you use when creating an image.

# hammer compute-profile values create \
--compute-attributes="resource_group=resource_group,vm_size=Standard_B1s,username=azure_user,password=azure_password,platform=Linux,script_command=touch /var/tmp/text.txt" \
--compute-profile "compute_profile_name" \
--compute-resource azure_cr_name \
--interface="compute_public_ip=Dynamic,compute_network=mysubnetID,compute_private_ip=false" \
--volume="disk_size_gb=5,data_disk_caching=None"

In the Foreman web UI, navigate to Hosts > Create Host.

In the Name field, enter a name for the host.

Click the Organization and Location tabs to ensure that the provisioning context is automatically set to the current context.

From the Host Group list, select the host group that you want to use to populate the form.

From the Deploy on list, select the Microsoft Azure Resource Manager connection.

From the Compute Profile list, select a profile to use to automatically populate virtual machine settings.

From the Lifecycle Environment list, select the environment.

Click the Interfaces tab and click Edit on the host’s interface.

Verify that the fields are automatically populated, particularly the following items:

Optional: If you want to use a static private IP address, from the IPv4 Subnet list select the Foreman subnet with the Network Address field matching the Azure subnet address. In the IPv4 Address field, enter an IPv4 address within the range of your Azure subnet.

Click the Operating System tab, and confirm that all fields automatically contain values.

For Provisioning Method, ensure Image Based is selected.

From the Image list, select the Azure Resource Manager image that you want to use for provisioning.

In the Root Password field, enter the root password to authenticate with.

Click Resolve in Provisioning templates to check the new host can identify the right provisioning templates to use.

Click the Virtual Machine tab and confirm that these settings are populated with details from the host group and compute profile. Modify these settings to suit your needs.

Click Submit to save the host entry.

In the Foreman web UI, navigate to Infrastructure > Compute Resources.

Select your Microsoft Azure provider.

On the Virtual Machines tab, click Delete from the Actions menu. This deletes the virtual machine from the Microsoft Azure compute resource while retaining any associated hosts within Foreman. If you want to delete the orphaned host, navigate to Hosts > All Hosts and delete the host manually.

Uninstall the Azure compute resource provider from your Foreman server:

Optional: In the Foreman web UI, navigate to Administer > About and select the Available Providers tab to verify the removal of the Microsoft Azure plugin.

Identify the Operating System IDs:

# hammer os list

Update each operating system’s password hash value.

# hammer os update \
--password-hash SHA256
--title "My_Operating_System"

Log on to the host as root or with an admin-level account.

Enter the following command:

$ cat /proc/sys/crypto/fips_enabled