To ensure that your modules work with the newest version
of PE, update and test them with Puppet Development Kit (PDK) before upgrading.
Before you begin
If you are already using
PDK, your modules should pass validation and unit
tests with your currently installed version of PDK.
Update PDK with each new release to ensure compatability
with new versions of PE.
-
Download and install PDK. If you already have PDK installed, this updates PDK to its latest version. For detailed
instructions and download links, see the installing instructions.
-
If you have not previously used PDK with your modules, convert them to a PDK compatible format. This makes changes to your
module to enable validation and unit testing with PDK. For important usage details, see the converting modules documentation.
For example, from within the module directory, run:
pdk convert
-
If your modules are already compatible with PDK, update them to the latest module
template. If you converted modules in step 2, you do not need to update the
template. To learn more about updating, see the updating module templates documentation.
For example, from within the module directory, run:
pdk update
-
Validate and run unit tests for each module,
specifying the version of PE you are upgrading
to. When specifying a PE version, be sure to
specify at least the year and the release number, such as 2018.1. For
information about module validations and testing, see the validating and testing modules documentation.
For example, from within the module directory, run:
pdk validate
pdk test unit
The
pdk test
unit command verifies that testing dependencies and directories are
present and runs the unit tests that you write. It does not create unit tests
for your module.
-
If your module fails validation or unit tests,
make any necessary changes to your code.
Results
After you've verified
that your modules work with the new PE version, you
can continue with your upgrade.