Chapter 3. Upgrading Red Hat Satellite

Warning

If you have Satellite installed in a high availability configuration, contact Red Hat Support before upgrading to Satellite 6.12.

Use the following procedures to upgrade your existing Red Hat Satellite to Red Hat Satellite 6.12:

  1. Review Section 1.1, “Prerequisites”.
  2. Section 3.1, “Upgrading Satellite Server”
  3. Section 3.2, “Synchronizing the New Repositories”
  4. Section 3.3, “Upgrading Capsule Servers”
  5. Section 3.5, “Performing Post-Upgrade Tasks”

3.1. Upgrading Satellite Server

This section describes how to upgrade Satellite Server from 6.11 to 6.12. You can upgrade from any minor version of Satellite Server 6.11.

Before You Begin

  • Note that you can upgrade Capsules separately from Satellite. For more information, see Section 1.4, “Upgrading Capsules Separately from Satellite”.
  • Review and update your firewall configuration prior to upgrading your Satellite Server. For more information, see Preparing your environment for installation in Installing Satellite Server in a Connected Network Environment.
  • Ensure that you do not delete the manifest from the Customer Portal or in the Satellite web UI because this removes all the entitlements of your content hosts.
  • If you have edited any of the default job or provisioning templates, back up the files either by cloning or exporting them. Cloning is the recommended method because that prevents them being overwritten in future updates or upgrades. To confirm if a template has been edited, you can view its History before you upgrade or view the changes in the audit log after an upgrade. In the Satellite web UI, navigate to Monitor > Audits and search for the template to see a record of changes made. If you use the export method, restore your changes by comparing the exported template and the default template, manually applying your changes.

Capsule Considerations

  • If you use Content Views to control updates to a Capsule Server’s base operating system, or for Capsule Server repository, you must publish updated versions of those Content Views.
  • Note that Satellite Server upgraded from 6.11 to 6.12 can use Capsule Servers still at 6.11.
Warning

If you implemented custom certificates, you must retain the content of both the /root/ssl-build directory and the directory in which you created any source files associated with your custom certificates.

Failure to retain these files during an upgrade causes the upgrade to fail. If these files have been deleted, they must be restored from a backup in order for the upgrade to proceed.

Upgrade Scenarios

You cannot upgrade a self-registered Satellite. You must migrate a self-registered Satellite to the Red Hat Content Delivery Network (CDN) and then perform the upgrade.

FIPS mode

You cannot upgrade Satellite Server from a RHEL base system that is not operating in FIPS mode to a RHEL base system that is operating in FIPS mode.

To run Satellite Server on a Red Hat Enterprise Linux base system operating in FIPS mode, you must install Satellite on a freshly provisioned RHEL base system operating in FIPS mode. For more information, see Preparing your environment for installation in Installing Satellite Server in a Connected Network Environment.

3.1.1. Upgrading a Connected Satellite Server

Use this procedure for a Satellite Server with access to the public internet

Warning

If you customize configuration files, manually or using a tool such as Hiera, these changes are overwritten when the installation script runs during upgrading or updating. You can use the --noop option with the satellite-installer script to test for changes. For more information, see the Red Hat Knowledgebase solution How to use the noop option to check for changes in Satellite config files during an upgrade.

Upgrade Satellite Server

  1. Create a backup.

  2. Optional: If you made manual edits to DNS or DHCP configuration in the /etc/zones.conf or /etc/dhcp/dhcpd.conf files, back up the configuration files because the installer only supports one domain or subnet, and therefore restoring changes from these backups might be required.

  3. Optional: If you made manual edits to DNS or DHCP configuration files and do not want to overwrite the changes, enter the following command: 

    # satellite-installer --foreman-proxy-dns-managed=false \
--foreman-proxy-dhcp-managed=false
  4. In the Satellite web UI, navigate to Hosts > Discovered hosts. On the Discovered Hosts page, power off and then delete the discovered hosts. From the Select an Organization menu, select each organization in turn and repeat the process to power off and delete the discovered hosts. Make a note to reboot these hosts when the upgrade is complete.

  5. In the current upgrade process, you must enable the Satellite 6.12 (or Capsule) repository to restrict any updates outside the Satellite Maintenance repository. Please read the Known Issues in the Release Notes as a workaround before proceeding further.

    Enable the Satellite Maintenance repository and the Satellite 6.12 repositories: 

    # subscription-manager repos \
--enable satellite-maintenance-6.12-for-rhel-8-x86_64-rpms \
--enable satellite-6.12-for-rhel-8-x86_64-rpms

    If the Satellite 6.11 system was upgraded from Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 using Leapp, manually enable the Satellite module: 

    # dnf module enable satellite:el8

  6. Check the available versions to confirm the version you want is listed: 

    # satellite-maintain upgrade list-versions

  7. Use the health check option to determine if the system is ready for upgrade. When prompted, enter the hammer admin user credentials to configure satellite-maintain with hammer credentials. These changes are applied to the /etc/foreman-maintain/foreman-maintain-hammer.yml file. 

    # satellite-maintain upgrade check --target-version 6.12

    Review the results and address any highlighted error conditions before performing the upgrade.

  8. Because of the lengthy upgrade time, use a utility such as tmux to suspend and reattach a communication session. You can then check the upgrade progress without staying connected to the command shell continuously.

    If you lose connection to the command shell where the upgrade command is running you can see the logged messages in the /var/log/foreman-installer/satellite.log file to check if the process completed successfully.

  9. Perform the upgrade: 

    # satellite-maintain upgrade run --target-version 6.12

  10. Determine if the system needs a reboot:

    1. Check the version of newest installed kernel: 

      # rpm --query --last kernel | head -n 1

    2. Compare this to the version of currently running kernel: 

      # uname --kernel-release

  11. Optional: If the newest kernel differs from the currently running kernel, reboot the system: 

    # reboot

  12. If using a BASH shell, after a successful or failed upgrade, enter: 

    # hash -d satellite-maintain service 2> /dev/null

3.1.2. Upgrading a Disconnected Satellite Server

Use this procedure if your Satellite Server is not connected to the Red Hat Content Delivery Network.

Warning
  • If you customized configuration files, either manually or using a tool such as Hiera, these changes are overwritten when you enter the satellite-maintain command during upgrading or updating. You can use the --noop option with the satellite-installer command to review the changes that are applied during upgrading or updating. For more information, see the Red Hat Knowledgebase solution How to use the noop option to check for changes in Satellite config files during an upgrade.

  • The hammer import and export commands have been replaced with hammer content-import and hammer content-export tooling.

    If you have scripts that are using hammer content-view version export, hammer content-view version export-legacy, hammer repository export, or their respective import commands, you have to adjust them to use the hammer content-export command instead, along with its respective import command.

  • If you implemented custom certificates, you must retain the content of both the /root/ssl-build directory and the directory in which you created any source files associated with your custom certificates.

    Failure to retain these files during an upgrade causes the upgrade to fail. If these files have been deleted, they must be restored from a backup in order for the upgrade to proceed.

Before You Begin

  • Review and update your firewall configuration before upgrading your Satellite Server. For more information, see Ports and Firewalls Requirements in Installing Satellite Server in a Disconnected Network Environment.
  • Ensure that you do not delete the manifest from the Customer Portal or in the Satellite web UI because this removes all the entitlements of your content hosts.
  • Back up and remove all Foreman hooks before upgrading. Reinstate hooks only after Satellite is known to be working after the upgrade is complete.
  • All Satellite Servers must be on the same version.

Upgrade Disconnected Satellite Server

  1. Create a backup.

    • On a virtual machine, take a snapshot.
    • On a physical machine, create a backup.

  2. A pre-upgrade script is available to detect conflicts and list hosts which have duplicate entries in Satellite Server that can be unregistered and deleted after upgrade. In addition, it will detect hosts which are not assigned to an organization. If a host is listed under Hosts > All hosts without an organization association and if a content host with same name has an organization already associated with it then the content host will automatically be unregistered. This can be avoided by associating such hosts to an organization before upgrading.

    Run the pre-upgrade check script to get a list of hosts that can be deleted after upgrading. If any unassociated hosts are found, associating them to an organization before upgrading is recommended. 

    # foreman-rake katello:upgrade_check
  3. Optional: If you made manual edits to DNS or DHCP configuration in the /etc/zones.conf or /etc/dhcp/dhcpd.conf files, back up the configuration files because the installer only supports one domain or subnet, and therefore restoring changes from these backups might be required.

  4. Optional: If you made manual edits to DNS or DHCP configuration files and do not want to overwrite the changes, enter the following command: 

    # satellite-installer --foreman-proxy-dns-managed=false \
--foreman-proxy-dhcp-managed=false
  5. In the Satellite web UI, navigate to Hosts > Discovered hosts. If there are discovered hosts available, turn them off and then delete all entries under the Discovered hosts page. Select all other organizations in turn using the organization setting menu and repeat this action as required. Reboot these hosts after the upgrade has completed.
  6. Make sure all external Capsule Servers are assigned to an organization, otherwise they might get unregistered due to host-unification changes.

  7. Remove old repositories: 

    # rm /etc/yum.repos.d/*

  8. Stop Satellite services: 

    # satellite-maintain service stop
  9. Obtain the latest ISO files by following the Downloading the Binary DVD Images procedure in Installing Satellite Server in a Disconnected Network Environment.

  10. Create directories to serve as a mount point, mount the ISO images, and configure the rhel8 repository by following the Configuring the Base Operating System with Offline Repositories in RHEL 8 procedure in Installing Satellite Server in a Disconnected Network Environment.

    Do not install or update any packages at this stage.

  11. Configure the Satellite 6.12 repository from the ISO file.

    1. Copy the ISO file’s repository data file for the Red Hat Satellite packages: 

      # cp /media/sat6/Satellite/media.repo /etc/yum.repos.d/satellite.repo

    2. Edit the /etc/yum.repos.d/satellite.repo file: 

      # vi /etc/yum.repos.d/sat6.repo

      1. Change the default InstallMedia repository name to Satellite-6.12: 

        [Satellite-6.12]

      2. Add the baseurl directive: 

        baseurl=file:///media/sat6/Satellite

  12. Configure the Red Hat Satellite Maintenance repository from the ISO file.

    1. Copy the ISO file’s repository data file for Red Hat Satellite Maintenance packages: 

      # cp /media/sat6/Maintenance/media.repo /etc/yum.repos.d/satellite-maintenance.repo

    2. Edit the /etc/yum.repos.d/satellite-maintenance.repo file: 

      # vi /etc/yum.repos.d/satellite-maintenance.repo

      1. Change the default InstallMedia repository name to Satellite-Maintenance: 

        [Satellite-Maintenance]

      2. Add the baseurl directive: 

        baseurl=file:///media/sat6/Maintenance/

  13. Because of the lengthy upgrade time, use a utility such as tmux to suspend and reattach a communication session. You can then check the upgrade progress without staying connected to the command shell continuously.

    If you lose connection to the command shell where the upgrade command is running you can see the logs in /var/log/foreman-installer/satellite.log to check if the process completed successfully.

  14. Check the available versions to confirm the version you want is listed: 

    # satellite-maintain upgrade list-versions

  15. Use the health check option to determine if the system is ready for upgrade. When prompted, enter the hammer admin user credentials to configure satellite-maintain with hammer credentials. These changes are applied to the /etc/foreman-maintain/foreman-maintain-hammer.yml file. 

    # satellite-maintain upgrade check --target-version 6.12 \
--whitelist="repositories-validate,repositories-setup"

    Review the results and address any highlighted error conditions before performing the upgrade.

  16. Perform the upgrade: 

    # satellite-maintain upgrade run --target-version 6.12 \
--whitelist="repositories-validate,repositories-setup"

    If the script fails due to missing or outdated packages, you must download and install these separately. For more information, see Resolving Package Dependency Errors in Installing Satellite Server in a Disconnected Network Environment.

  17. If using a BASH shell, after a successful or failed upgrade, enter: 

    # hash -d satellite-maintain service 2> /dev/null

  18. Check when the kernel packages were last updated: 

    # rpm -qa --last | grep kernel

  19. Optional: If a kernel update occurred since the last reboot, stop Satellite services and reboot the system: 

    # satellite-maintain service stop
# reboot
  20. Optional: If you made manual edits to DNS or DHCP configuration files, check and restore any changes required to the DNS and DHCP configuration files using the backups that you made.

  21. If you make changes in the previous step, restart Satellite services: 

    # satellite-maintain service restart

  22. If you have the OpenSCAP plug-in installed, but do not have the default OpenSCAP content available, enter the following command. 

    # foreman-rake foreman_openscap:bulk_upload:default
  23. In the Satellite web UI, go to Configure > Discovery Rules and associate selected organizations and locations with discovery rules.

3.2. Synchronizing the New Repositories

You must enable and synchronize the new 6.12 repositories before you can upgrade Capsule Servers and Satellite clients.

Procedure

  1. In the Satellite web UI, navigate to Content > Red Hat Repositories.
  2. Toggle the Recommended Repositories switch to the On position.

  3. From the list of results, expand the following repositories and click the Enable icon to enable the repositories:

    • To upgrade Satellite clients, enable the Red Hat Satellite Client 6 repositories for all Red Hat Enterprise Linux versions that clients use.

    • If you have Capsule Servers, to upgrade them, enable the following repositories too:

      Red Hat Satellite Capsule 6.12 (for RHEL 8 x86_64) (RPMs)

      Red Hat Satellite Maintenance 6.12 (for RHEL 8 x86_64) (RPMs)

      Red Hat Enterprise Linux 8 (for x86_64 – BaseOS) (RPMs)

      Red Hat Enterprise Linux 8 (for x86_64 – AppStream) (RPMs)

    Note

    If the 6.12 repositories are not available, refresh the Red Hat Subscription Manifest. In the Satellite web UI, navigate to Content > Subscriptions, click Manage Manifest, then click Refresh.

  4. In the Satellite web UI, navigate to Content > Sync Status.
  5. Click the arrow next to the product to view the available repositories.
  6. Select the repositories for 6.12. Note that Red Hat Satellite Client 6 does not have a 6.12 version. Choose Red Hat Satellite Client 6 instead.

  7. Click Synchronize Now.

    Important

    If an error occurs when you try to synchronize a repository, refresh the manifest. If the problem persists, raise a support request. Do not delete the manifest from the Customer Portal or in the Satellite web UI; this removes all the entitlements of your content hosts.

  8. If you use Content Views to control updates to the base operating system of Capsule Server, update those Content Views with new repositories, publish, and promote their updated versions. For more information, see Managing Content Views in Managing Content.

3.3. Upgrading Capsule Servers

This section describes how to upgrade Capsule Servers from 6.11 to 6.12.

Before You Begin

  • You must upgrade Satellite Server before you can upgrade any Capsule Servers. Note that you can upgrade Capsules separately from Satellite. For more information, see Section 1.4, “Upgrading Capsules Separately from Satellite”.
  • Ensure the Red Hat Satellite Capsule 6.12 repository is enabled in Satellite Server and synchronized.
  • Ensure that you synchronize the required repositories on Satellite Server. For more information, see Section 3.2, “Synchronizing the New Repositories”.
  • If you use Content Views to control updates to the base operating system of Capsule Server, update those Content Views with new repositories and publish their updated versions. For more information, see Managing Content Views in Managing Content.
  • Ensure the Capsule’s base system is registered to the newly upgraded Satellite Server.
  • Ensure the Capsule has the correct organization and location settings in the newly upgraded Satellite Server.
  • Review and update your firewall configuration prior to upgrading your Capsule Server. For more information, see Preparing Your Environment for Capsule Installation in Installing Capsule Server.
Warning

If you implemented custom certificates, you must retain the content of both the /root/ssl-build directory and the directory in which you created any source files associated with your custom certificates.

Failure to retain these files during an upgrade causes the upgrade to fail. If these files have been deleted, they must be restored from a backup in order for the upgrade to proceed.

Upgrading Capsule Servers

  1. Create a backup.

  2. Clean yum cache: 

    # yum clean metadata

  3. The rubygem-foreman_maintain is installed from the Satellite Maintenance repository or upgraded from the Satellite Maintenance repository if currently installed.

    In the current upgrade process, you must enable the Satellite 6.12 (or Capsule) repository to restrict any updates outside the Satellite Maintenance repository. Please read the Known Issues in the Release Notes as a workaround before proceeding further.

    Ensure Capsule has access to satellite-maintenance-6.12-for-rhel-8-x86_64-rpms and execute: 

    # subscription-manager repos --enable \
satellite-capsule-6.12-for-rhel-8-x86_64-rpms

# satellite-maintain self-upgrade

    If the Capsule 6.11 system was upgraded from Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 using Leapp, manually enable the Capsule module: 

    # dnf module enable satellite-capsule:el8

  4. On Capsule Server, verify that the foreman_url setting points to the Satellite FQDN: 

    # grep foreman_url /etc/foreman-proxy/settings.yml

  5. Check the available versions to confirm the version you want is listed: 

    # satellite-maintain upgrade list-versions

  6. Because of the lengthy upgrade time, use a utility such as tmux to suspend and reattach a communication session. You can then check the upgrade progress without staying connected to the command shell continuously.

    If you lose connection to the command shell where the upgrade command is running you can see the logged messages in the /var/log/foreman-installer/capsule.log file to check if the process completed successfully.

  7. Use the health check option to determine if the system is ready for upgrade: 

    # satellite-maintain upgrade check --target-version 6.12

    Review the results and address any highlighted error conditions before performing the upgrade.

  8. Perform the upgrade: 

    # satellite-maintain upgrade run --target-version 6.12

  9. Check when the kernel packages were last updated: 

    # rpm -qa --last | grep kernel

  10. Optional: If a kernel update occurred since the last reboot, reboot the system: 

    # reboot
  11. Optional: If you made manual edits to DNS or DHCP configuration files, check and restore any changes required to the DNS and DHCP configuration files using the backups made earlier.
  12. Optional: If you use custom repositories, ensure that you enable these custom repositories after the upgrade completes.

3.4. Upgrading the External Database

You can upgrade an external database from Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 while upgrading Satellite from 6.11 to 6.12.

Prerequisites

  • Create a new Red Hat Enterprise Linux 8 based host for PostgreSQL server that follows the external database on Red Hat Enterprise Linux 8 documentation. For more information, see Using External Databases with Satellite.

Procedure

  1. Create a backup.
  2. Restore the backup on the new server.

  3. If Satellite reaches the new database server via the old name, no further changes are required. Otherwise reconfigure Satellite to use the new name: 

    # satellite-installer \
--foreman-db-host newpostgres.example.com \
--katello-candlepin-db-host newpostgres.example.com \
--foreman-proxy-content-pulpcore-postgresql-host newpostgres.example.com

3.5. Performing Post-Upgrade Tasks

Some of the procedures in this section are optional. You can choose to perform only those procedures that are relevant to your installation.

3.5.1. Upgrading Discovery

If you use the PXE-based discovery process, then you must complete the discovery upgrade procedure on Satellite and on any Capsule Server with hosts that you want to be listed in Satellite on the Hosts > Discovered hosts page.

This section describes updating the PXELinux template and the boot image passed to hosts that use PXE booting to register themselves with Satellite Server.

From Satellite 6.12, provisioning templates now have a separate association with a subnet, and do not default to using the TFTP Capsule for that subnet. If you create subnets after the upgrade, you must specifically enable the Satellite or a Capsule to provide a proxy service for discovery templates and then configure all subnets with discovered hosts to use a specific template Capsule.

During the upgrade, for every subnet with a TFTP proxy enabled, the template Capsule is set to be the same as the TFTP Capsule. After the upgrade, check all subnets to verify this was set correctly.

These procedures are not required if you do not use PXE booting of hosts to enable Satellite to discover new hosts.

3.5.1.1. Upgrading Discovery on Satellite Server

  1. Update the Discovery template in the Satellite web UI:

    1. In the Satellite web UI, navigate to Hosts > Provisioning templates.
    2. On the PXELinux global default line, click Clone.
    3. Enter a new name for the template in the Name field, for example ACME PXE global default.
    4. In the template editor field, change the line ONTIMEOUT local to ONTIMEOUT discovery and click Submit.
    5. In the Satellite web UI, navigate to Administer > Settings.
    6. On the Provisioning tab, set Default PXE global template entry to a custom value for your environment.
    7. Locate Global default PXELinux template and click on its Value.
    8. Select the name of the newly created template from the menu and click Submit.
    9. In the Satellite web UI, navigate to Hosts > Provisioning templates.
    10. Click Build PXE Default, then click OK.
    Note

    If the template is modified, a Satellite upgrade overrides it to its default version. Once the PXE Default configuration is built, the template configured in the Settings is deployed to the TFTP. This can result in deploying the default template if the new template is correctly set in the Settings.

  2. In the Satellite web UI, go to Configure > Discovery Rules and associate selected organizations and locations with discovery rules.

3.5.1.2. Verifying Subnets have a Template Capsule

Ensure all subnets with discovered hosts have a template Capsule:

  1. In the Satellite web UI, navigate to Infrastructure > Subnets.
  2. Select the subnet you want to check.
  3. On the Capsules tab, ensure a Template Capsule has been set for this subnet.

For more information about configuring subnets with template Capsules, see Configuring the Discovery Service in Provisioning Hosts.

3.5.2. Upgrading virt-who

If virt-who is installed on Satellite Server or a Capsule Server, it will be upgraded when they are upgraded. No further action is required. If virt-who is installed elsewhere, it must be upgraded manually.

Before You Begin

If virt-who is installed on a host registered to Satellite Server or a Capsule Server, first upgrade the host to the latest packages available in the Satellite Client 6 repository.

Upgrade virt-who Manually

  1. Upgrade virt-who. 

    # yum upgrade virt-who

  2. Restart the virt-who service so the new version is activated. 

    # systemctl restart virt-who

3.5.3. Removing the Previous Version of the Satellite Tools Repository

After completing the upgrade to Satellite 6.12, the Red Hat Satellite Tools 6.11 repository can be removed from Content Views and then disabled.

Disable Version 6.11 of the Satellite Tools Repository:

  1. In the Satellite web UI, navigate to Content > Red Hat Repositories.
  2. In the Enabled Repositories area, locate Red Hat Satellite Tools 6.11 for RHEL 7 Server RPMs x86_64.
  3. Click the Disable icon to the right.

If the repository is still contained in a Content View then you cannot disable it. Packages from a disabled repository are removed automatically by a scheduled task.

3.5.4. Migrating Ansible Content

The upgrade from Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 includes an upgrade from Ansible Engine 2.9 to Ansible Core 2.12.

If you have custom Ansible content such as playbooks, job templates inside REX, roles and collections on disk, and you rely on modules being delivered by the Ansible RPM on Satellite, you have to take additional steps to adapt your Ansible installation or migrate your Ansible content.

Ansible Core contains only essential modules. In terms of FQCN notation namespace.collection.module, you can continue to use ansible.builtin.*, but everything else is missing in Ansible Core. That means you will be no longer able to use non-builtin Ansible modules as you were used to and you have to get them from another source, eventually.

You have the following options to handle your Ansible content after the upgrade:

  • You can obtain additional community-maintained collections that provide the non-essential functionality from Ansible Galaxy. For more information, see Installing collections in the Galaxy User Guide.

    Note that Red Hat does not provide support for this content.

  • If you have a subscription for Red Hat Automation Hub, you can configure your ansible-galaxy to talk to Automation Hub server and download content from there. That content is supported by Red Hat. For more information on configuring Automation Hub connection for ansible-galaxy, see Configuring Red Hat automation hub as the primary source for content.
  • You can rewrite your Ansible roles, templates and other affected content. Note that Red Hat does not provide support for content that you maintain yourself.
Note

If you want to download and install Ansible content on Capsule that does not have a connection to an external Ansible Galaxy server, then you must pass the content through Satellite Server instead of using the URL of the Ansible Galaxy server in the configuration on the Capsule directly:

  1. Sync the content from a Ansible Galaxy server to a custom repository on your Satellite Server.
  2. Configure Ansible on your Capsule to download the content from Satellite Server.

Additional resources

3.5.5. Reclaiming PostgreSQL Space

The PostgreSQL database can use a large amount of disk space especially in heavily loaded deployments. Use this procedure to reclaim some of this disk space on Satellite.

Procedure

  1. Stop all services, except for the postgresql service: 

    # satellite-maintain service stop --exclude postgresql

  2. Switch to the postgres user and reclaim space on the database: 

    # su - postgres -c 'vacuumdb --full --all'

  3. Start the other services when the vacuum completes: 

    # satellite-maintain service start

3.5.6. Tuning Satellite Server with Predefined Profiles

If your Satellite deployment includes more than 5000 hosts, you can use predefined tuning profiles to improve performance of Satellite.

Note that you cannot use tuning profiles on Capsules.

You can choose one of the profiles depending on the number of hosts your Satellite manages and available hardware resources.

The tuning profiles are available in the /usr/share/foreman-installer/config/foreman.hiera/tuning/sizes directory.

When you run the satellite-installer command with the --tuning option, deployment configuration settings are applied to Satellite in the following order:

  1. The default tuning profile defined in the /usr/share/foreman-installer/config/foreman.hiera/tuning/common.yaml file
  2. The tuning profile that you want to apply to your deployment and is defined in the /usr/share/foreman-installer/config/foreman.hiera/tuning/sizes/ directory
  3. Optional: If you have configured a /etc/foreman-installer/custom-hiera.yaml file, Satellite applies these configuration settings.

Note that the configuration settings that are defined in the /etc/foreman-installer/custom-hiera.yaml file override the configuration settings that are defined in the tuning profiles.

Therefore, before applying a tuning profile, you must compare the configuration settings that are defined in the default tuning profile in /usr/share/foreman-installer/config/foreman.hiera/tuning/common.yaml, the tuning profile that you want to apply and your /etc/foreman-installer/custom-hiera.yaml file, and remove any duplicated configuration from the /etc/foreman-installer/custom-hiera.yaml file.

default

Number of managed hosts: 0 – 5000

RAM: 20G

Number of CPU cores: 4

medium

Number of managed hosts: 5001 – 10000

RAM: 32G

Number of CPU cores: 8

large

Number of managed hosts: 10001 – 20000

RAM: 64G

Number of CPU cores: 16

extra-large

Number of managed hosts: 20001 – 60000

RAM: 128G

Number of CPU cores: 32

extra-extra-large

Number of managed hosts: 60000+

RAM: 256G

Number of CPU cores: 48+

Procedure

  1. Optional: If you have configured the custom-hiera.yaml file on Satellite Server, back up the /etc/foreman-installer/custom-hiera.yaml file to custom-hiera.original. You can use the backup file to restore the /etc/foreman-installer/custom-hiera.yaml file to its original state if it becomes corrupted: 

    # cp /etc/foreman-installer/custom-hiera.yaml \
/etc/foreman-installer/custom-hiera.original
  2. Optional: If you have configured the custom-hiera.yaml file on Satellite Server, review the definitions of the default tuning profile in /usr/share/foreman-installer/config/foreman.hiera/tuning/common.yaml and the tuning profile that you want to apply in /usr/share/foreman-installer/config/foreman.hiera/tuning/sizes/. Compare the configuration entries against the entries in your /etc/foreman-installer/custom-hiera.yaml file and remove any duplicated configuration settings in your /etc/foreman-installer/custom-hiera.yaml file.

  3. Enter the satellite-installer command with the --tuning option for the profile that you want to apply. For example, to apply the medium tuning profile settings, enter the following command: 

    # satellite-installer --tuning medium