Installing PE client tools
PE client tools are a set of command line tools that let you access Puppet Enterprise services from a workstation that might or might not be managed by Puppet.
The pe-client-tools
package is included in the PE installation tarball. When you
install, the client tools are automatically installed on the same node as the master.
Client tools versions align with PE versions. For example, if you're running PE 2017.3, use the 2017.3 client tools. In some cases, we might issue patch releases ("x.y.z") for PE or the client tools. You don't need to match patch numbers between PE and the client tools. Only the "x.y" numbers need to match.
The package includes client tools for these services:
- Orchestrator — Allow you to control the rollout of changes in your
infrastructure, and provides the interface to the orchestration service. Tools include
puppet-job
andpuppet-app
. - Puppet access — Authenticates you to the PE RBAC token-based authentication service so that you can use other capabilities and APIs.
-
Code Manager — Provides the interface for
the Code Manager and file sync services. Tools include
puppet-code
. - PuppetDB CLI — Enables certain operations with PuppetDB, such as building queries and handling exports.
Because you can safely run these tools remotely, you no longer need to
SSH into the master to execute commands. Your permissions to see information and to take
action are controlled by PE role-based access control. Your
activity is logged under your username rather than under root
or the pe-puppet
user.
Supported PE client tools operating systems
The PE client tools package can be installed on these platforms.
Operating system | Versions | Arch |
---|---|---|
Red Hat Enterprise Linux | 6, 7 | x86_64 |
CentOS | 6, 7 | x86_64 |
Oracle Linux | 6, 7 | x86_64 |
Scientific Linux | 6, 7 | x86_64 |
SUSE Linux Enterprise Server | 11, 12 | x86_64 |
Ubuntu | 16.04 | amd64 |
Windows (Consumer OS) | 7, 8.1, 10 | x86, x64 |
Windows Server (Server OS) |
2008 |
x86, x64 |
2008r, 22012, 2012r2, 2012r2 core |
x64 | |
2016 | ||
macOS | 10.10, 10.11, 10.12, 10.13 |
Install PE client tools on a managed workstation
To use the client tools on a system other than the master, where they're installed by default, you can install the tools on a controller node.
- In the console, create a controller classification group, for example PE Controller, and ensure that its Parent name is set to All Nodes.
- Select the controller group and add the puppet_enterprise::profile::controller class.
-
Pin the node that you want to be a controller to
the controller group.
- In the controller group, on the Rules tab, in the Certname field, enter the certname of the node.
- Click Pin node and commit changes.
- Run Puppet on the controller machine.
Install PE client tools on an unmanaged workstation
You can install the pe-client-tools
package on any workstation running a supported OS. The
workstation OS does not need to match the master OS.
- 8143 — The orchestrator client uses this port to communicate with orchestration services running on the master.
- 4433 — The Puppet access client uses this port to communicate with the RBAC service running on the master.
- 8170 — If you use the Code Manager service, it requires this port.
Install PE client tools on an unmanaged Linux workstation
Install PE client tools on an unmanaged Windows workstation
You can install the client tools on a Windows workstation using the setup wizard or the command line.
To start using the client tools on your Windows workstation, open the PE ClientTools Console from the Start menu.
Install PE client tools on an unmanaged macOS workstation
You can install the client tools on a macOS workstation using Finder or the command line.
-
On the workstation, create the directory
/etc/puppetlabs/puppet/ssl/certs
. -
On the master, navigate to
/etc/puppetlabs/puppet/ssl/certs/
and copyca.pem
to the directory you created on the workstation. -
On the workstation, make sure file permissions are
correct:
chmod 444 /etc/puppetlabs/puppet/ssl/certs/ca.pem
-
Verify that the checksum of
ca.pem
on the workstation matches the checksum of the same file on the master. -
Install the client tools using Finder or the
command line.
- Finder
-
Download the macOS pe-client-tools-package.
-
Open the
pe-client-tools
.dmg and click theinstaller
.pkg. -
Follow the prompts to install the client tools.
-
- Command line
-
Download the macOS pe-client-tools-package.
-
Mount the disk image:
sudo hdiutil mount <DMGFILE>
.A line appears ending with
/Volumes/puppet-agent-VERSION
. This directory location is the mount point for the virtual volume created from the disk image. - Run
cd /Volumes/pe-client-tools-VERSION
. - Run
sudo installer -pkg pe-client-tools-<VERSION>-installer.pkg -target /
. - Run
cd ~
and then runsudo umount /Volumes/pe-client-tools-VERSION
.
-
- Finder
Configuring and using PE client tools
Use configuration files to customize how client tools communicate with the master.
For each client tool, you can create config files for individual machines (global) or for individual users. Configuration files are structured as JSON.
-
Global
-
*nix —
/etc/puppetlabs/client-tools/
-
Windows —
%ProgramData%\puppetlabs\client-tools
-
- User
-
*nix —
~/.puppetlabs/client-tools/
-
Windows —
%USERPROFILE%\.puppetlabs\client-tools
-
On managed client nodes where the operating system and architecture
match the master, you can have PE manage Puppet code and orchestrator global configuration files
using the puppet_enterprise::profile::controller
class.
Client tool | Documentation |
---|---|
Orchestrator | |
Puppet access | |
Puppet code | |
PuppetDB |