Katello 3.17 Documentation

Katello Upgrade

Katello supports upgrades from the previous two versions only. Upgrades should be performed sequentially without skipping versions in between.


Before upgrading, run the upgrade check script that will check for any active tasks:

foreman-rake katello:upgrade_check

Step 1 - Backup

If Katello is running on a virtual machine, we recommend to take a snapshot prior to upgrading. Otherwise, take a backup of the relevant databases by following the instructions here.

Step 2 - Operating System

Ensure your operating system is fully up-to-date:

yum -y update

Step 3 - Repositories

Update the Foreman and Katello release packages:

  • RHEL7 / CentOS 7:
  yum update -y https://fedorapeople.org/groups/katello/releases/yum/3.17/katello/el7/x86_64/katello-repos-latest.rpm
  yum update -y https://yum.theforeman.org/releases/2.2/el7/x86_64/foreman-release.rpm
  yum update -y foreman-release-scl

Step 4 - Update Packages

Clean the yum cache

yum clean all

Update the required packages:

yum -y update

Step 5 - Run Installer

The installer will run the right database migrations for all component services, as well as adjust the configuration to reflect what’s new in Katello 3.17.


Step 6 - Reboot if necessary

If kernel packages are updated during Step 2 the system must be rebooted to ensure the new kernel and SELinux policy are loaded. If there are no kernel or selinux updates then this step can be omitted.


You have now successfully upgraded your Katello to 3.17.

For a rundown of what was added, please see the release notes.

If the above steps failed, please review /var/log/foreman-installer/katello.log and let us know about it if unable to resolve.

Pulp3 Migration

Katello 3.17 supports migrations of Content to Pulp 3 for container, yum, and file content as a Technical Preview. Its perfectly safe to run through this process up to step 2 to help identify issues and help us make the full migration in 3.18 more stable. Depending on how much content is present, this can take a very long time. The largest part of the process can be run without downtime. This full process will need to be complete before upgrading to Katello 4.0.

  1. Correct pulp 2 content permissions:

Due to a bug in Pulp 2.21.3 and earlier, content permissions need to be changed before migrating content. If you are fully updated to pulp-rpm-plugins-2.21.4, this only needs to be done once before migrating:

chmod -R g+rwX /var/lib/pulp/content
find /var/lib/pulp/content -type d -perm -g-s -exec sudo chmod g+s {} \;
chgrp -R pulp /var/lib/pulp/content

These commands can be run without outage, but may take a long time depending on the amount of content and the latency of the filesystem.

  1. Migrate the content:
foreman-maintain content prepare

Note that this is run without downtime, while content and repositories are migrated in the background. This can be run multiple times.

  1. Perform the switchover to pulp3:
foreman-maintain content switchover

This will require some downtime to do the final switchover, but this will:

  • Perform one last content migration
  • Perform a check to verify everything that is needed has been migrated
  • Re-run the installer to ‘switch’ over to pulp3 for yum, docker, and file content.

If you run into any issues with this process, please file a support issue with ‘[ContentMigration]’ in the subject.

Foreman 3.11.1 has been released! Follow the quick start to install it.

Foreman 3.10.0 has been released! Follow the quick start to install it.