Jenkins Enterprise by CloudBees 14.5 User Guide

Table of Contents

1. Introducing Jenkins Enterprise by CloudBees

Introduction

Large Install Plugins

Optimized Utilization Plugins

Security Plugins

2. Backup Plugin

Introduction

Taking Backup

Configuring Backup

Restoring From Backup

3. Even Scheduler Plugin

Introduction

Default Jenkins Behavior

Even Loading Strategy

Using Even Scheduler Plugin

Selecting Global Preference

Selecting Per-Job Preference

4. Folders Plugin

Introduction

Overview

Setting up the Folders plugin

Using the Folders plugin

A sample taxonomy with the Folders plugin

Using folders with other Jenkins Enterprise plugins

5. Folders Plus Plugin

Introduction

Controlled slaves

Configuring Controlled slaves

Troubleshooting

Miscellaneous features

Moving

Health reports

Icons

Environment variables

List view column

Restricting children

6. Label Throttle Build Plugin

Introduction

Overview

Setting up the Label Throttle Build plugin

Configuring a label throttle

7. Fast Archiver Plugin

Introduction

Overview

Setting up Fast Archiver

8. Role Based Access Control Plugin

Introduction

Concepts and Definitions

Setting up the Role Based Access Control plugin

Enabling the authorization strategy

Configuring and managing roles

Configuring and managing groups

Configuring and managing role filters

Example Configurations

Instance owned by one cross-functional team

Instance shared by multiple cross-functional teams

Instance shared by multiple single-function teams

Secret projects on a shared instance

Scripting RBAC

group-membership

create-group

delete-group

group-role-assignments

list-groups

Troubleshooting

Recovering from a lock-out

Completely resetting the configuration

Finding hidden projects

9. Skip Next Build Plugin

Introduction

Using the Skip Next Build plugin

Advanced usage

10. Template Plugin

Introduction

Tutorial: Hello world builder

Define a template

Use a template

Changing the template definition

Tutorial: job template

Creating a template

Defining transformation

Concepts

Models

Attributes

Attribute Type Reference

Text field

Text area

Checkbox

Nested Auxiliary Models

Select a string among many

Computed Value

Model Transformer

Heterogeneous components from descriptors

Heterogeneous components from descriptors (one instance per descriptor)

Single Describable object

Select another model

Select Item

Select Tool Installation

Select Credentials

Builder Template

Creating a new Builder Template

Defining a Transformer

Job Templates

Configuration

Folders Template

What a folder template controls and what it doesn’t

Folder features that work well with templates

Auxiliary Template

Accessing attributes of auxiliary instances

Templates Defined in Folders

Transformer Reference

Jelly-based transformation

Groovy template transformation

Template Security

Script Approval

Groovy Sandboxing

Advanced Template Techniques

Navigating around objects in context

Instance to Item, Item to Instance

Accessing containing folder

Accessing a folder template’s attributes from a child job template

Scripting Templates

REST API operations

CLI commands

Groovy scripting

11. Validated Merge Plugin

Introduction

Tutorial

Server setup

Client setup

Mental picture of the validated merge

Sending changes and have them validated

Access Control

Permissions

Accessing the gate repository

Pushing to the upstream repository

Reusing a job between CI and validated merge

Dealing with post-build push failure

Refs in the gate repository

Tags

Branches

12. VMWare Pool Auto-Scaling Plugin

Introduction

Configuration

Machine Centers

Machine Pools

Building Jobs on Virtual Machines

Reserving a Virtual Machine for a build

Taking virtual machines offline

13. Plugin Usage Plugin

Introduction

Using the Plugin Usage plugin

Limitations

14. Wikitext Security Plugin

Introduction

Overview

Supported Wiki Markup Languages

Setting up the Wikitext Security plugin

Using the Wikitext Security plugin

15. Update Center Plugin

Introduction

Creating an Update Center

Using the update center

Info tab

Core tab

Plugins tab

Tools tab

Upload Core tab

Upload Plugin tab

Maintenance

Pull new versions

Pull everything

Reference Information

Version number rules

Other tasks

Removing a custom update center as an updates source from a Jenkins

16. Secure Copy Plugin

Introduction

Creating an exported permalink

17. High Availability

Introduction

Tutorial

Using haproxy as a reverse proxy

Components of Jenkins Enterprise HA

Jenkins Enterprise by CloudBees WAR file

Jenkins Enterprise HA proxy WAR

Jenkins Enterprise HA monitor tool

Fail-over behavior in more details

Sanity checking the environment while acting as primary

Requirements from the environment

Storage

HTTP reverse proxy

Network

Troubleshooting and Tips

Nodes don’t form a cluster

Using a newer HA version on top of Jenkins Enterprise

Using a stand-by node as a slave

Copying a Jenkins installation

18. Restart Aborted Builds Plugin

Introduction

Using the Restart Aborted Builds plugin

19. Long-Running Build Plugin

Introduction

Using the Long-Running Build plugin

Limitations

20. Nodes Plus Plugin

Introduction

Node owners

Configuring Node owners

21. Support Plugin

Introduction

Generating a bundle

Getting a bundle when Jenkins will not start

Controlling who can generate Support bundles

22. Consolidated Build View Plugin

Introduction

Using the Consolidated Build View plugin

23. NIO SSH Slaves Plugin

Introduction

Using the NIO SSH Slaves plugin

24. Monitoring Plugin

Introduction

Basic usage

Standard metrics dashboard

Creating a Standard metrics dashboard

Metrics based alerts

Advanced usage

Custom metrics dashboards

Reference

Standard metrics

Standard health checks

25. Pull-Request Builder for GitHub Plugin

Introduction

Overview

Setting up Pull-Request Builder for GitHub

Using Pull-Request Builder for GitHub