Setting up DevOptics on Jenkins

2 minute read

Do the following steps in the order listed to set up DevOptics on Jenkins:

If you use a custom Docker image, skip steps 1 and 2 below and follow the instructions for installing for a customer Docker image instead.
  1. Install the DevOptics installation plugin.
    This step is required to add the DevOptics update center to Jenkins.

  2. Install the DevOptics plugin.

  3. Connect to the DevOptics service.

  4. Confirm that the master is connected successfully.
    Optional: Repeat the above steps for all masters.

Installing the DevOptics installation plugin

The DevOptics™ installation plugin is not stored in the main Jenkins update center. The DevOptics installation plugin must be installed first to add the CloudBees update center to Jenkins.

  1. Go to Jenkins > Manage Jenkins > Manage Plugins.
    If you see a warning that the Jenkins root URL is empty, fix the root URL first.

  2. On the Available tab, type "DevOptics" in the Filter field.

  3. Click the checkbox for the DevOptics Installation Plugin.

  4. Click Install without restart.

After the DevOptics installation plugin is installed, you must Install the DevOptics plugin.

Installing the DevOptics plugin

Install the plugin on any master you want to connect to DevOptics.

  1. Go to Jenkins > Manage Jenkins > Manage Plugins.

  2. On the Available tab, type "DevOptics" in the Filter field.

  3. Click the checkbox for DevOptics Plugin.

  4. Click Install without restart.

After the DevOptics plugin is installed, you must connect to the DevOptics service.

Installing the DevOptics plugins on Jenkins for a custom Docker image

If you use a custom Docker image, follow these steps to install the DevOptics installation plugin and the DevOptics plugin. Skip these steps if you do not use a custom Docker image.

FROM jenkins/jenkins:latest
# Install the DevOptics installation plugin, and the DevOptics plugin
RUN /usr/local/bin/install-plugins.sh "cloudbees-devoptics-enabler" "devoptics:latest:https://jenkins-updates.cloudbees.com/download/plugins/devoptics/latest/devoptics.hpi"

After the DevOptics plugins are installed, you must connect to the DevOptics service.

Connecting to the DevOptics service

Before you connect to the DevOptics service, ensure there are no warnings for URL mismatches. If you see one, fix the root URL first.
  1. Go to Jenkins > Manage Jenkins > DevOptics.
    The plugin reports Not Enabled and This master is NOT enabled for connection to the DevOptics service until the connection is set up.

  2. Under Status, click Connect to set up the connection. This redirects you to DevOptics and requires you to sign in.

  3. On Connect to DevOptics, under Account, select the DevOptics organization from the list of accounts.

  4. Click Connect to complete the connection between DevOptics and your master.

After completing these steps, the master is now connected to the DevOptics service. You can see this on the DevOptics plugin configuration page. Additionally, you can confirm successful connection of the client master.

Confirming that a master is connected

After your subscription is activated, you can sign in to DevOptics using the same credentials you used to connect your master to the DevOptics service.

  1. Open a browser and navigate to https://devoptics.cloudbees.com.

  2. Click Login or login here.

  3. Sign in using your credentials.

  4. Click the Settings icon.

  5. Select Connected masters.

You should now be able to see your master listed in the Connected masters section.