Share

Jira Bridge Installation Guide

Preface

While this documentation is intended for software engineers, pipeline TDs, and anyone who will be setting up a production pipeline that integrates Flow Production Tracking and Jira, it assumes readers have very little knowledge on most topics.

This guide attempts to clarify and simplify every step of the process of connecting Flow Production Tracking and Jira.

By the end of this guide, you should be able to:

  • Set up a Flow Production Tracking site for Flow Production Tracking Jira Bridge integration, including creating custom fields, creating Flow Production Tracking Entity records, and creating a Legacy Login Passphrase and Personal Access Token
  • Set up a Jira site for Flow Production Tracking Jira Bridge integration, including creating custom fields, Jira Webhooks and Jira Users, and setting user permissions
  • Configure Flow Production Tracking with Jira settings
  • Install the Flow Production Tracking Python API, including installing Python and a Python editor, cloning the Python API repository, installing the Python API, creating a Flow Production Tracking Script entity, and creating a Flow Production Tracking API instance
  • Prepare for setup by downloading the Flow Production Tracking Jira Bridge and Flow Production Tracking Event Daemon repositories, installing the requirements, and creating a virtual environment
  • Install the Flow Production Tracking Event Daemon Trigger, including setting up the configuration file and environment variables, connecting the trigger to the Flow Production Tracking Jira Bridge, and running the trigger
  • Run the Flow Production Tracking Jira Bridge, including creating a handler for the Flow Production Tracking Jira Bridge, mapping Flow Production Tracking and Jira statuses, matching Flow Production Tracking users with Jira users, and starting and testing the bridge

Throughout this guide, as you create new credentials, including logins, scripts, and tokens, you will see a note that will link you to the Flow Production Tracking Jira Bridge Cheat Sheet and indicate which line of the cheat sheet your new credentials pertain to. The cheat sheet will act as a quick reference guide later in the installation process. Store all credentials somewhere safe and secure.

You will find several pages of Troubleshooting tips for macOS and for Windows, Known issues & compatibility notes and Additional resources relating to each topic covered. If you find yourself with questions throughout this process, these resources are a great place to start.

The installation guide is available for both macOS and Windows.

Was this information helpful?