CloudBees Jenkins Advisor Plugin

Introduction

The CloudBees Jenkins Advisor Plugin periodically uploads support bundles to the CloudBees Advisor service. This service scans support bundles for potential issues and makes recommendations for the Jenkins instance based on the knowledge of CloudBees experts. These recommendations are compiled into a report and emailed to a designated address.

CloudBees Jenkins Advisor will send an initial report with everything it detects in your system. Subsequent reports will only report changes from your initial report. You will not receive a report if nothing new is detected on your system.

Install Requirements

The requirements for installing and using the CloudBees Jenkins Advisor Plugin are listed below.

  • An internet connection is required for the Advisor Plugin to send support bundles to your Master. Please refer to the Network Configuration section.

  • Jenkins LTS Instances must be on version 2.60.3 or newer to install the CloudBees Jenkins Advisor Plugin.

  • CloudBees Jenkins Instances must be on version 2.60.1.1 or newer to install the CloudBees Jenkins Advisor Plugin.

    • If you are using an older version than those listed and you are a CloudBees Subscriber, you can use the Assisted Update process by submitting a ticket to CloudBees Support. For more information, see the Required Data: Assisted Update article.

  • A Support Bundles generated from your Master must be less than 500MB to successfully send the report.

Install Process

The CloudBees Jenkins Advisor Plugin should be installed on each Master in your instance.

For CloudBees Jenkins Instances

  1. Access the plugin manager for your Masters, Manage Jenkins > Manage Plugins and select the Available tab.

    1. Direct Link is: {JENKINS_URL}/pluginManager/available

  2. Search for the Plugin named CloudBees Jenkins Advisor Plugin.

  3. Select the checkbox to the left under the Install column and Download this plugin.

  4. After the plugin has been installed, restart your CloudBees Jenkins instance.

For CloudBees Jenkins Masters from an Operations Center

Using the Cluster Operation, you can you can automatically install and update Configure Advisor on multiple CloudBees Jenkins Masters managed by a CloudBees Operations Center.

To create a Cluster Operation and configure it:

  1. Configure the Target Managed masters to define on which masters you want to install / configure Advisor (take care of the prerequisites as described abode).

  2. Add the following steps:

    1. An Install plugin step with the Plugin ID set to cloudbees-jenkins-advisor and no version defined (to use the one available for the given master).

    2. An Execute Groovy Script on Master step where the script will be the following (replace the test@email.com email with the one you want to use):

      import com.cloudbees.jenkins.plugins.advisor.*
      
      println "Configuration of Advisor ..."
      
      def config = AdvisorGlobalConfiguration.instance
      
      config.email = "test@email.com"
      config.cc = "testCC@email.com" // optional
      config.isValid = true
      config.nagDisabled = true
      config.acceptToS = true
      
      config.save()
      println "Configuration of Advisor done."
  3. After running this script, restart your CloudBees Jenkins masters. Your masters should now be configured to use Advisor. You should receive the first reports within 24 hours.

For Jenkins LTS Installations

To use the plugin, you must upload the CloudBees Jenkins Advisor plugin to your Instance.

  1. Download the latest version of the CloudBees Jenkins Advisor Plugin in HPI format.

  2. Navigate to the Plugin Manager page, Manage Jenkins > Manage Plugins. Select the Advanced tab.

    1. Direct Link at {JENKINS_URL}/pluginManager/advanced

  3. Select Choose File in the Upload Plugin section. Browse to and select the HPI file for the CloudBees Jenkins Advisor plugin. Click Upload.

  4. Restart your Jenkins instance to use the CloudBees Advisor service.

Configuration

After the CloudBees Jenkins Advisor plugin is properly configured, your Jenkins instance will be connected to the Advisor service.

You should receive your first report within the next 24 hours when using defaults.

To configure your system to use CloudBees Jenkins Advisor:

  1. Select "Configure CloudBees Jenkins Advisor" from the "Manage Jenkins" screen.

    global config
  2. Add a valid company email to the email field.

  3. You may optionally test the connection to ensure your Jenkins instance can indeed reach the CloudBees Advisor server.

    configure
  4. Accept the terms and conditions, and save your configuration.

  5. Save your configuration.

You will begin receiving reports to your defined email.

Tip
You will have to designate one email address to receive emails from the Advisor service. This email service will need to accept mail coming from no-reply@cloudbees.com. Please check your email filters.
advisor report

Optional Configuration

You can configure what information is sent to CloudBees Jenkins Advisor in the bundle from the "Optional" section of the configuration page. The options are the same as the CloudBees Support plugin.

configure optional

If your system is configured so that you cannot access the CloudBees Jenkins Advisor service from your instance, you can disable the message from the Optional section as well.

Select the box to "Suppress register account reminder."

Network Configuration

CloudBees Advisor service is hosted on Amazon Web Services infrastructure (us-east-1 region). The CloudBees Jenkins Advisor plugin must be able to connect to the CloudBees Advisor service at insights.cloudbees.com on port 443 (https). Refer to AWS IP address ranges if a more specific IP address range definition is required.

Known Issues

In the legacy version 1.x of the plugin, CloudBees used go.pardot.com to track users' registrations when the plugin was available for free. With the version 2.x, the Advisor service is accessible only for CloudBees customers. This notification to Pardot is not used; it was removed in version 2.5 of the plugin.

After saving the Advisor configuration, if you reach a go.pardot.com url with a "Cannot find success page to redirect to. Please use your browser back button." message, use your browser back button to return to your instance (The configuration was correctly saved).

If your instance is deployed in a network with a restricted access to internet, you don’t have to open an access to go.pardot.com. Use the browser back button to return to your instance if you reach an unaccessible URL.