4.9.1. General Upgrade Instructions

SIMP uses the Puppet modules’ parameters as the system “API” (in terms of compatibility) and attempts to limit any API breaking changes to a minimum during a major release.

API breaking changes will have at least one minor release with deprecation warnings unless the change was to fix an actual bug in functionality.

A SIMP release version (e.g., “6.5.0-Alpha”) can be separated into three major numbers, in the format X.Y.Z:

  • X is the MAJOR release number, and indicates severe API-breaking changes.
  • Y is the MINOR release number, and indicates the addition of features or minor API-breaking changes either due to functionality bugs or after at least one MINOR release announcing the deprecation.
    • All API-breaking changes are kept to an absolute minimum and well documented in the release CHANGELOG.
  • Z is the PATCH release number, and indicates full backwards-compatibility changes, such as bug fixes and improvements.

This section describes both the general, recommended upgrade procedures for X, Y, or Z releases.

4.9.1.1. Incremental Upgrades

For Y and Z SIMP changes, you should feel comfortable dropping the changes directly into your test systems. The promotion cycle from test to production should be short and painless if you reference the version upgrade documentation.

Beginning with SIMP 6.4.0, SIMP-packaged Puppet module RPMs no longer install updates directly into the simp/ Puppet environment directory. You must upgrade your Puppet modules using the mechanism appropriate for your environment deployment scenario:

Important

Review any Version-Specific Upgrade Instructions prior to executing an Incremental Upgrade. There may be specific instructions regarding the upgrade process that you should follow.

4.9.1.1.1. Upgrading systems using the local deployment scenario

The following instructions are specific to the Local deployment scenario. They assume the Puppet environment you are updating is named test, and that you execute these steps as root:

  1. Update the YUM Repositories

    • Update the repositories using a SIMP ISO:

      If you have the latest SIMP ISO available to you and have installed the simp-utils package, update the YUM repositories by unpacking the ISO using unpack_dvd from that package:

      1. Copy the new SIMP ISO file to the SIMP master

      2. From the SIMP master (as root):

        # Unpack the new SIMP ISO's RPMs into yum repositories
        unpack_dvd </path/to/ISO>
        
    • For RPM-based installation, follow your site’s procedures to update your repositories.

  2. Install the RPMs

    # Make sure yum picks up the new RPMs
    yum clean all; yum makecache
    
    # Apply updates to the local master
    yum update -y
    

    For SIMP 6.4 and later, this will also update the system-local, SIMP-managed Puppet module Git repositories.

  3. If you are upgrading from a version before SIMP 6.4 you can skip to the last step, Apply the changes by running puppet.

    ** The following steps only apply for upgrades from version 6.4 or later

    1. Generate the new Puppetfile.simp, a Puppetfile containing the latest versions of only SIMP-packaged Puppet modules:

      cd /etc/puppetlabs/code/environments/test
      simp puppetfile generate > Puppetfile.simp
      
    2. Verify the environment’s Puppetfile:

      Warning

      Any module not listed in the Puppetfile will be deleted from the target environment’s modules directory, when you use r10k to deploy the modules.

      Make sure the Puppetfile you will be deploying from includes the following:

      • A line that includes the Puppetfile.simp which should look like:

        instance_eval(File.read(File.join(__dir__,"Puppetfile.simp")))
        
      • A line for each of your own modules.

      See How To Generate a SIMP Puppetfile for more information on how to generate and clean up the Puppetfile if needed.

    3. Deploy the modules from the local Git repositories into the environment

      Use r10k to deploy the modules, making sure the umask and group are set correctly so that the puppetserver has access to the files.

      # Set the umask and Run r10k as the puppet group to make sure the modules
      # to make sure the permissions and ownership are correct on the modules
      ( umask 0027 && sg puppet -c '/usr/share/simp/bin/r10k puppetfile install \
      --puppetfile /etc/puppetlabs/code/environments/test/Puppetfile \
      --moduledir /etc/puppetlabs/code/environments/test/modules' )
      

    Tip

    Use simp --help for more information on the simp utility and alternate options provided for each command.

    ** This ends the steps that are only for 6.4 or later. The next steps apply to all systems.

  4. Apply the changes by running puppet

    puppet agent -t
    

4.9.1.1.2. Upgrading systems that use control repositories

If you manage your SIMP server using r10k or Code Manager and are not using the server-local, SIMP-managed Git module repositories, you will need to work with the upstream Git repositories as appropriate for your workflow. This is the same for all versions of SIMP.

For SIMP 6.4 and later, the instructions in HOWTO Set up a SIMP Environment in a Control Repository may be helpful.

4.9.1.2. Breaking Changes

If the X version number has changed then you should expect major breaking changes to the way SIMP works. Please carefully read the Changelog and the SIMP User Guide and do not deploy these changes directly on top of your production environment.

If the Y version number has changed then there may either be deprecation notices or minor breaking changes to the way SIMP works. Please carefully read the CHANGELOG and the User’s Guide and do not deploy these changes directly on top of your production environment.

Important

Upgrading SIMP does not require re-kicking your clients, even if some core services move to the new Puppet node. All software configurations can be updated in Puppet, as needed.

With the release of 6.4, SIMP RPM upgrades now have a “hands-off” approach to upgrades that allow users to easily preserve different combinations of module sets as required by their environment. That being said, the SIMP team does not test all combinations of modules and may have difficulty providing support for untested combinations.

4.9.1.2.1. Creating a new server and migrating clients

The recommended method for upgrading major breaking changes (X bump) is to create a new Puppet Server and migrate your data and clients to it. This process follows the path of least destruction; we will guide you through how to back up the existing Puppet server, create a new server, and transfer your clients.

  1. Set up a new Puppet server that will house your new SIMP environment.

    Note

    You must ensure that this node can be reached by any client that is to be migrated. The new system will not interfere with your existing Puppet system unless you specifically configure it to do so.

    Important

    Do NOT destroy your old Puppet server until everything has been successfully migrated and is in production under the new server.

  2. Consider vital services other than Puppet that are housed on your current Puppet server node (eg. DNS, DHCP, LDAP, custom kickstart, YUM, NFS, etc.). You may choose to keep many of these services running on your old Puppet server node. Anything not preserved must be migrated to a new system.

4.9.1.2.1.1. Back Up the Existing Puppet Server

Prior to any modifications to your infrastructure, we highly recommend following HOWTO Back up the Puppet Master.

4.9.1.2.1.2. Create a New Server

Obtain an official SIMP ISO or point your server at the latest `YUM Repositories: <https://download.simp-project.com/simp/yum/releases/latest`_ and follow the ISO Installation (Preferred) or Installing SIMP From A Repository as appropriate.

Follow the Client Management guide, and set up services as needed. Remember, you can opt-out of any core services (DNS, DHCP, etc.) you want your clients or old Puppet server to run! If you want the new Puppet server to run services the existing Puppet server ran, you may be able to use the backup of the rsync directories from the old system.

Warning

Do not blindly drop rsync (or other) materials from the old Puppet server onto the new one. The required structures for these components may have changed.

When you Apply Certificates you may wish to transfer client certs to the new server. If you are using the FakeCA and still wish to preserve the certificates, follow the Installing Official Certificates guidance, and treat the existing Puppet server as your ‘proper CA’.

4.9.1.2.1.3. Promote the New Puppet Server and Transfer Your Clients

Follow the HOWTO Change Puppet Masters guide to begin integration of your new Puppet server into the existing environment.

Note

You should always start migration with a small number of least critical clients!

4.9.1.2.1.4. Retire the Old Puppet Server

Once you have transferred the management of all your clients over to the new Puppet server, you may safely retire the old Puppet server.