Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

connect_yaml

YAML importer for Connect
Project URLRSS FeedReport issues

9,780 downloads

9,780 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.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.0.1 (latest)
released May 1st 2015
This version is compatible with:
  • Puppet Enterprise >=3.4.3
  • Puppet >=3.4.3
  • , , , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'hajee-connect_yaml', '0.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add hajee-connect_yaml
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install hajee-connect_yaml --version 0.0.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.

Download

Documentation

hajee/connect_yaml — version 0.0.1 May 1st 2015

Build Status Coverage StatusCode Climate

####Table of Contents

  1. Overview
  2. Module Description - What YAML importer for Connect does and why it is useful
  3. Setup - The basics of getting started with the YAML importer for Connect
  4. Usage - Configuration options and additional functionality
  5. Troubleshooting
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

##Overview

Connect is a replacement for YAML in hiera when using Puppet. Connect allows you to assign, manipulate and reference data. It also allows you to import data items from external sources. The code to import this data is called a datasource.

##Module Description

This module contains the data source for reading YAML files into Connect. Although Connect, is build to get away from YAML, sometimes it is useful to be able to read and use the contents of a YAML file. This module allows you to do so.

##Example

Here is an example reading a YAML file.

import from yaml('/aaa/a.yaml') do
  variable1 = 'key1'
  variable2 = 'yaml::key2'
end

In this example we are opening the file /aaa/a.yaml, and reading the keys key1 and yaml::Key2 . In the rest of the Connect configuration, you can use the variables as variable1 and variable2

##Setup

###Installing the module

To use the YAML datasource module, you first have to make sure it is installed.

puppet module install hajee/connect_yaml

If you are using a Puppetfile, you need the following lines:

mod 'hajee-connect_yaml'

No additional actions are required. Connect searches for available data sources when staring. So when this data source is installed, it is usable instantaneous.

###What connect_yaml affects

connect_yaml affects no other modules then only Connect.

###Setup Requirements

A requirement for connect_yaml is the [Connect]](https://github.com/hajee/connect), module. This requirement is specified in the module metadata so you don’t have to manage it yourself.

###Beginning with connect YAML module

Check the Connect Language, in a Nutshell, for more intro into the language.

##Troubleshooting

Use the --debug option to puppet to see what is happening

##Limitations

This module is tested CentOS and Redhat. It will probably work on other Linux distributions.

##Development

This is an open source project, and contributions are welcome.

###OS support

Currently we have tested:

  • CentOS 5
  • Redhat 5

###Testing

Make sure you have:

  • rake
  • bundler

Install the necessary gems:

bundle install

And run the tests from the root of the source code:

rake spec

We are currently working on getting the acceptance test running as well.