diff options
Diffstat (limited to 'doc/user/group')
19 files changed, 298 insertions, 160 deletions
diff --git a/doc/user/group/contribution_analytics/index.md b/doc/user/group/contribution_analytics/index.md index 3b866c4a1b0..cd2d5c190a1 100644 --- a/doc/user/group/contribution_analytics/index.md +++ b/doc/user/group/contribution_analytics/index.md @@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3090) in GitLab 12.2 for subgroups. -With Contribution Analytics, you can get an overview of the [contribution events](../../index.md#user-contribution-events) in your +With Contribution Analytics, you can get an overview of the [contribution events](../../profile/index.md#user-contribution-events) in your group. - Analyze your team's contributions over a period of time. diff --git a/doc/user/group/epics/img/related_epic_block_v14_9.png b/doc/user/group/epics/img/related_epic_block_v14_9.png Binary files differindex 7b5824b84d1..20fdce0151d 100644 --- a/doc/user/group/epics/img/related_epic_block_v14_9.png +++ b/doc/user/group/epics/img/related_epic_block_v14_9.png diff --git a/doc/user/group/epics/img/related_epics_add_v14_9.png b/doc/user/group/epics/img/related_epics_add_v14_9.png Binary files differindex 3da6eeaff43..112b900f2e3 100644 --- a/doc/user/group/epics/img/related_epics_add_v14_9.png +++ b/doc/user/group/epics/img/related_epics_add_v14_9.png diff --git a/doc/user/group/epics/index.md b/doc/user/group/epics/index.md index 149c5362ac9..f2cb437ffda 100644 --- a/doc/user/group/epics/index.md +++ b/doc/user/group/epics/index.md @@ -45,20 +45,6 @@ have a start or due date, a visual  -## Permissions - -If you have access to view an epic and an issue added to that epic, you can view the issue in the -epic's issue list. - -If you have access to edit an epic and an issue added to that epic, you can add the issue to or -remove it from the epic. - -For a given group, the visibility of all projects must be the same as -the group, or less restrictive. That means if you have access to a group's epic, -then you already have access to its projects' issues. - -You can also consult the [group permissions table](../../permissions.md#group-members-permissions). - ## Related topics - [Manage epics](manage_epics.md) and multi-level child epics. diff --git a/doc/user/group/epics/manage_epics.md b/doc/user/group/epics/manage_epics.md index 3350b0f1169..e8f720238ed 100644 --- a/doc/user/group/epics/manage_epics.md +++ b/doc/user/group/epics/manage_epics.md @@ -16,6 +16,10 @@ to them. > - In [GitLab 13.7](https://gitlab.com/gitlab-org/gitlab/-/issues/229621) and later, the New Epic button on the Epics list opens the New Epic form. > - In [GitLab 13.9](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/45948) and later, you can create a new epic from an empty roadmap. +Prerequisites: + +- You must have at least the Reporter role for the epic's group. + To create an epic in the group you're in: 1. Get to the New Epic form: @@ -68,6 +72,10 @@ After you create an epic, you can edit the following details: - Due date - Labels +Prerequisites: + +- You must have at least the Reporter role for the epic's group. + To edit an epic's title or description: 1. Select **Edit title and description** **{pencil}**. @@ -87,6 +95,10 @@ Users with at least the Reporter role can manage epics. When bulk editing epics in a group, you can edit their labels. +Prerequisites: + +- You must have at least the Reporter role for the parent epic's group. + To update multiple epics at the same time: 1. In a group, go to **Epics > List**. @@ -97,8 +109,9 @@ To update multiple epics at the same time: ## Delete an epic -NOTE: -To delete an epic, you must be an Owner of a group or subgroup. +Prerequisites: + +- You must have the Owner role for the epic's group. To delete the epic: @@ -112,6 +125,10 @@ If you delete an epic, all its child epics and their descendants are deleted as ## Close an epic +Prerequisites: + +- You must have at least the Reporter role for the epic's group. + Whenever you decide that there is no longer need for that epic, close the epic by: @@ -123,13 +140,19 @@ close the epic by: ## Reopen a closed epic -You can reopen an epic that was closed by: +You can reopen an epic that was closed. + +Prerequisites: -- Selecting **Reopen epic**. +- You must have at least the Reporter role for the epic's group. + +To do so, either: + +- Select **Reopen epic**.  -- Using the `/reopen` [quick action](../../project/quick_actions.md). +- Use the `/reopen` [quick action](../../project/quick_actions.md). ## Go to an epic from an issue @@ -144,6 +167,13 @@ In a group, the left sidebar displays the total count of open epics. This number indicates all epics associated with the group and its subgroups, including epics you might not have permission to view. +Prerequisites: + +- You must be a member of either: + - The group + - A project in the group + - A project in one of the group's subgroups + To view epics in a group: 1. On the top bar, select **Menu > Groups** and find your group. @@ -225,6 +255,10 @@ and confidential child epics. However, merge requests are public, if created in Read [Merge requests for confidential issues](../../project/merge_requests/confidential.md) to learn how to create a confidential merge request. +Prerequisites: + +- You must have at least the Reporter role for the epic's group. + To make an epic confidential: - **When creating an epic:** select the checkbox under **Confidentiality**. @@ -236,6 +270,15 @@ To make an epic confidential: This section collects instructions for all the things you can do with [issues](../../project/issues/index.md) in relation to epics. +### View issues assigned to an epic + +On the **Epics and Issues** tab, you can see epics and issues assigned to this epic. +Only epics and issues that you can access show on the list. + +You can always view the issues assigned to the epic if they are in the group's child project. +It's possible because the visibility setting of a project must be the same as or less restrictive than +of its parent group. + ### View count of issues in an epic On the **Epics and Issues** tab, under each epic name, hover over the total counts. @@ -258,7 +301,12 @@ An epic contains a list of issues and an issue can be associated with at most on When you add a new issue that's already linked to an epic, the issue is automatically unlinked from its current parent. -To add a new issue to an epic: +Prerequisites: + +- You must have at least the Reporter role for the epic's group. +- You must be able to [edit the issue](../../project/issues/managing_issues.md#edit-an-issue). + +To add an existing issue to an epic: 1. On the epic's page, under **Epics and Issues**, select **Add**. 1. Select **Add an existing issue**. @@ -277,19 +325,30 @@ To add a new issue to an epic: Creating an issue from an epic enables you to maintain focus on the broader context of the epic while dividing work into smaller parts. +Prerequisites: + +- You must have at least the Reporter role for the epic's group. + To create an issue from an epic: 1. On the epic's page, under **Epics and Issues**, select **Add**. 1. Select **Add a new issue**. 1. Under **Title**, enter the title for the new issue. -1. From the **Project** dropdown, select the project in which the issue should be created. +1. From the **Project** dropdown list, select the project in which the issue should be created. 1. Select **Create issue**. +The new issue is assigned to the epic. + ### Remove an issue from an epic You can remove issues from an epic when you're on the epic's details page. After you remove an issue from an epic, the issue is no longer associated with this epic. +Prerequisites: + +- You must have at least the Reporter role for the epic's group. +- You must be able to [edit the issue](../../project/issues/managing_issues.md#edit-an-issue). + To remove an issue from an epic: 1. Next to the issue you want to remove, select **Remove** (**{close}**). @@ -305,6 +364,10 @@ To remove an issue from an epic: New issues appear at the top of the list in the **Epics and Issues** tab. You can reorder the list of issues by dragging them. +Prerequisites: + +- You must have at least the Reporter role for the epic's group. + To reorder issues assigned to an epic: 1. Go to the **Epics and Issues** tab. @@ -317,32 +380,47 @@ To reorder issues assigned to an epic: New issues appear at the top of the list in the **Epics and Issues** tab. You can move issues from one epic to another. +Prerequisites: + +- You must have at least the Reporter role for the epic's group. +- You must be able to [edit the issue](../../project/issues/managing_issues.md#edit-an-issue). + To move an issue to another epic: 1. Go to the **Epics and Issues** tab. -1. Drag issues into the desired parent epic. +1. Drag issues into the desired parent epic in the visible hierarchy. ### Promote an issue to an epic > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3777) in GitLab 11.6. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/37081) from GitLab Ultimate to GitLab Premium in 12.8. -If you have the necessary [permissions](../../permissions.md) to close an issue and create an -epic in the immediate parent group, you can promote an issue to an epic with the `/promote` +Prerequisites: + +- The project to which the issue belongs must be in a group. +- You must have at least the Reporter role the project's immediate parent group. +- You must either: + - Have at least the Reporter role for the project. + - Be the author of the issue. + - Be assigned to the issue. + +You can promote an issue to an epic with the `/promote` [quick action](../../project/quick_actions.md#issues-merge-requests-and-epics). -Only issues from projects that are in groups can be promoted. When you attempt to promote a confidential -issue, a warning is displayed. Promoting a confidential issue to an epic makes all information + +NOTE: +Promoting a confidential issue to an epic makes all information related to the issue public as epics are public to group members. When an issue is promoted to an epic: +- If the issue was confidential, an additional warning is displayed first. - An epic is created in the same group as the project of the issue. - Subscribers of the issue are notified that the epic was created. The following issue metadata is copied to the epic: - Title, description, activity/comment thread. -- Upvotes/downvotes. +- Upvotes and downvotes. - Participants. - Group labels that the issue already has. - Parent epic. @@ -367,6 +445,10 @@ Epics can contain multiple nested child epics, up to a total of seven levels dee ### Add a child epic to an epic +Prerequisites: + +- You must have at least the Reporter role for the parent epic's group. + To add a child epic to an epic: 1. Select **Add**. @@ -388,6 +470,10 @@ You can move child epics from one epic to another. When you add a new epic that's already linked to a parent epic, the link to its current parent is removed. Issues and child epics cannot be intermingled. +Prerequisites: + +- You must have at least the Reporter role for the parent epic's group. + To move child epics to another epic: 1. Go to the **Epics and Issues** tab. @@ -400,6 +486,10 @@ To move child epics to another epic: New child epics appear at the top of the list in the **Epics and Issues** tab. You can reorder the list of child epics. +Prerequisites: + +- You must have at least the Reporter role for the parent epic's group. + To reorder child epics assigned to an epic: 1. Go to the **Epics and Issues** tab. @@ -407,6 +497,10 @@ To reorder child epics assigned to an epic: ### Remove a child epic from a parent epic +Prerequisites: + +- You must have at least the Reporter role for the parent epic's group. + To remove a child epic from a parent epic: 1. Select **Remove** (**{close}**) in the parent epic's list of epics. diff --git a/doc/user/group/import/index.md b/doc/user/group/import/index.md index 0c16b535ed1..0185cb9cfdf 100644 --- a/doc/user/group/import/index.md +++ b/doc/user/group/import/index.md @@ -138,9 +138,9 @@ migrated: In a [rails console session](../../../administration/operations/rails_console.md#starting-a-rails-console-session), you can find the failure or error messages for the group import attempt using: -```shell +```ruby # Get relevant import records -import = BulkImports::Entity.where(namespace_id: Group.id).bulk_import +import = BulkImports::Entity.where(namespace_id: Group.id).map(&:bulk_import) # Alternative lookup by user import = BulkImport.where(user_id: User.find(...)).last @@ -154,3 +154,18 @@ entities.map(&:failures).flatten # Alternative failure lookup by status entities.where(status: [-1]).pluck(:destination_name, :destination_namespace, :status) ``` + +### Stale imports + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352985) in GitLab 14.10. + +When troubleshooting group migration, an import may not complete because the import workers took +longer than 8 hours to execute. In this case, the `status` of either a `BulkImport` or +`BulkImport::Entity` is `3` (`timeout`): + +```ruby +# Get relevant import records +import = BulkImports::Entity.where(namespace_id: Group.id).map(&:bulk_import) + +import.status #=> 3 means that the import timed out. +``` diff --git a/doc/user/group/index.md b/doc/user/group/index.md index 4b9ff7f64e8..085cd054c14 100644 --- a/doc/user/group/index.md +++ b/doc/user/group/index.md @@ -1,7 +1,6 @@ --- -type: reference, howto stage: Manage -group: Authentication and Authorization +group: Workspace 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 --- @@ -68,7 +67,7 @@ To create a group: 1. Enter a name for the group in **Group name**. For a list of words that cannot be used as group names, see [reserved names](../reserved_names.md). 1. Enter a path for the group in **Group URL**, which is used for the [namespace](#namespaces). -1. Choose the [visibility level](../../public_access/public_access.md). +1. Choose the [visibility level](../public_access.md). 1. Personalize your GitLab experience by answering the following questions: - What is your role? - Who will be using this group? @@ -279,8 +278,8 @@ To view the activity feed in Atom format, select the [Feature flag `invite_members_group_modal`](https://gitlab.com/gitlab-org/gitlab/-/issues/352526) removed. Similar to how you [share a project with a group](../project/members/share_project_with_groups.md), -you can share a group with another group. Members get direct access -to the shared group. This includes members who inherited group membership from a parent group. +you can share a group with another group. To invite a group, you must be a member of it. Members get direct access +to the shared group. This includes members who inherited group membership from a parent group. To share a given group, for example, `Frontend` with another group, for example, `Engineering`: @@ -289,10 +288,14 @@ To share a given group, for example, `Frontend` with another group, for example, 1. On the left sidebar, select **Group information > Members**. 1. Select **Invite a group**. 1. In the **Select a group to invite** list, select `Engineering`. -1. Select a [role](../permissions.md). +1. Select a [role](../permissions.md) as maximum access level. 1. Select **Invite**. -All the members of the `Engineering` group are added to the `Frontend` group. +After sharing the `Frontend` group with the `Engineering` group: + +- The **Groups** tab lists the `Engineering` group. +- The **Groups** tab lists a group regardless of whether it is a public or private group. +- All members of the `Engineering` group have access to the `Frontend` group. The same access levels of the members apply up to the maximum access level selected when sharing the group. ## Manage group memberships via LDAP **(PREMIUM SELF)** @@ -793,23 +796,25 @@ The group's new subgroups have push rules set for them based on either: - The closest parent group with push rules defined. - Push rules set at the instance level, if no parent groups have push rules defined. -## Group approval rules **(PREMIUM)** +## Group approval settings **(PREMIUM)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/285458) in GitLab 13.9. [Deployed behind the `group_merge_request_approval_settings_feature_flag` flag](../../administration/feature_flags.md), disabled by default. > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/285410) in GitLab 14.5. > - [Feature flag `group_merge_request_approval_settings_feature_flag`](https://gitlab.com/gitlab-org/gitlab/-/issues/343872) removed in GitLab 14.9. -Group approval rules manage [project merge request approval rules](../project/merge_requests/approvals/index.md) -at the top-level group level. These rules [cascade to all projects](../project/merge_requests/approvals/settings.md#settings-cascading) +Group approval settings manage [project merge request approval settings](../project/merge_requests/approvals/settings.md) +at the top-level group level. These settings [cascade to all projects](../project/merge_requests/approvals/settings.md#settings-cascading) that belong to the group. -To view the merge request approval rules for a group: +To view the merge request approval settings for a group: 1. Go to the top-level group's **Settings > General** page. 1. Expand the **Merge request approvals** section. 1. Select the settings you want. 1. Select **Save changes**. +Support for group-level settings for merge request approval rules is tracked in this [epic](https://gitlab.com/groups/gitlab-org/-/epics/4367). + ## Related topics - [Group wikis](../project/wiki/index.md) diff --git a/doc/user/group/iterations/index.md b/doc/user/group/iterations/index.md index b5912a0b40e..1c316f2157d 100644 --- a/doc/user/group/iterations/index.md +++ b/doc/user/group/iterations/index.md @@ -12,6 +12,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w > - Moved to GitLab Premium in 13.9. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/221047) in GitLab 14.6. [Feature flag `group_iterations`](https://gitlab.com/gitlab-org/gitlab/-/issues/221047) removed. +WARNING: +After [Iteration Cadences](#iteration-cadences) becomes generally available, +manual iteration scheduling will be [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/356069) in GitLab 15.6. +To enhance the role of iterations as time boundaries, we will also deprecate the title field. + Iterations are a way to track issues over a period of time. This allows teams to track velocity and volatility metrics. Iterations can be used with [milestones](../../project/milestones/index.md) for tracking over different time periods. @@ -28,54 +33,6 @@ In GitLab, iterations are similar to milestones, with a few differences: - Iterations require both a start and an end date. - Iteration date ranges cannot overlap. -## Iteration cadences - -> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5077) in GitLab 14.1. -> - Deployed behind a [feature flag](../../feature_flags.md), disabled by default. -> - Disabled on GitLab.com. -> - Not recommended for production use. -> - To use in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-iteration-cadences). - -This in-development feature might not be available for your use. There can be -[risks when enabling features still in development](../../../administration/feature_flags.md#risks-when-enabling-features-still-in-development). -Refer to this feature's version history for more details. - -Iteration cadences automate some common iteration tasks. They can be used to -automatically create iterations every 1, 2, 3, 4, or 6 weeks. They can also -be configured to automatically roll over incomplete issues to the next iteration. - -With iteration cadences enabled, you must first -[create an iteration cadence](#create-an-iteration-cadence) before you can -[create an iteration](#create-an-iteration). - -### Create an iteration cadence - -Prerequisites: - -- You must have at least the Developer role for a group. - -To create an iteration cadence: - -1. On the top bar, select **Menu > Groups** and find your group. -1. On the left sidebar, select **Issues > Iterations**. -1. Select **New iteration cadence**. -1. Fill out required fields, and select **Create iteration cadence**. The cadence list page opens. - -### Delete an iteration cadence - -Prerequisites: - -- You must have at least the Developer role for a group. - -Deleting an iteration cadence also deletes all iterations within that cadence. - -To delete an iteration cadence: - -1. On the top bar, select **Menu > Groups** and find your group. -1. On the left sidebar, select **Issues > Iterations**. -1. Select the three-dot menu (**{ellipsis_v}**) > **Delete cadence** for the cadence you want to delete. -1. Select **Delete cadence** in the confirmation modal. - ## View the iterations list To view the iterations list, go to **{issues}** **Issues > Iterations**. @@ -84,12 +41,16 @@ From there you can create a new iteration or select an iteration to get a more d ## Create an iteration +> [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/356069) in GitLab 14.10. + +WARNING: +Manual iteration management is in its end-of-life process. Creating an iteration is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/356069) +in GitLab 14.10, and is planned for removal in GitLab 16.0. + Prerequisites: - You must have at least the Developer role for a group. -For manually scheduled iteration cadences, you create and add iterations yourself. - To create an iteration: 1. On the top bar, select **Menu > Groups** and find your group. @@ -100,7 +61,13 @@ To create an iteration: ## Edit an iteration -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218277) in GitLab 13.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218277) in GitLab 13.2. +> - [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/356069) in GitLab 14.10. + +WARNING: +Editing all attributes, with the exception of `description` is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/356069) +in GitLab 14.10, and is planned for removal in GitLab 16.0. +In the future only editing an iteration's `description` will be allowed. Prerequisites: @@ -110,7 +77,12 @@ To edit an iteration, select the three-dot menu (**{ellipsis_v}**) > **Edit**. ## Delete an iteration -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/292268) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/292268) in GitLab 14.3. +> - [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/356069) in GitLab 14.10. + +WARNING: +Manual iteration management is in its end-of-life process. Deleting an iteration is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/356069) +in GitLab 14.10, and is planned for removal in GitLab 16.0. Prerequisites: @@ -136,7 +108,7 @@ The report also shows a breakdown of total issues in an iteration. Open iteration reports show a summary of completed, unstarted, and in-progress issues. Closed iteration reports show the total number of issues completed by the due date. -To view an iteration report, go to the iterations list page and select an iteration's title. +To view an iteration report, go to the iterations list page and select an iteration's period. ### Iteration burndown and burnup charts @@ -195,33 +167,61 @@ To group issues by label: You can also search for labels by typing in the search input. 1. Select any area outside the label dropdown list. The page is now grouped by the selected labels. -### Enable or disable iteration cadences **(PREMIUM SELF)** +## Iteration cadences + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5077) in GitLab 14.1. +> - Deployed behind a [feature flag](../../feature_flags.md), named `iteration_cadences`, disabled by default. + +FLAG: +On self-managed GitLab, by default this feature is not available. To make it available, ask an +administrator to [enable the feature flag](../../../administration/feature_flags.md) named +`iteration_cadences` for a root group. +On GitLab.com, this feature is not available. This feature is not ready for production use. + +Iteration cadences automate iteration scheduling. You can use them to +automate creating iterations every 1, 2, 3, 4, or 6 weeks. You can also +configure iteration cadences to automatically roll over incomplete issues to the next iteration. + +### Create an iteration cadence + +Prerequisites: + +- You must have at least the Developer role for a group. + +To create an iteration cadence: + +1. On the top bar, select **Menu > Groups** and find your group. +1. On the left sidebar, select **Issues > Iterations**. +1. Select **New iteration cadence**. +1. Fill out required fields, and select **Create iteration cadence**. The cadence list page opens. + +### Delete an iteration cadence + +Prerequisites: + +- You must have at least the Developer role for a group. -Iteration Cadences feature is under development and not ready for production use. It is -deployed behind a feature flag that is **disabled by default**. -[GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md) -can enable it. +Deleting an iteration cadence also deletes all iterations within that cadence. -To enable it: +To delete an iteration cadence: -```ruby -Feature.enable(:iteration_cadences) -``` +1. On the top bar, select **Menu > Groups** and find your group. +1. On the left sidebar, select **Issues > Iterations**. +1. Select the three-dot menu (**{ellipsis_v}**) > **Delete cadence** for the cadence you want to delete. +1. Select **Delete cadence** in the confirmation modal. -To disable it: +### Convert manual cadence to use automatic scheduling -```ruby -Feature.disable(:iteration_cadences) -``` +WARNING: +The upgrade is irreversible. After it's done, manual iteration cadences cannot be created. -<!-- ## Troubleshooting +When you **enable** the iteration cadences feature, all iterations are added +to a default iteration cadence. +In this default iteration cadence, you can continue to add, edit, and remove iterations. -Include any troubleshooting steps that you can foresee. If you know beforehand what issues -one might have when setting this up, or when something is changed, or on upgrading, it's -important to describe those, too. Think of things that may go wrong and include them here. -This is important to minimize requests for support, and to avoid doc comments with -questions that you know someone might ask. +To upgrade the iteration cadence to use the automation features: -Each scenario can be a third-level heading, e.g. `### Getting error message X`. -If you have none to add when creating a doc, leave this section in place -but commented out to help encourage others to add to it in the future. --> +1. On the top bar, select **Menu > Groups** and find your group. +1. On the left sidebar, select **Issues > Iterations**. +1. Select the three-dot menu (**{ellipsis_v}**) > **Edit cadence** for the cadence you want to upgrade. +1. Fill out required fields, and select **Save changes**. diff --git a/doc/user/group/saml_sso/index.md b/doc/user/group/saml_sso/index.md index 8ebcd9f62d0..4d122e337db 100644 --- a/doc/user/group/saml_sso/index.md +++ b/doc/user/group/saml_sso/index.md @@ -23,12 +23,14 @@ If required, you can find [a glossary of common terms](../../../integration/saml ## Configure your identity provider -1. On the top bar, select **Menu > Groups** and find your group. -1. On the left sidebar, select **Settings > SAML SSO**. -1. Configure your SAML identity provider using the **Assertion consumer service URL**, **Identifier**, and **GitLab single sign-on URL**. - Alternatively GitLab provides [metadata XML configuration](#metadata-configuration). +1. Find the information in GitLab required for configuration: + 1. On the top bar, select **Menu > Groups** and find your group. + 1. On the left sidebar, select **Settings > SAML SSO**. + 1. Note the **Assertion consumer service URL**, **Identifier**, and **GitLab single sign-on URL**. +1. Configure your SAML identity provider app using the noted details. + Alternatively, GitLab provides a [metadata XML configuration](#metadata-configuration). See [specific identity provider documentation](#providers) for more details. -1. Configure the SAML response to include a NameID that uniquely identifies each user. +1. Configure the SAML response to include a [NameID](#nameid) that uniquely identifies each user. 1. Configure the required [user attributes](#user-attributes), ensuring you include the user's email address. 1. While the default is enabled for most SAML providers, please ensure the app is set to have service provider initiated calls in order to link existing GitLab accounts. @@ -245,7 +247,7 @@ To migrate users to a new email domain, users must: ## User access and management -> [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/268142) in GitLab 13.7. +> SAML user provisioning [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/268142) in GitLab 13.7. Once Group SSO is configured and enabled, users can access the GitLab.com group through the identity provider's dashboard. If [SCIM](scim_setup.md) is configured, please see the [user access and linking setup section on the SCIM page](scim_setup.md#user-access-and-linking-setup). diff --git a/doc/user/group/saml_sso/scim_setup.md b/doc/user/group/saml_sso/scim_setup.md index 331288e33a1..3960c97142e 100644 --- a/doc/user/group/saml_sso/scim_setup.md +++ b/doc/user/group/saml_sso/scim_setup.md @@ -20,7 +20,7 @@ The GitLab [SCIM API](../../../api/scim.md) implements part of [the RFC7644 prot The following actions are available: - Create users -- Deactivate users +- Remove users (deactivate SCIM identity) The following identity providers are supported: @@ -133,7 +133,7 @@ After the above steps are complete: The Okta GitLab application currently only supports SCIM. Continue using the separate Okta [SAML SSO](index.md) configuration along with the new SCIM -application described above. +application described above. An [issue exists](https://gitlab.com/gitlab-org/gitlab/-/issues/216173) to add SAML support to the Okta GitLab application. ### OneLogin @@ -150,7 +150,7 @@ The following diagram is a general outline on what happens when you add users to ```mermaid graph TD - A[Add User to SCIM app] -->|IdP sends user info to GitLab| B(GitLab: Does the email exists?) + A[Add User to SCIM app] -->|IdP sends user info to GitLab| B(GitLab: Does the email exist?) B -->|No| C[GitLab creates user with SCIM identity] B -->|Yes| D[GitLab sends message back 'Email exists'] ``` diff --git a/doc/user/group/settings/group_access_tokens.md b/doc/user/group/settings/group_access_tokens.md index 6b20f1763d4..0666303bcf8 100644 --- a/doc/user/group/settings/group_access_tokens.md +++ b/doc/user/group/settings/group_access_tokens.md @@ -16,14 +16,17 @@ You can use a group access token to authenticate: - With the [GitLab API](../../../api/index.md#personalprojectgroup-access-tokens). - In [GitLab 14.2](https://gitlab.com/gitlab-org/gitlab/-/issues/330718) and later, authenticate with Git over HTTPS. + Use: -After you configure a group access token, you don't need a password when you authenticate. -Instead, you can enter any non-blank value. + - Any non-blank value as a username. + - The group access token as the password. Group access tokens are similar to [project access tokens](../../project/settings/project_access_tokens.md) and [personal access tokens](../../profile/personal_access_tokens.md), except they are associated with a group rather than a project or user. +In self-managed instances, group access tokens are subject to the same [maximum lifetime limits](../../admin_area/settings/account_and_limit_settings.md#limit-the-lifetime-of-personal-access-tokens) as personal access tokens if the limit is set. + You can use group access tokens: - On GitLab SaaS if you have the Premium license tier or higher. Group access tokens are not available with a [trial license](https://about.gitlab.com/free-trial/). @@ -33,6 +36,8 @@ You can use group access tokens: - Consider [disabling group access tokens](#enable-or-disable-group-access-token-creation) to lower potential abuse. +You cannot use group access tokens to create other access tokens. + Group access tokens inherit the [default prefix setting](../../admin_area/settings/account_and_limit_settings.md#personal-access-token-prefix) configured for personal access tokens. @@ -45,7 +50,7 @@ To create a group access token: 1. On the top bar, select **Menu > Groups** and find your group. 1. On the left sidebar, select **Settings > Access Tokens**. 1. Enter a name. The token name is visible to any user with permissions to view the group. -1. Optional. Enter an expiry date for the token. The token will expire on that date at midnight UTC. +1. Optional. Enter an expiry date for the token. The token will expire on that date at midnight UTC. An instance-wide [maximum lifetime](../../admin_area/settings/account_and_limit_settings.md#limit-the-lifetime-of-personal-access-tokens) setting can limit the maximum allowable lifetime in self-managed instances. 1. Select a role for the token. 1. Select the [desired scopes](#scopes-for-a-group-access-token). 1. Select **Create group access token**. diff --git a/doc/user/group/subgroups/index.md b/doc/user/group/subgroups/index.md index a98f213bb3f..2cddbaa9723 100644 --- a/doc/user/group/subgroups/index.md +++ b/doc/user/group/subgroups/index.md @@ -1,6 +1,6 @@ --- stage: Manage -group: Authentication and Authorization +group: Workspace 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 --- @@ -49,9 +49,16 @@ graph TD ## Create a subgroup -Users with the at least the Maintainer role on a group can create subgroups immediately below the group, unless -[configured otherwise](#change-who-can-create-subgroups). These users can create subgroups even if group creation is -[disabled by an Administrator](../../admin_area/index.md#prevent-a-user-from-creating-groups) in the user's settings. +Prerequisites: + +- You must either: + - Have at least the Maintainer role for a group to create subgroups for it. + - Have the [role determined by a setting](#change-who-can-create-subgroups). These users can create + subgroups even if group creation is + [disabled by an Administrator](../../admin_area/index.md#prevent-a-user-from-creating-groups) in the user's settings. + +NOTE: +You cannot host a GitLab Pages subgroup website with a top-level domain name. For example, `subgroupname.example.io`. To create a subgroup: diff --git a/doc/user/group/value_stream_analytics/img/vsa_aggregated_data_toggle_v14_9.png b/doc/user/group/value_stream_analytics/img/vsa_aggregated_data_toggle_v14_9.png Binary files differnew file mode 100644 index 00000000000..5ad8026b8fd --- /dev/null +++ b/doc/user/group/value_stream_analytics/img/vsa_aggregated_data_toggle_v14_9.png diff --git a/doc/user/group/value_stream_analytics/img/vsa_filter_bar_v13_12.png b/doc/user/group/value_stream_analytics/img/vsa_filter_bar_v13_12.png Binary files differdeleted file mode 100644 index 834556df051..00000000000 --- a/doc/user/group/value_stream_analytics/img/vsa_filter_bar_v13_12.png +++ /dev/null diff --git a/doc/user/group/value_stream_analytics/img/vsa_overview_stage_v13_11.png b/doc/user/group/value_stream_analytics/img/vsa_overview_stage_v13_11.png Binary files differdeleted file mode 100644 index 8d77c53db7f..00000000000 --- a/doc/user/group/value_stream_analytics/img/vsa_overview_stage_v13_11.png +++ /dev/null diff --git a/doc/user/group/value_stream_analytics/img/vsa_path_nav_v13_11.png b/doc/user/group/value_stream_analytics/img/vsa_path_nav_v13_11.png Binary files differdeleted file mode 100644 index 5dd79d06463..00000000000 --- a/doc/user/group/value_stream_analytics/img/vsa_path_nav_v13_11.png +++ /dev/null diff --git a/doc/user/group/value_stream_analytics/img/vsa_stage_table_v14_7.png b/doc/user/group/value_stream_analytics/img/vsa_stage_table_v14_7.png Binary files differdeleted file mode 100644 index 7c3305792bb..00000000000 --- a/doc/user/group/value_stream_analytics/img/vsa_stage_table_v14_7.png +++ /dev/null diff --git a/doc/user/group/value_stream_analytics/img/vsa_time_metrics_v13_12.png b/doc/user/group/value_stream_analytics/img/vsa_time_metrics_v13_12.png Binary files differdeleted file mode 100644 index 68d9741bed8..00000000000 --- a/doc/user/group/value_stream_analytics/img/vsa_time_metrics_v13_12.png +++ /dev/null diff --git a/doc/user/group/value_stream_analytics/index.md b/doc/user/group/value_stream_analytics/index.md index 5ea8512ed5a..3fce9baa9ce 100644 --- a/doc/user/group/value_stream_analytics/index.md +++ b/doc/user/group/value_stream_analytics/index.md @@ -16,6 +16,7 @@ Use value stream analytics to identify: - The amount of time it takes to go from an idea to production. - The velocity of a given project. - Bottlenecks in the development process. +- Detecting long-running issues or merge requests. - Factors that cause your software development lifecycle to slow down. Value stream analytics is also available for [projects](../../analytics/value_stream_analytics.md). @@ -26,7 +27,10 @@ Value stream analytics is also available for [projects](../../analytics/value_st > - Filtering [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13216) in GitLab 13.3 > - Horizontal stage path [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12196) in 13.0 and [feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/323982) in 13.12 -You must have at least the Reporter role to view value stream analytics for groups. +Prerequisite: + +- You must have at least the Reporter role to view value stream analytics for groups. +- You must create a [custom value stream](#custom-value-streams). Value stream analytics only shows custom value streams created for your group. To view value stream analytics for your group: @@ -37,6 +41,9 @@ To view value stream analytics for your group: 1. Select the **Filter results** text box. 1. Select a parameter. 1. Select a value or enter text to refine the results. + 1. Select whether to view metrics for items with a start or stop event: + - To view items with a stop event in the date range, turn on the **Filter by stop date** toggle. Enabled by default. + - To view items with a start event in the date range, turn off the **Filter by stop date** toggle. 1. To adjust the date range: - In the **From** field, select a start date. - In the **To** field, select an end date. The charts and list show workflow items created @@ -71,6 +78,9 @@ To view the median time spent in each stage by a group: 1. Select the **Filter results** text box. 1. Select a parameter. 1. Select a value or enter text to refine the results. + 1. Select whether to view metrics for items with a start or stop event: + - To view items with a stop event in the date range, turn on the **Filter by stop date** toggle. Enabled by default. + - To view items with a start event in the date range, turn off the **Filter by stop date** toggle. 1. To adjust the date range: - In the **From** field, select a start date. - In the **To** field, select an end date. @@ -91,6 +101,9 @@ To view the lead time and cycle time for issues: 1. Select the **Filter results** text box. 1. Select a parameter. 1. Select a value or enter text to refine the results. + 1. Select whether to view metrics for items with a start or stop event: + - To view items with a stop event in the date range, turn on the **Filter by stop date** toggle. Enabled by default. + - To view items with a start event in the date range, turn off the **Filter by stop date** toggle. 1. To adjust the date range: - In the **From** field, select a start date. - In the **To** field, select an end date. @@ -111,6 +124,9 @@ To view the lead time for changes for merge requests in your group: 1. Select the **Filter results** text box. 1. Select a parameter. 1. Select a value or enter text to refine the results. + 1. Select whether to view metrics for items with a start or stop event: + - To view items with a stop event in the date range, turn on the **Filter by stop date** toggle. Enabled by default. + - To view items with a start event in the date range, turn off the **Filter by stop date** toggle. 1. To adjust the date range: - In the **From** field, select a start date. - In the **To** field, select an end date. @@ -125,7 +141,7 @@ To view deployment metrics, you must have a [production environment configured](../../../ci/environments/index.md#deployment-tier-of-environments). Value stream analytics shows the following deployment metrics for your group: - + - Deploys: The number of successful deployments in the date range. - Deployment Frequency: The average number of successful deployments per day in the date range. @@ -137,6 +153,9 @@ To view deployment metrics for your group: 1. Select the **Filter results** text box. 1. Select a parameter. 1. Select a value or enter text to refine the results. + 1. Select whether to view metrics for items with a start or stop event: + - To view items with a stop event in the date range, turn on the **Filter by stop date** toggle. Enabled by default. + - To view items with a start event in the date range, turn off the **Filter by stop date** toggle. 1. To adjust the date range: - In the **From** field, select a start date. - In the **To** field, select an end date. @@ -150,25 +169,24 @@ NOTE: In GitLab 13.9 and later, metrics are calculated based on when the deployment was finished. In GitLab 13.8 and earlier, metrics are calculated based on when the deployment was created. -## Upcoming date filter change +### How value stream analytics aggregates data + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335391) in GitLab 14.5 [with a flag](../../../administration/feature_flags.md) named `use_vsa_aggregated_tables`. Disabled by default. +> - Filter by stop date toggle [added](https://gitlab.com/gitlab-org/gitlab/-/issues/352428) in GitLab 14.9 +> - Data refresh badge [added](https://gitlab.com/gitlab-org/gitlab/-/issues/341739) in GitLab 14.9 + +Plans for value stream analytics to filter items by stop event instead of start event are tracked in this [epic](https://gitlab.com/groups/gitlab-org/-/epics/6046). With the completion of this work, value stream analytics will only display items with a stop event in the date range. -In the [epics](https://gitlab.com/groups/gitlab-org/-/epics/6046), we plan to alter -the date filter behavior to filter the end event time of the currently selected stage. +To preview this functionality, you can use the **Filter by stop date** toggle to enable or disable this filter until the [default filtering mode is introduced](../../../update/deprecations.md#value-stream-analytics-filtering-calculation-change) and the toggle is removed. -The change makes it possible to get a much better picture about the completed items within the -stage and helps uncover long-running items. +If you turn on the **Filter by stop date** toggle, the results show items with a stop event within the date range. When this function is enabled, it may take up to 10 minutes for results to show due to data aggregation. There are occasions when it may take longer than 10 minutes for results to display: -For example, an issue was created a year ago and the current stage was finished in the current month. -If you were to look at the metrics for the last three months, this issue would not be included in the calculation of -the stage metrics. With the new date filter, this item would be included. +- If this is the first time you are viewing value stream analytics and have not yet [created a value stream](#create-a-value-stream). +- If the group hierarchy has been re-arranged. +- If there have been bulk updates on issues and merge requests. -DISCLAIMER: -This section contains information related to upcoming products, features, and functionality. -It is important to note that the information presented is for informational purposes only. -Please do not rely on this information for purchasing or planning purposes. -As with all projects, the items mentioned on this page are subject to change or delay. -The development, release, and timing of any products, features, or functionality remain at the -sole discretion of GitLab Inc. +To view when the data was most recently updated, in the right corner next to **Edit**, hover over the **Last updated** badge. This badge is only available if you have turned on the **Filter by start date** toggle. + ## How value stream analytics measures stages @@ -177,7 +195,10 @@ Value stream analytics measures each stage from its start event to its end event For example, a stage might start when a user adds a label to an issue, and ends when they add another label. Items aren't included in the stage time calculation if they have not reached the end event. -Each stage of value stream analytics is further described in the table below. +Value stream analytics allows you to customize your stages based on pre-defined events. To make the +configuration easier, GitLab provides a pre-defined list of stages that can be used as a template + +Each pre-defined stages of value stream analytics is further described in the table below. | Stage | Measurement method | | ------- | -------------------- | @@ -188,21 +209,21 @@ Each stage of value stream analytics is further described in the table below. | Review | The median time taken to review a merge request that has a closing issue pattern, between its creation and until it's merged. | | Staging | The median time between merging a merge request that has a closing issue pattern until the very first deployment to a [production environment](#how-value-stream-analytics-identifies-the-production-environment). If there isn't a production environment, this is not tracked. | -## Example workflow +### Example workflow -This example shows a workflow through all seven stages in one day. +This example shows a workflow through all seven stages in one day. -If a stage does not include a start and a stop time, its data is not included in the median time. +If a stage does not include a start and a stop time, its data is not included in the median time. In this example, milestones have been created and CI/CD for testing and setting environments is configured. - 09:00: Create issue. **Issue** stage starts. -- 11:00: Add issue to a milestone, start work on the issue, and create a branch locally. - **Issue** stage stops and **Plan** stage starts. +- 11:00: Add issue to a milestone, start work on the issue, and create a branch locally. + **Issue** stage stops and **Plan** stage starts. - 12:00: Make the first commit. - 12:30: Make the second commit to the branch that mentions the issue number. **Plan** stage stops and **Code** stage starts. -- 14:00: Push branch and create a merge request that contains the - [issue closing pattern](../../project/issues/managing_issues.md#closing-issues-automatically). +- 14:00: Push branch and create a merge request that contains the + [issue closing pattern](../../project/issues/managing_issues.md#closing-issues-automatically). **Code** stage stops and **Test** and **Review** stages start. - GitLab CI/CD takes 5 minutes to run scripts defined in [`.gitlab-ci.yml`](../../../ci/yaml/index.md). - 19:00: Merge the merge request. **Review** stage stops and **Staging** stage starts. @@ -214,7 +235,7 @@ Value stream analytics records the following times for each stage: - **Plan**: 11:00 to 12:00: 1 hr - **Code**: 12:00 to 14:00: 2 hrs - **Test**: 5 minutes -- **Review**: 14:00 to 19:00: 5 hrs +- **Review**: 14:00 to 19:00: 5 hrs - **Staging**: 19:00 to 19:30: 30 minutes There are some additional considerations for this example: @@ -263,13 +284,16 @@ To create a value stream: 1. On the top bar, select **Menu > Groups** and find your group. 1. On the left sidebar, select **Analytics > Value Stream**. -1. In the top right, select the dropdown list and then **Create new Value Stream**. +1. If this is the first time you are creating a value stream, select **Create custom value stream**. Otherwise, in the top right, select the dropdown list and then **Create new Value Stream**. 1. Enter a name for the new Value Stream. - You can [customize the stages](#create-a-value-stream-with-stages). 1. Select **Create Value Stream**.  +NOTE: +If you have recently upgraded to GitLab Premium, it can take up to 30 minutes for data to collect and display. + ### Create a value stream with stages > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/50229) in GitLab 13.7. @@ -283,7 +307,7 @@ To create a value stream with stages: 1. On the top bar, select **Menu > Groups** and find your group. 1. On the left sidebar, select **Analytics > Value Stream**. -1. In the top right, select the dropdown list and then **Create new Value Stream**. +1. If this is the first time you are creating a value stream, select **Create custom value stream**. Otherwise, in the top right, select the dropdown list and then **Create new Value Stream**. 1. Select either **Create from default template** or **Create from no template**. - You can hide or re-order default stages in the value stream. |
