puppetdb-rundeck

####Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with puppetdb_rundeck
   • What puppetdb_rundeck affects
   • Setup requirements
   • Beginning with puppetdb_rundeck
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

##Overview

This is a puppet module that will manage and install the puppetdb_rundeck puppetdb_rundeck ruby gem

##Module Description

This module installs the puppetdb_rundeck ruby gem. This gem is a small application that provides an api for puppetdb that can be used as a URL resource in rundeck.

##Setup

###What puppetdb_rundeck affects

• The installation of the puppetdb_rundeck ruby gem
• Creates a service to manage the application installed by this gem

###Beginning with puppetdb_rundeck

To install puppetdb_rundeck:

  puppetdb_rundeck { 'puppetdb_rundeck':
    version => '0.1.0'
  }

To install puppetdb_rundeck on a different port:

  puppetdb_rundeck { 'puppetdb_rundeck':
    version => '0.1.0',
    port    => '9090'
  }

To install puppetdb_rundeck on a system with an external host:

  puppetdb_rundeck { 'puppetdb_rundeck':
    version => '0.1.0',
    puppetdb_host => 'anotherhost.somedomain.com',
    puppetdb_post => '8081'
  }

##Usage

###Classes and Defined Types

####Class: puppetdb_rundeck The puppetdb_rundeck class is the root class to manage the installation of the puppetdb_rundeck gem and service

##Reference

###Classes ####Public Classes

• puppetdb_rundeck: Guides the installation of the puppetdb_rundeck application

####Private Classes

• [puppetdb_rundeck::install] Manages the installation of the puppetdb_rundeck gem
• [puppetbd_rundeck::service] Manages the puppetdb_rundeck service

##Limitations

This module is tested on the following platforms:

• CentOS 5
• CentOS 6
• Ubuntu 12.04
• Ubuntu 14.04

It is tested with the OSS version of Puppet only.

##Development

###Contributing

Please read CONTRIBUTING.md for full details on contributing to this project.