Beekeeper Upgrade Assistant

Working with the CloudBees Assurance Program, Beekeeper Upgrade Assistant (Beekeeper) provides a centralized view of monitored plugins, as well as recommended actions and configuration options.

Beekeeper allows administrators to review and install upgrades for plugins. Administrators can set up automatic upgrades or downgrades of plugins to keep their verified plugins up to date with the versions that the CloudBees Assurance Program recommends.

When your instance is enrolled in the CloudBees Assurance Program, Beekeeper displays the current compliance status, and the Update Center configuration is modified to show the CloudBees Assurance Program Update Center instead of the Jenkins Update Center.

How Beekeeper provides upgrade notifications

Beekeeper regularly evaluates the state of the instance to ensure compliance with the CloudBees Assurance Program and alerts administrators when plugin upgrades are available.

Before any upgrade, CloudBees recommends creating a backup of the instance in case there is an unexpected failure during the upgrade process.

When an upgrade is available, Beekeeper adds an alert on the Manage Jenkins screen and in the header on other screens.

Beekeeper alerting to an available upgrade
Figure 1. Upgrade message from header

Select More Info to go to the Upgrade Available screen to view details about the available upgrade.

Upgrade Available
Figure 2. Upgrade Available screen

The upgrade page shows:

  1. The current version and the offered release.

  2. A link to Release Notes describing the new features, fixes, and known issues.

  3. The results of a simulation of the upgrade, including changes in core and/or plugin versions.

  4. A link to documentation and downloads.

Viewing the Beekeeper Upgrade Assistant

To view the Beekeeper Upgrade Assistant:

  1. In your CloudBees product, go to Manage Jenkins > Beekeeper Upgrade Assistant.

Beekeeper after upgrade
Figure 3. Successful upgrade pending restart

Once an upgrade is installed, the recommended plugins that the CloudBees Assurance Program enforces are automatically changed, so the report offered by the Beekeeper plugin may automatically change from compliant to non-compliant. This is normal because restarting the instance is required for the upgrade to complete. After the restart, the Beekeeper report should return to its previous state.

If an upgrade fails, Beekeeper notifies the administrator and allows the upgrade to be canceled.

Failed upgrade
Figure 4. Failed upgrade

Enabling automatic upgrades of plugins

Enabling automatic plugin upgrades can help administrators to automatically keep their verified plugins up to date with the versions that the CloudBees Assurance Program recommends.

If automatic upgrades are not enabled, Beekeeper indicates when your instance becomes out of compliance with the verified plugins in the CloudBees Assurance Program. You can then manually upgrade the plugins that are out of compliance.

To enable automatic upgrades of plugins:

  1. In your CloudBees product, go to Manage Jenkins > Beekeeper Upgrade Assistant.

  2. On the left, select CAP Configuration.

  3. Verify that Enroll this instance in the CloudBees Assurance Program is selected.

  4. Select Allow automatic upgrades of plugins on restart.

  5. Select Save.

  6. Restart the instance to allow Beekeeper to perform any required upgrades.

Enabling automatic downgrades of plugins

You can enable Beekeeper to automatically downgrade any installed plugins that exceed the versions that the CloudBees Assurance Program recommends. While this option affects only the plugins considered to be verified and part of the CloudBees Assurance Program, using this option may cause unintended side effects on stability if the instance has been taking advantage of features and configurations provided by more recent versions of those plugins.

CloudBees does not recommend that you enable automatic plugin downgrades. If you choose to use this option, you should back up your instance before you enable it.

To enable automatic downgrades of plugins:

  1. In your CloudBees product, go to Manage Jenkins > Beekeeper Upgrade Assistant.

  2. On the left, select CAP Configuration.

  3. Verify that Enroll this instance in the CloudBees Assurance Program is selected.

  4. Select Allow automatic downgrades of plugins on restart.

  5. Select Save.

  6. Restart the instance.

Incremental upgrades

The CloudBees Assurance Program can provide incremental upgrades, which include a subset of functionality delivered prior to the full product release. For example, incremental upgrades may deliver plugin security fixes or important new features that can’t wait until the next full product release.

Incremental upgrades appear in Beekeeper with a message that a new revision is available. The upgrade page shows the current and offered revisions as well as a simulation of the changes.

Depending on the plugins you have installed, a change may not be needed in the running instance. CloudBees recommends that you choose the upgrade even in those cases so that Beekeeper uses the upgraded configuration.

Incremental upgrades
Figure 5. Incremental upgrades

If you perform an initial installation of a version for which an incremental upgrade is available and the instance is connected to CloudBees Update Center, you have the option to apply the upgrade from the setup wizard. If you decide to install the incremental upgrade from the setup wizard, depending on the affected plugins, an additional restart may be required at the end of the installation process. If you decide to skip the upgrade in the setup wizard, it is available from the Beekeeper Upgrade Assistant for you to install when it’s convenient.

If you need to automatically skip this behavior, set the system property cb.BeekeeperProp.disableIncrementalWizard to true.

Beekeeper system properties

Property Default Description

cb.BeekeeperProp.noFullUpgrade

false

Set to true to not check for full upgrades. Does not disable checks for security fixes to currently installed plugins, even if the security fixes for those currently installed plugins require a full upgrade. An older installation that includes a plugin with a known security issue will be shown as a Beekeeper warning. The solution to that warning may require a full upgrade, but with noFullUpgrade=true, that upgrade will not be included in the warnings

cb.BeekeeperProp.autoInstallIncremental

false

Set to true to install incremental upgrades automatically at startup

cb.BeekeeperProp.disableIncrementalWizard

false

Disable checking for incremental releases during the setup wizard

com.cloudbees.jenkins.cjp.installmanager.CJPPluginManager.allRequired

false

If true, every plugin in the envelope will be considered required when CloudBees Assurance Program is enabled

com.cloudbees.jenkins.cjp.installmanager.CJPPluginManager.suggestedRequired

false

If true, all suggested plugins (as defined in the setup wizard) in the envelope will be considered required when CloudBees Assurance Program is enabled.