Chapter 1. Introducing Red Hat Satellite 6.12
These release notes highlight major changes, enhancements, technology preview items, known issues, deprecated functionality, and removed functionality you must take into consideration when deploying this release of Red Hat Satellite 6. Notes for updates released during the support lifecycle of this Red Hat Satellite 6 release will appear in the advisory text associated with each update.
1.1. Major Changes
The 6.12 release of Red Hat Satellite features the following major changes:
- Satellite installation on Red Hat Enterprise Linux 7 is no longer supported
- Support for Red Hat Enterprise Linux 7 based Satellite installation is discontinued with this release. Satellite Server now supports installation on Red Hat Enterprise Linux 8. However, Satellite Clients remain unaffected.
- Satellite supports pull mode for remote job execution
- Previously, you used Katello Agent on hosts for pull-based transport in infrastructures that prohibit connections from Capsule to the hosts. With this release, Red Hat Satellite introduces Message Queueing Telemetry Transport (MQTT), and bundles a MQTT broker with Capsule and a MQTT client for hosts with Red Hat Client. As a result, pull-based transport of remote jobs is supported in Satellite natively and you can enable it on Capsule and on hosts.
1.2. Enhancements
The 6.12 release of Red Hat Satellite features the following enhancements:
- Improvements to Hosts Page
Red Hat Satellite now loads the new UI for host details by default. The functionality previously available under Hosts > Content Hosts is now available on the new Hosts page. To reach the page, navigate to Hosts > All Hosts and select the host you want to see in more detail.
Additions:
Overview tab
- You can now change the content source by clicking the vertical ellipsis next to the Edit button, then clicking on Change content source.
- You can now change the content view and the lifecycle environment by clicking the vertical ellipsis on the Content view details card, then clicking Edit content view assignments.
- You can now set system purpose attributes like role, service-level agreement, usage (SLA), release version, and add-ons for the host by editing the System purpose card.
- You can now assign the host to a host collection by clicking the Add to a host collection button on the Host collections card.
Content tab
- Packages tab, Repository sets tab, and Module streams tab are no longer view-only.
- You can now install, upgrade, or remove packages in the Packages tab.
- The Repository sets tab is now located under the Content tab.
- You can now disable and enable the repositories in bulk.
- You can now display repositories specific to your content view and environment in the Repository sets tab.
- You can now manage modules by remotely executing jobs on your host in the Module streams tab.
- You now get a notification when a remote execution job is complete.
Traces tab
- You can now enable traces on the host.
- You can now restart applications on the host.
Insights tab
- You can now see the recommendations for the host.
- You can now apply remediations to the host.
- The ID field is now searchable for all resources
Previously, the ID column was not searchable for certain entities. With this release, you can sort and order all entities by ID. For example:
hammer ansible roles list --order 'id DESC'
- You can now use API to import Ansible playbooks
- You can now import Ansible playbooks from collections installed on Capsule using the API.
- Satellite Server now performs better with
mpm_event
module -
The default Apache multiprocessing module has been changed from
mpm_prefork
tompm_event
, which performs better at scale. - Satellite installer parameter changes
-
Satellite installer parameter
--foreman-proxy-plugin-remote-execution-ssh
has been replaced with--foreman-proxy-plugin-remote-execution-script
. - Satellite installer now installs a minimal set of Apache httpd modules
Previously, the
satellite-installer
command installed the default set of Apache httpd modules, some of which were not required for most Satellite deployments. With this release, the set of Apache modules is reduced to include only required modules. You can check the currently enabled Apache modules by running thehttpd -M
command. You can enable additional modules by adding theapache::default_mods:
parameter to the/etc/foreman-installer/custom-hiera.yaml
file. For example:apache::default_mods: - additional_module_1 - additional_module_2
After editing the
custom-hiera.yaml
file, runsatellite-installer
to install the additional modules.- Satellite supports pull mode for remote job execution
- Previously, you used Katello Agent on hosts for pull-based transport in infrastructures that disallow connections from Capsule to the hosts. With this release, Red Hat Satellite introduces Message Queueing Telemetry Transport (MQTT), and bundles a MQTT broker with Capsule and a MQTT client for hosts with Red Hat Client. As a result, pull-based transport of remote jobs is supported in Satellite natively and you can enable it on Capsule and on hosts.
- Email notifications about completed jobs
- When a remote execution job completes, Satellite can send an email notification with a summary to the user who scheduled the job. This can be configured per user. Each user can set their preference in Administer > Users > USER > Email Preferences > Remote execution job to receive either no email notifications, email notifications about failed jobs, email notifications about succeeded jobs, or email notifications about all jobs.
- Show and hide Satellite version on the login page
-
Previously, the Satellite version displayed in the login page footer could not be changed. With this release, the default value of the general setting
Login page footer text
has been changed toVersion $VERSION
. The$VERSION
keyword is converted to the version of your Satellite instance. You can hide the Satellite version in the login page footer by setting the value of theLogin page footer text
variable to empty string. To make the text visible again, reset the variable to the default value. You can display additional text in the login page footer by adding the text to the variable. - Satellite ignores configured HTTP proxies
- When Satellite internally makes requests to Capsules, it assumes it has direct visibility to Capsule and ignores any configured HTTP proxies. Satellite previously honored the configured proxy, which caused issues if the Capsules were not reachable through the proxy. However, the connection to Red Hat Content Delivery Network (CDN) or any other content sources remains unaffected and will continue to pass through HTTP proxies.
- API docs generate dynamically and stop generating cache
-
API docs (
/apidoc
) now generate dynamically at the time of a request. This ensures accurate API documentation based on the current installation and options. There is no appreciable change in load time of documentation. - Puma now restarts upon plugin installation or upgrade
- Previously, when a plugin was installed or upgraded directly from RPM, the installer did not always restart Puma. With this release, plugins inform the installer and it restarts Puma if necessary.
- Automatic configuration of Pulp-cli on Satellite through Installer
- With this release, Pulp-cli is configured on Satellite automatically through Installer with the proper client certificates for authentication. Additionally, the Pulp cli is configured in a dry run mode to prevent accidental writing.
- Truthy and Falsy template macros
- Two new template macros, truthy and falsy, are introduced with this release. With these macros, you can declare if the value passed is true or false, regardless of whether the value is an integer or boolean, or string.
- Simplified changing of host content source
- This release includes further enhancements in the host content source workflow. You can change the content source of hosts from the Hosts > All Hosts page. After selecting the hosts, click Select Action > Change Content Source. You can also change the content source of a host on the host’s detail page. Click the vertical ellipsis and select Change content source. You can change the content source using remote execution or using the command generated by the Change content source wizard.
1.3. Bug Fixes
The 6.12 release of Red Hat Satellite features the following bug fixes:
- Local boot in UEFI provisioning on virtual machines defaults to booting from disk
Previously, booting from disk was temporarily suspended as the default boot entry for UEFI provisioning when using the PXEGrub2 default local boot template. Consequently, you had to force the local boot from disk using a global setting. With this release, the local boot from disk is restored as the default boot entry. As a result, you do not have to force the workflow.
After the upgrade to 6.12, reset the global setting to its default value. In the Satellite web UI, navigate to Administer > Settings > Provisioning and clear the value of Default PXE local template entry.
- Provisioning a RHEL 9 host does not result in booting into the emergency mode
- Previously, when you provisioned the RHEL 9 host, the operating system could go into the emergency mode when attempting to boot the new kernel. This is resolved with an update in the RHEL 9 Kickstart repository. Synchronize your repository with the updated Kickstart repository.
- Disabled repository types no longer appear in the API documentation
- Previously, disabled repository types were listed in the API documentation. This was happening because the API documentation did not take data from your Satellite instance. With this release, the API documentation does not contain enabled repository types directly but instead has an endpoint which lists the content types that are enabled on your Satellite instance. As a result, disabled repository types no longer appear in the API documentation.
1.4. Technology Previews
Technology Preview features are not supported with Red Hat production service-level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information, see Red Hat Technology Preview Features Support Scope.
The following features are available as Technology Previews in Red Hat Satellite 6.12:
- OVAL / CVE Reporting Support
Satellite now includes the ability to scan systems for vulnerabilities using the OVAL standard data feed provided by Red Hat.
foreman_openscap
contains the API to upload the OVAL content used to trigger the OVAL oscap scans. The results are parsed for CVEs and sent to Satellite which then generates reports of managed hosts and the CVEs that effect them.- OpenShift Virtualization plugin
- You can provision virtual machines using the OpenShift Virtualization compute resource as a Technology Preview.
- Kernel execution (kexec) template
- Kernel execution template for PXE-less boot methods.
- Job invocation wizard
This release introduces a job invocation wizard in the Lab Features menu as a Technology Preview.
Options from the previous job invocation form remain the same in the job invocation wizard, and there are also new search options.
Note that the wizard is not enabled by default. You can enable it in settings by going to Administer > Settings > Show Experimental Lab.
- Alternate Content Sources
This release introduces the Alternate Content Sources feature as a Technology Preview. Using the alternate content sources feature, you can populate a repository with content that is locally stored or geographically closer to you. This can be used to speed up repository synchronization, as only the metadata will be pulled in from the repository server, while the content itself will be synchronized from the alternate content source.
The alternate content source can be set up for a Satellite server, as well as for Capsule servers.
To create alternate content sources, navigate to Lab Features > Alternate Content Sources > Add Source.
For more information, see Using Alternate Content Sources With Satellite 6.12 (Tech Preview).
1.5. Known Issues
The following known issues exist in Red Hat Satellite 6.12 at this time:
- Disabled Puppet with all data removed cannot be re-enabled
If the Puppet plug-in was disabled with the
-f, --remove-all-data
argument and you attempt to enable it again, Satellite maintain fails.BZ#(2087067)
- Job invocation details show incorrect results of execution on multiple hosts
When you run an Ansible job against multiple hosts and the execution fails on some hosts, the results of the execution on all hosts are marked as failed in the job invocation details. As a result, partial failure of jobs is not respected and you can see the failed result status even for hosts on which execution succeeded.
BZ#(2167396)
This is fixed in the 6.12.4 update.
- Information from host group is not completely inherited when provisioning a discovered host in the Satellite web UI
When you provision a discovered host, after selecting a host group and trying to customize the host entry, many critical pieces of information are missing. This results in a failed deployment attempt.
As a workaround, perform one of the following actions:
Provision the host using hammer:
# hammer discovery provision --name discovered_host_name \ --hostgroup-id your_hostgroup_id \ --organization-id your_organization_id \ --location-id your_location_id \ --new-name new_host_name\ --build true
For more information, see hammer discovery provision in Hammer CLI Guide.
- Configure discovery rules and enable auto-provisioning so that no manual intervention is required to provision a discovered host. For more information, see Creating Discovery Rules in Provisioning Hosts.
BZ#(2069324)
- Upgrade to version 6.12 fails with "Nothing to update, can’t find new version of satellite-maintain."
Due to a modularity issue, the
dnf
tool currently cannot detect the relevant version of therubygem-foreman_maintain
package.Consequently, the
satellite-maintain upgrade list-versions
command does not list Red Hat Satellite version 6.12 for running an upgrade after enabling thesatellite-maintenance-6.12-for-rhel-8-x86_64-rpms
repository, therefore Satellite Servers and Capsule Servers cannot be upgraded to the version 6.12.To work around this problem, use the below commands to enable the satellite 6.12 repositories after enabling the
satellite-maintenance-6.12-for-rhel-8-x86_64-rpms repository
.For Satellite Server:
# subscription-manager repos --enable satellite-6.12-for-rhel-8-x86_64-rpms
For Capsule Server:
# subscription-manager repos --enable satellite-capsule-6.12-for-rhel-8-x86_64-rpms
For more information, see the Knowledgebase Solution.
BZ#(2143451)
- Logging error during the host registration with Red Hat Insights
During host provisioning, the host is registered with Red Hat Insights by running the command
insights-client —register –verbose
. It ended up with a logging error after package installation.However, it requires no workaround as this error occurs only once and it does not repeat after the initial output. More details for the same can be found in the provisioning log.
BZ#(2129254)
- Insights tab does not show the correct recommendations after switching to a new host
When you switch to a new host using the breadcrumb switcher, the Insights tab continues to show data from the previous host.
To work around this issue, refresh the page in your web browser to view the recommendations for the newly selected host.
BZ#(2120640)
- Job is dropped in pull mode when MQTT client was not running at invocation time
When you invoke a remote job execution on a host in pull mode and the
yggdrasild
service is not running at that time, then afteryggdrasild
restarts, the service drops the job instead of executing it. You must invoke the job again withyggdrasild
running on the host.BZ#(2124419)
qpidd
orkatello_agent
fails during database restoreqpidd
orkatello_agent
from hammer ping fails during the database restore process.As a workaround, restart the foreman by
systemctl restart foreman
and repeat the process.BZ#(2124215)
1.6. Deprecated Functionality
This part provides an overview of functionalities that have been deprecated in Red Hat Satellite 6.12.
Deprecated functionality will likely not be supported in a future release of this product and is not recommended for new deployments.
- Package group actions
- Package group actions in the Satellite web UI is deprecated and will be removed in a future release.
- Append domain names to the host
-
The
Append domain names to the host
setting is deprecated and will be removed in a future release. Use FQDN (Fully Qualified Domain Name) to identify the hosts. - Foreman Hooks
- Foreman Hooks functionality has been deprecated and will be removed in a future release. The functionality will be replaced by the new Foreman Webhooks feature that will be documented with its release.
- Provisioning on Red Hat Virtualization
- The integration of Red Hat Virtualization (RHV) with Satellite is deprecated and will be removed in a future release. All the existing compute resources of RHV type will be removed and the hosts associated with RHV will be disconnected.
- Bootstrap.py
-
The
bootstrap.py
script used to register a host to Satellite or Capsule Server has been replaced with thecurl
command created with the global registration template. - Entitlements
Entitlement-based Subscription Management is deprecated and will be removed in a future release.
It is recommended to use Simple Content Access, which simplifies the entitlement experience for administrators in regards to subscriptions as a substitute.
- Katello Agent
-
Katello Agent is deprecated and will be removed in a future release. Transition your workloads to use the
Remote Execution
feature. Katello-ca-consumer
package-
The
katello-ca-consumer
package is deprecated and will be removed in a future release. Use the global registration template for registering a host to Red Hat Satellite.
1.7. Removed Functionality
This part provides an overview of functionalities that have been removed in Red Hat Satellite 6.12.
- Satellite installation on Red Hat Enterprise Linux 7 is no longer supported
- Support for Red Hat Enterprise Linux 7 based Satellite installation is discontinued from Satellite 6.12. Satellite Server now supports installation on Red Hat Enterprise Linux 8. However, Satellite Clients remain unaffected.
:unattended:
Setting-
The
:unattended:
setting has been removed from thesettings.yaml
file. Satellite defaults totrue
.