Commit ae5edc4f authored by Evan Read's avatar Evan Read

Merge branch 'docs-jira-server-update' into 'master'

Update Jira process with style updates

See merge request gitlab-org/gitlab!52422
parents 2ac0cad8 7813d940
...@@ -4,61 +4,65 @@ group: Ecosystem ...@@ -4,61 +4,65 @@ group: Ecosystem
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
--- ---
# Creating a username and password for Jira Server # Create Jira Server username and password
We need to create a user in Jira to have access to all projects that need to integrate with GitLab. We need to create a user account in Jira to have access to all projects that
need to integrate with GitLab.
As an example, we create a user named `gitlab` and add it to a new group The Jira user account created for the integration must have write access to
named `gitlab-developers`. your Jira projects.
NOTE: As an example, the following process creates a user named `gitlab` and that's a
It is important that the Jira user created for the integration is given 'write' member of a new group named `gitlab-developers`:
access to your Jira projects. This is covered in the process below.
1. Log in to your Jira instance as an administrator and under **Jira Administration** 1. Sign in to your Jira instance as an administrator, and
go to **User Management** to create a new user. then go to the gear icon and select **User Management**.
![Jira user management link](img/jira_user_management_link.png) ![Jira user management link](img/jira_user_management_link.png)
1. The next step is to create a new user (e.g., `gitlab`) who has write access 1. Create a new user account (for example, `gitlab`) with write access to
to projects in Jira. Enter the user's name and a _valid_ e-mail address projects in Jira. Enter the user account's name and a valid e-mail address,
since Jira sends a verification e-mail to set up the password. because Jira sends a verification email to set up the password.
Jira creates the username automatically by using the e-mail Jira creates the username by using the email prefix. You can change the
prefix. You can change it later, if needed. Our integration does not support SSO (such as SAML). You username later, if needed. The GitLab integration doesn't support SSO (such
need to create an HTTP basic authentication password. You can do this by visiting the user as SAML). You need to create an HTTP basic authentication password. You can
profile, looking up the username, and setting a password. do this by visiting the user profile, looking up the username, and setting a
password.
![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 (we give this group write access to Jira 1. From the sidebar, select **Groups**.
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 a name and click **Add group**. 1. In the **Add group** section, enter a **Name** for the group (for example,
`gitlab-developers`), and then select **Add group**.
1. Add the `gitlab` user to the `gitlab-developers` group by clicking **Edit members**. 1. Add the `gitlab` user to the `gitlab-developers` group by selecting **Edit members**.
The `gitlab-developers` group should be listed in the leftmost box as a selected group. The `gitlab-developers` group should be listed in the leftmost box as a
Under **Add members to selected group(s)**, enter `gitlab`. selected group. In the **Add members to selected group(s)** area, enter `gitlab`.
![Jira add user to group](img/jira_add_user_to_group.png) ![Jira add user to group](img/jira_add_user_to_group.png)
Click **Add selected users** and `gitlab` should appear in the **Group member(s)** box. Select **Add selected users**, and `gitlab` should appear in the **Group member(s)**
This membership is saved automatically. area. This membership is saved automatically.
![Jira added user to group](img/jira_added_user_to_group.png) ![Jira added user to group](img/jira_added_user_to_group.png)
1. To give the newly-created group 'write' access, you need to create a **Permission Scheme**. 1. To give the newly-created group 'write' access, you must create a permission
To do this, click the gear icon and select **Issues**. Then click **Permission Schemes**. scheme. To do this, in the admin menu, go to the gear icon and select **Issues**.
Click **Add Permission Scheme** and enter a **Name** and, optionally, a **Description**.
1. Once your permission scheme is created, you are taken back to the permissions scheme list. 1. From the sidebar, select **Permission Schemes**.
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` 1. Select **Add Permission Scheme**, enter a **Name** and (optionally) a
from the dropdown. **Description**, and then select **Add**.
1. In the permissions scheme list, locate your new permissions scheme, and
select **Permissions**. Next to **Administer Projects**, select **Edit**. In
the **Group** list, select `gitlab-developers`.
![Jira group access](img/jira_group_access.png) ![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 are needed when [configuring GitLab in the next section](jira.md#configuring-gitlab). password, as you'll need them 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