Skip to content
Nevin Kaplan edited this page Mar 20, 2018 · 12 revisions

Overview

The CastSLA Jenkins plugin will terminate the job in the event that specific criteria is not met.

Target audience

This document is to be used by the CAST Delivery Specialist or onsite administrator with a working knowledge of Jenkins.

Summary

This document provides installation, deployment and usage instructions for the CAST SLA Plugin.

Application On-board Requirements

  • The application must be properly on-boarded into the CAST AIP system
  • At least one snapshot, for the application, must exist in the CAST Application Engineering Dashboard (AED).
  • An active user account for CAST AED

Release History

Version Author Description
1.0.0 Julien Godfroid Initial Version
1.2.0 Nevin Kaplan Enable plugin to work with AED
1.3.2 Nevin Kaplan Added ability to compare latest snapshot health factor with previous production snapshot values
1.4.0 Nevin Kaplan Fix null pointer exception

Use Cases

  • Prevent the continuation of a Jenkins job when CAST Health factors do not meet specific criteria
  • Prevent the continuation of a Jenkins job when user specified CAST finding are created during the most recient snapshot.

Compatibility

  • CAST AIP Release: 8.0.x or better

Installation Instructions

  1. Download the CastSLA.hpi file.
  2. Login to Jenkins and go to the Manage Plugin screen (Manage Jenkins → Manager Plugins)
  3. Go to the Advanced tab - Upload Plugin section
  4. Click on the Choose File button and locate the CastSLA.hpi file downloaded in step 1
  5. Click the Upload button
  6. If requested, restart Jenkins

Usage

This plugin is designed to be used as part of the application DevOps process and stops the Jenkins job in the event specific criteria is NOT met. It is divided into three sections, REST service configuration, Blocker metrics and Health Factor conditions.

REST Service

To function properly it must be configured to connect to a CAST Engineering Dashboard (AED), or Analytics Application Dashboard (AAD), containing the application to be tested. The tool works equally well with either dashboard, however it is recommended for use with AED since not all snapshot are punished to AAD. Once the dashboard URL and credentials are entered the Analytics Application Dashboard drop-down is populated and the user can select the dashboard and application to be tested against.

Blocker Metrics

Blocker Metrics are used to prevent the job from completing if there are any new violations for specific rules. The user can select a metric from the Metric List then click the Add Metric button to add the id to the Blocker metrics list. The Metric List will only contain items that exist in the latest snapshot. It is possible to add other metric id's manually added by adding a new id separated by a semicolon (;). The Check blocker metrics button will show what ids do not exist in the latest snapshot.

Health Factor Conditions

There are eight health factor options use to compare against the latest snapshot. The plugin will stop the job when the condition is false. The example below will stop the job when Total Quality Score (TQI) falls below 3.0. As with the blockers multiple contitions can be selected by clicking the Add New Condition button.