How to integrate on-prems GitLab to Jira Cloud securely

[Guy]

While GitLab.com integration is rather straight forward, what are the different possible secure ways to integrate an on-prems GitLab instance to a Jira Cloud ?

We can assume the availability of an API gateway in the middle for incoming traffic (Jira to GitLab), or a web proxy for outgoing (GitLab to Jira).

Securely means that i can do things like:
* IP white-listing (of Atlassian obviously) on my API gateway for incoming traffic
* authentication for either way of traffic
* a Jira project can only access 1 (or few) GitLab projects can be a good control
* the Jira user identity is passed to GitLab (we use SAML via Guard)
* encrypted traffic obviously

[Akash Singh · Accepted solution]

Hi @Guy 

Assuming the self-hosted version of GitLab is updated to the latest version (v17.8), and both ingress (incoming traffic to GitLab) and egress (outgoing traffic from GitLab) are allowed, integrating GitLab with Jira Cloud can be broadly divided into two key steps:

1. Integrating Jira Issues with GitLab
2. Jira Development Panel Integration

Both steps are explained in detail in the official GitLab documentation: GitLab Jira Integration Documentation

---

1. Integrating Jira Issues with GitLab

This step enables linking Jira issues to GitLab commits and merge requests. Since this integration only requires outgoing traffic from GitLab to Jira, ensure that your GitLab instance can access Jira Cloud.

Follow the steps outlined in the GitLab documentation: Configuring Jira Issue Integration

This configuration is straightforward and does not require additional setup on the Jira side. Once configured, GitLab can automatically reference Jira issues using issue keys in commit messages.

2. Jira Development Panel Integration

This integration adds a development panel to Jira issues, displaying information about related commits, branches, and merge requests from GitLab. Since this requires incoming & outgoing traffic to GitLab from Jira Cloud, it is crucial to ensure that:

• The Gitlab instance must be publicly available.
• An API gateway or reverse proxy is configured to securely allow incoming traffic.

Steps to Install and Configure the GitLab for Jira Cloud App:

1. Install the GitLab for Jira Cloud App

   Follow the instructions to manually install the GitLab for Jira Cloud app: Manual Installation Guide

   You have two options for installation:

   a. Development Mode:

   • Install the app in development mode by registering it directly in your Jira instance.
   • This approach is quicker but requires manual reinstallation after future GitLab upgrades.

   b. Private Marketplace Listing:

   • Create a private listing of your GitLab instance’s Jira app in the Atlassian Marketplace.
   • This approach involves additional setup but ensures automatic updates whenever GitLab releases new versions of the app.

   Detailed instructions for both methods can be found here:

   • Development Mode Installation
   • Private Marketplace Listing

2. Configure the Installed App

   Once the app is installed, configure it by following the steps in this guide: Configuring the GitLab for Jira Cloud App

[Guy]

Thanks a lot, I was a little lost in all the pages. Your hints are very useful.

I will need to further test, and also validate the access control of Jira to my self-hosted GitLab, that Jira should be able to access only a very limited list of GitLab projects.

[sanam malleswari · Accepted solution]

Hi @Guy ,

I hope this below integration will help.

Please follow below path in jira cloud for gitlab integration,
Settings>>Apps>>Atlassian Marketplace>>OAuth credentials.

[Guy]

Good emphasis. I need to test. Debug seems very low level in case things go wrong!