Forge Home

vaultlocker

Install and configure vaultlocker (https://pypi.org/project/vaultlocker/)

968 downloads

968 latest version

3.1 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.0 (latest)
released Mar 18th 2021
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 7.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'walkamongus-vaultlocker', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add walkamongus-vaultlocker
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install walkamongus-vaultlocker --version 0.1.0

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

walkamongus/vaultlocker — version 0.1.0 Mar 18th 2021

vaultlocker

Table of Contents

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

Description

This module will install and configure vaultlocker and its requirements (such as the cryptsetup utility).

Setup

What vaultlocker affects

By default, this module will attempt to install and manage Python using the https://forge.puppet.com/modules/puppet/python module and also install the cryptsetup package.

Beginning with vaultlocker

include vaultlocker

will install the vaultlocker tool and a default configuration file. The default configuration will not work as site-specific Vault configuration is necessary for Vault storage of encryption keys.

Usage

An example of passing in a working vaultlocker configuration:

class { 'vaultlocker':
  config => {
    'url'       => https://my-vault-server:8200,
    'approle'   => 'approle-id',
    'secret_id' => 'secret-id',
    'backend'   => 'secret/vaultlocker',
  },
}

An example of passing in devices for encryption:

class { 'vaultlocker':
  config                  => {
    ...
  },
  encrypted_block_devices => [
    '/dev/sdd1',
    '/dev/sde',
  ],
}

Limitations

Developed and tested only on RHEL 8.

Development

All pull requests welcome. pdk test unit should pass for all contributions.