Jenkins SyncPack Release Notes, version 1.0.0

Version 1.0.0 of the "Jenkins" SyncPack provides a bidirectional integration between SL1 events and Jenkins jobs, pipeline jobs, and nodes.

This SyncPack uses the "Jenkins Automation" PowerPack.

Features Included in this Release

The following PowerFlow applications are included in this SyncPack:

  • Create External Notes For SL1 Event. This application queries Jenkins for job information to be added to the associated SL1 event.
  • Create Event in SL1 For Jenkins Job Run. This application creates an SL1 event when a Jenkins job fails.
  • Create Event In SL1 For Jenkins Node Status. This application creates an SL1 event when a node is offline in Jenkins.
  • Create Event In SL1 For Jenkins Pipeline Job Run. This application creates an SL1 event when a Jenkins pipeline job fails.
  • Update SL1 Event Triggered. This application updates an SL1 event with job information.
  • Trigger Event In SL1. This application creates an SL1 event when an SL1 event reaches a major severity threshold.
  • Create Virtual Device In SL1 For Jenkins Jobs And Nodes. This application creates a virtual device in SL1 that is used to identify Jenkins jobs and nodes.

The following configuration object is included in the SyncPack:

  • Base Jenkins Configuration. This configuration object can be used as a template after the SyncPack is installed on the PowerFlow system. The configuration object includes the following:
    • Details for connecting to the SL1, including the host, username, and password.
    • Details for connecting to Jenkins, including the URL, username, and password.
    • Details for notifications including the sender and receiving email, password, server, and port.
    • Details for connecting to Jenkins devices including device ID, collector group ID, and device class ID.

The following steps are included in this SyncPack:

  • Build Jenkins Job
  • Build Jenkins Job From SL1 Event
  • Build Jenkins Pipeline Job
  • Create Jenkins Virtual Devices On SL1
  • Create SL1 Alert
  • Create Virtual Device
  • Get Event Details From SL1
  • Get Jenkins Nodes Status
  • Get List Of Existing Virtual Devices Of Nodes
  • Get Virtual Device
  • Post Update to SL1
  • Read Cache
  • Update Jenkins Details To SL1
  • Update SL1 Event of Jenkins Build Job

To view the latest manuals for the SL1 PowerFlow Platform, see the SL1 PowerFlow page. To view the latest release notes for PowerFlow, see SL1 PowerFlow Release Notes.

System Requirements

This release of the SyncPack requires:

  • SL1 PowerFlow platform version 2.4.0 or later.
  • SL1 version 11.2.0 or later. For details on upgrading SL1, see the relevant SL1 Platform Release Notes.
  • "Base Steps" SyncPack version 1.3.2 or later.
  • "Jenkins Automation" PowerPack version 100 or later.
  • Administrator access to Jenkins.

The following table lists the port access required by the PowerFlow platform and this SyncPack:

Source IP PowerFlow Destination PowerFlow Source Port Destination Port Requirement
PowerFlow SL1 API Any TCP 443 SL1 API Access
PowerFlow Jenkins API Any TCP 443 Jenkins API Access
PowerFlow SL1 Database Any TCP 7706 SL1 Database Access

Installing the SyncPack

A SyncPack file has the .whl file extension type. You can download the SyncPack file from the ScienceLogic Support site.

To locate and download the SyncPack:

  1. Go to the ScienceLogic Support site at https://support.sciencelogic.com/s/.
  2. Click the Product Downloads tab and select PowerPacks & SyncPacks.
  3. In the Search field, type the name of this SyncPack and select it from the search results. The Release Version page appears.
  4. On the Files tab, click the down arrow next to the SyncPack version that you want to install, and select Show File Details. The Release File Details page appears.
  5. Click the Download File button to download the SyncPack.

After you download a SyncPack, you can import it to the PowerFlow platform using the PowerFlow user interface.

To import a SyncPack in the PowerFlow user interface:

  1. On the SyncPacks page, click Import SyncPack. The Import SyncPack page appears.
  2. Click Browse and select the .whl file for the SyncPack you want to install. You can also drag and drop a .whl file to the Import SyncPack page.
  3. Click Import. PowerFlow registers and uploads the SyncPack. The SyncPack is added to the SyncPacks page.

You cannot edit the content package in a SyncPack published by ScienceLogic. You must make a copy of a ScienceLogic SyncPack and save your changes to the new SyncPack to prevent overwriting any information in the original SyncPack when upgrading.

To activate and install a SyncPack in the PowerFlow user interface:

  1. On the SyncPacks page, click the Actions button () for the SyncPack you want to install and select Activate & Install. The Activate & Install SyncPack modal appears.

    If you try to activate and install a SyncPack that is already activated and installed, you can choose to "force" installation across all the nodes in the PowerFlow system.

    If you do not see the PowerPack that you want to install, click the Filter icon () on the SyncPacks page and select Toggle Inactive SyncPacks to see a list of the imported PowerPacks.

  1. Click Yes to confirm the activation and installation. When the SyncPack is activated, the SyncPacks page displays a green check mark icon for that SyncPack. If the activation or installation failed, then a red exclamation mark icon appears.
  2. For more information about the activation and installation process, click the check mark icon or the exclamation mark icon in the Activated column for that SyncPack. For a successful installation, the "Activate & Install SyncPack" PowerFlow application appears, and you can view the Step Log for the steps. For a failed installation, the Error Logs window appears.
  3. If you have other versions of the same SyncPack on your PowerFlow system, you can click the Actions button () for that SyncPack and select Change active version to activate a different version other than the version that is currently running.