Updating Red Hat Satellite
Update Satellite Server and Capsule to a new minor release
Abstract
Providing Feedback on Red Hat Documentation Copy linkLink copied to clipboard!
We appreciate your feedback on our documentation. Let us know how we can improve it.
Use the Create Issue form in Red Hat Jira to provide your feedback. The Jira issue is created in the Red Hat Satellite Jira project, where you can track its progress.
Prerequisites
- Ensure you have registered a Red Hat account.
Procedure
- Click the following link: Create Issue. If Jira displays a login error, log in and proceed after you are redirected to the form.
- Complete the Summary and Description fields. In the Description field, include the documentation URL, chapter or section number, and a detailed description of the issue. Do not modify any other fields in the form.
- Click Create.
Chapter 1. Updating Satellite to the Next Minor Version Copy linkLink copied to clipboard!
You can update your Satellite Server and Capsule Server to a new minor release version, such as from 6.14.0 to 6.14.1, using the Satellite maintain tool. The minor releases are non-disruptive to your operating environment and often fast.
Red Hat recommends performing updates regularly, because the minor releases patch security vulnerabilities and minor issues discovered after code is released.
Chapter 2. Updating Satellite Server Copy linkLink copied to clipboard!
Update your connected Satellite Server to the next minor version. For information to update a disconnected Satellite setup, see Chapter 3, Updating a Disconnected Satellite Server.
Prerequisite
- Back up your Satellite Server. For more information, see Backing Up Satellite Server and Capsule Server in Administering Red Hat Satellite.
If you customize configuration files, manually or using a tool such as Hiera, these changes are overwritten when the maintenance script runs during upgrading or updating. You can use the --noop option with the satellite-installer 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.
Procedure
Ensure the Satellite Maintenance repository is enabled:
subscription-manager repos --enable \ satellite-maintenance-6.14-for-rhel-8-x86_64-rpms
# subscription-manager repos --enable \ satellite-maintenance-6.14-for-rhel-8-x86_64-rpmsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Check the available versions to confirm the next minor version is listed:
satellite-maintain upgrade list-versions
# satellite-maintain upgrade list-versionsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Use the health check option to determine if the system is ready for upgrade. On first use of this command,
satellite-maintainprompts you to enter the hammer admin user credentials and saves them in the/etc/foreman-maintain/foreman-maintain-hammer.ymlfile.satellite-maintain upgrade check --target-version 6.14.z
# satellite-maintain upgrade check --target-version 6.14.zCopy to Clipboard Copied! Toggle word wrap Toggle overflow Review the results and address any highlighted error conditions before performing the upgrade.
Because of the lengthy update time, use a utility such as
tmuxto 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.logfile to check if the process completed successfully.Perform the upgrade:
satellite-maintain upgrade run --target-version 6.14.z
# satellite-maintain upgrade run --target-version 6.14.zCopy to Clipboard Copied! Toggle word wrap Toggle overflow Determine if the system needs a reboot:
dnf needs-restarting --reboothint
# dnf needs-restarting --reboothintCopy to Clipboard Copied! Toggle word wrap Toggle overflow If the previous command told you to reboot, then reboot the system:
reboot
# rebootCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Additional resources
- To restore the backup of the Satellite Server or Capsule Server, see Restoring Satellite Server or Capsule Server from a Backup
Chapter 3. Updating a Disconnected Satellite Server Copy linkLink copied to clipboard!
Update your air-gapped Satellite setup where the connected Satellite Server, which synchronizes content from CDN, is air gapped from a disconnected Satellite Server, to the next minor version.
Prerequisites
- Back up your Satellite Server. For more information, see Backing Up Satellite Server and Capsule Server in Administering Red Hat Satellite.
Install
reposyncthat is required for the updating procedure:dnf install 'dnf-command(reposync)'
# dnf install 'dnf-command(reposync)'Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Procedure on the connected Satellite Server
Ensure that you have synchronized the following repositories in your connected Satellite Server:
- rhel-8-for-x86_64-baseos-rpms
- rhel-8-for-x86_64-appstream-rpms
- satellite-6.14-for-rhel-8-x86_64-rpms
- satellite-maintenance-6.14-for-rhel-8-x86_64-rpms
-
Download the debug certificate of the organization and store it locally at
/etc/pki/katello/certs/org-debug-cert.pemor a location of your choosing. For more information, see Creating an Organization Debug Certificate in Administering Red Hat Satellite. Create a Yum configuration file under
/etc/yum.repos.d, such assatellite-disconnected.repo, with the following contents:Copy to Clipboard Copied! Toggle word wrap Toggle overflow In the configuration file, complete the following steps:
-
For the
sslclientcertandsslclientkeyoptions, replace/etc/pki/katello/certs/org-debug-cert.pemwith the location of the downloaded organization debug certificate. -
For the
baseurloption, replacesatellite.example.comwith the correct FQDN of your connected Satellite Server. -
For the
baseurloption, replaceMy_Organizationwith your organization label.
-
For the
Obtain the organization label:
hammer organization list
# hammer organization listCopy to Clipboard Copied! Toggle word wrap Toggle overflow Enter the
reposynccommand:Copy to Clipboard Copied! Toggle word wrap Toggle overflow This downloads the contents of the repositories from the connected Satellite Server and stores them in the directory
~/Satellite-repos.-
Verify that the RPMs have been downloaded and the repository data directory is generated in each of the sub-directories of
~/Satellite-repos. Archive the contents of the directory:
tar czf Satellite-repos.tgz -C ~ Satellite-repos
# tar czf Satellite-repos.tgz -C ~ Satellite-reposCopy to Clipboard Copied! Toggle word wrap Toggle overflow -
Use the generated
Satellite-repos.tgzfile to upgrade in the disconnected Satellite Server.
Procedure on the disconnected Satellite Server
-
Copy the generated
Satellite-repos.tgzfile to your disconnected Satellite Server. Extract the archive to anywhere accessible by the
rootuser. In the following example/rootis the extraction location.tar zxf Satellite-repos.tgz -C /root
# tar zxf Satellite-repos.tgz -C /rootCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create a Yum configuration file under
/etc/yum.repos.dwith the following repository information:Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
In the configuration file, replace the
/root/Satellite-reposwith the extracted location. Check the available versions to confirm the next minor version is listed:
satellite-maintain upgrade list-versions
# satellite-maintain upgrade list-versionsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Use the health check option to determine if the system is ready for upgrade. On first use of this command,
satellite-maintainprompts you to enter the hammer admin user credentials and saves them in the/etc/foreman-maintain/foreman-maintain-hammer.ymlfile.satellite-maintain upgrade check \ --target-version 6.14.z \ --whitelist="check-upstream-repository,repositories-validate"
# satellite-maintain upgrade check \ --target-version 6.14.z \ --whitelist="check-upstream-repository,repositories-validate"Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Review the results and address any highlighted error conditions before performing the upgrade.
Due to the lengthy update time, use a utility such as
tmuxto 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.logfile to check if the process completed successfully.Perform the upgrade:
satellite-maintain upgrade run \ --target-version 6.14.z \ --whitelist="check-upstream-repository,repositories-setup,repositories-validate"
# satellite-maintain upgrade run \ --target-version 6.14.z \ --whitelist="check-upstream-repository,repositories-setup,repositories-validate"Copy to Clipboard Copied! Toggle word wrap Toggle overflow Determine if the system needs a reboot:
dnf needs-restarting --reboothint
# dnf needs-restarting --reboothintCopy to Clipboard Copied! Toggle word wrap Toggle overflow If the previous command told you to reboot, then reboot the system:
reboot
# rebootCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Additional resources
- To restore the backup of the Satellite Server or Capsule Server, see Restoring Satellite Server or Capsule Server from a Backup
Chapter 4. Updating Capsule Server Copy linkLink copied to clipboard!
Update Capsule Servers to the next minor version.
Procedure
-
Synchronize the
satellite-capsule-6.14-for-rhel-8-x86_64-rpmsrepository in the Satellite Server. - Publish and promote a new version of the content view with which the Capsule is registered.
Ensure that the Satellite Maintenance repository is enabled:
subscription-manager repos --enable \ satellite-maintenance-6.14-for-rhel-8-x86_64-rpms
# subscription-manager repos --enable \ satellite-maintenance-6.14-for-rhel-8-x86_64-rpmsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Check the available versions to confirm the next minor version is listed:
satellite-maintain upgrade list-versions
# satellite-maintain upgrade list-versionsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Use the health check option to determine if the system is ready for upgrade:
satellite-maintain upgrade check --target-version 6.14.z
# satellite-maintain upgrade check --target-version 6.14.zCopy to Clipboard Copied! Toggle word wrap Toggle overflow Review the results and address any highlighted error conditions before performing the upgrade.
Because of the lengthy update time, use a utility such as
tmuxto 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.logfile to check if the process completed successfully.Perform the update:
satellite-maintain upgrade run --target-version 6.14.z
# satellite-maintain upgrade run --target-version 6.14.zCopy to Clipboard Copied! Toggle word wrap Toggle overflow Determine if the system needs a reboot:
dnf needs-restarting --reboothint
# dnf needs-restarting --reboothintCopy to Clipboard Copied! Toggle word wrap Toggle overflow If the previous command told you to reboot, then reboot the system:
reboot
# rebootCopy to Clipboard Copied! Toggle word wrap Toggle overflow