Configuring Applications for the Jenkins SyncPack

Download this manual as a PDF file 

This section describes how to set up the run book automations in SL1 and how to configure the PowerFlow applications in the "Jenkins" SyncPack.

Workflow for Configuring the SyncPack

The following workflows describe how to configure SL1 and PowerFlow to work with the "Jenkins" SyncPack.

Configuring SL1

  1. Enable the Jenkins event policies
  2. Create a SOAP/XML credential to access PowerFlow
  3. Edit the Jenkins run book actions
  4. Enable the Jenkins run book automations

Configuring PowerFlow

  1. Create and align a PowerFlow configuration object
  2. Configure the Jenkins PowerFlow applications
  3. Schedule the PowerFlow applications

Configuring SL1

The following topics cover how to set up your SL1 instance to work with the "Jenkins" SyncPack.

Enabling the Jenkins Event Policies

The "Jenkins Automation" PowerPack includes 11 event policies that you can enable to trigger the events detected by the applications included in the"Jenkins" SyncPack and its associated automation action policy.

To enable the event policies:

  1. Go to the Event Policies page (Events > Event Policies).
  2. Click the check boxes for all of the "Jenkins" event policies. A row of buttons appear at the top of the list.
  3. Click Enable. The Status for all 11 policies is updated to "Enabled".

Creating a SOAP/XML Credential to Access PowerFlow

You will need to create a SOAP/XML credential in SL1 so that the action policies included in the "Jenkins Automation" PowerPack can access your PowerFlow system. The PowerPack includes the "PowerFlow Jenkins" sample credential, which you can edit for use with your PowerFlow system.

To create a SOAP/XML credential:

  1. Go to the Credentials page (Manage > Credentials).
  2. Locate the "PowerFlow Jenkins" sample credential, click its Actions icon (), and select Duplicate. A copy of the credential, called "PowerFlow Jenkins copy" appears.
  3. Supply values in the following fields:
  • Name. Type a new name for the credential.
  • All Organizations. Toggle on (blue) to align the credential to all organizations, or toggle off (gray) and then select one or more specific organizations from the What organization manages this service? drop-down field to align the credential with those specific organizations.
  • URL. Type the URL for your PowerFlow system.
  • HTTP Auth User. Type the username for your PowerFlow system.
  • HTTP Auth Password. Type the password for your PowerFlow system.
  1. Click Save & Close.
  2. Take note of the SL1-assigned ID number for the new credential on the Credentials page, in the ID column. You will need the ID number when editing the input parameters of the run book actions included in the PowerPack, below.

Editing the Jenkins Run Book Actions

The "Jenkins Automation" PowerPack includes eleven following run book action policies. These action policies use the "Run Integration Service Application" action type to trigger the corresponding PowerFlow application that collects data from Ansible. You can specify the credential ID in a JSON structure that you enter in the Input Parameters field in the Action Policy Editor modal.

To edit the action policies included in the PowerPack:

  1. In SL1, go to the Actions page (Registry > Run Book > Actions).
  2. Locate the action policy that you want to use, and then click its wrench icon (). The Editing Action page appears.
  3. In the Input Parameters field, change the values of the following parameters:
  • credential_id. Change the value to the credential ID that you noted earlier when creating a credential for your PowerFlow system in the previous procedure. This parameter is required.
  • include_event. Leave the value as "true".
  • application_name. Leave the default application value.
  • params. Leave the default parameter value.
  1. Make sure the Action State is set to Enabled, and then click Save.

Enabling the Jenkins Run Book Automations

The "Jenkins Automation" PowerPack includes eleven run book automation policies that you will need to enable. These policies update the SL1 event with the state of the associated Jenkins job. When a node is offline, a failure occurs, or a major event is detected in Jenkins, SL1 creates an event and updates the associated event with relevant job details.

To enable the run book automations:

  1. In SL1, go to the Automation page (Registry > Run Book > Automation).
  2. Locate a"Jenkins" automation policy and click its wrench icon (). The Automation Policy Editor page appears.
  3. Update the following fields:

  • Policy State. Select Enabled.
  • Policy Priority. Select High to ensure that this PowerFlow automation policy is added to the top of the queue.
  • Available Actions. If it is not already selected, select the "Run Integration Service Application: <name>" action that corresponds with the Jenkins automation policy you selected in step 2, and click the arrows to move it to Aligned Actions.

ScienceLogic highly recommends that you do not make changes to the Policy Type, Repeat Time, or Align With fields or the And event is NOT acknowledged setting.

  1. Click Save.
  2. Repeat steps 2-4 for the remaining "Jenkins" run book automation policies.

The following table shows the automation policy, its aligned events, and the automation action that runs in response to the events.

Automation Policy Name Aligned Events Run Book Action
Jenkins Node: Healthy Jenkins: Healthy Event Jenkins: Event Update
Jenkins Node: Major Jenkins: Major Event Jenkins: Alert
Jenkins: Job Pending Jenkins: Pending Event Jenkins: Event Update
Jenkins: Job Failure Jenkins: Major Event Jenkins: Alert
Jenkins: Healthy Jenkins: Healthy Event Jenkins: Event Update
Jenkins: Trigger Jenkins: Trigger Jenkins: Trigger
Jenkins: Trigger Healthy Jenkins: Healthy Event Jenkins: Event Update
Jenkins: Trigger Job Pending Jenkins: Pending Event Jenkins: Job Pending State
Jenkins: Pipeline Job Failure Jenkins: Major Event Jenkins: Alert
Jenkins: Pipeline Job Healthy Jenkins: Healthy Event Jenkins: Event Update
Jenkins: Pipeline Job Pending Jenkins: Pending Event Jenkins: Job Pending State

Configuring PowerFlow

The following topics cover how to set up your PowerFlow instance to work with the "Jenkins" SyncPack.

Creating and a Configuration Object

A configuration object supplies the login credentials and other required information needed to execute the steps for a PowerFlow application. The Configurations page () of the PowerFlow user interface lists all available configuration objects for that system.

You can create as many configuration objects as you need. A PowerFlow application can only use one configuration object at a time, but you can use (or "align") the same configuration object with multiple applications.

To use this SyncPack, you will need to use an existing configuration object in the PowerFlow user interface or create a new configuration object. Next, you need to align that configuration object to the relevant applications.

For this SyncPack, you should make a copy of the "Base Jenkins Configuration" configuration object, which is the sample configuration file that was installed with the Jenkins SyncPack.

The "Base Jenkins Configuration" configuration object contains all of the required variables. Simply update the variables from that object to match your SL1 and Jenkins settings.

To create a configuration object based on the "Base Jenkins Configuration" configuration object:

  1. In the PowerFlow user interface, go to the Configurations page ().
  2. Click the Actions button () for the "Base Jenkins Configuration" configuration object and select Edit. The Configuration pane appears.
  3. Click Copy as. The Create Configuration pane appears.
  4. Complete the following fields:
  • Friendly Name. Type a name for the configuration object that will display on the Configurations page.
  • Description. Type a brief description of the configuration object.
  • Author. Type the user or organization that created the configuration object.
  • Version. Type a version of the configuration object.
  1. In the Configuration Data field, update the default variable definitions to match your PowerFlow configuration:
  • sl1_host. Type the hostname or IP address of the SL1 system the alerts will synchronize with.
  • sl1_password. Type the password for your SL1 system.
  • sl1_user. Type the username for your SL1 system.
  • jenkins_url. Enter the URL for your Jenkins system.
  • jenkins_username. Type the username for your Jenkins system.
  • jenkins_password. Type the password for your Jenkins system.
  • job_name. Type the name for your Jenkins job.
  • receiver_mail. Type the email address that you want to receive updates on SL1 events and your Jenkins jobs.
  • sender_mail. Type the email address that you want updates on SL1 events and your Jenkins jobs to send from.
  • sender_mail_password. Type the password for the sender email address that you entered.
  • mailserver. Type the server for your sender email.
  • mailserverport. Type the port for your sender email.
  • node_device_class_id. Type the device class ID for your Jenkins instance.
  • job_device_class_id. Type the device class ID for your Jenkins job.
  • guid_node_major_event. Enter the GUID of the SL1 event policy.
  • collector_group_id. Type the collector group ID for your Jenkins instance.
  • device_id. Type the device ID for your Jenkins instance.
  • guid_job_major_event. Enter the GUID of the SL1 event policy.
  • guid_job_trigger_event. Enter the GUID of the SL1 event policy.
  • guid_pipeline_job_major_event Enter the GUID of the SL1 event policy.
  1. Click Save. You can now align this configuration object with one or more applications.

Aligning a Configuration Object and Configuring PowerFlow Applications

With this SyncPack, you can create SL1 events based on Jenkins jobs. You will need to align the Jenkins SyncPack applications with the relevant configuration object in PowerFlow, and, if needed, update any other fields on the Configuration pane for the applications.

To align the configuration object with the relevant PowerFlow applications:

  1. On the Applications page of the PowerFlow user interface, open one of the PowerFlow applications listed above and click Configure (). The Configurations pane for that application appears.

  1. From the Configurations drop-down, select the configuration object you want to use.

    The values for sl1_hostname and the other parameters that appear in the Configuration pane with a padlock icon () are populated by the configuration object you aligned with the application. Do not modify these values. If you encounter an error, make sure your configuration object is configured properly.

  1. Click Save to align that configuration with the application.

  2. Repeat this process for the other PowerFlow applications.

Scheduling PowerFlow Applications

To trigger the applications in the SyncPack, you must schedule the PowerFlow applications that are included in the SyncPack.

You can create one or more schedules for a single application in the PowerFlow user interface. When creating each schedule, you can specify the queue and the configuration file for that application.

To create a schedule:

  1. On the Applications page (), click the Schedule button for the application you want to schedule. The Scheduler window appears.
  2. In the Schedule List pane, click the down arrow icon () next to an existing schedule to view the details for that schedule.
  3. In the Schedule Creator pane, complete the following fields for the default Frequency setting:
  • Schedule Name. Type a name for the schedule.
  • Frequency in seconds. Type the number of seconds per interval that you want to run the application.
  • Custom Parameters. Type any JSON parameters you want to use for this schedule, such as information about a configuration file or mappings.
  1. To use a cron expression, click the Switch to Cron Expression toggle to turn it blue. If you select this option, you can create complicated schedules based on minutes, hours, the day of the month, the month, and the day of the week:

As you update the cron expression, the Schedule window displays the results of the expression in more readable language, such as Runs app: "Every 0 and 30th minute past every hour on Sat", based on 0,30 in the Minutes field and 6 in the Day of Week field.

  1. Click Save Schedule. The schedule is added to the Schedule List pane. Also, on the Applications page, the Schedule button now displays with a dark blue background:

After you create a schedule, it continues to run until you delete it. Also, you cannot edit an existing schedule, but you can delete it and create a similar schedule if needed.

To view or delete an existing schedule:

  1. On the Applications page, click the Schedule button for the application that contains a schedule you want to delete. The Scheduler window appears.
  2. Click the down arrow icon () to view the details of an existing schedule.
  3. To delete the selected schedule, click the Actions icon () and selectDelete.

On the Scheduler window for a PowerFlow application, you can click the Copy as button from the Schedule List pane to make a copy of an existing schedule.

When either multiple SL1 instances or multiple Jenkins instances are involved with PowerFlow, you should create an individual configuration object for each SL1 or Jenkins instance. Next, create an individual schedule for each configuration object. Each schedule should use a configuration object that is specific to that single SL1 or Jenkins instance. Creating copies of a PowerFlow application from a SyncPack for the purpose of distinguishing between domains is not supported, and will result in issues on upgrades.