Forge Home


Task for setting up hiera-eyaml


6,193 latest version

5.0 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.

Version information

  • 0.1.2 (latest)
  • 0.1.1
  • 0.1.0
released Mar 27th 2018
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 6.0.0
  • , , , , , , ,
  • encrypt
  • install

Start using this module

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

Add this module to your Puppetfile:

mod 'beersy-hiera_eyaml_setup', '0.1.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install beersy-hiera_eyaml_setup --version 0.1.2

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.



beersy/hiera_eyaml_setup — version 0.1.2 Mar 27th 2018


Table of Contents

  1. Description
  2. Requirements
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Getting help - Some Helpful commands


This module provides a task to set up hiera-eyaml on the master. The install task installs the hiera-eyaml gem, generate keys, optionally updates the global hiera.yaml, and restarts the puppet server. There is a separate task for encrypting hiera values.

NOTE: This task is meant to be an one-time operation. If you want to manage the keys and hieradata we recommend using Puppet Code instead of this task.


This module is compatible with Puppet Enterprise and Puppet Bolt.

  • To run tasks with Puppet Enterprise, PE 2017.3.2 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must be Puppet agents.

  • To run tasks with Puppet Bolt, Bolt 0.5 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must have SSH or WinRM services enabled.


To run a hiera_eyaml_setup task, use the task command:

  • With PE, run puppet task run hiera_eyaml_setup --nodes neptune.
  • With Bolt, run bolt task run hiera_eyaml_setup --nodes neptune --modulepath ~/modules.

You can also run tasks in the PE console. See PE task documentation for complete information.


  • configure_global_hiera: Configure the global hiera. Defaults to false.
  • paths: Additional hiera search paths separated by commas. The default is common.eyaml. Only used if configure_global_hiera is true.


To view the available actions and parameters, on the command line, run puppet task show hiera_eyaml_setup or see the hiera_eyaml_setup module page on the Forge.

For a complete list of optional hiera_eyaml_setup providers that are supported, see the Puppet Types documentation.

Getting Help

To display help for the hiera_eyaml_setup task, run puppet task show hiera_eyaml_setup

To show help for the task CLI, run puppet task run --help or bolt task run --help