Skip to content
Tutorials Center
My learning

Topics

Lesson 4 of 38 ยท Getting Started

Puppet Editions, Versions, and Terms

Sort out Puppet open source, Puppet Enterprise and OpenVox, how versions and platforms work, where files live, and the vocabulary (node, catalog, fact, module) used everywhere.

Puppet has a few names and editions that confuse newcomers. This lesson sorts them out and gives you the glossary used for the rest of the course. Keep it as a reference: when a later lesson says "catalog" or "node", it means what is defined here.

Editions and forks

  • Puppet (open source). The core: the language, the puppet command, puppet-agent (with Facter and Hiera) and Puppet Server (the JVM-based server that compiles catalogs). Free to use.
  • Puppet Enterprise (PE) and other commercial products from Perforce, the company that owns Puppet. PE adds a web console, role-based access, orchestration, reporting and support on top of the open source pieces.
  • OpenVox. A community fork of the open source Puppet code created after the open source releases changed hands. Its commands, language and module formats follow Puppet closely, so the concepts in this course carry over. Package and command names may differ slightly by distribution.
  • Bolt. A separate agentless tool for running tasks and plans over SSH or WinRM. It complements Puppet but does not replace the agent.

Always check which distribution you install and read its release notes. This course teaches the language and workflow (Puppet 8 era). If something differs on your platform, the documentation for your distribution wins.

Versions

Puppet has major versions every year or two (Puppet 7, Puppet 8, ...). Majors can remove deprecated features, so read the upgrade notes. Two points matter in practice:

  • Server and agent versions should be compatible: the server is normally the same or newer than the agents it serves.
  • Puppet 8 tightened several defaults, for example undefined variables are an error by default (strict_variables), and long-deprecated features were removed. Write code with $facts['os']['family'] style facts (not old top-scope $osfamily) so it works everywhere.

Check what you have:

Terminal
/opt/puppetlabs/bin/puppet --version
/opt/puppetlabs/bin/facter --version
/opt/puppetlabs/bin/puppet config print confdir

Supported agent platforms include most Linux distributions, Windows, macOS and several Unix systems. The Puppet Server needs Linux.

Where things live

What Path (Linux, agent package)
Binaries (puppet, facter, hiera) /opt/puppetlabs/bin
Configuration directory (puppet.conf) /etc/puppetlabs/puppet
Code directory (environments, modules) /etc/puppetlabs/code
Production environment /etc/puppetlabs/code/environments/production
Variable data (reports, certificates, state) /opt/puppetlabs/puppet/cache and /etc/puppetlabs/puppet/ssl
Puppet Server config /etc/puppetlabs/puppetserver

The puppet config print command reports the real value on your machine, and is better than memorising paths.

The glossary

  • Node: any machine Puppet manages, identified by its certificate name (usually its fully qualified hostname).
  • Agent: the puppet agent service running on a node.
  • Puppet Server: the server that compiles catalogs for agents. Formerly "master".
  • Manifest: a .pp file of Puppet code.
  • Resource: one managed thing: a package, file, service, user.
  • Resource type: the kind of resource (file); provider: the implementation for a platform (apt, dnf).
  • Catalog: the compiled, node-specific list of resources and relationships.
  • Fact: a piece of information about a node collected by Facter, for example os.family.
  • Class: a named group of resources you can reuse. Module: a folder of classes, files and templates.
  • Hiera: the key-value data lookup system that keeps data out of code.
  • Environment: an independent copy of code, such as production or staging.
  • Report: the record of one run.
flowchart TB
    M["Module"] --> C["Class"]
    C --> R["Resources"]
    F["Facts"] --> CAT["Catalog"]
    H["Hiera data"] --> CAT
    R --> CAT
    CAT --> A["Agent applies"]

Facts and Hiera data feed code; code becomes a catalog; the agent applies it.

Reading a resource, once more

PUPPET
file { '/etc/ntp.conf':           # type { title:
  ensure => file,                 # attribute => value,
  owner  => 'root',
}

The pair File['/etc/ntp.conf'] (capitalised type, title in brackets) is a resource reference: it is how other resources point to this one in relationships.

A stand-in glossary quiz tool

Python Stand-in: look up a term

Press Run (or Ctrl + Enter) to see the result here.

Program input ยท what you'd type while the program runs

Type the answers before you press Run, one per line. Each time the program reads a line (with input()), it gets the next line from this box.

Python Stand-in: check a Puppet version number

Press Run (or Ctrl + Enter) to see the result here.

Program input ยท what you'd type while the program runs

Type the answers before you press Run, one per line. Each time the program reads a line (with input()), it gets the next line from this box.

Check your understanding

Quick check ยท 4 questions

of 4 answered You scored / 4 ยท perfect!

  1. 1. What is a catalog?

    The catalog is what the server compiles for each node and the agent enforces.
  2. 2. Which tool collects facts about a node?

    Facter gathers facts such as operating system and memory.
  3. 3. Where is the production environment's code by default?

    Code lives under /etc/puppetlabs/code/environments/<name>.
  4. 4. What is the difference between a type and a provider?

    package is the type; apt and dnf are providers.

Summary

  • Open source Puppet, Puppet Enterprise and the OpenVox fork share the language and concepts.
  • Everything installs under /opt/puppetlabs (binaries) and /etc/puppetlabs (config, code).
  • Key words: node, agent, Puppet Server, manifest, resource, type, provider, catalog, fact, class, module, Hiera, environment.
  • Use modern $facts[...] syntax and check version compatibility.

Next: Puppet Architecture