Write and test Puppet code and modules with Puppet Development Kit (PDK)

Use the open source Puppet Development Kit (PDK) to write and validate Puppet code and modules. PDK includes a complete module skeleton, testing tools and all dependencies needed for its use.

You can also convert an existing module to a standardized PDK module with an infrastructure for testing it. This allows you to use PDK tools for creating classes, defined types, and tasks in your module, as well as validating and unit testing it.

Get support

We’d like to make sure that you get help with PDK and your code. We support PDK, but not the code created with it.

If you use PDK to write code that doesn’t work but your code passes rspec testing, please submit a priority 3 ticket so that we can help you figure out if there is an issue with PDK or an issue with your code.

If you use the PDK to write code that doesn’t work and your code fails rspec testing, this is likely a code issue. If you have an issue with your code, you can ask for help from our community Slack, and the pe-users mailing list.

Provide feedback

If you find a bug in PDK, please provide feedback at the PDK Jira project. If you have ideas for new features or enhancements for PDK, we welcome them! Please visit the Puppet Idea Portal or send an email with your company name, contact information, and ideas to productfeedback@puppet.com.

Learn more

Learn about PDK commands from our command reference. The most used commands are: pdk new (module, class, defined_type), pdk validate, and pdk test unit.

If you use an IDE, take a look at Microsoft Visual Studio Code. If you use Visual Studio Code, use the Puppet VSCode Extension.

Watch a video about using Visual Studio Code with the extension.

Additional information

• Installing PDK

• Developing modules

• Validate and test modules

• Customize module configuration

• PDK command reference

• PDK troubleshooting