Provisioning hosts

1. You create a host and select a domain and subnet. Satellite requests an available IP address from the DHCP Capsule Server that is associated with the subnet or from the PostgreSQL database in Satellite. Satellite 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.

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

   • A DHCP record on Capsule Server that is associated with the subnet.
   • A forward DNS record on Capsule Server that is associated with the domain.
   • A reverse DNS record on the DNS Capsule Server that is associated with the subnet.
   • PXELinux, Grub, Grub2, and iPXE configuration files for the host in the TFTP Capsule Server that is associated with the subnet.
   • A Puppet certificate on the associated Puppet server.
   • A realm on the associated identity server.
3. The host is configured to boot from the network as the first device and HDD as the second device.
4. The new host requests a DHCP reservation from the DHCP server.
5. The DHCP server responds to the reservation request and returns TFTP next-server and filename options.
6. The host requests the boot loader and menu from the TFTP server according to the PXELoader setting.
7. A boot loader is returned over TFTP.
8. The boot loader fetches configuration for the host through its provisioning interface MAC address.
9. The boot loader fetches the operating system installer kernel, init RAM disk, and boot parameters.
10. The installer requests the provisioning template from Satellite.
11. Satellite renders the provision template and returns the result to the host.

12. The installer performs installation of the operating system.

    • The installer registers the host to Satellite using Subscription Manager.
    • The installer notifies Satellite of a successful build in the postinstall script.
13. The PXE configuration files revert to a local boot template.
14. The host reboots.
15. The new host requests a DHCP reservation from the DHCP server.
16. The DHCP server responds to the reservation request and returns TFTP next-server and filename options.
17. The host requests the bootloader and menu from the TFTP server according to the PXELoader setting.
18. A boot loader is returned over TFTP.
19. The boot loader fetches the configuration for the host through its provision interface MAC address.
20. The boot loader initiates boot from the local drive.
21. If you configured the host to use any Puppet classes, the host configures itself using the modules.

1. The host is configured to boot from the network as the first device and HDD as the second device.
2. The new host requests a DHCP reservation from the DHCP server.
3. The DHCP server responds to the reservation request and returns TFTP next-server and filename options.
4. The host requests the boot loader and menu from the TFTP server according to the PXELoader setting.
5. A boot loader is returned over TFTP.
6. The boot loader fetches the configuration settings for the host through its provisioning interface MAC address.

7. For BIOS hosts:

   • The boot loader returns non-bootable device so BIOS skips to the next device (boot from HDD).

8. For EFI hosts:

   • The boot loader finds Grub2 on a ESP partition and chainboots it.
9. If the host is unknown to Satellite, a default bootloader configuration is provided. When Discovery service is enabled, it boots into discovery, otherwise it boots from HDD.

Procedure

1. Click Any Organization and select the organization.
2. Click Any Location and select the location to use.

Procedure

1. In the Satellite web UI, navigate to Hosts > Operating systems and click New Operating system.
2. In the Name field, enter a name to represent the operating system entry.
3. In the Major field, enter the number that corresponds to the major version of the operating system.
4. In the Minor field, enter the number that corresponds to the minor version of the operating system.
5. In the Description field, enter a description of the operating system.
6. From the Family list, select the operating system’s family.
7. From the Root Password Hash list, select the encoding method for the root password.
8. From the Architectures list, select the architectures that the operating system uses.
9. Click the Partition table tab and select the possible partition tables that apply to this operating system.
10. Optional: If you use non-Red Hat content, click the Installation Media tab and select the installation media that apply to this operating system. For more information, see Adding Installation Media to Satellite.
11. 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.
12. Click Submit to save your provisioning template.

Procedure

1. On Satellite 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

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

   # hammer os info --id 1

Procedure

1. In the Satellite web UI, navigate to Hosts > Provisioning Setup > Architectures.
2. Click Create Architecture.
3. In the Name field, enter a name for the architecture.
4. From the Operating Systems list, select an operating system. If none are available, you can create and assign them under Hosts > Provisioning Setup > Operating Systems.
5. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Hosts > Provisioning Setup > Hardware Models.
2. Click Create Model.
3. In the Name field, enter a name for the hardware model.
4. Optionally, in the Hardware Model and Vendor Class fields, you can enter corresponding information for your system.
5. In the Info field, enter a description of the hardware model.
6. Click Submit to save your hardware model.

Procedure

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

   For Red Hat Enterprise Linux 8, ensure that you add both Red Hat Enterprise Linux 8 for x86_64 - AppStream Kickstart x86_64 8 and Red Hat Enterprise Linux 8 for x86_64 - BaseOS Kickstart x86_64 8 repositories.

   If you use a disconnected environment, you must import the Kickstart repositories from a Red Hat Enterprise Linux binary DVD. For more information, see Importing Kickstart Repositories in Managing content.

2. 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 Managing content.
3. When you create a host, in the Operating System tab, for Media Selection, select the Synced Content checkbox.

Procedure

1. In the Satellite web UI, navigate to Hosts > Provisioning Setup > Installation Media.
2. Click Create Medium.
3. In the Name field, enter a name to represent the installation media entry.

4. 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:

   • $arch – The system architecture.
   • $version – The operating system version.
   • $major – The operating system major version.

   • $minor – The operating system minor version.

     Example HTTP path:

     http://download.example.com/centos/$version/Server/$arch/os/

5. 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.
6. Click the Organizations and Locations tabs, to change the provisioning context. Satellite Server adds the installation medium to the set provisioning context.
7. Click Submit to save your installation medium.

Procedure

1. In the Satellite web UI, navigate to Hosts > Templates > Partition Tables.
2. Click Create Partition Table.
3. In the Name field, enter a name for the partition table.
4. Select the Default checkbox if you want to set the template to automatically associate with new organizations or locations.
5. Select the Snippet checkbox if you want to identify the template as a reusable snippet for other partition tables.
6. 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.

7. In the Template editor field, enter the layout for the disk partition.

   The format of the layout must match that for the intended operating system. For example, Red Hat Enterprise Linux requires a layout that matches a Kickstart file, such as:

   zerombr
   clearpart --all --initlabel
   autopart

   For more information, see Section 2.10, “Dynamic partition example”.

   You can also use the file browser in the template editor to import the layout from a file.

8. In the Audit Comment field, add a summary of changes to the partition layout.
9. Click the Organizations and Locations tabs to add any other provisioning contexts that you want to associate with the partition table. Satellite adds the partition table to the current provisioning context.
10. Click Submit to save your partition table.

CLI procedure

1. Create a plain text file, such as ~/My_Partition_Table, that contains the partition layout.

   The format of the layout must match that for the intended operating system. For example, Red Hat Enterprise Linux requires a layout that matches a Kickstart file, such as:

   zerombr
   clearpart --all --initlabel
   autopart

   For more information, see Section 2.10, “Dynamic partition example”.

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

   # hammer partition-table create \
   --file "~/My_Partition_Table" \
   --locations "My_Location" \
   --name "My_Partition_Table" \
   --organizations "My_Organization" \
   --os-family "Redhat" \
   --snippet false

Procedure

1. In the Satellite web UI, navigate to Hosts > Templates > Provisioning Templates and click Create Template.
2. In the Name field, enter a name for the provisioning template.
3. 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.

CLI procedure

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

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

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

Procedure

1. In the Satellite web UI, navigate to Hosts > Templates > Provisioning Templates.
2. Find the template that you want to use.
3. Click Clone to duplicate the template.
4. In the Name field, enter a name for the provisioning template.
5. Select the Default checkbox to set the template to associate automatically with new organizations or locations.
6. 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.
7. In the Audit Comment field, enter a summary of changes to the provisioning template for auditing purposes.
8. 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.
9. From the Type list, select the type of the template. For example, Provisioning template.
10. 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.
11. 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.
12. Click the Organizations and Locations tabs to add any additional contexts to the template.
13. Click Submit to save your provisioning template.

Procedure

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

2. In the Name field, enter a name for your custom provisioning snippet. The name has to start with the name of a provisioning template that supports including custom provisioning snippets:

   • Append ` custom pre` to the name of a provisioning template to run code before provisioning a host.
   • Append ` custom post` to the name of a provisioning template to run code after provisioning a host.
3. On the Type tab, select Snippet.
4. Click Submit to create your custom provisioning snippet.

CLI procedure

1. Before you create a template with the CLI, create a plain text file that contains your custom snippet.

2. Create the template using hammer:

   # hammer template create \
   --file "/path/to/My_Snippet" \
   --locations "My_Location" \
   --name "My_Template_Name_custom_pre" \ --organizations "_My_Organization" \
   --type snippet

Procedure

1. In the Satellite web UI, navigate to Hosts > Templates > Provisioning Templates.
2. Select a provisioning template.
3. On the Association tab, select all applicable operating systems.
4. Click Submit to save your changes.

CLI procedure

1. Optional: View all templates:

   # hammer template list

2. Optional: View all operating systems:

   # hammer os list

3. Associate a template with an operating system:

   # hammer template add-operatingsystem \
   --id My_Template_ID \
   --operatingsystem-id My_Operating_System_ID

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Profiles and click Create Compute Profile.
2. In the Name field, enter a name for the profile.
3. Click Submit. A new window opens with the name of the compute profile.
4. In the new window, click the name of each compute resource and edit the attributes you want to set for this compute profile.

CLI procedure

1. Create a new compute profile:

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

2. Set attributes for the compute profile:

   # hammer compute-profile values create \
   --compute-attributes "flavor=m1.small,cpus=2,memory=4GB,cpu_mode=default \
   --compute-resource "My_Compute_Resource" \
   --compute-profile "My_Compute_Profile" \
   --volume size=40GB

3. Optional: To update the attributes of a compute profile, specify the attributes you want to change. For example, to change the number of CPUs and memory size:

   # hammer compute-profile values update \
   --compute-resource "My_Compute_Resource" \
   --compute-profile "My_Compute_Profile" \
   --attributes "cpus=2,memory=4GB" \
   --interface "type=network,bridge=br1,index=1" \
   --volume "size=40GB"

4. Optional: To change the name of the compute profile, use the --new-name attribute:

   # hammer compute-profile update \
   --name "My_Compute_Profile" \
   --new-name "My_New_Compute_Profile"

Procedure

1. Generate an encrypted password:

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

2. Copy the password for later use.
3. In the Satellite web UI, navigate to Administer > Settings.
4. On the Settings page, select the Provisioning tab.
5. In the Name column, navigate to Root password, and click Click to edit.
6. Paste the encrypted password, and click Save.

Procedure

1. On your Satellite Server, configure the firewall to allow VNC service on ports 5900 to 5930.

   # firewall-cmd --add-port=5900-5930/tcp
   # firewall-cmd --add-port=5900-5930/tcp --permanent

2. In the Satellite web UI, navigate to Infrastructure > Compute Resources and select the name of a compute resource.
3. In the Virtual Machines tab, select the name of your virtual machine. Ensure the machine is powered on and then select Console.

Procedure

1. In the Satellite web UI, navigate to Administer > Settings and select the Facts tab.
2. To filter out all interfaces starting with specific names, for example, blu, add blu* to the Ignore interfaces with matching identifier option.

3. 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 Satellite option.

   By default, it contains the same list as the Ignore interfaces with matching identifier option. You can override it based on the your requirements. This filters out facts completely without storing them.

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

   # foreman-rake facts:clean

   This command removes all facts matching with the filter added in Administer > Settings > Facts > the Exclude pattern for facts stored in Satellite option.

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

   # foreman-rake interfaces:clean

   This command removes all interfaces matching with the filter added in Administer > Settings > Facts > the Ignore interfaces with matching identifier option.

Procedure

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

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

3. To keep DHCP records in Satellite and in the DHCP server synchronized, you can remove unwanted DHCP records from the DHCP server. Note that Satellite 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

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

Procedure

1. Enter the satellite-installer command to configure the required network services:

   # satellite-installer --foreman-proxy-dhcp true \
   --foreman-proxy-dhcp-gateway "192.168.140.1" \
   --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" \
   --foreman-proxy-dns-forwarders "8.8.4.4" \
   --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

2. Find Capsule Server that you configure:

   # hammer capsule list

3. Refresh features of Capsule Server to view the changes:

   # hammer capsule refresh-features --name "satellite.example.com"

4. Verify the services configured on Capsule Server:

   # hammer capsule info --name "satellite.example.com"

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Domains and click Create Domain.
2. In the DNS Domain field, enter the full DNS domain name.
3. In the Fullname field, enter the plain text name of the domain.
4. 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.
5. Click Add Parameter and fill in the Name and Value fields.
6. Click the Locations tab, and add the location where the domain resides.
7. Click the Organizations tab, and add the organization that the domain belongs to.
8. Click Submit to save the changes.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Subnets, and in the Subnets window, click Create Subnet.
2. In the Name field, enter a name for the subnet.
3. In the Description field, enter a description for the subnet.
4. In the Network address field, enter the network address for the subnet.
5. In the Network prefix field, enter the network prefix for the subnet.
6. In the Network mask field, enter the network mask for the subnet.
7. In the Gateway address field, enter the external gateway for the subnet.
8. In the Primary DNS server field, enter a primary DNS for the subnet.
9. In the Secondary DNS server, enter a secondary DNS for the subnet.
10. From the IPAM list, select the method that you want to use for IP address management (IPAM). For more information about IPAM, see Chapter 3, Configuring networking.
11. Enter the information for the IPAM method that you select. Click the Remote Execution tab and select the Capsule that controls the remote execution.
12. Click the Domains tab and select the domains that apply to this subnet.
13. Click the Capsules tab and select the Capsule that applies to each service in the subnet, including DHCP, TFTP, and reverse DNS services.
14. 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.
15. Click the Locations tab and select the locations that use this Capsule.
16. Click the Organizations tab and select the organizations that use this Capsule.
17. Click Submit to save the subnet information.

Procedure

1. On Capsule, enter the following command:

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

2. Optional: In the Satellite web UI, navigate to Infrastructure > Capsules, select the Capsule with the DHCP Infoblox module, and ensure that the dhcp feature is listed.
3. In the Satellite web UI, navigate to Infrastructure > Subnets.
4. For all subnets managed through Infoblox, ensure that the IP address management (IPAM) method of the subnet is set to DHCP.

Procedure

1. On Capsule, enter the following command to configure the Infoblox module:

   # satellite-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-username admin \
   --foreman-proxy-plugin-dns-infoblox-password infoblox \
   --foreman-proxy-plugin-dns-infoblox-dns-view default

   Optionally, you can change the value of the --foreman-proxy-plugin-dns-infoblox-dns-view option to specify an Infoblox DNS view other than the default view.

2. Optional: In the Satellite web UI, navigate to Infrastructure > Capsules, select the Capsule with the Infoblox DNS module, and ensure that the dns feature is listed.
3. In the Satellite web UI, navigate to Infrastructure > Domains.
4. For all domains managed through Infoblox, ensure that the DNS Proxy is set for those domains.
5. In the Satellite web UI, navigate to Infrastructure > Subnets.
6. For all subnets managed through Infoblox, ensure that the DNS Capsule and Reverse DNS Capsule are set for those subnets.

Procedure

1. In the Satellite web UI, navigate to Administer > Settings, and click the Provisioning tab.
2. 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 kickstart from Satellite Server, including the encrypted root password.

Procedure

1. In the Satellite web UI, navigate to Hosts > Create Host.
2. In the Name field, enter a name for the host.
3. Optional: Click the Organization tab and change the organization context to match your requirement.
4. Optional: Click the Location tab and change the location context to match your requirement.
5. From the Host Group list, select a host group that you want to assign your host to. That host group will populate the form.
6. Click the Interfaces tab, and on the interface of the host, click Edit.

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

   • Satellite automatically assigns an IP address for the new host.
   • In the MAC address field, enter a MAC address of the provisioning interface of the host. This ensures the identification of the host during the PXE boot process.
   • The Name from the Host tab becomes the DNS name.
   • Ensure that Satellite automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.
8. Click OK to save. To add another interface, click Add Interface. You can select only one interface for Provision and Primary.
9. Click the Operating System tab, and verify that all fields contain values. Confirm each aspect of the operating system.

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

    For more information about associating provisioning templates, see Section 2.11, “Provisioning templates”.

11. Click the Parameters tab, and ensure that a parameter exists that provides an activation key. If not, add an activation key.

12. Click Submit to save the host details.

    For more information about network interfaces, see Adding network interfaces in Managing hosts.

CLI procedure

1. Create the host with the hammer host create command:

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

2. Ensure the 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

Procedure

1. In the Satellite web UI, navigate to Hosts > Create Host.
2. In the Name field, enter a name for the host.
3. Optional: Click the Organization tab and change the organization context to match your requirement.
4. Optional: Click the Location tab and change the location context to match your requirement.
5. From the Host Group list, select a host group that you want to assign your host to. That host group will populate the form.
6. Click the Interfaces tab, and on the interface of the host, click Edit.

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

   • Satellite automatically assigns an IP address for the new host.
   • In the MAC address field, enter a MAC address of the provisioning interface of the host. This ensures the identification of the host during the PXE boot process.
   • The Name from the Host tab becomes the DNS name.
   • Ensure that Satellite automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.
8. Click OK to save. To add another interface, click Add Interface. You can select only one interface for Provision and Primary.
9. Click the Operating System tab, and verify that all fields contain values. Confirm each aspect of the operating system.

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

    For more information about associating provisioning templates, see Section 2.11, “Provisioning templates”.

11. Click the Parameters tab, and ensure that a parameter exists that provides an activation key. If not, add an activation key.
12. Click Submit to save the host details. This creates a host entry and the host details page appears.

13. Download the boot disk from Satellite Server.

    • For Full host image, on the host details page, click the vertical ellipsis and select Full host 'My_Host_Name' image.
    • For Subnet image, navigate to Infrastructure > Subnets, click the dropdown menu in the Actions column of the required subnet and select Subnet generic image.
14. Write the ISO to a USB storage device using the dd utility or livecd-tools if required.

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

    When the installation completes, the host also registers to Satellite Server using the activation key and installs the necessary configuration and management tools from the Red Hat Satellite Client 6 repository.

CLI procedure

1. Create the host using the hammer host create command.

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

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

3. Download the boot disk from Satellite Server using the hammer bootdisk command:

   • For Full host image:

     # hammer bootdisk host \
     --full true \
     --host My_Host_Name

   • For Subnet image:

     # hammer bootdisk subnet --subnet My_Subnet_Name

   This creates a boot ISO for your host to use.

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

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

   When the installation completes, the host also registers to Satellite Server using the activation key and installs the necessary configuration and management tools from the Red Hat Satellite Client 6 repository.

Procedure

1. On Capsule that you use for provisioning, update the grub2-efi package to the latest version:

   # satellite-maintain packages update grub2-efi

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

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

3. Ensure that the Capsule has TFTP and HTTPBoot features recognized. In the Satellite web UI, navigate to Infrastructure > Capsules and click on Capsule to see the list of recognized features. Click Refresh Features if any of the features are missing.
4. Ensure that Capsule is associated with the provisioning subnet. In the Satellite web UI, navigate to Infrastructure > Subnets > Edit Subnet > Capsules and select the Capsule for both TFTP and HTTPBoot options.
5. Click OK to save.
6. In the Satellite web UI, navigate to Hosts > Create Host.
7. In the Name field, enter a name for the host.
8. Optional: Click the Organization tab and change the organization context to match your requirement.
9. Optional: Click the Location tab and change the location context to match your requirement.
10. From the Host Group list, select a host group that you want to assign your host to. That host group will populate the form.
11. Click the Interfaces tab, and on the interface of the host, click Edit.

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

    • Satellite automatically assigns an IP address for the new host.
    • In the MAC address field, enter a MAC address of the provisioning interface of the host. This ensures the identification of the host during the PXE boot process.
    • The Name from the Host tab becomes the DNS name.
    • Ensure that Satellite automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.
13. Click OK to save. To add another interface, click Add Interface. You can select only one interface for Provision and Primary.
14. Click the Operating System tab, and verify that all fields contain values. Confirm each aspect of the operating system.
15. From the PXE Loader list, select Grub2 UEFI HTTP.

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

    For more information about associating provisioning templates, see Section 2.13, “Creating provisioning templates”.

17. Click the Parameters tab, and ensure that a parameter exists that provides an activation key. If not, add an activation key.

18. Click Submit to save the host details.

    For more information about network interfaces, see Adding network interfaces in Managing hosts.

19. Set the host to boot in UEFI mode from network.
20. Start the host.
21. From the boot menu, select Kickstart default PXEGrub2.

CLI procedure

1. On Capsule that you use for provisioning, update the grub2-efi package to the latest version:

   # satellite-maintain packages update grub2-efi

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

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

3. Create the host with the hammer host create command.

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

4. Ensure the 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

5. Set the host to boot in UEFI mode from network.
6. Start the host.
7. From the boot menu, select Kickstart default PXEGrub2.

Procedure

1. In the Satellite web UI, navigate to Hosts > Templates > Provisioning Templates.
2. Create a provisioning template, or clone and edit an existing template. For more information, see Section 2.13, “Creating provisioning templates”.
3. In the template, click the Template tab.

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

   <%= snippet('create_users') %>

5. Select the Default checkbox.
6. Click the Association tab.
7. From the Application Operating Systems list, select an operating system.
8. Click Submit to save the provisioning template.

9. 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 Managing hosts.

   The SSH keys of the Owned by user are added automatically when the create_users snippet is executed during the provisioning process. You can set Owned by to an individual user or a user group. If you set Owned by to a user group, the SSH keys of all users in the user group are added automatically.

Procedure

1. Enable the TFTP and HTTPboot services on your Capsule:

   # satellite-installer \
   --foreman-proxy-httpboot true \
   --foreman-proxy-tftp true

2. Install the ipxe-bootimgs package on your Capsule:

   # satellite-maintain packages install ipxe-bootimgs

3. Copy iPXE firmware to the TFTP directory.

   • Copy the iPXE firmware with the Linux kernel header:

     # cp /usr/share/ipxe/ipxe.lkrn /var/lib/tftpboot/

   • Copy the UNDI iPXE firmware:

     # cp /usr/share/ipxe/undionly.kpxe /var/lib/tftpboot/undionly-ipxe.0

4. Correct the SELinux file contexts:

   # restorecon -RvF /var/lib/tftpboot/

5. Set the HTTP URL.

   • If you want to use Satellite Server for booting, run the following command on Satellite Server:

     # satellite-installer \
     --foreman-proxy-dhcp-ipxefilename "http://satellite.example.com/unattended/iPXE?bootstrap=1"

   • If you want to use Capsule Server for booting, run the following command on Capsule Server:

     # satellite-installer --foreman-proxy-dhcp-ipxe-bootstrap true

1. Virtual machine starts.
2. iPXE retrieves the network credentials, including an HTTP URL, by using DHCP.
3. iPXE loads the iPXE bootstrap template from Capsule.
4. iPXE loads the iPXE template with MAC as a URL parameter from Capsule.
5. iPXE loads the kernel and initial RAM disk of the installer.

Procedure

1. In the Satellite web UI, navigate to Hosts > Templates > Provisioning Templates.
2. Search for the Kickstart default iPXE template.
3. Click the name of the template.
4. Click the Association tab and select the operating systems that your host uses.
5. Click the Locations tab and add the location where the host resides.
6. Click the Organizations tab and add the organization that the host belongs to.
7. Click Submit to save the changes.
8. In the Satellite web UI, navigate to Hosts > Operating systems and select the operating system of your host.
9. Click the Templates tab.
10. From the iPXE template list, select the Kickstart default iPXE template.
11. Click Submit to save the changes.
12. In the Satellite web UI, navigate to Hosts > All Hosts.
13. In the Hosts page, select the host that you want to use.
14. Select the Operating System tab.
15. Set PXE Loader to iPXE Embedded.
16. Select the Templates tab.
17. In Provisioning Templates, click Resolve and verify that the iPXE template resolves to the required template.
18. Click Submit to save host settings.

1. Host powers on.
2. PXE driver retrieves the network credentials by using DHCP.
3. PXE driver retrieves the PXELinux firmware pxelinux.0 by using TFTP.
4. PXELinux searches for the configuration file on the TFTP server.
5. PXELinux chainloads iPXE ipxe.lkrn or undionly-ipxe.0.
6. iPXE retrieves the network credentials, including an HTTP URL, by using DHCP again.
7. iPXE chainloads the iPXE template from your Templates Capsule.
8. iPXE loads the kernel and initial RAM disk of the installer.

Procedure

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

2. Search for the required PXELinux template:

   • PXELinux chain iPXE to use ipxe.lkrn
   • PXELinux chain iPXE UNDI to use undionly-ipxe.0
3. Click the name of the template you want to use.
4. Click the Association tab and select the operating systems that your host uses.
5. Click the Locations tab and add the location where the host resides.
6. Click the Organizations tab and add the organization that the host belongs to.
7. Click Submit to save the changes.
8. On the Provisioning Templates page, search for the Kickstart default iPXE template.
9. Click the name of the template.
10. Click the Association tab and associate the template with the operating system that your host uses.
11. Click the Locations tab and add the location where the host resides.
12. Click the Organizations tab and add the organization that the host belongs to.
13. Click Submit to save the changes.
14. In the Satellite web UI, navigate to Hosts > Operating systems and select the operating system of your host.
15. Click the Templates tab.
16. From the PXELinux template list, select the template you want to use.
17. From the iPXE template list, select the Kickstart default iPXE template.
18. Click Submit to save the changes.
19. In the Satellite web UI, navigate to Configure > Host Groups, and select the host group you want to configure.
20. Select the Operating System tab.
21. Select the Architecture and Operating system.

22. Set the PXE Loader:

    • Select PXELinux BIOS to chainboot iPXE (ipxe.lkrn) from PXELinux.
    • Select iPXE Chain BIOS to load undionly-ipxe.0 directly.

Procedure

1. Enter the following commands on Capsule Server:

   # satellite-installer \
   --enable-foreman-proxy-plugin-discovery

2. Install foreman-discovery-image:

   # satellite-maintain packages install foreman-discovery-image

1. If a discovered host uses a subnet defined in Satellite, the host uses the first organization and location associated with the subnet.
2. If the default location and organization is configured in global settings, the discovered hosts are placed in this organization and location. To configure these settings, navigate to Administer > Settings > Discovery and select values for the Discovery organization and Discovery location settings. Ensure that the subnet of discovered host also belongs to the selected organization and location, otherwise Satellite refuses to set it for security reasons.
3. If none of the previous conditions is met, Satellite assigns the first organization and location ordered by name.

1. In the Satellite web UI, navigate to Administer > Settings and click the Provisioning tab.
2. For the Default PXE global template entry, in the Value column, enter discovery.

Procedure

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

2. Select from one of the two following options:

   • To provision a host from a host group, select a host group, organization, and location, and then click Create Host.
   • To provision a host with further customization, click Customize Host and enter the additional details you want to specify for the new host.

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

   • The Name from the Host tab becomes the DNS name.
   • Satellite Server automatically assigns an IP address for the new host.
   • Satellite Server automatically populates the MAC address from the Discovery results.
4. Ensure that Satellite Server automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.
5. Click the Operating System tab, and verify that all fields contain values. Confirm each aspect of the operating system.

6. 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:

   • kexec Template: Discovery Red Hat kexec

   • provision Template: Satellite Kickstart Default

     For more information about associating provisioning templates, see Section 2.11, “Provisioning templates”.

7. Click Submit to save the host details.

CLI procedure

1. Identify the discovered host to use for provisioning:

   # hammer discovery list

2. 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"

   This removes the host from the discovered host listing and creates a host entry with the provisioning settings. The Discovery image automatically resets the host so that it can boot to PXE. The host detects the DHCP service on Satellite Server’s integrated Capsule and starts installing the operating system. The rest of the process is identical to normal PXE workflow described in Section 5.3, “Creating hosts with unattended provisioning”.

Procedure

1. In the Satellite web UI, navigate to Configure > Discovery rules, and select Create Rule.
2. In the Name field, enter a name for the rule.
3. 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.
4. From the Host Group list, select the host group to use as a template for this host.

5. 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 Section 2.11, “Provisioning templates” and the API documentation.

   • myhost-<%= sequence_hostgroup_param_next("EL7/MyHostgroup", 10, "discovery_host") %>
   • myhost-<%= rand(99999) %>
   • abc-<%= @host.facts['bios_vendor'] %>-<%= rand(99999) %>
   • xyz-<%= @host.hostgroup.name %>
   • srv-<%= @host.discovery_rule.name %>

   • server-<%= @host.ip.gsub('.','-') + '-' + @host.hostgroup.subnet.name %>

     When creating host name patterns, ensure that the resulting host names are unique, do not start with numbers, and do not contain underscores or dots. A good approach is to use unique information provided by Facter, such as the MAC address, BIOS, or serial ID.

6. In the Hosts limit field, enter the maximum number of hosts that you can provision with the rule. Enter 0 for unlimited.
7. 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.
8. From the Enabled list, select whether you want to enable the rule.
9. To set a different provisioning context for the rule, click the Organizations and Locations tabs and select the contexts you want to use.
10. Click Submit to save your rule.

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

    • From the Discovered hosts list on the right, select Auto-Provision to automatically provisions a single host.
    • On the upper right of the window, click Auto-Provision All to automatically provisions all hosts.

CLI procedure

1. 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"

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

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

Attended use

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

2. 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:

   If you select Manual network setup, the Discovery image requests a set of network options. This includes the primary network interface that connects to Satellite Server. This Discovery image also asks for network interface configuration options, such as an IPv4 Address, IPv4 Gateway, and an IPv4 DNS server.

3. After entering these details, select Next.
4. If you select Discovery with DHCP, the Discovery image requests only the primary network interface that connects to Satellite Server. It attempts to automatically configure the network interface using a DHCP server, such as one that a Capsule Server provides.

5. After the primary interface configuration, the Discovery image requests the Server URL, which is the URL of Satellite Server or Capsule Server offering the Discovery service. For example, to use the integrated Capsule on Satellite Server, use the following URL:

   https://satellite.example.com:9090

6. Set the Connection type to Proxy, then select Next.
7. Optional: The Discovery image also provides a set of fields to input Custom facts for the Facter tool to relay back to Satellite Server. These are entered in a name-value format. Provide any custom facts you require and select Confirm to continue.

Procedure

1. Create the following directory structure:

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

   • The autostart.d directory contains scripts that are executed in POSIX order by the image when it starts, but before the host is registered to Satellite.
   • The bin directory is added to the $PATH variable; you can place binary files in this directory and use them in the autostart scripts.
   • The facts directory is added to the FACTERLIB variable so that custom facts can be configured and sent to Satellite.
   • The lib directory is added to the LD_LIBRARY_PATH variable and lib/ruby is added to the RUBYLIB variable, so that binary files in /bin can be executed correctly.

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

   # zip -r my_extension.zip .

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

Procedure

1. On Satellite Server, switch to the foreman user:

   # su foreman -s /bin/bash

2. Generate the key pair:

   $ ssh-keygen

3. Copy the public key to the KVM server:

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

4. Exit the bash shell for the foreman user:

   $ exit

5. Install the libvirt-client package:

   # satellite-maintain packages install libvirt-client

6. 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'

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources and click Create Compute Resource.
2. In the Name field, enter a name for the new compute resource.
3. From the Provider list, select Libvirt.
4. In the Description field, enter a description for the compute resource.

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

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

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

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

   The password is randomly generated every time the console for the virtual machine is opened, for example, with virt-manager.

8. Click Test Connection to ensure that Satellite Server connects to the KVM server without fault.
9. Verify that the Locations and Organizations tabs are automatically set to your current context. If you want, add additional contexts to these tabs.
10. Click Submit to save the KVM connection.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources and click the name of the KVM connection.
2. Click Create Image.
3. In the Name field, enter a name for the image.
4. From the Operating System list, select the base operating system of the image.
5. From the Architecture list, select the operating system architecture.
6. In the Username field, enter the SSH user name for image access. This is normally the root user.
7. In the Password field, enter the SSH password for image access.

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

9. Optional: Select the User Data checkbox if the image supports user data input, such as cloud-init data.
10. Click Submit to save the image details.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Profiles.
2. In the Compute Profiles window, click the name of an existing compute profile, or click Create Compute Profile, enter a Name, and click Submit.
3. Click the name of the KVM compute resource.
4. In the CPUs field, enter the number of CPUs to allocate to the new host.
5. In the Memory field, enter the amount of memory to allocate to the new host.
6. From the Image list, select the image to use if performing image-based provisioning.
7. 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 Capsule-managed network.
8. In the Storage area, enter the storage parameters for the host. You can create multiple volumes for the host.
9. Click Submit to save the settings to the compute profile.

CLI procedure

1. To create a compute profile, enter the following command:

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

2. 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"

Procedure

1. In the Satellite web UI, navigate to Hosts > Create Host.
2. In the Name field, enter a name for the host.
3. Optional: Click the Organization tab and change the organization context to match your requirement.
4. Optional: Click the Location tab and change the location context to match your requirement.
5. From the Host Group list, select a host group that you want to assign your host to. That host group will populate the form.
6. From the Deploy on list, select the KVM connection.
7. From the Compute Profile list, select a profile to use to automatically populate virtual machine settings. The KVM-specific fields are populated with settings from your compute profile. Modify these settings if required.
8. Click the Interfaces tab, and on the interface of the host, click Edit.

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

   • Satellite automatically assigns an IP address for the new host.
   • Ensure that the MAC address field is blank. KVM assigns a MAC address to the host during provisioning.
   • The Name from the Host tab becomes the DNS name.
   • Ensure that Satellite automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.
10. Click OK to save. To add another interface, click Add Interface. You can select only one interface for Provision and Primary.
11. Click the Operating System tab, and confirm that all fields automatically contain values.

12. Select the Provisioning Method that you want to use:

    • For network-based provisioning, click Network Based.
    • For image-based provisioning, click Image Based.
13. Click Resolve in Provisioning templates to check the new host can identify the right provisioning templates to use.
14. 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.
15. Click the Parameters tab, and ensure that a parameter exists that provides an activation key. If not, add an activation key.
16. Click Submit to save the host entry.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources and click Create Compute Resource.
2. In the Name field, enter a name for the new compute resource.
3. From the Provider list, select RHV.
4. In the Description field, enter a description for the compute resource.
5. In the URL field, enter the connection URL for the Red Hat Virtualization Manager’s API in the following form: https://rhv.example.com/ovirt-engine/api/v4.
6. In the User field, enter the name of a user with permissions to access Red Hat Virtualization Manager’s resources.
7. In the Password field, enter the password of the user.
8. Click Load Datacenters to populate the Datacenter list with data centers from your Red Hat Virtualization environment.
9. From the Datacenter list, select a data center.
10. From the Quota ID list, select a quota to limit resources available to Satellite.
11. 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.
12. Click the Locations tab and select the location you want to use.
13. Click the Organizations tab and select the organization you want to use.
14. Click Submit to save the compute resource.

Procedure

1. In Red Hat Virtualization, create a virtual machine to use for image-based provisioning in Satellite.

2. On the virtual machine, install cloud-init:

   # dnf install cloud-init

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

   datasource_list: ["NoCloud", "ConfigDrive"]

4. In Red Hat Virtualization, create an image from this virtual machine.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources and click the name of the Red Hat Virtualization connection.
2. Click Create Image.
3. In the Name field, enter a name for the image.
4. From the Operating System list, select the base operating system of the image.
5. From the Architecture list, select the operating system architecture.
6. In the Username field, enter the SSH user name for image access. This is normally the root user.
7. In the Password field, enter the SSH password for image access.
8. From the Image list, select an image from the Red Hat Virtualization compute resource.
9. Optional: Select the User Data checkbox if the image supports user data input, such as cloud-init data.
10. Click Submit to save the image details.

Procedure

1. In the Satellite web UI, navigate to Hosts > Templates > Provisioning Templates, and click Create Template.
2. In the Name field, enter a name for the template.

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

4. Click the Type tab and from the Type list, select User data template.
5. Click the Association tab, and from the Applicable Operating Systems list, select the operating system that you want associate with the template.
6. Click the Locations tab, and from the Locations list, select the location that you want to associate with the template.
7. Click the Organizations tab, and from the Organization list, select the organization that you want to associate with the template.
8. Click Submit.
9. In the Satellite web UI, navigate to Hosts > Provisioning Setup > Operating Systems.
10. Select the operating system you want to associate with the template.
11. Click the Templates tab, and from the User data template list, select the name of the new template.
12. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Profiles.
2. In the Compute Profiles window, click the name of an existing compute profile, or click Create Compute Profile, enter a Name, and click Submit.
3. Click the name of the Red Hat Virtualization compute resource.
4. From the Cluster list, select the target host cluster in the Red Hat Virtualization environment.
5. From the Template list, select the RHV template to use for the Cores and Memory settings.
6. In the Cores field, enter the number of CPU cores to allocate to the new host.
7. In the Memory field, enter the amount of memory to allocate to the new host.
8. From the Image list, select image to use for image-based provisioning.

9. 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 Capsule-managed network. For each network interface, enter the following details:

   1. In the Name field, enter the name of the network interface.
   2. From the Network list, select The logical network that you want to use.

10. 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:

    1. In the Size (GB) enter the size, in GB, for the new volume.
    2. From the Storage domain list, select the storage domain for the volume.
    3. From the Preallocate disk, select either thin provisioning or preallocation of the full disk.
    4. From the Bootable list, select whether you want a bootable or non-bootable volume.
11. Click Submit to save the compute profile.

CLI procedure

1. To create a compute profile, enter the following command:

   # hammer compute-profile create --name "Red Hat Virtualization CP"

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

   # hammer compute-profile values create --compute-profile "Red Hat Virtualization CP" \
   --compute-resource "My_RHV" \
   --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""

Procedure

1. In the Satellite web UI, navigate to Hosts > Create Host.
2. In the Name field, enter a name for the host.
3. Optional: Click the Organization tab and change the organization context to match your requirement.
4. Optional: Click the Location tab and change the location context to match your requirement.
5. From the Host Group list, select a host group that you want to assign your host to. That host group will populate the form.
6. From the Deploy on list, select the Red Hat Virtualization connection.
7. From the Compute Profile list, select a profile to use to automatically populate virtual machine settings. The Red Hat Virtualization-specific fields are populated with settings from your compute profile. Modify these settings if required.
8. Click the Interfaces tab, and on the interface of the host, click Edit.

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

   • Satellite automatically assigns an IP address for the new host.
   • Ensure that the MAC address field is blank. Red Hat Virtualization assigns a MAC address to the host during provisioning.
   • The Name from the Host tab becomes the DNS name.
   • Ensure that Satellite automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.
10. Click OK to save. To add another interface, click Add Interface. You can select only one interface for Provision and Primary.
11. Click the Operating System tab, and confirm that all fields automatically contain values.

12. Select the Provisioning Method that you want to use:

    • For network-based provisioning, click Network Based.
    • For image-based provisioning, click Image Based.
13. Click Resolve in Provisioning templates to check the new host can identify the right provisioning templates to use.
14. 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.
15. Click the Parameters tab, and ensure that a parameter exists that provides an activation key. If not, add an activation key.
16. Click Submit to save the host entry.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources, and in the Compute Resources window, click Create Compute Resource.
2. In the Name field, enter a name for the resource.
3. From the Provider list, select VMware.
4. In the Description field, enter a description for the resource.
5. In the VCenter/Server field, enter the IP address or host name of the vCenter server.
6. In the User field, enter the user name with permission to access the vCenter’s resources.
7. In the Password field, enter the password for the user.
8. Click Load Datacenters to populate the list of data centers from your VMware vSphere environment.
9. From the Datacenter list, select a specific data center to manage from this list.
10. In the Fingerprint field, ensure that this field is populated with the fingerprint from the data center.
11. 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.

12. 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'>

    The password randomly generates every time the console for the virtual machine opens, for example, with virt-manager.

13. From the Enable Caching list, you can select whether to enable caching of compute resources. For more information, see Section 11.10, “Caching of compute resources”.
14. Click the Locations and Organizations tabs and verify that the values are automatically set to your current context. You can also add additional contexts.
15. Click Submit to save the connection.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources.
2. Select your VMware compute resource.
3. Click Create Image.
4. In the Name field, enter a name for the image.
5. From the Operating System list, select the base operating system of the image.
6. From the Architecture list, select the operating system architecture.
7. In the Username field, enter the SSH user name for image access. By default, this is set to root.
8. If your image supports user data input such as cloud-init data, click the User data checkbox.
9. Optional: In the Password field, enter the SSH password to access the image.
10. From the Image list, select an image from VMware.
11. Click Submit to save the image details.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Profiles.
2. Select a compute profile.
3. Select a VMware compute resource.
4. In the CPUs field, enter the number of CPUs to allocate to the host.
5. In the Cores per socket field, enter the number of cores to allocate to each CPU.
6. In the Memory field, enter the amount of memory in MiB to allocate to the host.
7. In the Firmware checkbox, select either BIOS or UEFI as firmware for the host. By default, this is set to automatic.
8. In the Cluster list, select the name of the target host cluster on the VMware environment.
9. From the Resource pool list, select an available resource allocations for the host.
10. In the Folder list, select the folder to organize the host.
11. From the Guest OS list, select the operating system you want to use in VMware vSphere.
12. From the Virtual H/W version list, select the underlying VMware hardware abstraction to use for virtual machines.
13. If you want to add more memory while the virtual machine is powered on, select the Memory hot add checkbox.
14. If you want to add more CPUs while the virtual machine is powered on, select the CPU hot add checkbox.
15. If you want to add a CD-ROM drive, select the CD-ROM drive checkbox.
16. From the Boot order list, define the order in which the virtual machines tried to boot.
17. Optional: In the Annotation Notes field, enter an arbitrary description.
18. If you use image-based provisioning, select the image from the Image list.
19. From the SCSI controller list, select the disk access method for the host.
20. If you want to use eager zero thick provisioning, select the Eager zero checkbox. By default, the disk uses lazy zero thick provisioning.
21. From the Network Interfaces list, select the network parameters for the host’s network interface. At least one interface must point to a Capsule-managed network.
22. Optional: Click Add Interface to create another network interfaces.
23. Click Submit to save the compute profile.

CLI procedure

1. Create a compute profile:

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

2. 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"

Procedure

1. In the Satellite web UI, navigate to Hosts > Create Host.
2. In the Name field, enter a name for the host.
3. Optional: Click the Organization tab and change the organization context to match your requirement.
4. Optional: Click the Location tab and change the location context to match your requirement.
5. From the Host Group list, select a host group that you want to assign your host to. That host group will populate the form.
6. From the Deploy on list, select the VMware vSphere connection.
7. From the Compute Profile list, select a profile to use to automatically populate virtual machine-based settings.
8. Click the Interfaces tab, and on the interface of the host, click Edit.

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

   • Satellite automatically assigns an IP address for the new host.
   • Ensure that the MAC address field is blank. VMware assigns a MAC address to the host during provisioning.
   • The Name from the Host tab becomes the DNS name.
   • Ensure that Satellite automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.
10. In the interface window, review the VMware-specific fields that are populated with settings from our compute profile. Modify these settings to suit your needs.
11. Click OK to save. To add another interface, click Add Interface. You can select only one interface for Provision and Primary.
12. Click the Operating System tab, and confirm that all fields automatically contain values.

13. Select the Provisioning Method that you want:

    • For network-based provisioning, click Network Based.
    • For image-based provisioning, click Image Based.
    • For boot-disk provisioning, click Boot disk based.
14. Click Resolve in Provisioning templates to check the new host can identify the right provisioning templates to use.
15. 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.
16. Click the Parameters tab and ensure that a parameter exists that provides an activation key. If a parameter does not exist, click + Add Parameter. In the field Name, enter kt_activation_keys. In the field Value, enter the name of the activation key used to register the Content Hosts.
17. Click Submit to provision your host on VMware.

Associating the Userdata and Cloud-init templates with the operating system

1. In the Satellite web UI, navigate to Hosts > Templates > Provisioning Templates.
2. Search for the CloudInit default template and click its name.
3. Click the Association tab.
4. Select all operating systems to which the template applies and click Submit.
5. Repeat the steps above for the UserData open-vm-tools template.
6. Navigate to Hosts > Provisioning Setup > Operating Systems.
7. Select the operating system that you want to use for provisioning.
8. Click the Templates tab.
9. From the Cloud-init template list, select CloudInit default.
10. From the User data template list, select UserData open-vm-tools.
11. Click Submit to save the changes.

Procedure

1. On the virtual machine that you use to create the image, install the required packages:

   # dnf install cloud-init open-vm-tools perl-interpreter perl-File-Temp

2. Disable network configuration by cloud-init:

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

3. Configure cloud-init to fetch data from Satellite:

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

   If you intend to provision through Capsule Server, use the URL of your Capsule Server in the seedfrom option, such as https://capsule.example.com:9090/userdata/.

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

5. Enable the CA certificates for the image:

   # update-ca-trust enable

6. Download the katello-server-ca.crt file from Satellite Server:

   # wget -O /etc/pki/ca-trust/source/anchors/cloud-init-ca.crt https://satellite.example.com/pub/katello-server-ca.crt

   If you intend to provision through Capsule Server, download the file from your Capsule Server, such as https://capsule.example.com/pub/katello-server-ca.crt.

7. Update the record of certificates:

   # update-ca-trust extract

8. Clean the image:

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

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

10. Remove udev hardware rules:

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

11. 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*

12. Remove the SSH host keys:

    # rm -f /etc/ssh/ssh_host_*

13. Remove root user’s SSH history:

    # rm -rf ~root/.ssh/known_hosts

14. Remove root user’s shell history:

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

15. Create an image from this virtual machine.
16. Add your image to Satellite.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources.
2. Select your VMware provider.
3. 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 Satellite. If you want to delete the orphaned host, navigate to Hosts > All Hosts and delete the host manually.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources.
2. Select your VMware compute resource.
3. 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 Satellite in Managing hosts.
4. Click Submit to import the virtual machine into Satellite.

Procedure

1. Enter the following satellite-installer command to enable the OpenShift Virtualization plugin for Satellite:

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

2. Obtain a token to use for HTTP and HTTPs authentication:

   1. Log in to the OpenShift Container Platform cluster and list the secrets that contain tokens:

      $ oc get secrets

   2. Obtain the token for your secret:

      $ oc get secrets MY_SECRET -o jsonpath='{.data.token}' | base64 -d | xargs

   3. Record the token to use later in this procedure.
3. In the Satellite web UI, navigate to Infrastructure > Compute Resources, and click Create Compute Resource.
4. In the Name field, enter a name for the new compute resource.
5. From the Provider list, select OpenShift Virtualization.
6. In the Description field, enter a description for the compute resource.
7. In the Hostname field, enter the FQDN, hostname, or IP address of the OpenShift Container Platform cluster.
8. In the API Port field, enter the port number that you want to use for provisioning requests from Satellite to OpenShift Virtualization.
9. In the Namespace field, enter the user name of the OpenShift Container Platform cluster.
10. In the Token field, enter the bearer token for HTTP and HTTPs authentication.
11. Optional: In the X509 Certification Authorities field, enter a certificate to enable client certificate authentication for API server calls.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources.
2. Click Create Compute Resource.
3. In the Name field, enter a name for the new compute resource.
4. From the Provider list, select RHEL OpenStack Platform.
5. Optional: In the Description field, enter a description for the compute resource.
6. 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.
7. In the Username and Password fields, enter the user authentication for Satellite to access the environment.
8. Optional: In the Project (Tenant) name field, enter the name of your tenant (v2) or project (v3) for Satellite Server to manage.
9. In the User domain field, enter the user domain for v3 authentication.
10. In the Project domain name field, enter the project domain name for v3 authentication.
11. In the Project domain ID field, enter the project domain ID for v3 authentication.
12. Optional: Select Allow external network as main network to use external networks as primary networks for hosts.
13. Optional: Click Test Connection to verify that Satellite can connect to your compute resource.
14. 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.
15. Click Submit to save the Red Hat OpenStack Platform connection.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources and click the name of the Red Hat OpenStack Platform connection.
2. Click Create Image.
3. In the Name field, enter a name for the image.
4. From the Operating System list, select the base operating system of the image.
5. From the Architecture list, select the operating system architecture.
6. In the Username field, enter the SSH user name for image access. This is normally the root user.
7. In the Password field, enter the SSH password for image access.
8. From the Image list, select an image from the Red Hat OpenStack Platform compute resource.
9. Optional: Select the User Data checkbox if the image supports user data input, such as cloud-init data.
10. Click Submit to save the image details.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Profiles.
2. In the Compute Profiles window, click the name of an existing compute profile, or click Create Compute Profile, enter a Name, and click Submit.
3. Click the name of the Red Hat OpenStack Platform compute resource.
4. From the Flavor list, select the hardware profile on Red Hat OpenStack Platform to use for the host.
5. From the Availability zone list, select the target cluster to use within the Red Hat OpenStack Platform environment.
6. From the Image list, select the image to use for image-based provisioning.
7. From the Tenant list, select the tenant or project for the Red Hat OpenStack Platform instance.
8. From the Security Group list, select the cloud-based access rules for ports and IP addresses.
9. From the Internal network, select the private networks for the host to join.
10. From the Floating IP network, select the external networks for the host to join and assign a floating IP address.
11. From the Boot from volume, select whether a volume is created from the image. If not selected, the instance boots the image directly.
12. In the New boot volume size (GB) field, enter the size, in GB, of the new boot volume.
13. Click Submit to save the compute profile.

Procedure

1. In the Satellite web UI, navigate to Hosts > Create Host.
2. In the Name field, enter a name for the host.
3. Optional: Click the Organization tab and change the organization context to match your requirement.
4. Optional: Click the Location tab and change the location context to match your requirement.
5. From the Host Group list, select a host group that you want to assign your host to. That host group will populate the form.
6. From the Deploy on list, select the Red Hat OpenStack Platform connection.
7. From the Compute Profile list, select a profile to use to automatically populate virtual machine settings.
8. From the Lifecycle Environment list, select the environment.
9. Click the Interfaces tab, and on the interface of the host, click Edit.

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

    • Satellite automatically assigns an IP address for the new host.
    • Ensure that the MAC address field is blank. Red Hat OpenStack Platform assigns a MAC address to the host during provisioning.
    • The Name from the Host tab becomes the DNS name.
    • Ensure that Satellite automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.
11. Click OK to save. To add another interface, click Add Interface. You can select only one interface for Provision and Primary.
12. Click the Operating System tab, and confirm that all fields automatically contain values.
13. 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.
14. Click Resolve in Provisioning templates to check the new host can identify the right provisioning templates to use.
15. 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.
16. Click the Parameters tab, and ensure that a parameter exists that provides an activation key. If not, add an activation key.
17. Click Submit to save the host entry.

Procedure

1. Install the EC2 compute resource provider on your Satellite Server:

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

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

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources and in the Compute Resources window, click Create Compute Resource.
2. In the Name field, enter a name to identify the Amazon EC2 compute resource.
3. From the Provider list, select EC2.
4. In the Description field, enter information that helps distinguish the resource for future use.
5. Optional: From the HTTP proxy list, select an HTTP proxy to connect to external API services. You must add HTTP proxies to Satellite before you can select a proxy from this list. For more information, see Section 14.4, “Using an HTTP proxy with compute resources”.
6. 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.
7. Optional: Click Load Regions to populate the Regions list.
8. From the Region list, select the Amazon EC2 region or data center to use.
9. Click the Locations tab and ensure that the location you want to use is selected, or add a different location.
10. Click the Organizations tab and ensure that the organization you want to use is selected, or add a different organization.
11. Click Submit to save the Amazon EC2 connection.
12. 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 Section 14.9, “Connecting to an Amazon EC2 instance using SSH”.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > HTTP Proxies, and select New HTTP Proxy.
2. In the Name field, enter a name for the HTTP proxy.
3. In the URL field, enter the URL for the HTTP proxy, including the port number.
4. Optional: Enter a username and password to authenticate to the HTTP proxy, if your HTTP proxy requires authentication.
5. Click Test Connection to ensure that you can connect to the HTTP proxy from Satellite.
6. Click the Locations tab and add a location.
7. Click the Organization tab and add an organization.
8. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources.
2. Select your Amazon EC2 provider.

3. Click Create Image.

   • In the Name field, enter a meaningful and unique name for your EC2 image.
   • From the Operating System list, select an operating system to associate with the image.
   • From the Architecture list, select an architecture to associate with the image.
   • In the Username field, enter the username needed to SSH into the machine.
   • In the Image ID field, enter the image ID provided by Amazon or an operating system vendor.
   • Optional: Select the User Data check box to enable support for user data input.
   • Optional: Set an Iam Role for Fog to use when creating this image.
   • Click Submit to save your changes to Satellite.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources and select an Amazon EC2 connection.
2. Click the Images tab, and then click Create Image.
3. In the Name field, enter a name to identify the image for future use.
4. From the Operating System list, select the operating system that corresponds with the image you want to add.
5. From the Architecture list, select the operating system’s architecture.
6. In the Username field, enter the SSH user name for image access. This is normally the root user.
7. In the Password field, enter the SSH password for image access.
8. In the Image ID field, enter the Amazon Machine Image (AMI) ID for the image. This is usually in the following format: ami-xxxxxxxx.
9. 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.
10. Optional: In the IAM role field, enter the Amazon security role used for creating the image.
11. Click Submit to save the image details.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Profiles and click the name of your profile, then click an EC2 connection.
2. From the Flavor list, select the hardware profile on EC2 to use for the host.
3. From the Image list, select the image to use for image-based provisioning.
4. From the Availability zone list, select the target cluster to use within the chosen EC2 region.
5. From the Subnet list, add the subnet for the EC2 instance. If you have a VPC for provisioning new hosts, use its subnet.
6. From the Security Groups list, select the cloud-based access rules for ports and IP addresses to apply to the host.
7. From the Managed IP list, select either a Public IP or a Private IP.
8. Click Submit to save the compute profile.

Procedure

1. In the Satellite web UI, navigate to Hosts > Create Host.
2. In the Name field, enter a name for the host.
3. Optional: Click the Organization tab and change the organization context to match your requirement.
4. Optional: Click the Location tab and change the location context to match your requirement.
5. From the Host Group list, select a host group that you want to assign your host to. That host group will populate the form.
6. From the Deploy on list, select the EC2 connection.
7. From the Compute Profile list, select a profile to use to automatically populate virtual machine-based settings.
8. Click the Interfaces tab, and on the interface of the host, click Edit.

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

   • Satellite automatically assigns an IP address for the new host.
   • Ensure that the MAC address field is blank. EC2 assigns a MAC address to the host during provisioning.
   • The Name from the Host tab becomes the DNS name.
   • Ensure that Satellite automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.
10. Click OK to save. To add another interface, click Add Interface. You can select only one interface for Provision and Primary.
11. Click the Operating System tab and confirm that all fields are populated with values.
12. Click the Virtual Machine tab and confirm that all fields are populated with values.
13. Click the Parameters tab, and ensure that a parameter exists that provides an activation key. If not, add an activation key.
14. Click Submit to save your changes.

Procedure

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

   # hammer compute-resource list

2. Switch user to the postgres user:

   # su - postgres

3. Initiate the postgres shell:

   $ psql

4. Connect to the Foreman database as the user postgres:

   # postgres=# \c foreman

5. Select the secret from key_pairs where compute_resource_id = 3:

   # select secret from key_pairs where compute_resource_id = 3; secret

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

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

   # vim Keyname.pem

8. Ensure that you restrict access to the .pem file:

   # chmod 600 Keyname.pem

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

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

Procedure

1. In the Satellite web UI, navigate to Hosts > Templates > Provisioning Templates.
2. In the Provisioning Templates page, enter Kickstart default finish into the search field and click Search.
3. On the Kickstart default finish template, select Clone.
4. In the Name field, enter a unique name for the template.

5. In the template, prefix each command that requires root privileges with sudo, except for subscription-manager register and yum commands, or add the following line to run the entire template as the sudo user:

   sudo -s << EOS
   _Template_ _Body_
   EOS

6. Click the Association tab, and associate the template with a Red Hat Enterprise Linux operating system that you want to use.
7. Click the Locations tab, and add the the location where the host resides.
8. Click the Organizations tab, and add the organization that the host belongs to.
9. Make any additional customizations or changes that you require, then click Submit to save your template.
10. In the Satellite web UI, navigate to Hosts > Operating systems and select the operating system that you want for your host.
11. Click the Templates tab, and from the Finish Template list, select your finish template.
12. In the Satellite web UI, navigate to Hosts > Create Host.
13. In the Name field, enter a name for the host.
14. Optional: Click the Organization tab and change the organization context to match your requirement.
15. Optional: Click the Location tab and change the location context to match your requirement.
16. From the Host Group list, select a host group that you want to assign your host to. That host group will populate the form.
17. Click the Parameters tab and navigate to Host parameters.

18. In Host parameters, click Add Parameter two times to add two new parameter fields. Add the following parameters:

    1. In the Name field, enter activation_keys. In the corresponding Value field, enter your activation key.
    2. In the Name field, enter remote_execution_ssh_user. In the corresponding Value field, enter ec2-user.
19. Click Submit to save the changes.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources.
2. Select your Amazon EC2 provider.
3. 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 Satellite. If you want to delete an orphaned host, navigate to Hosts > All Hosts and delete the host manually.

Procedure

1. In Google GCE, generate a service account key in JSON format. For more information, see Create and manage service account keys in the GCE documentation.
2. In the Satellite web UI, navigate to Infrastructure > Compute Resources and click Create Compute Resource.
3. In the Name field, enter a name for the compute resource.
4. From the Provider list, select Google.
5. Optional: In the Description field, enter a description for the resource.
6. In the JSON key field, click Choose File and locate your service account key for upload from your local machine.
7. Click Load Zones to populate the list of zones from your GCE environment.
8. From the Zone list, select the GCE zone to use.
9. Click Submit.

CLI procedure

1. In Google GCE, generate a service account key in JSON format. For more information, see Create and manage service account keys in the GCE documentation.

2. Copy the file from your local machine to Satellite Server:

   # scp My_GCE_Key.json root@satellite.example.com:/etc/foreman/My_GCE_Key.json

3. On Satellite Server, change the owner for your service account key to the foreman user:

   # chown root:foreman /etc/foreman/My_GCE_Key.json

4. On Satellite Server, configure permissions for your service account key to ensure that the file is readable:

   # chmod 0640 /etc/foreman/My_GCE_Key.json

5. On Satellite Server, restore SELinux context for your service account key:

   # restorecon -vv /etc/foreman/My_GCE_Key.json

6. Use the hammer compute-resource create command to add a GCE compute resource to Satellite:

   # hammer compute-resource create \
   --key-path "/etc/foreman/My_GCE_Key.json" \
   --name "My_GCE_Compute_Resource" \
   --provider "gce" \
   --zone "My_Zone"

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources and click the name of the Google Compute Engine connection.
2. Click Create Image.
3. In the Name field, enter a name for the image.
4. From the Operating System list, select the base operating system of the image.
5. From the Architecture list, select the operating system architecture.
6. 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.
7. From the Image list, select an image from the Google Compute Engine compute resource.
8. Optional: Select the User Data checkbox if the image supports user data input, such as cloud-init data.
9. Click Submit to save the image details.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Profiles.
2. In the Compute Profiles window, click the name of an existing compute profile, or click Create Compute Profile, enter a Name, and click Submit.
3. Click the name of the GCE compute resource.
4. From the Machine Type list, select the machine type to use for provisioning.
5. From the Image list, select the image to use for provisioning.
6. From the Network list, select the Google GCE network to use for provisioning.
7. Optional: Select the Associate Ephemeral External IP checkbox to assign a dynamic ephemeral IP address that Satellite 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.
8. In the Size (GB) field, enter the size of the storage to create on the host.
9. Click Submit to save the compute profile.

CLI procedure

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

   # hammer compute-profile create --name My_GCE_Compute_Profile

2. 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"

Procedure

1. In the Satellite web UI, navigate to Hosts > Create Host.
2. In the Name field, enter a name for the host.
3. Optional: Click the Organization tab and change the organization context to match your requirement.
4. Optional: Click the Location tab and change the location context to match your requirement.
5. From the Host Group list, select a host group that you want to assign your host to. That host group will populate the form.
6. From the Deploy on list, select the Google Compute Engine connection.
7. From the Compute Profile list, select a profile to use to automatically populate virtual machine settings.
8. From the Lifecycle Environment list, select the environment.
9. Click the Interfaces tab, and on the interface of the host, click Edit.

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

    • Satellite automatically assigns an IP address for the new host.
    • Ensure that the MAC address field is blank. Google Compute Engine assigns a MAC address to the host during provisioning.
    • The Name from the Host tab becomes the DNS name.
    • The Domain field is populated with the required domain.
    • Ensure that Satellite automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.
11. Click OK to save. To add another interface, click Add Interface. You can select only one interface for Provision and Primary.
12. Click the Operating System tab, and confirm that all fields automatically contain values.
13. Click Resolve in Provisioning templates to check the new host can identify the right provisioning templates to use.
14. 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.
15. Click the Parameters tab, and ensure that a parameter exists that provides an activation key. If not, add an activation key.
16. Click Submit to save the host entry.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources.
2. Select your Google GCE provider.
3. 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 Satellite. If you want to delete the orphaned host, navigate to Hosts > All Hosts and delete the host manually.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources and click Create Compute Resource.
2. In the Name field, enter a name for the compute resource.
3. From the Provider list, select Azure Resource Manager.
4. Optional: In the Description field, enter a description for the resource.

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

   • US Government
   • China
   • Germany
6. In the Client ID field, enter your Application or client ID.
7. In the Client Secret field, enter your client secret.
8. In the Subscription ID field, enter your subscription ID.
9. In the Tenant ID field, enter your Directory or tenant ID.
10. Click Load Regions. This tests if your connection to Azure Resource Manager is successful and loads the regions available in your subscription.
11. From the Azure Region list, select the Azure region to use.
12. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources and click the name of the Microsoft Azure Resource Manager connection.
2. Click Create Image.
3. In the Name field, enter a name for the image.
4. From the Operating System list, select the base operating system of the image.
5. From the Architecture list, select the operating system architecture.
6. In the Username field, enter the SSH user name for image access. You cannot use the root user.
7. Optional: In the Password field, enter a password to authenticate with.

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

   • For a custom image, use the prefix custom. For example, custom://image-name.
   • For a shared gallery image, use the prefix gallery. For example, gallery://image-name.

   • For public and RHEL Bring Your Own Subscription (BYOS) images, use the prefix marketplace. For example, marketplace://OpenLogicCentOS:7.5:latest.

     For more information, see Find Linux VM images in the Azure Marketplace with the Azure CLI.

9. Optional: Select the User Data checkbox if the image supports user data input, such as cloud-init data.
10. Click Submit to save the image details.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Profiles.
2. In the Compute Profiles window, click the name of an existing compute profile, or click Create Compute Profile, enter a Name, and click Submit.
3. Click the name of the Azure compute resource.
4. From the Resource group list, select the resource group to provision to.
5. From the VM Size list, select a size of a virtual machine to provision.
6. From the Platform list, select Linux.
7. 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.

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

   • To authenticate using a password, enter a password in the Password field.
   • To authenticate using an SSH key, enter an SSH key in the SSH Key field.
9. Optional: If you want the virtual machine to use a premium virtual machine disk, select the Premium OS Disk checkbox.
10. From the OS Disk Caching list, select the disc caching setting.
11. Optional: In the Custom Script Command field, enter commands to perform on the virtual machine when the virtual machine is provisioned.
12. 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 Red Hat Satellite downloads files to the /var/lib/waagent/custom-script/download/0/ directory on the host and scripts require sudo privileges to be executed.

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

    • NVIDIA GPU Driver Extension for Linux
    • NVIDIA GPU Driver Extension for Windows

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

    • Note that the maximum number of these disks depends on the VM Size selected. For more information on Microsoft Azure VM storage requirements, see the Microsoft Azure documentation.

15. Click Add Interface.

    Important

    The maximum number of interfaces depends on the VM Size selected. For more information, see the Microsoft Azure documentation link above.

16. From the Azure Subnet list, select the Azure subnet to provision to.
17. From the Public IP list, select the public IP setting.
18. Optional: If you want the virtual machine to use a static private IP, select the Static Private IP checkbox.
19. Click Submit.

CLI procedure

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

   # hammer compute-profile create --name compute_profile_name

2. 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"

   Optional: If you want to run scripts on the virtual machine after provisioning, specify the following settings:

   • To enter the script directly, with the script_command setting, enter a command to be executed on the provisioned virtual machine.
   • To run a script from a URI, with the script_uris setting, enter comma-separated file URIs of scripts to use. The scripts must contain sudo at the beginning because Red Hat Satellite downloads files to the /var/lib/waagent/custom-script/download/0/ directory on the host and therefore scripts require sudo privileges to be executed.

Procedure

1. In the Satellite web UI, navigate to Hosts > Create Host.
2. In the Name field, enter a name for the host.
3. Optional: Click the Organization tab and change the organization context to match your requirement.
4. Optional: Click the Location tab and change the location context to match your requirement.
5. From the Host Group list, select a host group that you want to assign your host to. That host group will populate the form.
6. From the Deploy on list, select the Microsoft Azure Resource Manager connection.
7. From the Compute Profile list, select a profile to use to automatically populate virtual machine settings.
8. From the Lifecycle Environment list, select the environment.
9. Click the Interfaces tab, and on the interface of the host, click Edit.

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

    • Satellite automatically assigns an IP address for the new host.
    • Ensure that the MAC address field is blank. Microsoft Azure Resource Manager assigns a MAC address to the host during provisioning.
    • The Name from the Host tab becomes the DNS name.
    • The Azure Subnet field is populated with the required Azure subnet.
    • Optional: If you want to use a static private IP address, from the IPv4 Subnet list select the Satellite 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.
    • Ensure that Satellite automatically selects the Managed, Primary, and Provision options for the first interface on the host. If not, select them.
11. Click OK to save. To add another interface, click Add Interface. You can select only one interface for Provision and Primary.
12. Click the Operating System tab, and confirm that all fields automatically contain values.
13. For Provisioning Method, ensure Image Based is selected.
14. From the Image list, select the Azure Resource Manager image that you want to use for provisioning.
15. In the Root Password field, enter the root password to authenticate with.
16. Click Resolve in Provisioning templates to check the new host can identify the right provisioning templates to use.
17. 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.
18. Click the Parameters tab, and ensure that a parameter exists that provides an activation key. If not, add an activation key.
19. Click Submit to save the host entry.

Procedure

1. In the Satellite web UI, navigate to Infrastructure > Compute Resources.
2. Select your Microsoft Azure provider.
3. 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 Satellite. If you want to delete the orphaned host, navigate to Hosts > All Hosts and delete the host manually.