RoadieDocs

Configuring Jenkins plugin

Published on March 18th, 2021

Introduction

The Jenkins plugin can display build information from a GitHub Organization project in your Jenkins instances.

ℹ️ NB: Other Jenkins project types like Freestyle project and Pipeline are not supported yet.

Jenkins Overview Content

This page explains how to configure it in Roadie Backstage.

Prerequisites

  1. You must be an admin in Roadie. By default, all users are admins. Learn how to designate certain users as admins here.
  2. Your Jenkins instance must be accessible by Roadie backend instances. To allow list Roadie access you can check our IPs here.

Step 1: Create a Jenkins API token

Roadie requires an API token to be able to connect to Jenkins.

You can generate an API token for your user by visiting Jenkins UI at <your-Jenkins-instance>/user/<your-account>/configure/ and by clicking “Generate” in the “API Token” section.

Step 2: Store the API token in Roadie

Visit the Roadie Secrets page (show me how) and enter the token into the JENKINS_API_KEY secret.

Set jenkins-api-key via UI

Step 3: Configure Roadie with your Jenkins instance URL

Enter your Jenkins instance API endpoint and username into Roadie.

  1. Click “Administration” in the sidebar, then “Settings” in the tabs.
  2. Find “Jenkins” in the Configuration sidebar.
  3. Enter your Jenkins instance URL and the username your Jenkins API token is owned by and click “Save” then “Apply & Restart”.

Set Jenkins Config

Step 4: Add the UI elements

The Jenkins plugin provides two type of UI elements.

The EntityLatestJenkinsRunCard displays the latest runs for an entity. This card can be added to component dashboards.

The EntityJenkinsContent presents a job folder in Jenkins and jobs it contains. It also display details of each job within the folder. This component can be added as a tab to component layouts.

Step 5: Modify your catalog files to contain references to Jenkins jobs

The Jenkins plugin uses jenkins.io/job-full-name annotation to determine the correct GitHub organization folder and job name within your Jenkins instance. You can configure it as follows:

// catalog-info.yaml
metadata:
  annotations:
    jenkins.io/job-full-name: [github-organization-project-name/job-name]

More information how to configure the plugin for your component can be found from the plugins documentation.

Multiple Jenkins Instances

If you require integrating with multiple Jenkins instances contact Roadie via the in-app chat widget and we will enable it for you.

References