Forge Home

hiera_redis

A Hiera 5 backend for Redis

5,182 downloads

81 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.3.5 (latest)
  • 0.3.0
released Jul 29th 2024
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'maxadamo-hiera_redis', '0.3.5'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add maxadamo-hiera_redis
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install maxadamo-hiera_redis --version 0.3.5

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

maxadamo/hiera_redis — version 0.3.5 Jul 29th 2024

hiera_redis

Table of Contents

  1. Description
  2. Setup - The basics of getting started with hiera_redis
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

This module provides a Hiera 5 backend for Redis.

Setup

Setup Requirements

The backend requires the redis gem installed in the Puppet Server JRuby. It can be installed with:

/opt/puppetlabs/bin/puppetserver gem install redis

It is also recommended to install the gem into the agent's Ruby:

/opt/puppetlabs/puppet/bin/gem install redis

This allows commands such as puppet apply or puppet lookup to use the backend.

Beginning with hiera_redis

If Redis is running on the Puppet master with the default settings, specifying the lookup_key as 'redis_lookup_key' is sufficient, for example

---
version: 5
hierarchy:
  - name: hiera_redis
    lookup_key: redis_lookup_key

Usage

By default, the backend will query Redis with the key provided. It is also possible to query multiple scopes such as with the YAML backend, where the expected key in Redis is composed of the scope and the key separated by a character (default is :). For example, the following can be used:

---
version: 5
hierarchy:
  - name: hiera_redis
    lookup_key: redis_lookup_key
    options:
      confine_to_keys:
        - '^redis_.*'
        - '^myapp_.*'
        - '^ssh_group$'
      scopes:
        - "osfamily/%{facts.os.family}"
        - common

The backend then expects keys of a format such as common:foo::bar for a lookup of 'foo::bar'.

The other options available include:

  • host: The host that Redis is located on. Defaults to 'localhost'.
  • port: The port that Redis is running on. Defaults to 6379.
  • socket: Optional Unix socket path
  • password: Optional Redis password
  • db: The database number to query on the Redis instance. Defaults to 0.
  • scope: The scope to use when querying the database.
  • scopes: An array of scopes to query. Cannot be used in conjunction with the scope option.
  • separator: The character separator between the scope and key being queried. Defaults to ':'.
  • confine_to_keys: Only use this backend if the key matches one of the regexes in the array:
  confine_to_keys:
    - "application.*"
    - "apache::.*"

Limitations

This module has only been tested on CentOS.

Development

PRs welcome.