Setting Up Jenkins Integration

Jenkins is a cross-platform, open-source build automation tool for delivery pipelines. Whether your goal is continuous integration or continuous delivery Jenkins can help automate it.

           

TIP

See how to Manage Builds.

           

           

TIP

In order to retrieve the list of parameters for each job, the following Jenkins plugins – Build with Parameters and Extended Read Permission must be installed on your instance of Jenkins. The user configured on the Jenkins integration setup in Release & Verify must have the Extended Read permission. 

Jenkins1-600x236.png

1. Set up Jenkins to trigger builds remotely

To build an environment with a single click, using Release & Verify and Jenkins:

  1. Open Jenkins.
  2. Click a blue-linked job Name.
    Click-to-open-an-item-in-Jenkins-red-arrow-600x115.png
  3. Click Configure.
    Click-Configure-in-Jenkins-red-arrow-600x130.png
  4. Click to select the Trigger builds remotely (e.g., from scripts) checkbox.
    Build-Triggers-Jenkins-red-arrow-600x298.png
  5. Type an Authentication Token.
  6. Click Save.

2. Enable Jenkins Integration

To enable Jenkins Integration:

  1. Go to Settings  > Customization > Integrations.
  2. Click Jenkins.
  3. Click to select the Enable Jenkins Integration checkbox to toggle on Jenkins Integration.
    Reskin493-600x205.png

3. Add and Enable a Jenkins Instance

To add and enable a new Jenkins instance:

  1. Click + New Jenkins Instance at the bottom of the left-hand panel.
    Reskin494-600x205.png
  2. Type the Jenkins URL.
  3. Type the Username. (Mandatory field.)
  4. Type the Password/Token. (Mandatory field.)

               

    TIP

    Enter_tip_text_here.

              

  5. Click Test Connection.

               

    TIP

    Enter_tip_text_here.

              

  6. If the connection is successful, click Create.
  7. Enable the new instance by clicking the OFF toggle switch in the left-hand panel until it is blue and ON.
    Reskin495-600x205.png

4. Fetch and Enable Jobs

Jenkins Integration now retrieves only the top-level (root) folder of Jenkins jobs and the contents of folders are only retrieved when clicked. This minimizes the level of data coming back in response requests and prevents timeouts.

To enable Jenkins jobs in the new Jenkins instance:

  1. Click Fetch Jobs. The Job Names column should populate with jobs and jobs folders.
    Reskin496-600x205.png
  2. Click to select the job checkboxes to enable the jobs.
    Reskin497-600x205.png

               

    TIP

    Only enabled jobs can be added to a System’s automated jobs list.

               

  3. Click Save.

5. Select and Sequence Jenkins Jobs

See Orchestration Using Automated Jobs.

6. Select a Component to Update the Version Number

Now set which of the Environment’s components will be updated:

  1. Click the Environment’s Details tab.
  2. Click to select the Summary Version checkbox of the Component which is updated by the job:
    Reskin498-600x281.png
  3. Click Update on Build.
    Reskin499-600x281.png
    The component’s icon becomes a Jenkins icon.

    Reskin500-600x281.png

    • The component’s Version will contain a build version number when a build is initiated.
    • Only one Component can be active with Jenkins at a time.
  4. Click Save & Close.

7. Run Jenkins Jobs in a TECR and View the Execution History

See Orchestration Using Automated Jobs.