Upgrading Puppet Enterprise
A newer version is available; see the version menu above for details.
The Puppet Installer script is used to perform both installations and upgrades. You start by downloading and unpacking a tarball with the appropriate version of the PE packages for your system. Then, when you run the
puppet-enterprise-installer script, the script will check for a prior installation of PE and, if it detects one, will ask if you want to proceed with the upgrade. The installer will then upgrade all the PE components (master, agent, etc.) it finds on the node to version 3.0.1.
The process involves the following steps, which must be performed in order:
- Provision and prepare a node for use by PuppetDB
- Upgrade Master
- Install PuppetDB/Database support role
- Upgrade Console
- Upgrade Agents
If more than one of these roles is present on a given node (for example your master and console run on the same node), the installer will upgrade each role in the correct order.
To upgrade Windows agents, simply download and run the new MSI package as described in Installing Windows Agents. However, be sure to upgrade your master, console, and database nodes first.
Important Notes and Warnings
- Upgrading is only supported from a PE 2.8.2 or newer installation. To upgrade from a version older than 2.8.2, you must first upgrade to 2.8.2, make sure everything is working correctly, and then move on to upgrading to 3.0.1. You can find older versions of PE on the previous releases page.
- Upgrading is now handled by the installer, which will detect whether or not a previous version of PE is present and will then run in “install” or “upgrade” mode as appropriate.
- After upgrading your puppet master server, you will not be able to issue orchestration commands to PE 2.x agent nodes until they have been upgraded to PE 3.0. The version of the orchestration engine used in PE 3.0 is incompatible with that used by previous PE versions.
- For PE 3.0 and later, URLs pointing to module files must contain
modules/, as in
- PE 3 uses Ruby 1.9 which is stricter about character encoding than the previous version used in PE 2.8. If your manifests contain non-ASCII characters they may fail to compile or behave unpredictably. When upgrading, make sure manifests contain only ASCII characters. For more information see the release notes.
- On AIX 5.3, as in PE 2.8.2, puppet agents still depend on readline-4-3.2 being installed. You can check the installed version of readline by running
rpm -q readline.
On AIX 6.1 and 7.1, the default version of readline, 4-3.2, is insufficient. You need to replace it before upgrading by running:
rpm -e --nodeps readline rpm -Uvh readline-6.1-1.aix6.1.ppc.rpm
If you see an error message after running this, you can disregard it. Readline-6 should be successfully installed and you can proceed with the upgrade (you can verify the installation with
rpm -q readline).
- If you upgraded from PE 2.5, your
rubycas-server/config.ymlfiles will not have the relevant commented-out sections, as they were added for 2.6 and the upgrader does not overwrite the config files. You can find example config code that can be copied and pasted into the live config files; look in files with the same names and either the
-These instructions refer to upgrades to PE 3.0.1 from 2.8.2 or higher. For instructions on how to upgrade to PE 3.0.0 from PE 2.8.2 or higher, refer to the previous upgrade instructions. However, Puppet Labs strongly recommends you upgrade directly to PE 3.0.1.
- If you have been using activerecord storeconfigs and relying on the
puppet node clean --unexportcommand, be advised that it doesn’t work in PE 3; we are investigating ways to re-implement this feature in issue 14608.
If you haven’t done so already, you will need a Puppet Enterprise tarball appropriate for your system(s). See the Installing PE section of this guide for more information on accessing Puppet Enterprise tarballs, or go directly to the download page.
Once downloaded, copy the appropriate tarball to each node you’ll be upgrading.
Running the Upgrade
Before starting the upgrade, all of the components (agents, master, console, etc.) in your current deployment should be correctly configured and communicating with each other, and live management should be up and running with all nodes connected.
Important: All installer commands should be run as
Note: PE3 has moved from the MySQL implementation used in PE 2.x to PostgreSQL for all database support. PE3 also now includes PuppetDB, which requires PostgreSQL. When upgrading from 2.x to 3.x, the installer will migrate your existing data from MySQL to PostgreSQL. To do this, the installer requires a staging directory to which it can export the data before transferring it to the new PostgreSQL databases.
Prepare a Node for PostgreSQL
You will need to have a node available and ready to receive an installation of PuppetDB and PostgreSQL. This can be the same node as the one running the master and console (if you have a monolithic, all-on-one implementation), or it can be a separate node (if you are running a split role implementation). In a split role implementation, the database node must be up and running and reachable at a known hostname before starting the upgrade process on the console node.
The upgrader can install a pre-configured version of PostgreSQL along with PuppetDB on the node you select. If you prefer to use a node with an existing instance of PostgreSQL, that instance needs to be manually configured with the correct users and access. This also needs to be done BEFORE starting the upgrade.
If provisioning a standalone PostgreSQL database, you will need to create a database for the console, for console authentication, and for puppetdb, as well as users that can access the databases remotely. You will be prompted for this information during the install process.
Start the upgrade by running the
puppet-enterprise-installer script on the master node. You can use any of the flags described in the install instructions. The script will detect any previous versions of PE roles and stop any PE services that are currently running. The script will then step through the install script, providing default answers based on the roles it has detected on the node (e.g., if the script detects only an agent on a given node, it will provide “No” as the default answer to installing the master role). The installer should be able to answer all of the questions based on your current installation except for the hostname and port of the PuppetDB node you prepped before starting the install.
As with installation, the script will also check for any missing dependent vendor packages and offer to install them automatically.
Lastly, the script will summarize the upgrade plan and ask you to go ahead and perform the upgrade. Your answers to the script will be saved as usual in
The upgrade script will run and provide detailed information as to what it installs, what it updates and what it replaces. It will preserve existing certificates and
On the node you provisioned for PuppetDB before starting the upgrade, unpack the PE 3.0.1 tarball and run the
puppet-enterprise-installer script. If you are upgrading from a 2.8 deployment, you will need to provide some answers to the upgrader, as follows:
?? Install puppet master? [y/N]Answer N. This will not be your master. The master was upgraded in the previous step.
?? Puppet master hostname to connect to? [Default: puppet]Enter the FQDN of the master node you upgraded in the previous step.
?? Install PuppetDB? [y/N]Answer Y. This is the reason we are performing this installation on this node.
?? Install the cloud provisioner? [y/N]Choose whether or not you would like to install the cloud provisioner role on this node.
?? Install a PostgreSQL server locally? [Y/n]If you want the installer to create a PostgreSQL server instance for PuppetDB data, answer ‘Y’. If you are using an existing PostgresSQL instance located elsewhere, answer ‘N’ and be prepared to answer questions about its hostname, port, database name, database user, and password.
?? Certname for this node? [Default: my_puppetdb_node.example.com ]Enter the FQDN for this node.
?? Certname for the master? [Default: hostname.entered.earlier ]You only need to change the default if the hostname and certname of your master are different.
The installer will save auto-generated users and passwords in
/etc/puppetlabs/installer/database_info.install. Do not delete this file, you will need its information in the next step.
Upgrade the Console
On the node serving the console role, unpack the PE 3.0.1 tarball and run the
puppet-enterprise-installer script. The installer will detect the version from which you are upgrading and answer as many installer questions as possible based on your existing deployment.
Note: When upgrading a node running the console role, the upgrader will dump the current MySQL databases to disk and import them into the new PostgreSQL databases. This may require additional system resources:
- The upgrader requires a temporary staging directory for the exported data. This directory should have enough available space to hold roughly twice the size of the current databases.
- Pruning the MySQL data before starting the upgrade will make things go faster. We recommend deleting all but two weeks to a month worth of reports.
- If you are running the console on a VM, you may also wish to temporarily increase the amount of RAM available.
Note that your old database and the temporary export file will NOT be deleted after the upgrade completes. After you are sure the upgrade was successful, you will need to delete these files yourself to reclaim disk space.
When the installer asks
?? What is a staging directory for use by the export utility?, enter an absolute path to a directory with enough available disk space, as described above.
You will also need to provide the following information:
- The hostname and port number for the PuppetDB node you created in the previous step.
- Database credentials; specifically, the database names, user names, and passwords for the
pe-puppetdbdatabases. These can be found in
/etc/puppetlabs/installer/database_info.installon the PuppetDB node.
Note: If you will be using your own instance of PostgreSQL (as opposed to the instance PE can install) for the console and PuppetDB, it must be version 9.1 or higher.
Upgrade Agents and Complete the Upgrade
On each node with a puppet agent, unpack the PE 3.0.1 tarball and run the
puppet-enterprise-installer script. The installer will detect the version from which you are upgrading and answer as many installer questions as possible based on your existing deployment. Note that the agents on your master and console nodes will have been updated already when you upgraded those nodes. Nodes running 2.x agents will not be available for live management until they have been upgraded.
PE services should restart automatically after the upgrade. But if you want to check that everything is working correctly, you can run
puppet agent -t on your agents to ensure that everything is behaving as it was before upgrading.
Checking For Updates
Check here to find out what the latest maintenance release of Puppet Enterprise is. To see the version of PE you are currently using, you can run
puppet --version on the command line .
Note: By default, the puppet master will check for updates whenever the
pe-httpd service restarts. As part of the check, it passes some basic, anonymous information to Puppet Labs’ servers. This behavior can be disabled if need be. The details on what is collected and how to disable checking can be found in the answer file reference.