Create and configure pipelines in the Jenkins UI

This topic describes how to create and configure pipelines directly from the Jenkins CI server's user interface.

See Create and configure pipelines for details on working with pipelines in ALM Octane.

Prerequisite: Install and configure the HPE ALM Octane CI plugin on your CI server.

Create an ALM Octane pipeline in Jenkins

  1. In Jenkins, click on the job that you want to use as the root job for your pipeline.

    Note: Select a job that is not already part on an existing ALM Octane pipeline.

  2. In the menu, on the left side of the screen, click HPE ALM Octane Pipelines.

  3. Click Create Pipeline.

  4. Enter the details for the pipeline:

    1. Provide a name for the pipeline.

    2. The Workspace list displays all of the workspaces on the ALM Octane server configured in the HPE ALM Octane CI plugin.

      Select a workspace for your pipeline.

    3. The Release list displays the releases available in the workspace you selected.

      Optionally, select a release to associate with your pipeline.

  5. Click Create.

Caution: If you delete a pipeline, all its labels and configuration information are lost.

Back to top

Edit the pipeline and configure pipeline steps on Jenkins

  1. In Jenkins, click on a job that is included in an existing ALM Octane pipeline.

  2. In the menu, on the left side of the screen, click HPE ALM Octane Pipelines.

    The page for editing pipelines opens.

  3. You can edit the following pipeline details: Name, workspace or release.

  4. On a job that runs tests, configure test and environment details.

    Note: A Jenkins job may be included in a pipeline more than once. When you configure a Jenkins job, this affects all of the relevant steps in the ALM Octane pipeline.

    • If a job runs tests that you do not want to track in ALM Octane, select Ignore test run results at the bottom. When this job runs tests, the results are not sent to ALM Octane, and it does not create the corresponding tests.

      For example, we recommend that you use this option to ignore unit tests. This will prevent unnecessary load on ALM Octane, which could result in performance issues.

      You can also specify whether to delete test run results that were previously collected from tests run by this job. If all of a test's run results are subsequently deleted, the automated test is deleted as well.

      Caution: Deleting test results will affect your pipeline's build run history. In addition, failure analysis will not be available for steps whose test results are ignored.

      If you select Ignore test run results, you can skip the Fields and Environment settings described below. These are only relevant for tagging test run results. If you choose to enter these settings, they are sent to ALM Octane and are displayed in the pipeline configuration.

    • In the Fields area, configure the test fields for the selected job. Test fields: Test level, tool type, framework, or type.

      Select from the existing values in the list or, for framework and tool type, create your own values.

      For details about test fields, see Configure steps: Define test and test run information.

    • In the Environment area, add information about the environment on which the job runs. For example, the operating system, browser, and database.

      Select from the existing values in the list or create your own values.

      Note: To dynamically set environment tags during the build run, based on build parameter values, configure the pipeline in ALM Octane.

  5. Click Apply.

Back to top

Troubleshoot creating and configuring pipelines from the Jenkins UI

  • Issue: Error when trying to create a pipeline: Unable to create pipeline

    Solution: Make sure the workspace you selected is included in the list of workspaces defined for the access keys that you used to connect the HPE ALM Octane CI to ALM Octane.

    Otherwise: Select a different workspace, or ask an ALM Octane shared space admin to add the workspace to the list. For details, see Set up API access for integration.

  • Issue: Error when trying to configure a job: Unable to retrieve job configuration

    Solution: The pipeline containing this job might have been created in ALM Octane in a workspace that is not accessible from the HPE ALM Octane CI plugin.

    Make sure the workspace is included in the list of workspaces defined for the access keys that you used to connect the HPE ALM Octane CI to ALM Octane.

    Otherwise, ask an ALM Octane shared space admin to add the workspace to the list. For details, see Set up API access for integration.

Back to top

Next steps: