Installing PDK

Before you install Puppet Development Kit (PDK), make sure you meet the system and language version requirements.

To download and install PDK 3.5.0, which is stored in a protected repository, you must authenticate using either your Puppet Core or Puppet Enterprise (PE) credentials. You can use either of the following sets of credentials, ensuring that you use either a Forge username and password or a PE username and password.

  • The string literal forge-key as the username and the Puppet Forge API key associated with your Puppet Core free or paid user as the password. For more information about the API key, see Purchasing Puppet Core and Accessing Puppet Core for limited use for testing or development.

  • The string literal license-id as the username and your PE License ID as the password. You can find your PE License ID in your PE license file or in the PE console by selecting License from the navigation bar.

You can't install this version of PDK using Homebrew or Chocolatey, but you can install it directly on macOS and Windows. See Install PDK on macOS and Install PDK on Windows.

By default, PDK installs to the following locations:

  • On *nix and macOS systems: /opt/puppetlabs/pdk/

  • On Windows systems: C:\Program Files\Puppet Labs\DevelopmentKit

PDK uses the latest version of Puppet 8 available at the time of release. Modules created with PDK work with all Puppet and Ruby version combinations currently under maintenance. See Puppet and Puppet Enterprise lifecycle pages for details.

PDK functions, such as creating classes, testing, and validation, are supported only on modules created or converted with PDK.

Supported operating systems

PDK is compatible with *nix, Windows, and macOS systems. For detailed version support, see the table below.

Operating system Versions Arch Package type
Debian 10, 11, 12 x86_64, aarch64 DEB
Fedora 40 x86_64 RPM
macOS 13, 14 x86_64, arm64

DPKG

Red Hat Enterprise Linux (RHEL) 7, 8, 9 x86_64, aarch64 RPM
SUSE Linux Enterprise Server 15 x86_64 N/A
Ubuntu 18.04, 20.04, 22.04, 24.04 x86_64, aarch64 DEB
Windows (Consumer OS) 10, 11 x86_64 MSI
Windows (Server OS) 2016, 2019, 2022 x86_64 MSI

In this section: