• Puppet.com
  • Forge
  • Compass
  • Try Puppet
  • Products
  • Puppet Enterprise
  • Open Source Puppet
  • Bolt
  • Puppet Development Kit
  • Puppet DB
  • Puppet Remediate
  • Puppet Plugin for VMware
  • Get
  • Technical Support Plans
  • Support Lifecycle Policy
  • New Puppet Enterprise Customer?
  • About Puppet
  • TBD...
  • TBD...
  • Community
  • Puppet Champions
  • Puppet Test Pilots
  • Community Office Hours
  • Slack Channel

    PRODUCT AND VERSION

        • Welcome to Puppet Enterprise® 2018.1.18
          • PE architecture
          • Component versions in recent PE releases
          • PE and open source version numbers
          • Getting support
          • API index
          • Puppet platform documentation for PE
          • Translated PE
        • Release notes
          • New features
          • Enhancements
          • Deprecations and removals
          • Known issues
            • Installation and upgrade known issues
            • High availability known issues
            • PuppetDB and PostgreSQL known issues
            • Puppet Server known issues
            • Puppet and Puppet services known issues
            • Supported platforms known issues
            • Configuration and maintenance known issues
            • Console and console services known issues
            • Orchestration services known issues
            • Permissions known issues
            • Code management known issues
            • Razor known issues
            • Internationalization known issues
          • Resolved issues
          • What's new since PE 2016.4
        • Getting started
          • Getting started on *nix
            • Start installing PE on *nix
            • Start installing *nix agents
            • Start installing modules
            • Start adding classes
            • Start assigning user permissions
            • Start writing modules for *nix
            • Next steps
          • Getting started on Windows
            • Start installing PE in a Windows environment
            • Start installing Windows agents
            • Start installing modules
            • Start adding classes
            • Start assigning user access
            • Start writing modules for Windows
            • Next Steps
          • Common configuration tasks
            • Managing NTP with PE
            • Managing a DNS nameserver with PE
            • Managing SSH with Puppet
            • Managing sudo with PE
            • Managing firewalls with PE
            • Managing Windows configurations
            • Installing and using Windows modules
        • Installing
          • Choosing an architecture
          • System requirements
            • Hardware requirements
            • Supported operating systems
            • Supported browsers
            • System configuration
          • What gets installed and where?
          • Installing Puppet Enterprise
          • Purchasing and installing a license key
          • Installing agents
          • Installing network device agents
          • Installing compile masters
          • Installing ActiveMQ hubs and spokes
          • Installing PE client tools
          • Installing external PostgreSQL
          • Uninstalling
        • Upgrading
          • Upgrading Puppet Enterprise
          • Upgrading agents
        • Configuring Puppet Enterprise
          • Methods for configuring Puppet Enterprise
          • Configuring and tuning Puppet Server
          • Configuring and tuning the console
          • Configuring and tuning PuppetDB
          • Configuring and tuning orchestration
          • Configuring proxies
          • Configuring Java arguments for Puppet Enterprise
          • Configuring ulimit for PE services
          • Tuning monolithic installations
          • Writing configuration files
          • Analytics data collection
          • Static catalogs in Puppet Enterprise
        • Configuring high availability
          • High availability
          • Configure high availability
        • Accessing the console
        • 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 v1
            • Endpoints
            • Forming RBAC API requests
            • Users endpoints
            • User group endpoints
            • User roles endpoints
            • Permissions endpoints
            • Token endpoints
            • Directory service endpoints
            • Password endpoints
            • RBAC service errors
            • Configuration options
          • RBAC API v2
            • Tokens endpoints
          • Activity service API
            • Forming activity service API requests
            • Event types reported by the activity service
            • Events endpoints
        • Inspecting your infrastructure
          • Monitoring current infrastructure state
          • Exploring your catalog with the node graph
          • Viewing and managing all packages in use
          • Infrastructure reports
          • Analyzing changes across Puppet runs
          • Viewing and managing Puppet Server metrics
            • Getting started with Graphite
            • Available Graphite metrics
            • Using the developer dashboard
          • Status API
            • Authenticating to the status API
            • Forming requests to the status API
            • JSON endpoints
            • Activity service plaintext endpoints
            • Metrics endpoints
            • The metrics API
        • Managing nodes
          • Adding and removing nodes
          • Running Puppet on nodes
          • Grouping and classifying nodes
          • Making changes to node groups
          • Environment-based testing
          • Preconfigured node groups
          • Designing system configs: roles and profiles
            • The roles and profiles method
            • Roles and profiles example
            • Designing advanced profiles
            • Designing convenient roles
          • Node classifier service API
            • 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
        • Managing applications
          • Application orchestration
          • Deploying applications with Puppet Application Orchestration: workflow
          • Creating application definitions
          • Declaring application instances
          • Producing and consuming service resources
          • Writing custom service resource types
          • Availability tests
        • Orchestrating Puppet and tasks
          • Running jobs with Puppet orchestrator
          • Configuring Puppet orchestrator
          • Using Bolt
            • Using Bolt with orchestrator
          • Direct Puppet: a workflow for controlling change
          • Running Puppet on demand
            • Running Puppet on demand in the console
            • Running Puppet on demand from the CLI
            • Running Puppet on demand with the API
          • Running tasks
            • Running tasks in Puppet Enterprise
            • Installing tasks
            • Running tasks from the console
            • Running tasks from the command line
          • Writing tasks
          • Reviewing jobs
            • Review jobs from the console
            • Review jobs from the command line
          • Puppet orchestrator API v1 endpoints
            • Puppet orchestrator API: forming requests
            • Puppet orchestrator API: command endpoint
            • Puppet orchestrator API: events endpoint
            • Puppet orchestrator API: inventory endpoint
            • Puppet orchestrator API: jobs endpoint
            • Puppet orchestrator API: scheduled jobs endpoint
            • Puppet orchestrator API: plan jobs endpoint
            • Puppet orchestrator API: tasks endpoint
            • Puppet orchestrator API: root endpoint
            • Puppet orchestrator API: error responses
        • 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
            • Configuring Code Manager
            • 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
            • Configuring r10k
            • Customizing r10k configuration
            • Deploying environments with r10k
            • r10k command reference
          • About file sync
        • Provisioning with Razor
          • How Razor works
          • Setting up a Razor environment
          • Installing Razor
          • Using the Razor client
          • Protecting existing nodes
          • Provisioning a *nix node
          • Provisioning a Windows node
          • Provisioning with custom facts
          • Working with Razor objects
            • Repositories
            • Razor tasks
            • Tags
            • Policies
            • Brokers
            • Hooks
            • Keeping Razor scalable
          • Using the Razor API
          • Upgrading Razor
          • Uninstalling Razor
        • SSL and certificates
          • Regenerating certificates: monolithic installs
          • Regenerating certificates: split installs
          • Individual PE component cert regeneration (split installs only)
          • Regenerate Puppet agent certificates
          • Regenerate compile master certs
          • Use the PE CA as an intermediate CA
          • Use a custom SSL certificate for the console
          • Change the hostname of a monolithic master
          • Generate a custom Diffie-Hellman parameter file
          • Disable TLSv1 in PE
        • Managing MCollective
          • MCollective
          • Invoking actions
          • Controlling Puppet
          • List of built-in actions
          • Adding actions and plugins to PE
          • Disabling MCollective
          • Change the port used by MCollective/ActiveMQ
          • Moving from MCollective to Puppet orchestrator
          • Removing MCollective
        • Maintenance
          • Backing up and restoring Puppet Enterprise
            • Backup and restore split installations and upgrades
            • Backup and restore monolithic installations and same-version infrastructure
          • Puppet Enterprise database maintenance
            • Databases in Puppet Enterprise
            • Optimize a database
            • List all database names
        • Troubleshooting
          • Troubleshooting the installer
          • Troubleshooting connections between components
          • Troubleshooting Code Manager
          • Troubleshooting the databases
          • Troubleshooting MCollective
          • Troubleshooting Windows

        Maintenance

        • Backing up and restoring Puppet Enterprise
          Keep regular backups of your PE infrastructure. Backups allow you to more easily migrate to a new master, troubleshoot, and quickly recover in the case of system failures.
        • Puppet Enterprise database maintenance
          You can optimize the Puppet Enterprise (PE) databases to improve performance.

        Puppet automates the delivery and operation of the software that powers some of the biggest brands in the world.

        • Legal
        • Privacy Policy
        • Terms of Use
        • Security
        • Sitemap © 2021
        • Puppet