Page tree
Skip to end of metadata
Go to start of metadata

Intro

It is necessary to understand basic principles. There is either generic Git support with basic Git functionalities but without any advanced integrations like merge requests, branches and so on.

You have to choose proper way based on available options. If Gitlab is hosting intended repositories, you shall use Gitlab auto-connect in Jira Git plugin. Use generic Git connect only in custom and edge cases.

Recommended setup:

  • service account available for integration purposes

    Personal accounts are NOT recommended because integrations usually fail when person changes credentials or leaves the project/company.

  • do not use service accounts with huge amount of repositories access as the sync can/will use lot of Jira server storage
  • in case of custom/generic repositories limit the projects that will use every specific repository otherwise it can be security issue

Gitlab repositories integration

How does it work:

  • service account needs to be created in Gitlab
  • personal access token must be generated for that service account in Gitlab
  • access to proper repositories must be granted to this service account
  • Jira admins shall setup integration using service account credentials

Getting service account in Gitlab

These instructions are made for TDS users. Getting service account into your local Gitlab installations will be similar in principle, however you need to adapt them on your environment.

Preparing service account in TDS GItlab by end users

  • Make sure you have credentials for service account, if not, reset them in portal following steps described in Project Details#ServiceAccount
  • Add service account into proper repositories using portal
  • Open inkognito/private window
  • Login to Gitlab using service account credentials
  • Then go to Personal Access Tokens page https://gitlab.shared.CUSTOMERX.tds.tieto.com/profile/personal_access_tokens
  • Fill the name , for example like "jira-integration"
  • Leave Expires at EMPTY to keep it unlimited depending on project needs
  • Choose "api,read_user, read_api, read_repository, write_repository"
  • Copy generated token for later use
  • Verify that account can access desired repositories
  • Send request to TDS team with relevant information:
    • service account token
    • Gitlab URL
    • Jira project URLs with KEYs that you need to integrate this Gitlab with

Preparing service account in TDS GItlab by TDS support/consultancy team

Setting Git integration in Jira by administrators

  • Go to https://jira.shared.CUSTOMERX.tds.tieto.com/secure/ViewGitRepositories.jspa
  • Click Gitlab in auto-connect options
  • Provide Gitlab URL
  • Enter access token generated in previous step
  • Click Next and check loaded projects/repositories list to see whether accesses are correct and make sure to fix it
  • Click Continue
  • Untick "Associate with all projects" and choose proper Jira projects to map selected repositories to
    • Or enable PAT for users interactions with Gitlab which is even better but can be very confusing and complex for users
  • Click Finish
  • Find newly created integration
  • Click gear next to it and select "Edit integration connection settings"
  • Change "Display Name" from Gitlab URL to service account username and something which represents that integration, usually portal project name, for example "srv123abc - MyPortalProject"
  • Click Update

Generic Git repositories integration

  • service account is recommended to be created in remote Git solution
  • SSH key, username and password or personal access token must be generated for that service account
  • access to proper repositories must be granted to this service account
  • Jira admins shall setup integration using provided service account credentials and all required repositories one by one

Integrate Gitlab project into Jira

More details can be found in Gitlab documentation https://gitlab.shared.pub.tds.tieto.com/help/user/project/integrations/jira


  • No labels