pe_upgrade

#Puppet Enterprise Upgrade Module

WARNING: This module has recently moved to puppetlabs.

This is warning that the adrienthebo namespace version of pe_upgrade is being deprecated in favor of the puppetlabs version. We will be working to retire his forge version in favor of this one. If you previously used the git repo at:

• https://github.com/adrienthebo/puppet-pe\_upgrade/

You will need to update your remotes and file PRs against the puppetlabs/ one.

##Description

This module will upgrade Puppet Enterprise.

Travis Test status:

Usage

Downloading PE from puppetlabs.com

The simplest use of this class downloads the installer from the Puppet Labs servers.

include pe_upgrade

You can also locally host the downloads to conserve bandwidth and speed up deployment time.

Hosting the installer on the master

To cut down on size, the Puppet Enterprise installer is not included. You will need to download your operating system specific installers and place the installers in ${modulename}/files, for instance site-files/files.

You can use the following class definition to download the installer from your Puppet Master.

class { 'pe_upgrade':
  version      => '2.7.0',
  answersfile  => "pe/answers/agent.txt.erb",
  download_dir => 'puppet:///site-files/pe/2.7.0',
  timeout      => '3600',
}

Hosting the installer on a web server

In this example, download 'puppet-enterprise-${version}-all.tar.gz' and place it on your webserver.

class { 'pe_upgrade':
  version      => '2.5.0',
  answersfile  => "pe/answers/agent.txt.erb",
  download_dir => 'http://site.downloads.local/pe/2.7.0',
  timeout      => '3600',
}

Deploying the module from Puppet Dashboard

You can use Puppet Dashboard to configure this module. Since Puppet Dashboard doesn't directly support parameterized classes, you can use global variables to configure the module. See the params.pp class documentation for all respected variables.

Puppet Dashboard will show errors on pe_upgrade runs

The PE Upgrader restarts the puppet service as part of the upgrade process. This results in a TERM signal being sent to the puppet process executing the pe_upgrade module. This will look something like this:

notice executed successfully    /Stage[main]/Pe_upgrade/Staging::File[puppet-enterprise-2.5.3-all.tar.gz]/Exec[/opt/staging/pe_upgrade/puppet-enterprise-2.5.3-all.tar.gz]/returns  /etc/puppetlabs/puppet/modules/staging/manifests/file.pp    83  2012-08-08 20:29 UTC
notice  executed successfully   /Stage[main]/Pe_upgrade/Staging::Extract[puppet-enterprise-2.5.3-all.tar.gz]/Exec[extract puppet-enterprise-2.5.3-all.tar.gz]/returns   /etc/puppetlabs/puppet/modules/staging/manifests/extract.pp 116 2012-08-08 20:30 UTC
notice  executed successfully   /Stage[main]/Pe_upgrade/Exec[Validate answers]/returns  /etc/puppetlabs/puppet/modules/pe_upgrade/manifests/init.pp 137 2012-08-08 20:30 UTC
notice  Caught TERM; calling stop   Puppet          2012-08-08 20:30 UTC

The "failure" is expected and is not really a failure. Restarting the puppet service can also leave unexecuted changes for the next run. So a "full" upgrade may take two puppet runs.

Answers Templates

A default answers file is available at templates/answers/default-agent.txt.erb. It's recommended that you upgrade the master by hand, since that will provide hiera for you, and since 2.5.0 has some new very site specific questions due to the console auth component, it's not really possible to provide a generic answers file.

Required modules

The puppet-staging module is a prerequisite for this module. You can find it at the following locations:

• Puppet Forge: http://forge.puppetlabs.com/nanliu/staging
• Github: https://github.com/nanliu/puppet-staging

See Also

Please view the documentation in the enclosed manifests specific descriptions and usage.

Caveats

Due to the complexity of upgrading masters, using this module to upgrade a master is possible but not supported out of the box; you'll have to supply your own answers file.

##2014-05-14 - Release 2.1.1

This release merely fixes a mistake in the README.

####Features

####Bugfixes

• Minor fix to the README.

####Known Bugs

• No known bugs

2.1.0

2013-10-14

The release adds support for the installer parameter in the main pe_upgrade class. This allows you to use pe_upgrade as:

  class { 'pe_upgrade':
    version => '2.5.3',
    download_dir => 'http://ourdownloads.example.com',
    installer => 'puppet-enterprise-2.5.3-ubuntu-10.04-amd64',
  }

In order to upgrade PE on distributions and versions of Puppet Enterprise that this module doesn't support.

2.0.0

2013-09-08

This is a major release to add support for PE3 (and SuSE).

• Add PE3 support.
• Add Suse Support.

1.0.0

2013-07-10

This is a backwards incompatible feature release. There should be no major changes and the vast majority of use cases should be unaffected, but no guarantees are made.

• rspec-puppet test coverage added.
• (pe-upgrade-#15) Drop dependency on lsb facts
• Drop dependency on hiera, require nanliu/staging >= 0.2.0

0.4.2

2013-04-05

This is a backwards compatible bugfix release.

• (pe_upgrade-#17) ACTUALLY correct module permissions in published module.

0.4.1

2013-04-05

This is a backwards compatible bugfix release.

• (pe_upgrade-#17) Correct module permissions in published module

0.4.0

2012-12-05

This is a backwards compatible bugfix and feature release

• (pe_upgrade-#12) Remove internal pe_upgrade version facts in favor of stdlib
• (pe_upgrade-#14) Purge old installer tarballs from staging
• (pe_upgrade-#11) Fix SLES osfamily name in pe_pkgname

0.3.0

This is a backwards compatible feature and bugfix release

• Clean up fact resolution for pe_version facts
• Add function to intelligently select pe packages to download
• Improved validation, prevention of downgrades and accidental master upgrades
• Split up validation, staging, and execution steps
• Add support for logging the upgrade process
• If the install mode is used, open source ssl data can be migrated to PE

0.2.0

This is a backwards compatible feature release

• Add support for upgrading Puppet OSS to Puppet Enterprise. Thanks to Ben Ford for adding this feature.