ALM Octane DevOps plugin for Microsoft TFS

Description
Suggested apps
Releases
Resources
Reviews

Have questions about this item?

Contact us
Subscribe to receive update notifications for this item
Subscribe

Description

To set up the plugin, you download and install the zip file from the Releases section on this page, then configure your settings as described below.

Install the Azure DevOps Server (TFS) plugin

Download the zip file that matches your AzureDevOps or TFS version, and extract its contents. Make sure you download the plugin for the correct AzureDevOps/TFS version. If the version of your AzureDevOps/TFS does not match the plugin version, the plugin may not work.
Run the setup.exe installation file. The default installation folder depends on your Azure DevOps Server/TFS version. For example, for Azure DevOps Server 2019 the path is C:\Program Files\Azure DevOps Server 2019\Application Tier\TFSJobAgent\Plugins\. If you are using a different installation path, enter it when running the installer.

Note that when installing or uninstalling the plugin, the TFSJobAgent service will be restarted, and TFS activity is momentarily paused.

Configure the AzureDevOps/TFS plugin to connect to ALM Octane

Before you configure the connection:

Ask your ALM Octane shared space admin for an API access Client ID and Client secret. The plugin uses these for authentication when communicating with ALM Octane. The access keys must be assigned the CI/CD Integration role in all relevant workspaces. For details, see Set up API access in the ALM Octane Help.

To configure the connection:

After installation, enter the following information in the relevant fields:

ALM Octane Location: Use the format http://myServer.myCompany.com:8081/ui/?p=1002 where 1002 is your shared space ID, and 8081 is the ALM Octane service port.
ALM Octane Client ID/Secret: Enter your ALM Octane API access client ID and client secret. The plugin uses these for authentication when communicating with ALM Octane.
Azure DevOps Server Location: Enter the location of your Azure DevOps/TFS Server.
PAT (TFS Personal access token): Enter a token that is configured by TFS admin (see PAT). PAT minimal permission set should contain:
- Build (read and execute)
- Code (read)
- Project and team (read)
- Test management (read)
Instance ID: Automatically generated to identify the plugin instance

Note that the TFSJobAgent service will be restarted to enable the plugin to load.

After the connection is set up, open ALM Octane, define a CI server and create pipelines. For details, see Set up CI servers in the ALM Octane Help.

Administer the plugin

You can use the plugin management console to perform the following:

Modify plugin connection settings
Define proxy settings to connect to ALM Octane (for Azure DevOps Server 2019 only)
View logs
Start/stop the plugin

The plugin management console is available from your local machine, using the address http://localhost:4567/. Only localhost can administer the plugin. (Other addresses will be read-only.)

Plugin logs are located in C:\Users\Public\Documents\OctaneTfsPlugin\logs.

Limitations

The plugin does not support commits to ALM Octane if using TFVC.