Puppet Enterprise user's guide

Puppet Enterprise 2016.5

• Overview
  • Welcome to PE
  • PE architecture overview
  • Component versions in recent PE releases
  • Getting support
  • PE version numbers
• Release notes
  • New features and enhancements
  • Known issues
    • Install and upgrade
    • PE console and console services
    • Puppet Server
    • Databases and PostgreSQL
    • Orchestration services
    • PE services and Puppet core
    • Supported platforms
    • Razor
    • Code management
    • UTF-8
    • High availability
  • Resolved issues
• Puppet platform documentation
• Quick start guides
  • Quick start guide for *nix users
    • 1: Install PE
    • 2: Install agents
    • 3: Module install
    • 4: Add classes
    • 5: Give users access
    • 6: Write modules
  • Quick start guide for Windows users
    • 1: Install PE
    • 2: Install agents
    • 3: Module install
    • 4: Classify agents
    • 5: Assign user access
    • 6: Write modules
  • Essential configuration tasks
    • NTP quick start guide
    • DNS quick start guide
    • SSH quick start guide
    • Sudo quick start guide
    • Firewall quick start guide
• Managing Windows nodes
  • Installing PE for a Windows environment
  • Basic tasks and concepts in Windows
  • Managing Windows configurations
  • Installing and using Windows modules
  • Troubleshooting Puppet on Windows
• Installing
  • System requirements
    • Hardware requirements
    • Supported operating systems
    • Supported browsers
    • System config and firewall requirements
  • What gets installed where?
  • Downloading PE and installing overview
  • Web-based installation: monolithic
  • Text-mode installation
    • Text-mode installation overview
    • Text-mode installation: monolithic
    • Text-mode installation: split
    • Configuration settings in pe.conf
  • Installing PE license key
  • Installing Puppet agents
    • Installing PE agents: *nix
    • Installing PE agents: Windows
    • Installing PE agents: Mac OS X
  • Installing network device agents
    • Installing PE agents: Arista EOS
    • Installing PE agents: Cisco NS-OX
    • Installing PE agents: Cisco IOS-XR
    • Installing PE agents: Cumulus Linux
    • Installing PE agents: Huawei CloudEngine
  • Installing compile masters
  • Load balancing compile masters
  • Installing ActiveMQ hubs and spokes
  • Installing PE client tools
  • Uninstalling PE
  • PE and external PostgreSQL Setup
    • External PostgreSQL prep
    • SSL for PE and external PostgreSQL
    • PE and external PostgreSQL without root access
• Upgrading
  • Upgrading PE: monolithic
  • Upgrading PE: split
  • Upgrading PE agents: *nix
  • Upgrading PE agents: Windows
  • Upgrading large environment installations
• Migrating from 3.8
  • Preparing for Migration to PE 2016.5
  • Migrating from PE 3.8 to 2016.5: monolithic
  • Migrating: important notes
  • Major path changes
• Configuring PE
  • Your PE infrastructure
  • Tuning Puppet Server
  • Puppet Server config files
  • Tuning the console
  • Tuning PuppetDB
  • Tuning orchestration
  • Java arguments For PE
  • Configuring ulimit for PE services
  • Tuning mono installs (reference)
  • Writing configuration files
  • PE analytics data collection
  • Static catalogs
• Configuring high availability
  • High availability overview
  • Configure high availability
• Monitoring infrastructure state
  • Monitor and analyze infrastructure state
  • Explore your catalog with the node graph
  • Analyze changes across Puppet runs
  • Infrastructure reports
  • Monitoring Puppet Server metrics
  • Monitoring PE services
• Managing nodes
  • Managing node requests
  • Running Puppet on agent nodes
  • Getting started with classification
  • Grouping and classifying nodes
  • Roles and profiles: Designing system configs
    • Introduction
    • A complete example
    • Designing advanced profiles
    • Designing convenient roles
  • Viewing node-specific information
  • Making changes to node groups
  • Removing nodes
  • Preconfigured node groups
  • How does inheritance work?
  • Working with environments
  • Node classifier service API
    • Endpoints
    • Forming node classifier requests
    • Groups
      • Groups endpoint examples
    • Classes
    • Classification
    • Commands
    • Environments
    • Node history
    • Group children
    • Rules
    • Importing node classifier hierarchy
    • Last class
    • Updating node classifier classes
    • Validating node classifier endpoints
    • Node classifier errors
• Managing access
  • Accessing the console
  • Role-based access control
  • Connecting PE with external directory services
  • About RBAC permissions
  • Creating and managing users and user roles
  • Token-based authentication
  • Running agents without root privileges
  • RBAC service API v1
    • Endpoints
    • Forming RBAC requests
    • Users
    • User groups
    • Roles
    • Permissions
    • Authentication tokens
    • Directory service
    • Passwords
    • Errors
    • Configuration options
  • RBAC service API v2
    • Endpoints
    • Revoke tokens
  • Activity service API
    • Endpoints
    • Activity reporting
• Managing applications
  • Application orchestration: Overview
  • Application orchestration: Key concepts and workflow
    • Application orchestration workflow
    • Creating application definitions
    • Declaring application instances
    • Producing and consuming service resources
    • Writing custom service resource types
    • Availability tests
• Enforcing change with Puppet orchestrator
  • Direct Puppet: a workflow
  • Puppet orchestrator: overview
  • Configuring Puppet orchestrator
  • Reviewing applications
  • Checking a Puppet job plan
  • Running Puppet jobs
  • Reviewing Puppet jobs
  • Puppet orchestrator API
    • Endpoints
    • Forming requests
    • Commands
    • Events
    • Inventory
    • Jobs
    • Root
    • Errors
• Managing and deploying Puppet code
  • Managing and deploying Puppet code
  • Managing environments with a control repository
  • Managing environment content with Puppetfiles
  • Code Manager
    • Managing code with Code Manager
    • Configuring Code Manager
    • Customizing Code Manager configuration
    • Triggering Code Manager from the command line
    • Triggering Code Manager with a webhook
    • Triggering Code Manager with custom scripts
    • Troubleshooting Code Manager
  • r10k
    • Managing code with r10k
    • Configuring r10k
    • Customizing r10k configuration
    • Deploying environments with r10k
    • r10k subcommand reference
  • About file sync
• Provisioning with Razor
  • Bare-metal provisioning with Razor
  • Setting up a Razor environment
  • Installing Razor
  • Using the Razor client
    • Razor client commands
  • Protecting existing nodes
  • Provisioning a node
  • Provisioning a Windows node
  • Provisioning with custom facts
  • Working with Razor objects
    • Repositories
    • Tasks
    • Tags
    • Policies
    • Brokers
    • Hooks
  • Using the Razor API
    • API reference
  • Upgrading Razor
  • Uninstalling Razor
• SSL and certificates
  • Complete PE cert regeneration
    • Regenerating certs: mono
    • Regenerating certs: splits
  • Individual PE component cert regeneration
    • Regenerating certs for the Puppet master
    • Regenerating certs for PuppetDB
    • Regenerating certs for the PE console
  • Regenerating a Puppet agent certificate
  • Regenerating a compile master certificate
  • Using an external certificate authority with PE
  • Configuring the PE console to use a custom SSL certificate
  • Custom Diffie-Hellman param file generation
  • SSL for PE and external PostgreSQL
• APIs
  • Index of Puppet APIs
• Managing MCollective
  • Overview
  • Invoking actions
  • Controlling Puppet
  • List of built-in actions
  • Adding new actions
  • Configuring MCollective
• Maintenance
  • PE database maintenance
  • Back up and restore PE
• Troubleshooting
  • Troubleshooting the installer
  • Troubleshooting connections
  • Troubleshooting Code Manager
  • Troubleshooting the databases
  • Troubleshooting Puppet core
  • Troubleshooting MCollective
  • Troubleshooting Windows
• Appendix
  • Compliance alternate workflow