https://github.com/valtri/cesnet-jenkins_node

Jenkins Node Puppet Module
https://github.com/valtri/cesnet-jenkins_node

Last synced: about 1 month ago
JSON representation

Jenkins Node Puppet Module

• Host: GitHub
• URL: https://github.com/valtri/cesnet-jenkins_node
• Owner: valtri
• License: mit
• Created: 2015-11-10T23:01:00.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2019-10-23T17:42:30.000Z (over 6 years ago)
• Last Synced: 2024-04-25T02:41:49.045Z (about 2 years ago)
• Language: Puppet
• Size: 34.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown
  • Changelog: CHANGELOG
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Jenkins Node Puppet Module

[![Build Status](https://travis-ci.org/valtri/cesnet-jenkins_node.svg?branch=master)](https://travis-ci.org/valtri/cesnet-jenkins\_node) [![Puppet Forge](https://img.shields.io/puppetforge/v/cesnet/jenkins_node.svg)](https://forge.puppetlabs.com/cesnet/jenkins\_node)

#### Table of Contents

1. [Module Description - What the module does and why it is useful](#module-description)

2. [Setup - The basics of getting started with jenkins\_node](#setup)

    * [What jenkins\_node affects](#what-jenkins_node-affects)

    * [Setup requirements](#setup-requirements)

    * [Beginning with jenkins\_node](#beginning-with-jenkins_node)

3. [Usage - Configuration options and additional functionality](#usage)

4. [Reference - An under-the-hood peek at what the module is doing and how](#reference)

    * [Module Parameters (`jenkins_node` class)](#parameters)

5. [Limitations - OS compatibility, etc.](#limitations)

6. [Development - Guide for contributing to the module](#development)

## Module Description

Jenkins node setup for building packages in chroot environment using mock or pbuilder.

## Setup

### What jenkins\_node affects

* Packages: Java, build tools

* Sudo: pbuilder under *jenkins* user, cleanups

* Files:

 * config files for dput, mini-dinstall

 * user rpm macros

 * credentials (gpg, ssh)

 * build scripts checkout

 * helper *~jenkins/.puppet-\** files

* SELinux setup

* cron:

 * refresh chroot images

### Setup Requirements

gnupg directory with key needs to be prepared locally at each Jenkins node or at the puppet master.

## Usage

    class{'jenkins_node':

      gpg_dir      => [

        "puppet:///extra_files/${::fqdn}/gnupg",

        "puppet:///extra_files/cluster-${::cluster}/gnupg",

      ],

      gpg_identity => 'Jenkins Builder ',

      gpg_keyid => '64fa8786',

      gpg_keys => {

        '64fa8786' => 'http://scientific.zcu.cz/repos/jenkins-builder.asc',

      },

    }

### SSH keys

SSH keys must be specified separately. For example:

    ssh_authorized_key{'root@myriads.zcu.cz':

      user => 'jenkins',

      type => 'ssh-dss',

      key => 'AAAA...',

    }



## Reference

### Classes

* [**`jenkins_node`**](#class-jenkins_node): Jenkins Node

### Resources

* `jenkins_node::gpgkey_rpm` (internal): Import GPG key into rpm



###`jenkins_node` class



#### Parameters

#####`homedir`

Jenkins user home directory. Default: '/var/lib/jenkins'.

#####`gpg_dir`

GnuPG config directory with key pair. Default: undef.

Note, it is passed directly to source of *file* type.

#####`gpg_identity`

gnupg identity in the form of "Name <email\_address>". Default: "Jenkins Builder <jenkins@${::fqdn}>".

Used for rpm.

#####`gpg_keyid`

GPG key ID. Default: undef.

#####`gpg_keys`

Hash of GPG key ID and GPG key URL pairs. Default: undef.

Example:

    gpg_keys => {

      '64fa8786' => 'http://scientific.zcu.cz/repos/jenkins-builder.asc'

    }

#####`jenkins_principals`

Array of Kerberos principals to authenticate to Jenkins node into *jenkins* user. Default: undef.

#####`parameters`

Hash of parameters for build scripts. Default: undef.

#####`platforms`

List of supported platforms. Default: (autodetect).

#####`refresh_enable`

Enable creating and refreshing chroot images. Default: true.

#####`refresh_hour`

#####`refresh_minute`

#####`refresh_month`

#####`refresh_monthday`

#####`refresh_weekday`

Parameters for the refresh image cron job. Default: 0, 0, *, *, 0.



##Limitations

### RHEL 5

RHEL 5 platform is not supported.

It is possible to build for RHEL 5 though:

* any other RedHat-like platform can be used for the build node (it is used mock tool)

* there is limit on the GPG key size (see below)

### Build platforms

Some build platforms can be collocated on the single node, but each "OS family" need its own machine.

Build "OS families":

* Debian

* Ubuntu

* Fedora/EPEL

Different GPG key:

* separated build machine must be used when different GPG key is needed for some platform



##Development

* Repository: [https://github.com/valtri/cesnet-jenkins\_node](https://github.com/valtri/cesnet-jenkins_node)

* Tests: see *.travis.yml*

* Email: František Dvořák <valtri@civ.zcu.cz>