Chapter 5. Tuning Satellite Server performance with predefined profiles
If your Satellite deployment includes a large number of hosts, you can use predefined tuning profiles to configure your Satellite Server to use the optimal amount of CPU cores and memory. This can help improve Satellite performance.
5.1. How predefined tuning profiles apply
When you run the satellite-installer command with the --tuning option, deployment configuration settings from multiple sources are applied to Satellite in a specific order. This order defines the priority of these settings.
Satellite loads tuning configuration settings from the following sources:
- Custom Hiera settings
-
If you use custom Hiera settings on your Satellite Server, you can find them in the
/etc/foreman-installer/custom-hiera.yamlfile. - Predefined tuning profile
-
This is the profile that you select when running the
satellite-installercommand with the--tuningoption. The settings for these profiles are defined in the/usr/share/foreman-installer/config/foreman.hiera/tuning/sizes/directory. - Base tuning profile
-
The settings for this profile are defined in the
/usr/share/foreman-installer/config/foreman.hiera/tuning/common.yamlfile.
When merging these settings, Satellite applies them in the following order:
-
Custom settings in the
/etc/foreman-installer/custom-hiera.yamlfile override the settings in any predefined profile and the base profile. - Predefined profile settings override the settings in the base profile.
5.2. Predefined tuning profiles
The following predefined tuning profiles are available in Satellite to right-size your Satellite Server based on the number of hosts your Satellite manages and available hardware resources.
The predefined tuning profiles are available in the /usr/share/foreman-installer/config/foreman.hiera/tuning/sizes directory. Each profile targets a managed-host range and minimum RAM and CPU cores.
| Tuning profile | Number of hosts | RAM | Number of CPU cores |
|---|---|---|---|
| default | 0 – 5000 | 20G | 4 |
| medium | 5001 – 10000 | 32G | 8 |
| large | 10001 – 20000 | 64G | 16 |
| extra-large | 20001 – 60000 | 128G | 32 |
| extra-extra-large | 60000+ | 256G | 48+ |
5.3. Applying a predefined tuning profile
Run satellite-installer with the --tuning option to apply a profile. Choosing the right tuning profile helps your Satellite Server use its CPU cores and memory better.
You cannot use predefined tuning profiles on Capsule Servers.
Procedure
If you use a
custom-hiera.yamlfile on your Satellite Server, perform the following steps:Optional: Back up your
custom-hiera.yamlfile:# cp /etc/foreman-installer/custom-hiera.yaml \ /etc/foreman-installer/custom-hiera.original.yamlThis ensures you can restore the
custom-hiera.yamlfile to its original state if it becomes corrupted.-
Review the definitions of the base tuning profile in
/usr/share/foreman-installer/config/foreman.hiera/tuning/common.yamland 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.yamlfile. -
Remove any duplicated configuration settings that you find in
custom-hiera.yaml. This ensures the settings incustom-hiera.yamldo not override the settings in the base tuning profile and your chosen predefined tuning profile.
Apply the tuning profile:
# satellite-installer --tuning medium
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}