Upgrading Razor

If you used Razor in a previous Puppet Enterprise (PE) environment, upgrade Razor to keep your PE and Razor versions synched.

After a PE upgrade, your pe_razor module continues to operate normally, but we recommend upgrading Razor as soon as possible to avoid unintended effects.

Note: If nodes are actively provisioning during upgrade, provisioning might fail. You can resume provisioning after pe-razor-server restarts and – for upgrade from 3.8.x only – after a Puppet run completes.

The upgrade process varies by PE version.

Upgrade from 3.8.x to later versions

An upgrade script handles upgrading Razor from PE 3.8.x to any later version. The script carries out these tasks:

Performs pre-verification, including checking that:

The script is being run as root.

The puppet-agent class is installed. The script exits if not.

The Razor node has sufficient disk space available. The host’s disk space must be at least three times the size of the Razor database.

Tip: If you want to upgrade Razor offline, follow the instructions here.

Verify that no services are active on the agent or Razor server. Services are stopped during upgrade.

Ensure that no custom or modified tasks, brokers, or hooks exist inside /opt/puppetlabs. If they do, move them to a directory in the appropriate class parameter (task_path, broker_path, or hook_path) of the pe_razor class. By default, the paths for these objects are:

Run the upgrade script

SSH into your razor-server node, then run sudo bash /opt/puppet/razor/upgrade/upgrade.bash.

Upgrade from 2015.2.x or later

Upgrading from 2015.2.x or later is a mostly automated process that replaces the software repository, installs software packages, and migrates the Razor database.

Upgrading to 2016.2 or later requires manual migration of any custom configuration from your config.yaml file to class parameters in the pe_razor module.

Before you begin: If you’re upgrading to PE 2016.2 or later and you’ve modified your config.yaml file – for example, by changing protect_new_nodes or customizing tasks, brokers, or hooks – make a note of the modified settings.

Upgrade the Puppet master.

Upgrade the agent on the Razor server node.

The pe-razor-server service automatically restarts.

(Optional) If you’re upgrading to 2016.2 or later, transfer any customized configurations to class parameters in the pe_razor module.

Note: To prevent accidentally overwriting machines during upgrade, the default for protect_new_nodes was changed to true in PE 2016.2 and later. If your environment and workflows rely on provisioning all new nodes, you must manually change protect_new_nodes to false after upgrade, then run puppet and restart the pe-razor-server service.

Tip: You can run razor --version to verify that the upgrade was successful.