CloudBees
Home
Wiki
Contents
Index
Search
Jenkins Enterprise by CloudBees 14.11 Install Guide
Copyright
Introducing Jenkins Enterprise by CloudBees
Introduction
About Jenkins Enterprise and Nectar
About Nectar
Releases
Hardware and Software Requirements
Upgrading Jenkins Enterprise
How to report problems on Jenkins Enterprise?
Creating Custom Extensions to Jenkins Enterprise
Additional Resources
Jenkins Enterprise by CloudBees 14.11 User Guide
Copyright
Introducing Jenkins Enterprise by CloudBees
Introduction
Large Install Plugins
Optimized Utilization Plugins
Security Plugins
Backup Plugin
Introduction
Taking Backup
Configuring Backup
Restoring From Backup
Even Scheduler Plugin
Introduction
Default Jenkins Behavior
Even Loading Strategy
Using Even Scheduler Plugin
Selecting Global Preference
Selecting Per-Job Preference
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
Role-Based Access Control Plugin
Templates Plugin
Folders Plus Plugin
Introduction
Controlled slaves
Configuring Controlled slaves
Troubleshooting
Issues with third-party plugins
Issues with builds being blocked forever
Miscellaneous features
Moving
Health reports
Icons
Environment variables
List view column
Restricting children
Label Throttle Build Plugin
Introduction
Overview
Setting up the Label Throttle Build plugin
Configuring a label throttle
Fast Archiver Plugin
Introduction
Overview
Setting up Fast Archiver
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
Skip Next Build Plugin
Introduction
Using the Skip Next Build plugin
Advanced usage
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
Generate shell script via Jelly/Groovy
Predefine variables for shell/batch script
Template evaluation timing
Job Templates
Configuration
Folders Template
What a folder template controls and what it doesn’t
Folder features that work well with templates
Restrict child type in a folder
Environment variables
Model attribute list view column
Auxiliary Template
Accessing attributes of auxiliary instances
Templates Defined in Folders
Transformer Reference
Jelly-based transformation
Variable Bindings
Groovy template transformation
Variable Bindings
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
Miscellaneous features
View Creation Filter plugin
Groovy View plugin
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
VMWare Pool Auto-Scaling Plugin
Introduction
Configuration
Machine Centers
Machine Pools
Static Pools
Folder Pools
Power Cycling
Power-on Wait Conditions
Building Jobs on Virtual Machines
Reserving a Virtual Machine for a build
Taking virtual machines offline
Plugin Usage Plugin
Introduction
Using the Plugin Usage plugin
Limitations
Wikitext Security Plugin
Introduction
Overview
Supported Wiki Markup Languages
Setting up the Wikitext Security plugin
Using the Wikitext Security plugin
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
Secure Copy Plugin
Introduction
Creating an exported permalink
High Availability
Introduction
Tutorial
Using haproxy as a reverse proxy
Components of Jenkins Enterprise HA
Jenkins Enterprise by CloudBees WAR file
Network configuration
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
NFS
DRBD
HTTP reverse proxy
IP aliasing
haproxy
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
Workflow Plugin Suite
Introduction
Checkpoints
Restoring files
Stage View
Restart Aborted Builds Plugin
Introduction
Using the Restart Aborted Builds plugin
Long-Running Build Plugin
Introduction
Using the Long-Running Build plugin
Limitations
Nodes Plus Plugin
Introduction
Node owners
Configuring Node owners
Support Plugin
Introduction
Generating a bundle
Getting a bundle from the CLI
Getting a bundle when Jenkins will not start
Controlling who can generate Support bundles
Consolidated Build View Plugin
Introduction
Using the Consolidated Build View plugin
Quiet Start Plugin
NIO SSH Slaves Plugin
Introduction
Using the NIO SSH Slaves plugin
Monitoring Plugin
Introduction
Basic usage
Standard metrics dashboard
Creating a Standard metrics dashboard
Metrics based alerts
Creating some basic alerts
Managing alerts
Advanced usage
Custom metrics dashboards
Creating a custom metrics dashboard
Reference
Standard metrics
System and Java Virtual Machine metrics
Web UI metrics
Jenkins specific metrics
Standard health checks
Pull-Request Builder for GitHub Plugin
Introduction
Overview
Setting up Pull-Request Builder for GitHub
Using Pull-Request Builder for GitHub
Jenkins Enterprise by CloudBees 14.5 Install Guide
Copyright
Introducing Jenkins Enterprise by CloudBees
Introduction
About Jenkins Enterprise and Nectar
About Nectar
Releases
Hardware and Software Requirements
Upgrading Jenkins Enterprise
How to report problems on Jenkins Enterprise?
Creating Custom Extensions to Jenkins Enterprise
Additional Resources
Jenkins Enterprise by CloudBees 14.5 User Guide
Copyright
Introducing Jenkins Enterprise by CloudBees
Introduction
Large Install Plugins
Optimized Utilization Plugins
Security Plugins
Backup Plugin
Introduction
Taking Backup
Configuring Backup
Restoring From Backup
Even Scheduler Plugin
Introduction
Default Jenkins Behavior
Even Loading Strategy
Using Even Scheduler Plugin
Selecting Global Preference
Selecting Per-Job Preference
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
Role-Based Access Control Plugin
Templates Plugin
Folders Plus Plugin
Introduction
Controlled slaves
Configuring Controlled slaves
Troubleshooting
Issues with third-party plugins
Issues with builds being blocked forever
Miscellaneous features
Moving
Health reports
Icons
Environment variables
List view column
Restricting children
Label Throttle Build Plugin
Introduction
Overview
Setting up the Label Throttle Build plugin
Configuring a label throttle
Fast Archiver Plugin
Introduction
Overview
Setting up Fast Archiver
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
Skip Next Build Plugin
Introduction
Using the Skip Next Build plugin
Advanced usage
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
Generate shell script via Jelly/Groovy
Predefine variables for shell/batch script
Template evaluation timing
Job Templates
Configuration
Folders Template
What a folder template controls and what it doesn’t
Folder features that work well with templates
Restrict child type in a folder
Environment variables
Model attribute list view column
Auxiliary Template
Accessing attributes of auxiliary instances
Templates Defined in Folders
Transformer Reference
Jelly-based transformation
Variable Bindings
Groovy template transformation
Variable Bindings
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
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
VMWare Pool Auto-Scaling Plugin
Introduction
Configuration
Machine Centers
Machine Pools
Static Pools
Folder Pools
Power Cycling
Power-on Wait Conditions
Building Jobs on Virtual Machines
Reserving a Virtual Machine for a build
Taking virtual machines offline
Plugin Usage Plugin
Introduction
Using the Plugin Usage plugin
Limitations
Wikitext Security Plugin
Introduction
Overview
Supported Wiki Markup Languages
Setting up the Wikitext Security plugin
Using the Wikitext Security plugin
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
Secure Copy Plugin
Introduction
Creating an exported permalink
High Availability
Introduction
Tutorial
Using haproxy as a reverse proxy
Components of Jenkins Enterprise HA
Jenkins Enterprise by CloudBees WAR file
Network configuration
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
NFS
DRBD
HTTP reverse proxy
IP aliasing
haproxy
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
Restart Aborted Builds Plugin
Introduction
Using the Restart Aborted Builds plugin
Long-Running Build Plugin
Introduction
Using the Long-Running Build plugin
Limitations
Nodes Plus Plugin
Introduction
Node owners
Configuring Node owners
Support Plugin
Introduction
Generating a bundle
Getting a bundle when Jenkins will not start
Controlling who can generate Support bundles
Consolidated Build View Plugin
Introduction
Using the Consolidated Build View plugin
NIO SSH Slaves Plugin
Introduction
Using the NIO SSH Slaves plugin
Monitoring Plugin
Introduction
Basic usage
Standard metrics dashboard
Creating a Standard metrics dashboard
Metrics based alerts
Creating some basic alerts
Managing alerts
Advanced usage
Custom metrics dashboards
Creating a custom metrics dashboard
Reference
Standard metrics
System and Java Virtual Machine metrics
Web UI metrics
Jenkins specific metrics
Standard health checks
Pull-Request Builder for GitHub Plugin
Introduction
Overview
Setting up Pull-Request Builder for GitHub
Using Pull-Request Builder for GitHub
Jenkins Enterprise by CloudBees 14.5 Install Guide
Next
Jenkins Enterprise by CloudBees 14.5 Install Guide
Table of Contents
1. Introducing Jenkins Enterprise by CloudBees
Introduction
About Jenkins Enterprise and Nectar
About Nectar
Releases
Hardware and Software Requirements
Upgrading Jenkins Enterprise
How to report problems on Jenkins Enterprise?
Creating Custom Extensions to Jenkins Enterprise
Additional Resources
List of Tables
1.1.
List of Jenkins Enterprise Releases in Reverse Chronological Order
CloudBees