Installing Puppet agent: OS X
Included in Puppet Enterprise 2016.4.
Make sure you’re ready
Note: If you’ve used older Puppet versions, Puppet 4 changed the locations for a lot of the most important files and directories. See this page for a summary of the changes.
Review supported versions
We publish and test official
puppet-agent packages for the following OS X versions:
- 10.11 El Capitan
- 10.10 Yosemite
- 10.9 Mavericks
To install on other operating systems, see the pages linked in the navigation sidebar.
Download the OS X
puppet-agent package is the only component of a Puppet Collection available on OS X, you can still use Puppet Collections to ensure the version of
package-agent you install is compatible with the Puppet Collection powering your infrastructure.
puppet-agent for Puppet Collection 1:
You can also download older versions of Puppet; browse to
<OS X VERSION>/PC1/x86_64 for the most recently released packages.
These packages are tied to Puppet Collection 1, which is a set of Puppet software designed to work well with Puppet 4. The
puppet-agent package bundles all of Puppet’s prerequisites, so you don’t need to download anything else to install Puppet on an agent node.
Choosing a package
OS X packages are named according to their
puppet-agent version and compatible OS X version:
puppet-agent-<PACKAGE VERSION>.osx<OS X VERSION>.dmg
To see which versions of Puppet and its related tools and components are in a given
puppet-agent release, as well as release notes for each release, see About Puppet Agent.
Previous package names
We used some different naming schemes in the puppet-agent 1.2 series before settling on the current convention in 1.2.5.
- 1.2.0 through 1.2.2:
puppet-agent-<VERSION>-osx-<OS X VERSION>-<ARCH>.dmg. Redundant; OS X only runs on x86_64.
puppet-agent-<VERSION>-<OS X CODE NAME>.dmg. This was too hard for automated tooling to deal with, because OS X’s built-in CLI tools don’t report the code name.
Make sure you can run Puppet executables
The new location for Puppet’s executables is
/opt/puppetlabs/bin/, which is not in your
PATH environment variable by default.
This doesn’t matter for Puppet services, so enabling or disabling Puppet agent with
launchctl works fine. However, if you’re running any interactive
puppet commands, you need to either add the location to your
PATH or refer to the executables by their full locations.
For more information, see our page about files and directories moved in Puppet 4.
There are three ways to install Puppet on OS X:
- With the GUI installer.
- On the command line.
- With Puppet (if upgrading).
Regardless which you choose, installing the package will start the
mcollective services. You can later disable these services with
launchctl or with
sudo puppet resource service <NAME> ensure=stopped enable=false.
Installing with the GUI
puppet-agent disk image you downloaded. This mounts it at
A Finder window appears showing the disk’s contents: a single
puppet-agent-<VERSION>-installer.pkg file. Double-click the package file, and follow the installer prompts to install it. When installation finishes, Puppet agent and MCollective will be running.
After installing, unmount and delete the disk image.
Installing on the command line
Alternately, you can use the
installer commands to mount the disk image and install the package from the command line.
First, mount the disk image with:
sudo hdiutil mount <DMG FILE>
Next, locate the
.pkg file in the mounted volume and install it with:
sudo installer -pkg /Volumes/<IMAGE>/<PKG FILE> -target /
When installation finishes, Puppet agent and MCollective will be running.
After installing, unmount the disk image with:
sudo hdiutil unmount /Volumes/<IMAGE>
You can then delete the
Upgrading with Puppet
Puppet includes a
package resource provider for OS X that can install
.pkg files from a disk image. If you already have Puppet installed, you can use the
puppet resource command to upgrade with fewer steps.
Locate the disk image you downloaded, and note both the filename and its full path on disk. Then, run:
sudo puppet resource package "<NAME>.dmg" ensure=present source=<FULL PATH TO DMG>
Configure critical agent settings
You probably want to set the
server setting to your master’s hostname. The default value is
server = puppet, so if your master is reachable at that address, you can skip this.
For other settings you might want to change, see the list of agent-related settings.
Sign certificates (on the CA master)
As each agent runs for the first time, it will submit a certificate signing request (CSR) to the certificate authority (CA) Puppet master. You’ll need to log into that server to check for certs and sign them.
sudo /opt/puppetlabs/bin/puppet cert listto see any outstanding requests.
sudo /opt/puppetlabs/bin/puppet cert sign <NAME>to sign a request.
After an agent’s certificate is signed, it regularly fetches and applies configurations from the Puppet master.