CloudBees Free Enterprise Plugins

Skip to end of metadata
Go to start of metadata

Plugin Information

Plugin ID cloudbees-plugin-gateway Changes In Latest Release
Since Latest Release
Latest Release
Latest Release Date
Required Core
Dependencies
5.0
Feb 26, 2014
1.509
credentials (version:1.9.4)
async-http-client (version:1.7.8)
Source Code
Issue Tracking
Maintainer(s)
GitHub
Open Issues
Stephen Connolly (id: stephenconnolly)
Usage Installations 2013-Apr 91
2013-May 100
2013-Jun 109
2013-Jul 120
2013-Aug 132
2013-Sep 138
2013-Oct 153
2013-Nov 139
2013-Dec 118
2014-Jan 121
2014-Feb 110
2014-Mar 101

CloudBees Free Enterprise Plugins

This plugin installs free enterprise plugins from CloudBees. The following plugins are automatically installed:

  • Folders: easily organize your jobs
  • Backup to Cloud: backup your Jenkins into CloudBees cloud
  • Wasted Minutes: find out if you are short of slaves and need to add capacity to speed up builds
  • CloudBees Status: find out how much of the free CloudBees Jenkins capacity in the cloud is available for your use

Note: You will be asked to register for a free CloudBees account to use these plugins

(This plugin was formerly known as the CloudBees Plugin Gateway plugin)

The following is description of free plugins that are available from CloudBees:

Folders Plugin

Allows you to create folders so that you can create namespace differentiated jobs to represent hierarchies of jobs and manage large number of jobs. Lets walk through an example of creating a folder with 1 job and another folder in it. Start by adding a "New Job" and selecting the "Folder" radio button

Once created new jobs or other folders can be added to this folder:

The following image shows the "My folder" folder with a job and another folder in it.

This plugin is now open source. You can read more about folders here: CloudBees Folders Plugin

Backup to Cloud Plugin

Backup Jenkins through Jenkins into the cloud. This plugin is a modified version of Jenkins Enterprise plugin that lets to backup to CloudBees DEV@cloud service. The Jenkins Enterprise version of this plugin allows you to backup Jenkins on-premises.

Lets walk through an example of creating a backup every night of our entire Jenkins. Under "New Job" choose the "Backup Jenkins to CloudBees" as an option:

Now configure the various options. Here, we setup a backup to happen every night at 11:10 PM, store all build records, job configurations and system configurations and only keep the last 10 backups saved on an account on CloudBees. !backup-options.png|align=center

You can read more about Backup Plugin in the CloudBees Jenkins Enterprise User Guide

Wasted Minutes Plugin

This plugin keeps track of the number of minutes "wasted" by all jobs waiting for an executor. If administrators find that the minutes keep stacking up, they can add more capacity. The plugin shows up on the Jenkins dashboard. Every time a build is fired and the job is waiting in the queue for an executor, the amount of time the job wastes waiting for the executor is displayed in the dashboard. At this point, you can add more slaves or offload jobs to CloudBees DEV@cloud.

CloudBees Deployer Plugin

The deployer plugin lets users deploy their build artifacts to the CloudBees PaaS (RUN@cloud) service. More information can be found here

CloudBees Status Plugin

This plugin gives users an overview of the applications deployed on CloudBees, the number of free build minutes available on CloudBees DEV@cloud. Here, we can see that there are 300 build minutes on "thesinghs" account that should be utilized.

Installation/Uninstallation

Installation

This plugin can be installed without restart, but will require a restart to complete installation. 

  1. Install the CloudBees Free Enterprise Plugins plugin.
  2. Install the plugin without restart.
  3. Once the plugin is installed, it will add the CloudBees proprietary update center to the list of update centers used by your Jenkins instance as well as the certificate used to validate that update center's certificate.
  4. You will need to browse to at least one Jenkins screen. That will trigger the download of the update center metadata from the CloudBees proprietary update center, and the subsequent download of the CloudBees plugins
  5. When all the plugins have been downloaded, a Safe Restart will be triggered, or if the Servlet Container that your Jenkins instance is running in does not support safe restarts, a notice bar will be displayed to tell you to restart your Jenkins instance.
  6. When your Jenkins instance restarts, you will be asked to Register your system with CloudBees. This is a necessary condition for using some of the CloudBees proprietary plugins.

    If you already have a CloudBees account, you can provide the details of that account to register your instance against that account. [Note: There is no limit to the number of FREE licenses that you can register.]

    If you do not want to register your system with CloudBees there is an option for removing the CloudBees plugins that require a FREE license for use.

    You click on the red delete icons to remove the license enforcement check or the license manager plugin. A restart will be required if you remove any of the license enforcement checks or the license manager plugin.
  7. Once you have completed the registration process your Jenkins instance will complete startup as normal. 

Uninstallation

To uninstall, simply disable or delete the CloudBees Free Enterprise Plugins plugin and an any of the proprietary plugins that you want. If you disable only the CloudBees Free Enterprise Plugins you will no longer be able to access the CloudBees proprietary update center. If you disable or delete only the CloudBees proprietary plugins, they will not be reinstalled unless you upgrade the CloudBees Free Enterprise Plugins plugin to a newer version.

Version History

Version 4.2 (Sep 2, 2013)

  • Upgrade required Jenkins core to 1.480.3
  • Upgrade minimum version of installed plugins to latest releases.

Version 4.1 (Jul 30, 2013)

  • Upgrade required Jenkins core to 1.466
  • Use ACL.impersonate to avoid a race condition when elevating privileges.
  • Use a lock on UpdateCenter to ensure changes are atomic.

Version 4.0 (Apr 10, 2013)

  • Update to version 4.0 of the cloudbees-license plugin to resolve classloading conflicts with bouncycastle

Version 1.11 (Mar 14, 2013)

  • Upgrade required core to 1.447 as this is the minimum required for the current versions of the free plugins
  • Upgrade async-http-client dependency to 1.7.8
  • Upgrade credentials dependency to 1.3.1
  • Ensure the cloudbees-credentials plugin does not get disabled (while the free plugins are installed) as this breaks the free plugins
  • Ensure the cloudbees-registration plugin does not get disabled (while the free plugins are installed) as this breaks the free plugins
  • Upgrade the cloudbees-license plugin to latest
  • Upgrade the free-license plugin to latest
  • Upgrade the nectar-license plugin to latest so that Jenkins Enterprise in-place upgrades work.
  • Upgrade the cloudbees-folder plugin to latest
  • Upgrade the cloudbees-wasted-minutes-tracker to latest
  • Upgrade the cloudbees-deployer-plugin to latest
  • Fix plugin to work around breaking API change in Jenkins core
  • If the safe restart is cancelled by the user, don't display the banner

Version 1.10 (Jul 18, 2012)

  • Upgrade to Folders version 3.2 to pick up the ability to move items between folders
  • Upgrade to CloudBees Deployer version 3.7.8 to pick up a fix for the 'Deploy Now' functionality when the master does not have any executors and correspondingly does not have a Maven Home which was giving a NPE with the token expansion functionality for Maven2 project type based 'Deploy Now' deployments

Version 1.9 (Jul 16, 2012)

  • Fix registration on Jenkins 1.474 or newer.

Version 1.8 (Jul 9, 2012)

  • Rebranded from "CloudBees Plugin Gateway plugin" to "CloudBees Free Enterprise Plugins"
  • Updated base versions of the Free Enterprise plugins to pull in the latest fixes for people installing initially.

Version 1.7 (Jun 1, 2012)

  • Some authentication plugins do not propagate ACL.SYSTEM correctly to system threads, so this now assigns ACL.SYSTEM for the installer thread while installing the CloudBees plugins.

Version 1.6 (Jun 1, 2012)

  • Added some diagnostics when plugin installation fails
  • Only display the progress of CloudBees plugin installation to administrators

Version 1.5 (May 15, 2012)

  • Update the required minimum version of the CloudBees Deployer Plugin

Version 1.4 (May 15, 2012)

  • Fix installation when Jenkins is running on JBoss as a Servlet container.

Version 1.3 (May 11, 2012)

  • Updated core plugin versions.

Version 1.2 (Apr 27, 2012)

  • Fixes issue with installing the plugin when Jenkins is not on the ROOT context path.

If you are stuck with version 1.1 installed and your Jenkins installation is not on the ROOT context path, here is the procedure to follow to get your system upgraded:

    1. First you need to disable all the plugins that require the cloudbees-license. When the registration screen is active visit the following URL:
      http://jenkins-hostname:port/context-path/disable?plugin=cloudbees-license
      

      where you have replaced the _http://jenkins-hostname:port/context-path_ with the correct root URL for your Jenkins instance.

    2. Then restart Jenkins. It should start up with some of the cloudbees plugins that do not require a license installed.
    3. Clear your browser cache. It cannot be stated how important this step is.
    4. Go to the Manage Jenkins | Manage Plugins | Advanced tab and select the "Check now" option.
    5. Go to the Manage Jenkins | Manage Plugins | Updates tab and select the "CloudBees Plugin Gateway Plugin" ensuring that you are selecting version 1.2. Select the option to restart after the plugin is installed.
    6. When Jenkins has restarted, the plugin will then proceed as before to download the newer plugins, and restart Jenkins again. At this point the registration screen should work.
  • Note: The reasons for the rather complex procedure above are:
    • Jenkins only checks for update center metadata being changed once every 24 hours.
    • Jenkins downloads the update center metadata via the browser rather than trying to connect to the update center itself, the browser's cache can result in incorrect metadata being picked up.
    • When Jenkins installs a plugin it will install all of that plugin's dependencies even if it has just immediately prior installed the plugin's dependencies, thus our bootstrap of all the required plugins can be hindered.
  • This above procedure is not required if you have Jenkins's servlet container using a ROOT context as you would have been able to register the system and receive a license already.  

Version 1.1 (Apr 17, 2012)

  • Fixed issue with installing the CloudBees Deployer plugin.

Version 1.0 (Apr 17, 2012)

  • Initial release version.

Labels

Edit
plugin-misc plugin-misc Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Add Comment