Upgrading for the new CloudBees License Certificate

Article ID:360042376431
6 minute readKnowledge base

Issue Summary

If you are running a CloudBees Jenkins-based product with a version earlier than 2.176.1.4, your CloudBees software will not be compatible with licenses generated with the new certificate described in Preparing for the new CloudBees License Certificate. You must upgrade your CloudBees License Manager plugin to a version compatible with the new license certificate. Then you will be able to install a new license generated by the new certificate.

If you are running a CloudBees Jenkins-based product with a version of 2.176.1.4 or later, your software is already compatible with the new certificate. The only action needed in this case is to install a new license generated by the new certificate, as covered in Preparing for the new CloudBees License Certificate.

Locate the required version of the CloudBees License Manager Plugin

Find your current product version in the table below to see what version of the CloudBees License Manager plugin is required to enable compatibility with the new license certificate. CloudBees recommends applying the incremental upgrade revision indicated for your product version. You can also install the plugin manually as indicated in the instructions below. Either way, you will want to ensure that your system is running the target CloudBees License Manager plugin version indicated for your product version.

Product version

Original CloudBees License Manager plugin version

Target incremental upgrade

Target CloudBees License Manager plugin version

2.176.1.4 and later

9.34 and later

No update required

No update required

2.164.3.2

9.33

2.164.3.2-4

9.33.1

2.164.2.1

9.33

2.164.2.1-3

9.33.1

2.164.1.2

9.33

2.164.1.2-3

9.33.1

2.150.3.2

9.33

2.150.3.2-5

9.33.1

2.150.2.3

9.32

2.150.2.3-3

9.32.1

2.138.3.1

9.31

2.138.3.1-3

9.31.1

2.138.4.3

9.32

2.138.4.3-4

9.32.1

2.138.2.2

9.28

2.138.2.2-3

9.28.1

2.138.1.2

9.27

2.138.1.2-3

9.27.1

2.121.3.1

9.27

2.121.3.1-3

9.27.1

2.121.2.1

9.26

2.121.2.1-4

9.26.1

2.121.1.2

9.24

2.121.1.2-3

9.24.1

2.107.3.4

9.24

2.107.3.4-4

9.24.1

2.107.2.1

9.20

2.107.2.1-3

9.20.1

2.107.1.2

9.20

2.107.1.2-4

9.20.1

2.89.4.2

9.18.1

2.89.4.2-3

9.18.1.1

2.89.3.4

9.18

2.89.3.4-4

9.18.0.1

2.89.1.7

9.17

2.89.1.7-2

9.17.1

2.89.1.6

9.17

2.89.1.6-3

9.17.1

2.73.3.1

9.17

2.73.3.1-4

9.17.1

2.73.2.1

9.14

2.73.2.1-2

9.14.1

2.73.1.2

9.14

2.73.1.2-2

9.14.1

2.60.3.1

9.13

2.60.3.1-3

9.13.1

2.60.2.2

9.13

2.60.2.2-3

9.13.1

2.60.1.1

9.11

2.60.1.1-3

9.11.1

Earlier than 2.60.1.1

Contact Support

Contact Support

Releases of CloudBees Jenkins Platform Fixed line

Product version

Original CloudBees License Manager plugin version

Target incremental upgrade

Target CloudBees License Manager plugin version

2.164.33.0.1

9.33

2.164.33.0.1-5

9.33.1

2.164.32.0.1

9.33

2.164.32.0.1-6

9.33.1

2.138.44.0.1

9.32

2.138.44.0.1-3

9.32.1

2.138.43.0.1

9.32

2.138.43.0.1-3

9.32.1

2.164.31.0.1

9.33

2.164.31.0.1-3

9.33.1

2.138.42.0.1

9.32

2.138.42.0.1-3

9.32.1

2.164.30.0.1

9.33

2.164.30.0.1-3

9.33.1

2.138.41.0.1

9.32

2.138.41.0.1-5

9.32.1

2.107.38.0.1

9.24

2.107.38.0.1-2

9.24.1

2.107.37.0.2

9.24

2.107.37.0.2-8

9.24.1

2.138.40.0.2

9.32

2.138.40.0.2-6

9.32.1

2.107.36.0.2

9.24

2.107.36.0.2-3

9.24.1

2.107.35.0.1

9.24

2.107.35.0.1-3

9.24.1

2.73.36.0.2

9.17

2.73.36.0.2-2

9.17.1

2.73.35.0.1

9.17

2.73.35.0.1-4

9.17.1

2.107.34.0.1

9.24

2.107.34.0.1-3

9.24.1

2.73.34.0.1

9.17

2.73.34.0.1-3

9.17.1

2.107.33.0.1

9.24

2.107.33.0.1-3

9.24.1

2.73.32.0.1

9.17

2.73.32.0.1-4

9.17.1

2.73.31.0.1

9.17

2.73.31.0.1-3

9.17.1

2.73.30.0.1

9.17

2.73.30.0.1-4

9.17.1

2.73.28.0.1

9.17

2.73.28.0.1-4

9.17.1

Earlier than 2.73

Contact Support

Contact Support

Upgrade the CloudBees License Manager Plugin

You must update the CloudBees License Manager plugin for all installations of product versions earlier than 2.176.1.4. This includes any standalone controllers, client controllers, managed controllers, team controllers and operations center server instances. Be aware that this upgrade will involve a restart of each affected Jenkins controller or Operations Center instance.

As with any upgrade, you should follow these guidelines:

  • We recommend that you first take a backup of your system before upgrading.

  • We recommend that you test your upgrade procedure in a test environment prior to deploying the change in production.

  • If you are running CloudBees Jenkins Platform or CloudBees Core, first upgrade your CloudBees Jenkins Operations Center.

To help you with the planning of the upgrade, CloudBees has provided a script you can use to check if your system is correctly upgraded. See the section titled Verify System Readiness for details on this script and how to run it.

Choose one of the methods below to upgrade the License Manager Plugin:

Method

Details

Incremental Upgrade

This is the recommended option if you need to update a small set of controllers that are connected to the internet.

Manual plugin upload

Use this alternative if you do not have Beekeeper enabled and need to update a small set of controllers.

Upgrade script

This option is recommended if you have to upgrade a cluster of controllers connected to an Operations Center server.

To upgrade using the incremental upgrade:

  1. Enable Beekeeper to report the incremental update. Beekeeper normally recommends the next version, but you can run the script below to expose the Incremental Update.

    1. Navigate to the Script Console by choosing Manage Jenkins from the menu on the left and then Script Console from the Manage Jenkins page.

    2. Copy and paste the following lines into the text box provided: ` com.cloudbees.jenkins.plugins.assurance.props.BeekeeperProp.get().NO_FULL_UPGRADES.set() com.cloudbees.jenkins.plugins.assurance.CloudBeesAssurance.get().refreshStateSync() println "Success" `

    3. Click Run. You should see the word "Success" printed.

  2. Apply the upgrade using Beekeeper

    1. You will see a notification about the upgrade at the top of your screen.

    2. Please see our documentation on the CloudBees Assurance Program for more information on how to apply this upgrade.

To upgrade using the manual installation method:

  1. Download the plugin from the link provided for the target CloudBees License Manager Plugin version from the table above.

  2. Upload the plugin to Jenkins.

    1. Navigate to the Jenkins Plugin Manager by selecting the Manage Jenkins menu option, and then the Manage Plugins option.

    2. On the Plugin Manager page, choose the Advanced tab.

    3. In the Upload Plugin section, select the plugin you downloaded to your computer in step 1, and then click "Upload"

  3. Once the plugin is uploaded, restart Jenkins to complete the plugin installation.

Please note that this option will result in Beekeeper reporting a warning that you are running the wrong version of the CloudBees License Manager Plugin. You can ignore this warning.

To upgrade using the upgrade script:

The script provides options for you to control how the script behaves. The documentation for those options is at the top of the script. We encourage you to run the script using the default values provided. You can run the script multiple times without side effects.

Use the steps below to run the script:

  1. Download the upgrade-license-plugin.groovy script and open it in a local text editor.

  2. Make any modifications to the options in the script and save it to disk.

  3. Execute the script using either the Script Console or the Jenkins CLI. We recommend using the Jenkins CLI if you are upgrading a cluster of controllers connected to an operations center. See Appendix A: Running Groovy Scripts on how to do this if you are unfamiliar with running Groovy scripts.

  4. Restart all upgraded Jenkins instances.

Verify the License Manager Plugin upgrade

After applying the plugin upgrade, you should verify that your installation is now running the target version of the CloudBees License Manager Plugin.

  1. Navigate to the Jenkins Plugin Manager by selecting the Manage Jenkins menu option, and then the Manage Plugins option.

  2. On the Plugin Manager page, select the Installed tab.

  3. In the search box provided, search for "CloudBees License Manager".

Compare the version of the CloudBees License Manager plugin listed on the Installed tab with the target version of this plugin from the table above. If they are the same version, you have successfully updated your Jenkins instance. Be sure to perform the same steps on all CloudBees Jenkins-based products, including all controllers and CloudBees Jenkins Operations Centers.

Alternatively, you can also run the Verify System Readiness script which will verify the upgrade is complete, including checking all connected controllers if running on an Operations Center.

Once this step is complete, your system is ready to apply the new license as described in Preparing for the new CloudBees License Certificate.

Appendix A: Running Groovy Scripts

At several points in this guide, we direct you to run different Groovy scripts. The instructions below provide a common set of instructions that can be used for all the Groovy scripts provided in this article.

Execute the script using either the Script Console or the Jenkins CLI. We recommend using the Jenkins CLI if you are upgrading a cluster of controllers connected to an operations center.

Using the Script Console

  1. Navigate to the Script Console by choosing Manage Jenkins from the menu on the left and then Script Console from the Manage Jenkins page.

  2. Copy and paste the script from your text editor into the text box provided.

  3. Click Run.

  4. Review the output and save it for future reference. If you need to open a support case with CloudBees, we will need the output from this script.

Using the Jenkins CLI

  1. Read the Jenkins CLI guide if you are new to the CLI.

  2. Ensure that your Jenkins API Token is configured correctly.

  3. Download the jenkins-cli.jar.

  4. Run the script at the command line:

    1. java -jar jenkins-cli.jar -auth myusername:<MY API TOKEN> -s https://<MY JENKINS URL> groovy = < <SCRIPT FILE NAME>.

      1. For example: java -jar jenkins-cli.jar -auth myusername:abcd1121d3fb02896a101c1d5e -s https://myjenkins.corp groovy = < upgrade-license-plugin.groovy.

    2. Review the output from the script provided and save it for future reference. If you need to open a support case with CloudBees, we will need the output from this script.