Set up CI server integration

DevOps admin permissions are required.

A CI server, such as Jenkins or TeamCity, runs jobs in a certain sequence or flow, also called a pipeline.

By adding CI servers in ALM Octane, you can set up communication between ALM Octane and the CI server.

You can then create pipelines in ALM Octane that reflect the ones running on the CI server.

Overview

Connecting a CI server to ALM Octane results in the following:

  • ALM Octane collects the test run results from the pipelines running on the server.

  • By configuring pipeline steps, you describe the test context: testing tool, test type, framework, and the environment on which it runs.

  • ALM Octane incorporates the results of automated tests run by the CI server into ALM Octane product and release quality analysis.

Follow the steps in the sections below to set up ALM Octane's integration with a CI server.

Back to top

Prerequisite: Obtain API access

Ask your shared space admin for an API access Client ID and Client secret. The plugin uses these for authentication when communicating with ALM Octane.

The shared space admin can obtain the Client ID and Client secret in ALM Octane Settings. The access keys must be assigned the CI/CD Integration role in all relevant workspaces. For details, see Set up API access for integration.

Back to top

Install the HPE plugin on your CI server

Download, install, and configure the plugin that enables ALM Octane integration with your CI server.

This plugin enables ALM Octane to retrieve and display your CI server's build pipelines, synchronize test run results with the CI server, and trigger pipeline runs on the CI server.

Plugins for Jenkins, TeamCity, and Bamboo are available online, in the relevant plugin pages. For Jenkins, this functionality is part of the HP Application Automation Tools plugin.

For other CI servers, build your own plugin in Java using the CI Plugin SDK for ALM Octane available on GitHub.

For details, see Install and configure the HPE plugin on your CI server.

For a list of CI server requirements and supported plugins, see Supported CI and SCM systems.

Back to top

Add CI servers on ALM Octane

For ALM Octane to integrate with a CI server, the servers and their URLs must be added in ALM Octane.

  1. In Settings , click Workspaces and select a workspace.

  2. Click the DevOps tab. On the left side of the pane, select CI Servers.

  3. Click + to add a CI server and enter a name for the server.

  4. Select a URL from the list of CI servers.

    The list displays all CI servers that meet the following conditions:

    • The server has the HPE ALM Octane CI plugin installed and configured to access your ALM Octane.

    • The API Access keys that the plugin is using are assigned the CI/CD Integration role in the current workspace.

Now you can work with pipelines in ALM Octane. For details, see Pipelines: CI server & SCM system integration.

Back to top

Manage your CI servers

The list of CI servers provides information about the servers' status, type, URL, and more.

  1. In Settings , click Workspaces and select a workspace.

  2. Click the DevOps tab. On the left side of the pane, select CI Servers.

    The list displays all servers that are set up with the HPE ALM Octane CI plugin to access your ALM Octane.

  3. Select the columns that you want displayed. For example, for each server, you can see:

    • Whether the server is currently connected.

    • The CI server type.

To delete a CI server and remove its connection to ALM Octane, select a server from the list and click X. If you delete a server, all of the server's pipelines are deleted from ALM Octane as well.

Back to top

Next steps: