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

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

  • Synchronize test run results with the CI server

  • Trigger pipeline runs on the CI server

Perform these steps once, when setting up a CI server for ALM Octane for the first time.

Caution:  

  • To install a new version of the plugin, upgrade the existing plugin. If you uninstall the plugin and install a new one, you must re-create the CI server and its pipelines in ALM Octane.

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

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 for integration.

  • Obtain access to a CI server that meets the requirements listed in Supported CI and SCM systems.

  • 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 or Bamboo, decide which CI server user ALM Octane will use to execute jobs on the server.

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

    • Jenkins: Job Build permissions.
    • Bamboo: Build plan permissions.

Back to top

Download and install the HPE ALM Octane CI plugin

  1. Download the plugin from 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. In the instructions on the right, click the link to Download the plugin. Select your type of CI server and save the downloaded plugin.

  2. Upload the plugin file to install it on your CI server:

    In your CI server's user interface, open the plugin management area.

    Do one of the following: 

    Jenkins
    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
    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
    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 affects 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.

  3. Configure the plugin to access ALM Octane.

    Jenkins and TeamCity: After the CI server restarts, configure the plugin as described below.

    Bamboo: Refresh the CI server user interface page, then configure the plugin as described below.

Note: If you enable or disable the plugin at any time after installation, you must restart your CI server.

Back to top

Configure the HPE ALM Octane CI plugin to access ALM Octane

After you install the HPE 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), or refresh the add-on management page (Bamboo).

  1. In your CI server's user interface, locate the configuration area for the HPE ALM Octane CI plugin.

    Do one of the following:

    Jenkins
    1. Click Manage Jenkins (on the left).

    2. Click Configure System.

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

    TeamCity
    1. Go to Administration.
    2. Under Server Administration, click ALM Octane CI Plugin.
    Bamboo
    1. Click the Administration cogwheel button and select Add-ons from the menu.

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

  2. Enter the following information:

    Location

    The URL of the ALM Octane server. Use the following format (port number is optional):

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

    Example:  

    In this URL, the shared 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.

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

Back to top

Next steps: