Commit f08abfcc authored by Mike Lewis's avatar Mike Lewis

Merge branch 'docs/58975-jira-integration-docs' into 'master'

Improve Jira Server documentation

Closes #58975

See merge request gitlab-org/gitlab-ce!28463
parents 5997cc89 64cc393f
...@@ -47,11 +47,11 @@ project in Jira and then enter the correct values in GitLab. ...@@ -47,11 +47,11 @@ project in Jira and then enter the correct values in GitLab.
When connecting to **JIRA Server**, which supports basic authentication, a **username and password** are required. Check the link below and proceed to the next step: When connecting to **JIRA Server**, which supports basic authentication, a **username and password** are required. Check the link below and proceed to the next step:
- [Setting up an user in JIRA server](jira_server_configuration.md) - [Setting up a user in JIRA server](jira_server_configuration.md)
When connecting to **JIRA Cloud**, which supports authentication via API token, an **email and API token**, are required. Check the link below and proceed to the next step: When connecting to **JIRA Cloud**, which supports authentication via API token, an **email and API token**, are required. Check the link below and proceed to the next step:
- [Setting up an user in JIRA cloud](jira_cloud_configuration.md) - [Setting up a user in JIRA cloud](jira_cloud_configuration.md)
### Configuring GitLab ### Configuring GitLab
......
# Creating a username and password for JIRA server # Creating a username and password for JIRA server
We need to create a user in Jira which will have access to all projects that We need to create a user in Jira which will have access to all projects that
need to integrate with GitLab. Login to your Jira instance as admin and under need to integrate with GitLab.
*Administration*, go to *User Management* and create a new user.
As an example, we'll create a user named `gitlab` and add it to the `Jira-developers` As an example, we'll create a user named `gitlab` and add it to the `Jira-developers`
group. group.
NOTE: **Note** NOTE: **Note**
It is important that the user `gitlab` has 'write' access to projects in Jira. It is important that the Jira user created for the integration is given 'write'
access to your Jira projects. This is covered in the process below.
We have split this stage in steps so it is easier to follow. 1. Log in to your Jira instance as an administrator and under **Jira Administration**
1. Log in to your Jira instance as an administrator and under **Administration**
go to **User Management** to create a new user. go to **User Management** to create a new user.
![Jira user management link](img/jira_user_management_link.png) ![Jira user management link](img/jira_user_management_link.png)
...@@ -27,27 +25,34 @@ We have split this stage in steps so it is easier to follow. ...@@ -27,27 +25,34 @@ We have split this stage in steps so it is easier to follow.
![Jira create new user](img/jira_create_new_user.png) ![Jira create new user](img/jira_create_new_user.png)
1. Create a `gitlab-developers` group which will have write access 1. Create a `gitlab-developers` group. (We will give this group write access to Jira
to projects in Jira. Go to the **Groups** tab and select **Create group**. projects in a later step). Go to the **Groups** tab on the left, and select **Add group**.
![Jira create new user](img/jira_create_new_group.png) ![Jira create new user](img/jira_create_new_group.png)
Give it an optional description and click **Create group**. Give it a name and click **Add group**.
![Jira create new group](img/jira_create_new_group_name.png) 1. Add the `gitlab` user to the `gitlab-developers` group by clicking **Edit members**.
The `gitlab-developers` group should be listed in the leftmost box as a selected group.
Under **Add members to selected group(s)**, enter `gitlab`.
1. To give the newly-created group 'write' access, go to ![Jira add user to group](img/jira_add_user_to_group.png)
**Application access > View configuration** and add the `gitlab-developers`
group to Jira Core.
![Jira group access](img/jira_group_access.png) Click **Add selected users** and `gitlab` should appear in the **Group member(s)** box.
This membership is saved automatically.
1. Add the `gitlab` user to the `gitlab-developers` group by going to ![Jira added user to group](img/jira_added_user_to_group.png)
**Users > GitLab user > Add group** and selecting the `gitlab-developers`
group from the dropdown menu. Notice that the group says _Access_, which is
intended as part of this process.
![Jira add user to group](img/jira_add_user_to_group.png) 1. To give the newly-created group 'write' access, you need to create a **Permission Scheme**.
To do this, click the gear icon and select **Issues**. Then click **Permission Schemes**.
Click **Add Permission Scheme** and enter a **Name** and, optionally, a **Description**.
1. Once your permission scheme is created, you'll be taken back to the permissions scheme list.
Locate your new permissions scheme and click **Permissions**. Next to **Administer Projects**,
click **Edit**. In the resulting dialog box, select **Group** and select `gitlab-developers`
from the dropdown.
![Jira group access](img/jira_group_access.png)
The Jira configuration is complete. Write down the new Jira username and its The Jira configuration is complete. Write down the new Jira username and its
password as they will be needed when [configuring GitLab in the next section](jira.md#configuring-gitlab). password as they will be needed when [configuring GitLab in the next section](jira.md#configuring-gitlab).
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment