Puppet Enterprise 2019.8.12
Welcome to Puppet Enterprise® 2019.8.12
PE software architecture
Component versions in recent PE releases
FIPS 140-2 enabled PE
Cloud PE
Getting support
Using the PE docs
Puppet platform documentation for PE
API index
Release notes
PE release notes
PE known issues
What's new since PE 2018.1
Platform release notes
Puppet release notes
Puppet known issues
Puppet Server release notes
Puppet Server known issues
PuppetDB release notes (link)
Facter release notes
Facter known issues
Getting started with Puppet Enterprise
Install PE
Add nodes to the inventory
Add code and set up Code Manager
Manage Apache configuration on *nix targets
Install the apache module
Set up Apache node groups
Organize webserver configurations with roles and profiles
Manage IIS configuration on Windows targets
Install the iis module
Set up IIS node groups
Organize webserver configurations with roles and profiles
Next steps
Installing
Supported architectures
System requirements
Hardware requirements
Supported operating systems
Supported browsers
System configuration
What gets installed and where?
Installing PE
Installing PE in cloud environments
Purchasing and installing a license key
Installing agents
Installing compilers
Installing client tools
Uninstalling
Upgrading
Upgrading Puppet Enterprise
Upgrading agents
Configuring Puppet Enterprise
Tuning infrastructure nodes
Methods for configuring PE
Configuring Puppet Server
Configuring PuppetDB
Configuring security settings
Configuring proxies
Configuring the console
Configuring orchestration
Configuring ulimit
Writing configuration files
Analytics data collection
Static catalogs
Configuring disaster recovery
Disaster recovery
Configure disaster recovery
Accessing the console
Reaching the console
Logging in
Managing access
User permissions and user roles
Creating and managing local users and user roles
Connecting external directory services to PE
Working with user groups from an external directory service
Token-based authentication
RBAC API
Forming RBAC API requests
RBAC service errors
RBAC API v1
Users endpoints
Users keys
GET /users
GET /users/<sid>
GET /users/current
POST /users
PUT /users/<sid>
DELETE /users/<sid>
User group endpoints
User group keys
GET /groups
GET /groups/<sid>
POST /groups
PUT /groups/<sid>
DELETE /groups/<sid>
User roles endpoints
User role keys
GET /roles
GET /roles/<rid>
POST /roles
PUT /roles/<rid>
DELETE /roles/<rid>
Permissions endpoints
Permissions keys
GET /types
POST /permitted
GET /permitted/<object-type>/<action>
GET /permitted/<object-type>/<action>/<uuid>
Token endpoints
Token keys
POST /auth/token
Directory service endpoints
GET /ds
GET /ds/test
PUT /ds/test
PUT /ds
Password endpoints
RBAC API v2
Tokens endpoints
Activity service API
Forming activity service API requests
Event types reported by the activity service
Events endpoints
Monitoring and reporting
Monitoring infrastructure state
Viewing and managing packages
Value report
Infrastructure reports
Analyzing changes across Puppet runs
Puppet Enterprise metrics
Viewing and managing Puppet Server metrics
Getting started with Graphite
Available Graphite metrics
Status API
Authenticating to the status API
Forming requests to the status API
Status API: services endpoint
Status API: services plaintext endpoint
Status API: metrics endpoint
Metrics API
Managing nodes
Adding and removing agent nodes
Adding and removing agentless nodes
How nodes are counted
Running Puppet on nodes
Grouping and classifying nodes
Making changes to node groups
Environment-based testing
Preconfigured node groups
Managing Windows nodes
Designing system configs: roles and profiles
The roles and profiles method
Roles and profiles example
Designing advanced profiles
Designing convenient roles
Node classifier API v1
Forming node classifier requests
Groups endpoint
Groups endpoint examples
Classes endpoint
Classification endpoint
Commands endpoint
Environments endpoint
Nodes check-in history endpoint
Group children endpoint
Rules endpoint
Import hierarchy endpoint
Last class update endpoint
Update classes endpoint
Validation endpoints
Node classifier errors
Node classifier API v2
Classification endpoint
POST /v2/classified/nodes/<name>
Node inventory API
Managing patches
Configuring patch management
Patching nodes
Orchestrating Puppet runs, tasks, and plans
How Puppet orchestrator works
Setting up the orchestrator workflow
Configuring Puppet orchestrator
Running Puppet on demand
Running Puppet on demand from the console
Running Puppet on demand from the CLI
Running Puppet on demand with the API
Tasks in PE
Installing tasks
Running tasks in PE
Running tasks from the console
Running tasks from the command line
Stop a task in progress
Inspecting tasks
Writing tasks
Plans in PE
Plans in PE versus Bolt plans
Installing plans
Running plans in PE
Running plans from the console
Running plans from the command line
Inspecting plans
Running plans alongside code deployments
Writing plans
Writing plans in Puppet language
Writing plans in YAML
Orchestrator API v1 endpoints
Forming orchestrator API requests
Command endpoints
Events endpoints
Inventory endpoints
Jobs endpoints
Scheduled jobs endpoints
Plans endpoints
Plan jobs endpoints
Tasks endpoints
Root endpoints
Usage endpoints
Scopes endpoints
Orchestrator API error responses
Migrating Bolt tasks and plans to PE
Managing and deploying Puppet code
Managing environments with a control repository
Managing environment content with a Puppetfile
Managing code with Code Manager
How Code Manager works
Set up Code Manager
Configure Code Manager
Lockless code deploys
Customize Code Manager configuration in Hiera
Triggering Code Manager on the command line
Triggering Code Manager with a webhook
Triggering Code Manager with custom scripts
Troubleshooting Code Manager
Code Manager API
Managing code with r10k
Set up r10k
Configure r10k
Customizing r10k configuration
Deploying environments with r10k
r10k command reference
About file sync
SSL and certificates
Regenerate the console certificate
Regenerate infrastructure certificates
Use an independent intermediate certificate authority
Use a custom SSL certificate for the console
Generate a custom Diffie-Hellman parameter file
Enable TLSv1
Maintenance
Backing up and restoring PE
Database maintenance
Troubleshooting
Log locations
Troubleshooting installation
Troubleshooting disaster recovery
Troubleshooting puppet infrastructure run commands
Troubleshooting connections between components
Troubleshooting the databases
Troubleshooting cloud deployments
Troubleshooting Code Manager
Troubleshooting Windows
Troubleshooting backup and restore