Table of contents

Plugin management


CloudBees Assurance Program

Introduction

The CloudBees Assurance Program adds stability and security to your Jenkins instance by automatically monitoring and optionally modifying Jenkins plugins for compatibility. Once a Jenkins instance is enrolled in the CloudBees Assurance Program, the Beekeeper Plugin monitors installed plugin versions and reports on the configuration to the verified and trusted CAP Collection. The Beekeeper Page visualizes the CAP Collection and through CAP enforcement, Beekeeper automatically configures plugin versions to further improve the stability and security of your Jenkins instance.

Note
If you are testing functionality known to require plugin versions newer than those currently identified as verified or trusted (for example, beta plugins), you have the option of disabling Beekeeper for the duration of your tests.

CAP Collection

The CAP Collection specifies the set of plugins, plugin versions, and plugin dependencies that are either verified or trusted, depending on how much they have been tested. Not only are these plugins independently stable, but they are tested as a whole (in aggregate) to ensure compatibility with each other and your Jenkins instance.

Beekeeper Page

The Beekeeper Page is the administrative dashboard of the CloudBees Assurance Program. It provides a centralized view of the monitored Jenkins plugins, recommended actions, and configuration options. The Beekeeper assessment of plugin status is displayed in a table on the Beekeeper page. If a plugin is installed at the CAP Collection version, that status is indicated in a column to the right of the plugin name. Any problematic plugins are listed separately under the heading "Issues found in analyzed components". A column entry in the "Issues" describes recommended action for those problematic plugins.

Configuration

The following configuration options are available, one of which (Enrollment) is selected by default:

  • Enroll this instance in the CloudBees Assurance Program

  • Allow automatic upgrades of plugins on restart

  • Allow automatic downgrades of plugins on restart

When enrolled in the CloudBees Assurance Program, two changes are immediately made to the Jenkins instance: the Beekeeper Page displays the status of the CAP Collection and the Update Center configuration is modified to the CloudBees CAP Update Center. The CloudBees CAP Update Center modifies the list of "Updates" and "Available" plugins in the plugin manager to hide plugins that would be incompatible with CAP (because of dependencies on version of plugins that are outside of CAP, etc).

Provided you do not uncheck the "Enroll this instance in the CloudBees Assurance Program" option, you can select automatic upgrade, automatic downgrade, or both. These actions will automatically install the CAP Collection version of plugins relative to the version of the currently installed plugins, so as to ensure that your instance runs efficiently and is free of potential plugin incompatibilities.

Note Although it is possible to enable "Allow automatic downgrades of plugins on restart", CloudBees does not generally recommend doing that.

CAP Enforcement

Automatic Plugin upgrade and plugin downgrade together comprise CAP Enforcement, which is only possible if your instance is enrolled in the CloudBees Assurance Program. When CAP Enforcement is applied, plugins are automatically modified to the CAP Envelope version. Plugins which are not part of the CAP Envelope are not changed.

Upgrade Assistant

Simplified Upgrades

Beekeeper Upgrade Assistant now allows users to review and install upgrades for verified components in the CloudBees Assurance Program. The Beekeeper Plugin provides, as of version 2.32.0.1, an upgrade assistant through which CloudBees can update the configuration between releases, so that fixes can be safely deployed, keeping the Jenkins instance safely in the recommended configuration. A Simplified Upgrade only involves plugin upgrades, never a core upgrade.

The Beekeeper Plugin will display an alert if there is an upgrade available:

monitor
Figure 1. Administrative Monitor advising of a new upgrade

By clicking on the Manage button, a new screen will be displayed showing information about the upgrade and the effect it will have on the running instance:

upgradeView
Figure 2. Information about the available upgrade and possible actions to perform

The information and actions offered are:

  1. The current version and revision.

  2. The offered revision.

  3. The plugin operations to perform with the current CAP configuration.

    1. A button (Upgrade Now) to install the upgrade with the current configuration.

  4. The plugin operations to perform if "Allow automatic upgrades of plugins on restart" config value was enabled. This information is only shown if the mentioned config value is disabled.

    1. A button (Update config and upgrade now) to install the upgrade after enabling "Allow automatic upgrades of plugins on restart". When performing a Simplified Upgrade, this is the recommended approach to take.

Once an upgrade is installed, the set of recommended plugins that is enforced by the CloudBees Assurance Program will automatically change so the report offered by the Beekeeper Plugin may automatically change from compliant to non-compliant. This would be completely normal because restarting the instance is required for the upgrade to complete. After the restart, the Beekeeper report should be back to its previous state. The following message prompts for restart:

success
Figure 3. Successful upgrade

When an upgrade fails, the Jenkins admin is informed and Retry and Cancel options are offered:

failed
Figure 4. Failed upgrade