Forge Home

yaml

YAML plugin for bolt

71,825 downloads

55,288 latest version

4.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.2.0 (latest)
  • 0.1.0
released Feb 14th 2020

Start using this module

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

Add this module to your Puppetfile:

mod 'puppetlabs-yaml', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-yaml
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-yaml --version 0.2.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

puppetlabs/yaml — version 0.2.0 Feb 14th 2020

YAML Inventory

This module includes a yaml plugin for bolt. This allows you to compose multiple yaml files into a single bolt inventory file.

Usage

Resolve Reference

The resolve reference plugin can be used to load data from multiple files into a central bolt inventory file.

Parameters

  • filepath: The path to the yaml file. Relative paths are resolved in relation to the Bolt project directory

Examples

For example, to break the inventory file into multiple files based on groups.

---
# inventory.yaml
version: 2
groups:
  - _plugin: yaml
    filepath: inventory.d/first_group.yaml
  - _plugin: yaml
    filepath: invenotry.d/second_group.yaml
---
# inventory.d/first_group.yaml
name: first_group
targets:
  - one.example.com
  - two.example.com
---
# inventory.d/second_group.yaml
name: second_group
targets:
  - three.example.com
  - four.example.com

For example, to load user specific credentials into the inventory file.

---
# inventory.yaml
targets:
  - example.com
config:
  ssh:
    _plugin: yaml
    filepath: ~/.my_bolt_credentials.yaml
# ~/.my_bolt_credentials.yaml
user: me
password: hunter2