Skip to content

OpenVox Documentation

Main Navigation OpenFact OpenVox OpenBolt OpenVox Server OpenVoxDB

Appearance

OpenFact OpenVox OpenBolt OpenVox Server OpenVoxDB

Appearance

Search documentation Esc

Return to top

Sidebar Navigation

Puppet 5 Platform

Puppet release notes

Puppet known issues

System requirements

Component versions in `puppet-agent`

Puppet agent release notes

Quick start guides

NTP quick start guide

DNS quick start guide

Sudo quick start guide

Firewall quick start guide

Deprecated features

About deprecations in this version

Web servers

Upcoming operating system deprecations

Language features

Extension points and APIs

Settings

Installing and upgrading

Overview of Puppet's architecture

Pre-install tasks

Puppet Platform repositories

Install agent: Linux

Install agent: Windows

Install agent: macOS

File location changes since Puppet 3.8.x

Pre-upgrade tasks from 3.8

Upgrade agents from 3.8.x Puppet 5.x

Upgrade servers

Post-upgrade cleanup

Minor upgrades: From Puppet 4 and within Puppet 5.x

Configuration

About Puppet's settings

Short list of important settings

puppet.conf: The main config file

environment.conf: Per-environment settings

auth.conf (LEGACY): HTTPS authorization

fileserver.conf: Custom fileserver mount points

puppetdb.conf: PuppetDB server locations

hiera.yaml: Data lookup configuration

autosign.conf: Basic certificate autosigning

csr_attributes.yaml: Certificate extensions

custom_trusted_oid_mapping.yaml: Short names for cert extension OIDs

device.conf: Network hardware access

routes.yaml: Advanced plugin routing

Checking values of settings

Editing settings on the command line

Complete list of settings (configuration reference)

Important directories and files

Code and data directory (codedir)

Config directory (confdir)

The main manifest

The modulepath

The SSLdir

Cache directory (vardir)

Environments

About environments

Creating environments

Environment isolation

Modules

Fundamentals

Beginner's guide to writing modules

Plugins in modules

Installing modules

Publishing modules on the Puppet Forge

Module metadata and metadata.json

Documenting modules

Puppet Strings

Puppet Strings style guide

Module cheat sheet

Puppet's services and tools

Puppet's commands

Running Puppet commands on Windows

The rack Puppet master

Configuring a Server with Passenger and Apache

The WEBrick Puppet master

Puppet agent on *nix

Puppet agent on Windows

Puppet apply

The Puppet language

Visual index

Basics

Puppet language style guide

Handling file paths on Windows

Variables

Resources

Resources (advanced)

Relationships and ordering

Classes

Defined resource types

Type aliases

Expressions and operators

Conditional statements and expressions

Function calls

Docs for built-in functions

Node definitions

Comments

Facts and built-in variables

Reserved words and acceptable names

Writing functions (Puppet language)

Custom types

Provider development

About values and data types

Strings

Numbers

Booleans

Arrays

Hashes

Regular expressions

Sensitive

Undef

Resource references

Resource types

Default

Data type syntax

Abstract data types

Using templates

Embedded Puppet (EPP) template syntax

Embedded Ruby (ERB) template syntax

Iteration and loops

Lambdas (code blocks)

Resource defaults

Resource collectors

Virtual resources

Exported resources

Writing custom functions

Introduction to writing functions

Writing functions (Puppet language)

Overview and examples

Defining signatures

Special features in implementation methods

Documenting Ruby functions

Writing functions (legacy Ruby API --- avoid)

Hiera

Getting started with Hiera

Configuring Hiera

Creating and editing data

Looking up data with Hiera

Writing new data backends

Upgrading to Hiera 5

Resource types

All resource types (single-page reference)

Core types cheat sheet

Optional resource types for Windows

augeas

Augeas tips and examples

computer

cron

exec

Exec tips and examples for Windows

file

File tips and examples for Windows

filebucket

group

User and group tips and examples for Windows

host

index

interface

k5login

macauthorization

mailalias

maillist

mcx

mount

nagios_command

nagios_contact

nagios_contactgroup

nagios_host

nagios_hostdependency

nagios_hostescalation

nagios_hostextinfo

nagios_hostgroup

nagios_service

nagios_servicedependency

nagios_serviceescalation

nagios_serviceextinfo

nagios_servicegroup

nagios_timeperiod

notify

package

Package tips and examples for Windows

resources

router

schedule

scheduled_task

Scheduled task tips and examples

selboolean

selmodule

service

Service tips and examples

ssh_authorized_key

sshkey

stage

tidy

user

User and group tips and examples for Windows

vlan

yumrepo

zfs

zone

zpool

Reports: Tracking Puppet's activity

About reporting

Built-in report processors

Writing custom report processors

Puppet::Transaction::Report object format

Extensions for assigning classes to nodes

External node classifiers

The LDAP node classifier

Misc. references

Settings (configuration reference)

Functions

Metaparameters

Built-in report processors

Indirections and termini

Ruby API for developing extensions

Man pages

Index

puppet agent

puppet apply

puppet cert

puppet master

puppet module

puppet resource

puppet lookup

puppet config

puppet describe

puppet device

puppet doc

puppet help

puppet man

puppet node

puppet parser

puppet plugin

puppet ca

puppet catalog

puppet certificate

puppet certificate_request

puppet certificate_revocation_list

puppet facts

puppet filebucket

puppet key

puppet report

puppet status

HTTP API

Index

PSON

Catalog

Node

File bucket file

File content

File metadata

Report

Environments

Resource type

Status

Certificate

Certificate signing requests

Certificate status

Certificate revocation list

catalog.json

environments.json

error.json

facts.json

file_metadata.json

host.json

json-meta-schema.json

node.json

report.json

resource_type.json

status.json

SSL and certificates

Using an external CA

Configuring autosigning

CSR attributes and certificate extensions

Regenerating all certificates in a deployment

Details about Puppet's internals

Agent/master HTTPS communications

Catalog compilation

Experimental features

Overview

Msgpack support

On this page

Formats: Reports

This version of Puppet uses report format 9.

Pager

Previous page Adding file server mount points

Next page Function Reference