...
You have to choose proper way based on available options. If Gitlab GitLab is hosting intended repositories, you shall use Gitlab GitLab auto-connect in Jira Git plugin. Use generic Git connect only in custom and edge cases.
...
service account available for integration purposes
Note 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 GitlabGitLab
- personal access token must be generated for that service account in GitlabGitLab
- 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
| Note |
|---|
These instructions are made for TDS users. Getting service account into your local Gitlab 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 service account has access into proper repositories - use portal to check and correct if needed
- Make sure you have credentials for service account, if not, reset them in portal following steps described in Project Details#ServiceAccount
...
- 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
...
- For example for integrating with Jira choose "api, read_
...
- api, read_
...
- user, read_repository, write_repository"
- Copy generated token for later use
- Verify that account can access desired repositories
...
- Use the token as necessary or send request to TDS team with relevant information:
- service account token
...
- GitLab URL
- Which interation you would like to achieve, for example - Jira project URLs with KEYs that you need to integrate this
...
- GitLab with
Preparing service account in TDS
...
GitLab by TDS support/consultancy team
- Add service account into proper repositories using portal
- Go to Gitlab GitLab users list https://gitlab.shared.CUSTOMERX.tds.tieto.com/admin/users
- Search for that service account and open it by clicking username or simply go to user profile using this direct link while replacing XXX with username - https://gitlab.shared.CUSTOMERX.tds.tieto.com/admin/users/XXX
- Click "Impersonate"
- 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 Select desired validity or or remove the date to make it never expire - depending on project needs and your security rules and procedures
- Select reasonable scopes
- For example for integrating with Jira choose
- "api, read_
- api, read_
- user, read_repository, write_repository"
- Copy generated token for later use
- Verify that account can access desired repositories
- Stop impersonation
...
- Go to https://jira.shared.CUSTOMERX.tds.tieto.com/secure/ViewGitRepositories.jspa
- Click Gitlab GitLab in auto-connect options
- Provide Gitlab 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 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 GitLab URL to service account username and something which represents that integration, usually portal project name, for example "MyPortalProject - 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
- Go to you Gitlab GitLab project settings, URL shall be like https://gitlab.shared.CUSTOMERX.tds.tieto.com/PORTAL-PROJECT-NAME/GITLABGitLab-PROJECT-NAME/-/services/jira/edit
- Enable it (Active ~ true)
- Select triggers and actions feasible for you
- Enter Jira Web URL, for example https://jira.shared.CUSTOMERX.tds.tieto.com
- Leave "Jira API URL" empty as TDS provides REST api on standard endpoints. If you have some different NON TDS Jira, you might need to specify this REST API URL.
- Username or Email - recommended is username of your project dedicated service account, which is described in Project Details#ServiceAccount
- Password or API token - recommended is token of your project dedicated service account, which is described in Project Details#ServiceAccount
More details can be found in GitLab documentation https://gitlab.shared.pub.tds.tieto.com/help/user/project/integrations/Jira
GitHub Enterprise integration with Jira
After it is integrated, just give it some time, commits become to be visible with delay especially if many repositories is configured.