####Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with jenkins-job-builder
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
##Overview
Install jenkins-job-builder to allow you to manage your Jenkins jobs
##Module Description
The openstack jenkins-job-builder tool manages the configuration of jobs in your Jenkins instance. This module wraps that tool and allows you to control all the configuration of your Jenkins jobs from within hiera.
##Setup
###What jenkins-job-builder affects
- Install the jenkins-job-builder pip package
- Creates temporary files for each jenkins job you want to manage
###Beginning with jenkins-job-builder
Installing jenkins-job-builder to a specified version
class { 'jenkins-job-builder':
version => 'latest'
}
##Usage
###Classes and Defined Types
####Class: jenkins-job-builder
Parameters within jenkins-job-builder
:
####version
The version of the the plugin to be installed.
####jobs
A hash of the configuration for all the jobs you want to configure in your Jenkins instance.
####user
The user used to authenticate to the Jenkins instance.
####password
The password used to authenticate to the Jenkins instance.
####hipchat_token
If using the jenkins hipchat plugin, this is the token that should be specified in the global config.
####jenkins_url
The full url (including port) to the jenkins instance.
#####Define: jenkins-job-builder::job
Parameters within jenkins-job-builder::job
:
####config
A hash of the configuration for all the job you want to configure in your Jenkins instance.
####delay
The time (in seconds) to delay the creatation of the Jenkins job. This is to avoid issues where Jenkins restarts during a puppet run.
####service_name
The name of the jenkins service to restart when configuration changes are made. Defaults to 'jenkins'
##Reference
###Classes ####Public Classes
jenkins-job-builder
: Guides the installation of jenkins-job-builder ####Definitionsjenkins-job-builder::job
: Manages the configuration of a Jenkins job
##Limitations
This module is tested on the following platforms:
- CentOS 5
- CentOS 6
- Ubuntu 10.04.4
- Ubuntu 12.04.2
- Ubuntu 13.10
It is tested with the OSS version of Puppet only.
##Development
###Contributing
Please read CONTRIBUTING.md for full details on contributing to this project.