Using the PE docs

This release was removed from general availability due to upgrade issues.
Docs for the latest available release are here.
This version is out of date. For current versions, see Puppet Enterprise support lifecycle.
Sections

Review these tips to get the most out of the PE docs.

Archived PE docs

PE docs for recent end-of-life (EOL) or superseded product versions are archived in place, meaning that we continue to host them at their original URLs, but we limit their visibility on the main docs site and no longer update them. You can access archived-in-place docs using their original URLs, or from the links here.

PE docs for EOL versions earlier than those listed here are archived in our PE docs GitHub archive.

Usage notes for example commands

Review these guidelines to help you understand and use example commands throughout PE docs.

Using puppet commands to generate cURL arguments

The examples used throughout the PE docs rely on puppet commands to populate some cURL arguments, taking the guesswork out of providing those values. For example, you might see something like this:
url="http://$(puppet config print server):4433"
curl "$url"

Puppet commands can return different values depending on various conditions. In order for the cURL examples to work as intended, run the entire example (including setting the environment variables and calling the curl command) as root, Administrator, or with equivalent elevated privileges.

To run the command on a machine without elevated privileges, replace the inline puppet commands with hard-coded values. If you’re unsure about the correct values, run the puppet commands to get reasonable defaults.

Alternative ways to include authentication tokens

Any curl example that contains this line:
auth_header="X-Authentication: $(puppet-access show)"
can instead use an actual token if you have one available:
auth_header="X-Authentication: <TOKEN>"
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.