Important

If you have installed the Katello plugin, you must use Upgrading Foreman with Katello.

1. Preparing for Foreman upgrade

Review the following prerequisites and available upgrade paths before upgrading your current Foreman installation to Foreman nightly.

1.1. Upgrade path overview

You can upgrade from Foreman 3.15 to Foreman nightly. The upgrade process includes the following high-level steps:

  1. Upgrading your Foreman server to nightly.

  2. Upgrading your Smart Proxy servers to nightly.

You can upgrade your Smart Proxies separately over multiple maintenance windows because versions 3.15 and 3.14 remain compatible with your upgraded Foreman server nightly. Upgrading Smart Proxies separately can be useful in the following situations:

  • If you want to have several smaller outage windows instead of one larger window.

  • If Smart Proxies in your organization are managed by several teams and are located in different locations.

Smart Proxies at version 3.15 and 3.14 retain all of their previous functionality. New functionality added in the nightly release is available only after you upgrade your Smart Proxies to nightly.

1.2. Planning Foreman upgrade

Upgrading to Foreman nightly affects your entire Foreman infrastructure. Plan carefully before proceeding.

  • Read the Foreman nightly Release notes.

  • Consider whether any of your integrations need updating. Some Foreman API endpoints, Hammer CLI commands, and modules from the Foreman Ansible Collection can differ between versions of Foreman.

Foreman services are shut down during the upgrade. Ensure to plan for the required downtime. The upgrade process duration varies depending on your hardware configuration, network speed, and the amount of data that is stored on the server:

  • On average installations, upgrading Foreman server takes up to 30 minutes and upgrading a single Smart Proxy server takes up to 10 minutes.

  • On very large installations, upgrading Foreman server can take up to 1 – 2 hours and upgrading a single Smart Proxy server can take up to 15 – 30 minutes.

1.3. Following the progress of the upgrade

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/foreman.log to check if the process completed successfully.

Additional resources

  • tmux(1) man page on your system

2. Upgrading Foreman

Upgrading Foreman includes upgrading your Foreman server and upgrading Smart Proxy servers.

2.1. Upgrading a connected Foreman server

Use this procedure for a Foreman 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 maintenance script runs during upgrading or updating. You can use the --noop option with the foreman-installer to test for changes.
Prerequisites

  • If you have edited any of the default templates, back up the files either by cloning or exporting them.

    • To confirm if a template has been edited, view its History before you upgrade. Alternatively, view the changes in the audit log after you upgrade. In the Foreman web UI, navigate to Monitor > Audits and search for the template to see a record of changes made.

    • The recommended template backup method is cloning. Cloning prevents templates from being overwritten in future updates or upgrades.

    • If you use the export backup method, restore your changes by comparing the exported template and the default template, and then manually apply your changes.

Upgrade Foreman server

  1. Stop all Foreman services:

    # foreman-maintain service stop

  2. Take a snapshot or create a backup:

    • On a virtual machine, take a snapshot.

    • On a physical machine, create a backup.

  3. Start all Foreman services:

    # foreman-maintain service start

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

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

    # foreman-installer \
--foreman-proxy-dhcp-managed=false \
--foreman-proxy-dns-managed=false

  6. In the Foreman 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.

  7. Update operating system packages:

    # dnf upgrade

  8. Update repositories:

    # dnf upgrade https://yum.theforeman.org/releases/nightly/el9/x86_64/foreman-release.rpm

  9. Stop all services:

    # foreman-maintain service stop

  10. Update the required packages:

    # dnf upgrade

  11. Run the installer:

    # foreman-installer

  12. Determine if the system needs a reboot:

    # dnf needs-restarting --reboothint

  13. If the previous command told you to reboot, then reboot the system:

    # reboot

2.2. Performing post-upgrade tasks

  • Optional: If the default provisioning templates have been changed during the upgrade, recreate any templates cloned from the default templates. If the custom code is executed before and/or after the provisioning process, use custom provisioning snippets to avoid recreating cloned templates. For more information about configuring custom provisioning snippets, see Creating Custom Provisioning Snippets in Provisioning hosts.

2.3. Upgrading Smart Proxy servers

After you have upgraded your Foreman server, you can start upgrading your Smart Proxy servers.

Prerequisites

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

Upgrading Smart Proxy servers

  1. Create a backup.

  2. Update repositories:

    # dnf upgrade https://yum.theforeman.org/releases/nightly/el9/x86_64/foreman-release.rpm

  3. Stop Smart Proxy services:

    # foreman-maintain service stop

  4. Update the required packages:

    # dnf upgrade

  5. Run the installer:

    # foreman-installer

  6. Determine if the system needs a reboot:

    # dnf needs-restarting --reboothint

  7. If the previous command told you to reboot, then reboot the system:

    # reboot

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

Upgrading Smart Proxy servers using remote execution

  1. Create a backup or take a snapshot.

    For more information on backups, see Backing Up Foreman server and Smart Proxy server in Administering Foreman.

  2. In the Foreman web UI, navigate to Monitor > Jobs.

  3. Click Run Job.

  4. From the Job category list, select Maintenance Operations.

  5. From the Job template list, select Smart Proxy Upgrade Playbook.

  6. In the Search Query field, enter the host name of the Smart Proxy.

  7. Ensure that Apply to 1 host is displayed in the Resolves to field.

  8. In the target_version field, enter the target version of the Smart Proxy.

  9. In the whitelist_options field, enter the options.

  10. Select the schedule for the job execution in Schedule.

  11. In the Type of query section, click Static Query.

2.4. Upgrading the external database

If your Foreman server uses an external database, the database will be upgraded when running foreman-installer on your Foreman server.

Prerequisites

  • PostgreSQL version 13 is installed on your Enterprise Linux host.

Procedure

  1. Update permissions to prepare the postgresql-evr extension for removal:

    # runuser -l postgres -c \
"psql -d foreman -c \"UPDATE pg_extension SET extowner = (SELECT oid FROM pg_authid WHERE rolname='foreman') WHERE extname='evr';\""

  2. Follow Upgrading a connected Foreman server.

2.5. Upgrading the external database operating system

If your Foreman uses an external database, you can upgrade the database from Enterprise Linux 8 to Enterprise Linux 9 while upgrading Foreman from 3.15 to nightly.

Prerequisites

  • Create a host running Enterprise Linux 9 for PostgreSQL server that follows the external database on Enterprise Linux 9 documentation.

Procedure

  1. Create a backup of your existing external database.

  2. Restore the backup on the new Enterprise Linux 9 server.

  3. Verify that Foreman can reach the new database:

# PGPASSWORD='_My_Foreman_Database_Password_' psql -h _postgres.example.com_ -p 5432 -U foreman -d foreman -c "SELECT 1 as ping"

  1. If your Foreman server can reach the new database server by using the old name, no further changes are required. Otherwise, reconfigure Foreman to use the new name:

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

Appendix A: Troubleshooting permission issues

Foreman upgrades perform pre-upgrade checks. If the pre-upgrade check discovers permission issues, it fails with an error similar to the following one:

2024-01-29T20:50:09 [W|app|] Could not create role 'Ansible Roles Manager': ERF73-0602 [Foreman::PermissionMissingException]: some permissions were not found:

If you see an error like this on your Foreman server, identify and remedy the permission issues.

Procedure

  1. On your Foreman server, identify permission issues:

    # foreman-maintain health check --label duplicate_permissions

  2. Fix permission issues:

    # foreman-rake db:seed
Verification

  • Rerun the check to ensure no permission issues remain:

    # foreman-maintain health check --label duplicate_permissions