Forge Home

pe_client_tools_easy_setup

Easily install PE client tools

7,169 downloads

6,775 latest version

4.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 1.0.1 (latest)
  • 1.0.0
released Mar 13th 2017
This version is compatible with:
  • Puppet Enterprise >= 2016.4.0
  • , , , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'beersy-pe_client_tools_easy_setup', '1.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add beersy-pe_client_tools_easy_setup
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install beersy-pe_client_tools_easy_setup --version 1.0.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

beersy/pe_client_tools_easy_setup — version 1.0.1 Mar 13th 2017

pe_client_tools_easy_setup

Table of Contents

  1. Description
  2. Setup - The basics of getting started with pe_client_tools_easy_setup
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Description

This module installs and configures PE client tools on your machine

Setup

What pe_client_tools_easy_setup affects

This module will install files into /etc/puppetlabs/client-tools and /etc/puppetlabs/puppet/ssl/certs

Setup Requirements

This module assumes PE is already installed, and the agent is running on the client.

Pre-Install Steps

Install this module by running these command first on the master as root:
puppet module install beersy-pe_client_tools_easy_setup

Then add these values to your hiera file (ex, /etc/puppetlabs/code/environments/production/hieradata/common.yaml)

  • pe_client_tools_easy_setup::client_tools_package_path: CLIENT_TOOLS_PACKAGE_PATH
  • pe_client_tools_easy_setup::pe_server_certname: PE_SERVER_CERTNAME
  • pe_client_tools_easy_setup::access_token_path: ACCESS_TOKEN_PATH

Replace the values before running:

  • CLIENT_TOOLS_PACKAGE_PATH = Path to client tools .msi,.rpm, or .dmg
  • PE_SERVER_CERTNAME = certname of the PE Master (must match the name in the ca.pem file)
  • ACCESS_TOKEN_PATH = Where to find the access token

Install Steps

If you are using hiera, run this command: puppet apply -e "include ::pe_client_tools_easy_setup"

If you are not using hiera you can specify the parameters at the command line:
puppet apply -e "class { 'pe_client_tools_easy_setup': pe_server_certname => 'PE_SERVER_CERTNAME', client_tools_package_path => 'CLIENT_TOOLS_PACKAGE_PATH', access_token_path => 'ACCESS_TOKEN_PATH'}"

Release Notes/Contributors/Etc.

1.0.1 Updated metadata.json with supported OS & PE versions 1.0.0 Initial release