Install and configure the ALM Octane CI plugin on your CI server

When setting up a CI server for ALM Octane for the first time, install the ALM Octane CI plugin on your CI server and configure it to connect to ALM Octane.

Plugins for Jenkins, TeamCity, Bamboo, and TFS are available online. For Jenkins, this functionality is part of the HPE Application Automation Tools plugin.

Plugin overview

This plugin enables ALM Octane to integrate with a CI server, and provide the following abilities:

  • Retrieve and display the build pipelines that run on the CI server

  • Trigger pipeline runs on the CI server

  • Retrieve build run results, test run results, and commit information from the CI server

  • Retrieve code coverage reports from a Jenkins CI server

  • Trigger UFT test execution on a Jenkins CI server

Back to top

Prerequisites

DevOps admin permissions are required.

  • 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.

  • Obtain access to a CI server that meets the necessary requirements. For the CI servers that are supported by the ALM Octane CI plugins, see CI Servers.

    For a list of plugins that must be installed on the Jenkins server to enable ALM Octane integration, as well as plugins that are supported by the ALM Octane integration but not required, see HPE Application Automation Tools wiki page.

  • SaaS: To enable the CI server to communicate with ALM Octane, make sure that the server can access the Internet.

    If your network requires a proxy to connect to the Internet, setup the required proxy configuration.

    For example, on a Jenkins CI server: Go to Manage Jenkins > Manage Plugins > Advanced and define the necessary HTTP Proxy Configuration details.

  • For Jenkins, Bamboo, and TFS, decide which CI server user or TFS Personal Access Token (PAT) ALM Octane will use to execute jobs on the server.

    The CI server user or TFS PAT must have the following permissions:

    On Bamboo: Build plan
    On Jenkins, for working with pipelines: Job Build

    On Jenkins, for ALM Octane-UFT integration without pipelines:

    Job Create, Delete, and Read

    If your Git repository requires credentials, Credentials create and update permissions are also required.

    On TFS:

    Read permissions for: Build, Code, Project and team, Test management

    Execute permissions for Build

    Caution: We strongly recommend limiting this user’s permissions to the minimum required for this integration.

Back to top

Install the ALM Octane CI plugin

Download the relevant plugin from the Internet and install it on your CI server. Do one of the following:

Jenkins

In your Jenkins server's user interface, open the plugin management area and upload the plugin:

  1. Click Manage Jenkins (on the left).

  2. Click Manage Plugins, select the Advanced tab, and scroll down to Upload Plugin.

  3. Browse to the plugin file that you downloaded and click Upload.

  4. Select the option to restart Jenkins when installation is complete and no jobs are running.

TeamCity

In your TeamCity server's user interface, open the plugin management area and upload the plugin:

  1. Go to Administration > Plugins List and click Upload plugin zip.
  2. Browse to the plugin file that you downloaded and click Upload.
  3. Restart the TeamCity server.
Bamboo

In your Bamboo server's user interface, open the add on management area and upload the plugin:

  1. Click the Administration cogwheel button and select Add-ons from the menu.

  2. Click Pause server to pause the server while you install a new add on, to avoid adverse effects on currently running builds.

  3. Click Upload add-on, browse to the plugin file that you downloaded and click Upload.

  4. Click Resume server at the top of the page.

TFS

Run the downloaded MSI on your TFS machine to install the plugin.

Before configuring the plugin to access ALM Octane, the plugin installation must be complete:

Jenkins & TeamCity

Wait for the CI server to finish restarting.

Bamboo

Refresh the CI server user interface page.

TFS

Restart the TFS Windows service: Visual Studio Team Foundation Background Job Agent

Note:  

  • If you enable or disable the plugin at any time after installation, you must restart your CI server (Jenkins, TeamCity, Bamboo).
  • To update or reinstall the TFS plugin, you must first stop the TFS Windows service: Visual Studio Team Foundation Background Job Agent. Restart the service after the plugin is updated.

Back to top

Configure the ALM Octane CI plugin to access ALM Octane

After you install the ALM Octane CI plugin on your CI server, configure the plugin to access ALM Octane.

Tip: After installing the plugin and before configuring it, wait for the CI server to restart (Jenkins or TeamCity), refresh the add-on management page (Bamboo), or restart the CI server (TFS).

  1. Open the plugin's configuration area. Do one of the following:

    Jenkins

    In your Jenkins server's user interface, locate the configuration area for the ALM Octane CI plugin:

    1. Click Manage Jenkins (on the left).

    2. Click Configure System.

    3. Scroll down to the configuration area for the ALM Octane CI.

    TeamCity

    In your TeamCity server's user interface, locate the configuration area for the ALM Octane CI plugin:

    1. Go to Administration.
    2. Under Server Administration, click ALM Octane CI Plugin.
    Bamboo

    In your Bamboo server's user interface, locate the configuration area for the ALM Octane CI plugin:

    1. Click the Administration cogwheel button and select Add-ons from the menu.

    2. In the left pane, click ALM Octane CI Plugin under COMMUNICATION.

    TFS

    On your TFS machine, access the plugin's console:

    1. Go to http://localhost:4567.
    2. Click Configuration.

    For more details, see the plugin's readme.

  2. Enter the following information:

    Location

    The URL of the ALM Octane server, using its fully qualified domain name (FQDN).

    Use the following format (port number is optional):

    http://<ALM Octane hostname / IP address> {:<port number>}/ui/?p=<space ID>

    Example:  

    In this URL, the space ID is 1002: http://myServer.myCompany.com:8081/ui/?p=1002

    Tip: You can copy the URL from the address bar of the browser in which you opened ALM Octane.

    Client ID The API access Client ID that the plugin should use to connect to ALM Octane. For details, see prerequisites.
    Client secret The Client secret that the plugin should use to connect to ALM Octane. For details, see prerequisites.
    Jenkins user / Bamboo user

    The CI server user account that will run jobs at ALM Octane's request.

    This option is available only on Jenkins and Bamboo.

    Caution:  

    • Make sure the user exists in the CI server.
    • In Bamboo, you must specify a user.

      In Jenkins, if you do not specify a Jenkins user, ALM Octane uses Anonymous, and is limited to Anonymous’s permissions.

    TFS location and TFS PAT

    HTTP address and Personal Access Token for the plugin to use to access TFS. The permissions required for this PAT are specified above.

    These options are available only on TFS.

  3. Click Test Connection to validate the configuration, and then save your changes.

Back to top

Moving an existing CI server to a new address

If your Bamboo or TeamCity CI server moves to a new location and you reinstall the plugin, you must re-create the CI server and its pipelines in ALM Octane.

In Jenkins or TFS, if you move your server and reinstall the plugin, you can adjust the plugin's configuration to continue working with your existing pipelines.

Configure the Jenkins or TFS plugin to work with existing ALM Octane pipelines

  1. Get the plugin instance ID originally used to set up the CI server on ALM Octane:

    1. In ALM Octane, in Settings , click Spaces and select a workspace.

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

    3. In the grid, locate the Instance ID column and copy your CI server's Instance ID.

  2. In TFS or Jenkins, update the new plugin to use the original instance ID.

    Jenkins

    In your Jenkins server's user interface: 

    1. Click Manage Plugins in the left pane.

    2. Click Configure System.

    3. Scroll down to the ALM Octane CI configuration area.

    4. Click Show plugin instance ID.

    5. In the Instance ID box, enter the Instance ID you copied from ALM Octane earlier.

    TFS
    1. On the TFS server, go to http://localhost:4567 to access the plugin's console.
    2. Click Configuration.
    3. In the Instance ID box, enter the Instance ID you copied from ALM Octane earlier.

    For more details, see the plugin's readme.

Back to top

Upgrade from the ALM Octane CI Jenkins plugin to the HPE Application Automation Tools plugin

The HPE Application Automation Tools plugin now includes the functionality of the ALM Octane CI Jenkins plugin and includes the latest plugin improvements.

To upgrade from the ALM Octane CI plugin to the HPE Application Automation Tools plugin:

  1. In Jenkins, click Manage Plugins in the left pane.

  2. Select the Installed tab and uninstall the ALM Octane CI plugin.

  3. Restart Jenkins.

  4. On the HPE Application Automation Tools wiki page, click the link to the latest plugin version, download the plugin, and install it on your Jenkins server.

  5. Restart Jenkins.

  6. Configure the ALM Octane CI plugin to access ALM Octane.

  7. Configure the Jenkins or TFS plugin to work with existing ALM Octane pipelines.

Back to top

Next steps: