Puppet Class: jenkins_job_builder

Inherits:
jenkins_job_builder::params
Defined in:
manifests/init.pp

Overview

Class: jenkins_job_builder

The purpose of this module is to install the jenkins_job_builder tool to manage jenkins jobs

Requirements/Dependencies

Currently reequires the puppetlabs/stdlib module on the Puppet Forge in order to validate much of the the provided configuration.

Parameters

version

The version of jenkins_job_builder 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.

timeout

The connection timeout (in seconds) to the Jenkins server.

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.

install_from_git

Boolean, defaults to false. This will install JJB itself from git, but system pkgs will satisfy dependencies. The behavior when install_from_git and install_from_pkg are false is to install from pip

install_from_pkg

Boolean, defaults to false. Only allow system packages to satisfy installation sources. Useful for some environments that require this. The behavior when install_from_git and install_from_pkg are false is to install from pip

=== Examples

Installing jenkins_job_builder to a specified version

class { ‘jenkins_job_builder’:

version => 'latest'

}

Parameters:

  • version (Any) (defaults to: $jenkins_job_builder::params::version)
  • jobs (Any) (defaults to: $jenkins_job_builder::params::jobs)
  • user (Any) (defaults to: $jenkins_job_builder::params::user)
  • password (Any) (defaults to: $jenkins_job_builder::params::password)
  • timeout (Any) (defaults to: $jenkins_job_builder::params::timeout)
  • hipchat_token (Any) (defaults to: $jenkins_job_builder::params::hipchat_token)
  • jenkins_url (Any) (defaults to: $jenkins_job_builder::params::jenkins_url)
  • service (Any) (defaults to: 'jenkins')
  • install_from_git (Any) (defaults to: $jenkins_job_builder::params::install_from_git)
  • install_from_pkg (Any) (defaults to: $jenkins_job_builder::params::install_from_pkg)
  • git_revision (Any) (defaults to: $jenkins_job_builder::params::git_revision)
  • git_url (Any) (defaults to: $jenkins_job_builder::params::git_url) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'manifests/init.pp', line 53

class jenkins_job_builder(
  $version          = $jenkins_job_builder::params::version,
  $jobs             = $jenkins_job_builder::params::jobs,
  $user             = $jenkins_job_builder::params::user,
  $password         = $jenkins_job_builder::params::password,
  $timeout          = $jenkins_job_builder::params::timeout,
  $hipchat_token    = $jenkins_job_builder::params::hipchat_token,
  $jenkins_url      = $jenkins_job_builder::params::jenkins_url,
  $service          = 'jenkins',
  $install_from_git = $jenkins_job_builder::params::install_from_git,
  $install_from_pkg = $jenkins_job_builder::params::install_from_pkg,
  $git_revision     = $jenkins_job_builder::params::git_revision,
  $git_url          = $jenkins_job_builder::params::git_url,

) inherits jenkins_job_builder::params {

  validate_re($::osfamily,'RedHat|Debian',"${::osfamily} not supported")
  validate_hash($jobs)
  validate_string($user)
  validate_string($password)
  validate_string($hipchat_token)
  validate_string($jenkins_url)
  validate_string($version)
  validate_string($git_revision)
  validate_string($git_url)
  validate_bool($install_from_git)
  validate_bool($install_from_pkg)

  if count([$install_from_git, $install_from_pkg], true) > 1 {
    fail("A single primary install source must be selected for ${name}")
  }

  # only validate optional params if they are present
  if $timeout {
    validate_integer($timeout)
  }

  class {'::jenkins_job_builder::install': } ->
  class {'::jenkins_job_builder::config': } ->

  Class['jenkins_job_builder']
}