Forge Home


This module is used to retrieve data from MySQL through hiera.


4,774 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.1 (latest)
  • 0.1.0
released Sep 18th 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
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'nvitaterna-hiera_mysql2', '0.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add nvitaterna-hiera_mysql2
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install nvitaterna-hiera_mysql2 --version 0.1.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.



nvitaterna/hiera_mysql2 — version 0.1.1 Sep 18th 2018


This is hiera-mysql2 for use with Hiera 5 and Puppet 5.


This module is used to retrieve data from a MySQL database for use in Puppet.



puppet module install nvitaterna/hiera_mysql2


If you are using Hiera-mysql under jRuby (puppetserver): puppetserver gem install jdbc-mysql If you are using Hiera-mysql under standard ruby: /opt/puppetlabs/puppet/bin/gem install mysql2



- name: "MySQL lookup"              # this can be changed
  lookup_key: mysql2_lookup_key     # this must be mysql2_lookup_key
  paths:                            # can be any files you want this module to check for data
    - "common.sql"

Assuming the default data directory is ./data. ./data/common.sql:

  host: dev1                                # mysql server host
  username: root                            # mysql user
  password: "%{lookup('mysqlpassword')}"    # mysql password
  database: puppet                          # mysql database
  port: 3306                                # mysql port (optional, defaults to 3306)
machines: SELECT * FROM machines;           # queries can be named as you like
items: SELECT * FROM items;

NOTE: any of these fields, including the query, can reference can use hiera lookups.


When in puppet, use hiera like you normally would:

$machines = lookup('machines')


Credit to crayfishx/hiera-mysql and Telmo/hiera-mysql-backend.