diff options
Diffstat (limited to 'doc/user/group')
| -rw-r--r-- | doc/user/group/access_and_permissions.md | 6 | ||||
| -rw-r--r-- | doc/user/group/clusters/index.md | 2 | ||||
| -rw-r--r-- | doc/user/group/devops_adoption/index.md | 14 | ||||
| -rw-r--r-- | doc/user/group/epics/manage_epics.md | 41 | ||||
| -rw-r--r-- | doc/user/group/import/index.md | 218 | ||||
| -rw-r--r-- | doc/user/group/insights/img/insights_example_stacked_bar_chart_v15_4.png | bin | 75321 -> 0 bytes | |||
| -rw-r--r-- | doc/user/group/insights/index.md | 97 | ||||
| -rw-r--r-- | doc/user/group/issues_analytics/img/enhanced_issue_analytics_v16_7.png | bin | 61942 -> 17415 bytes | |||
| -rw-r--r-- | doc/user/group/issues_analytics/index.md | 18 | ||||
| -rw-r--r-- | doc/user/group/manage.md | 7 | ||||
| -rw-r--r-- | doc/user/group/saml_sso/troubleshooting.md | 5 | ||||
| -rw-r--r-- | doc/user/group/saml_sso/troubleshooting_scim.md | 28 | ||||
| -rw-r--r-- | doc/user/group/subgroups/index.md | 18 | ||||
| -rw-r--r-- | doc/user/group/value_stream_analytics/index.md | 14 |
14 files changed, 109 insertions, 359 deletions
diff --git a/doc/user/group/access_and_permissions.md b/doc/user/group/access_and_permissions.md index e08cfea7095..4628b7be9ce 100644 --- a/doc/user/group/access_and_permissions.md +++ b/doc/user/group/access_and_permissions.md @@ -63,8 +63,8 @@ address. This top-level group setting applies to: - The GitLab UI, including subgroups, projects, and issues. It does not apply to GitLab Pages. - [In GitLab 12.3 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/12874), the API. - In self-managed installations of GitLab 15.1 and later, you can also configure -[globally-allowed IP address ranges](../../administration/settings/visibility_and_access_controls.md#configure-globally-allowed-ip-address-ranges) -at the group level. + [globally-allowed IP address ranges](../../administration/settings/visibility_and_access_controls.md#configure-globally-allowed-ip-address-ranges) + at the group level. Administrators can combine restricted access by IP address with [globally-allowed IP addresses](../../administration/settings/visibility_and_access_controls.md#configure-globally-allowed-ip-address-ranges). @@ -118,7 +118,7 @@ To allow runner downloading, add the [outbound runner CIDR ranges](../gitlab_com > - Support for restricting access to projects in the group [added](https://gitlab.com/gitlab-org/gitlab/-/issues/14004) in GitLab 14.1.2. > - Support for restricting group memberships to groups with a subset of the allowed email domains [added](https://gitlab.com/gitlab-org/gitlab/-/issues/354791) in GitLab 15.1.1 -You can prevent users with email addresses in specific domains from being added to a group and its projects. You can define an email domain allowlist at the top-level namespace only. Subgroups do not offer the ability to define an alternative allowlist. +To ensure only users with email addresses in specific domains are added to a group and its projects, define an email domain allowlist at the top-level namespace. Subgroups do not offer the ability to define an alternative allowlist. To restrict group access by domain: diff --git a/doc/user/group/clusters/index.md b/doc/user/group/clusters/index.md index ded99f7c936..bbd53c09352 100644 --- a/doc/user/group/clusters/index.md +++ b/doc/user/group/clusters/index.md @@ -129,7 +129,7 @@ For example, if your project has the following Kubernetes clusters: | Test | `test` | Group | | Development| `*` | Group | -And the following environments are set in [`.gitlab-ci.yml`](../../../ci/yaml/index.md): +And the following environments are set in the [`.gitlab-ci.yml` file](../../../ci/index.md#the-gitlab-ciyml-file): ```yaml stages: diff --git a/doc/user/group/devops_adoption/index.md b/doc/user/group/devops_adoption/index.md index cdb11bb0548..978c893a0ec 100644 --- a/doc/user/group/devops_adoption/index.md +++ b/doc/user/group/devops_adoption/index.md @@ -21,9 +21,9 @@ DevOps Adoption shows you how groups in your organization adopt and use the most You can use Group DevOps Adoption to: - Identify specific subgroups that are lagging in their adoption of GitLab features, so you can guide them on -their DevOps journey. + their DevOps journey. - Find subgroups that have adopted certain features, and provide guidance to other subgroups on -how to use those features. + how to use those features. - Verify if you are getting the return on investment that you expected from GitLab.  @@ -43,11 +43,11 @@ To view DevOps Adoption: DevOps Adoption shows feature adoption for development, security, and operations. -| Category | Feature | -| --- | --- | -| Development | Approvals<br>Code owners<br>Issues<br>Merge requests | -| Security | DAST<br>Dependency Scanning<br>Fuzz Testing<br>SAST | -| Operations | Deployments<br>Pipelines<br>Runners | +| Category | Feature | +|-------------|---------| +| Development | Approvals<br>Code owners<br>Issues<br>Merge requests | +| Security | DAST<br>Dependency Scanning<br>Fuzz Testing<br>SAST | +| Operations | Deployments<br>Pipelines<br>Runners | ## Feature adoption diff --git a/doc/user/group/epics/manage_epics.md b/doc/user/group/epics/manage_epics.md index 9cdebdd7d9d..286a1c474da 100644 --- a/doc/user/group/epics/manage_epics.md +++ b/doc/user/group/epics/manage_epics.md @@ -11,10 +11,6 @@ to them. ## Create an epic -> - The New Epic form [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/211533) in GitLab 13.2. -> - 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. @@ -175,6 +171,9 @@ To do so, either: - In the upper-right corner, select **epic actions** (**{ellipsis_v}**) and then **Reopen epic** - Use the `/reopen` [quick action](../../project/quick_actions.md). +You can also create an epic by +[promoting an issue](../../project/issues/managing_issues.md#promote-an-issue-to-an-epic). + ## Go to an epic from an issue If an issue belongs to an epic, you can go to the parent epic with the @@ -453,40 +452,6 @@ To move an issue to another epic: 1. Go to the **Child issues and epics** section. 1. Drag issues into the desired parent epic in the visible hierarchy. -### Promote an issue to an epic - -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/37081) from GitLab Ultimate to GitLab Premium in 12.8. - -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). - -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 and downvotes. -- Participants. -- Group labels that the issue already has. -- Parent epic. - ### Use an epic template for repeating issues You can create a spreadsheet template to manage a pattern of consistently repeating issues. diff --git a/doc/user/group/import/index.md b/doc/user/group/import/index.md index 28878855098..28e77a942a6 100644 --- a/doc/user/group/import/index.md +++ b/doc/user/group/import/index.md @@ -4,7 +4,14 @@ group: Import and Integrate info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Migrating GitLab groups **(FREE ALL)** +# Migrate GitLab groups and projects by using direct transfer **(FREE ALL)** + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/249160) in GitLab 13.7 for group resources [with a flag](../../feature_flags.md) named `bulk_import`. Disabled by default. +> - Group items [enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/338985) in GitLab 14.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267945) in GitLab 14.4 for project resources [with a flag](../../feature_flags.md) named `bulk_import_projects`. Disabled by default. +> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.6. +> - New application setting `bulk_import_enabled` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383268) in GitLab 15.8. `bulk_import` feature flag removed. +> - `bulk_import_projects` feature flag [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.10. You can migrate GitLab groups: @@ -16,19 +23,10 @@ You can migrate GitLab groups: You can migrate groups in two ways: - By direct transfer (recommended). -- By uploading an export file. +- By [uploading an export file](../../project/settings/import_export.md). If you migrate from GitLab.com to self-managed GitLab, an administrator can create users on the self-managed GitLab instance. -## Migrate groups by direct transfer (recommended) - -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/249160) in GitLab 13.7 for group resources [with a flag](../../feature_flags.md) named `bulk_import`. Disabled by default. -> - Group items [enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/338985) in GitLab 14.3. -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267945) in GitLab 14.4 for project resources [with a flag](../../feature_flags.md) named `bulk_import_projects`. Disabled by default. -> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.6. -> - New application setting `bulk_import_enabled` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383268) in GitLab 15.8. `bulk_import` feature flag removed. -> - `bulk_import_projects` feature flag [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.10. - On self-managed GitLab, by default [migrating group items](#migrated-group-items) is not available. To show the feature, an administrator can [enable it in application settings](../../../administration/settings/import_and_export_settings.md#enable-migration-of-groups-and-projects-by-direct-transfer). @@ -59,12 +57,12 @@ We invite you to leave your feedback about migrating by direct transfer in If you want to move groups instead of copying groups, you can [transfer groups](../manage.md#transfer-a-group) if the groups are in the same GitLab instance. Transferring groups is a faster and more complete option. -### Known issues +## Known issues See [epic 6629](https://gitlab.com/groups/gitlab-org/-/epics/6629) for a list of known issues for migrating by direct transfer. -### Estimating migration duration +## Estimating migration duration Estimating the duration of migration by direct transfer is difficult. The following factors affect migration duration: @@ -111,7 +109,7 @@ There's no exact formula to reliably estimate a migration. However, the average If you are migrating large projects and encounter problems with timeouts or duration of the migration, see [Reducing migration duration](#reducing-migration-duration). -### Limits +## Limits > Eight hour time limit on migrations [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/429867) in GitLab 16.7. @@ -138,7 +136,7 @@ You can test the maximum relation size limit using these APIs: If either API produces files larger than the maximum relation size limit, group migration by direct transfer fails. -### Visibility rules +## Visibility rules After migration: @@ -154,7 +152,7 @@ After migration: If you used a private network on your source instance to hide content from the general public, make sure to have a similar setup on the destination instance, or to import into a private group. -### Prerequisites +## Prerequisites > Requirement for Maintainer role instead of Developer role introduced in GitLab 16.0 and backported to GitLab 15.11.1 and GitLab 15.10.5. @@ -181,7 +179,7 @@ To migrate groups by direct transfer: - [Configure `proxy_download`](../../../administration/object_storage.md#configure-the-common-parameters). - Ensure that the destination GitLab instance has access to the object storage of the source GitLab instance. -### Prepare user accounts +## Prepare user accounts To ensure GitLab maps users and their contributions correctly: @@ -196,7 +194,7 @@ To ensure GitLab maps users and their contributions correctly: 1. If users already exist on the destination instance and you use [SAML SSO for GitLab.com groups](../../group/saml_sso/index.md), all users must [link their SAML identity to their GitLab.com account](../../group/saml_sso/index.md#link-saml-to-your-existing-gitlabcom-account). -### Connect the source GitLab instance +## Connect the source GitLab instance Create the group you want to import to and connect the source GitLab instance: @@ -209,7 +207,7 @@ Create the group you want to import to and connect the source GitLab instance: 1. Enter the [personal access token](../../../user/profile/personal_access_tokens.md) for your source GitLab instance. 1. Select **Connect instance**. -### Select the groups and projects to import +## Select the groups and projects to import > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385689) in GitLab 15.8, option to import groups with or without projects. @@ -228,7 +226,7 @@ WARNING: Importing groups with projects is in [Beta](../../../policy/experiment-beta-support.md#beta). This feature is not ready for production use. -### Group import history +## Group import history > **Partially completed** status [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394727) in GitLab 16.7. @@ -248,16 +246,17 @@ To view group import history: 1. In the upper-right corner, select **History**. 1. If there are any errors for a particular import, select **See failures** to see their details. -### Review results of the import +## Review results of the import -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/429109) in GitLab 16.6 [with a flag](../../feature_flags.md) named `bulk_import_details_page`. Enabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/429109) in GitLab 16.6 [with a flag](../../feature_flags.md) named `bulk_import_details_page`. Enabled by default. +> - Feature flag `bulk_import_details_page` removed in GitLab 16.8. To review the results of an import: 1. Go to the [Group import history page](#group-import-history). 1. To see the details of a failed import, select the **See failures** link on any import with a **Failed** or **Partially completed** status. -### Migrated group items +## Migrated group items The group items that are migrated depend on the version of GitLab you use on the destination. To determine if a specific group item is migrated: @@ -304,14 +303,14 @@ Group items that are migrated to the destination GitLab instance include: - Already exists in the destination GitLab instance. - Has a public email in the source GitLab instance that matches a confirmed email in the destination GitLab instance. -#### Excluded items +### Excluded items Some group items are excluded from migration because they either: - May contain sensitive information: CI/CD variables, webhooks, and deploy tokens. - Are not supported: push rules. -### Migrated project items **(BETA)** +## Migrated project items **(BETA)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267945) in GitLab 14.4 [with a flag](../../feature_flags.md) named `bulk_import_projects`. Disabled by default. > - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/339941) in GitLab 15.6. @@ -384,7 +383,7 @@ Project items that are migrated to the destination GitLab instance include: </small> </html> -#### Issue-related items +### Issue-related items Issue-related project items that are migrated to the destination GitLab instance include: @@ -397,7 +396,7 @@ Issue-related project items that are migrated to the destination GitLab instance | Merge request URL references | [GitLab 15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/267947) | | Time tracking | [GitLab 14.4](https://gitlab.com/gitlab-org/gitlab/-/issues/267946) | -#### Merge request-related items +### Merge request-related items Merge request-related project items that are migrated to the destination GitLab instance include: @@ -411,7 +410,7 @@ Merge request-related project items that are migrated to the destination GitLab | Issue URL references | [GitLab 15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/267947) | | Time tracking | [GitLab 14.5](https://gitlab.com/gitlab-org/gitlab/-/issues/339403) | -#### Setting-related items +### Setting-related items Setting-related project items that are migrated to the destination GitLab instance include: @@ -422,7 +421,7 @@ Setting-related project items that are migrated to the destination GitLab instan | Project properties | [GitLab 14.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/75898) | | Service Desk | [GitLab 14.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/75653) | -#### Excluded items +### Excluded items Some project items are excluded from migration because they either: @@ -443,7 +442,7 @@ Some project items are excluded from migration because they either: - Pages domains - Remote mirrors -### Troubleshooting +## Troubleshooting 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: @@ -468,7 +467,7 @@ entities.where(status: [-1]).pluck(:destination_name, :destination_namespace, :s You can also see all migrated entities with any failures related to them using an [API endpoint](../../../api/bulk_imports.md#list-all-group-or-project-migrations-entities). -#### Stale imports +### Stale imports > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/352985) in GitLab 14.10. @@ -483,7 +482,7 @@ import = BulkImports::Entity.where(namespace_id: Group.id).map(&:bulk_import) import.status #=> 3 means that the import timed out. ``` -#### Error: `404 Group Not Found` +### Error: `404 Group Not Found` If you attempt to import a group that has a path comprised of only numbers (for example, `5000`), GitLab attempts to find the group by ID instead of the path. This causes a `404 Group Not Found` error in GitLab 15.4 and earlier. @@ -499,7 +498,7 @@ To solve this, you must change the source group path to include a non-numerical - The [Groups API](../../../api/groups.md#update-group). -#### Other `404` errors +### Other `404` errors You can receive other `404` errors when importing a group, for example: @@ -511,7 +510,7 @@ You can receive other `404` errors when importing a group, for example: This error indicates a problem transferring from the _source_ instance. To solve this, check that you have met the [prerequisites](#prerequisites) on the source instance. -#### Reducing migration duration +### Reducing migration duration A single direct transfer migration runs 5 entities (groups or projects) per import at a time, independent of the number of workers available on the destination instance. That said, having more workers on the destination instance speeds up migration by decreasing the time it takes to import each entity. @@ -529,157 +528,6 @@ Distributing projects in different groups helps to avoid timeouts. If several la The GitLab UI can only migrate top-level groups. Using the API, you can also migrate subgroups. -## Migrate groups by uploading an export file (deprecated) - -> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2888) in GitLab 13.0 as an experimental feature. May change in future releases. -> - [Deprecated](https://gitlab.com/groups/gitlab-org/-/epics/4619) in GitLab 14.6. - -WARNING: -This feature was [deprecated](https://gitlab.com/groups/gitlab-org/-/epics/4619) in GitLab 14.6 and replaced by -[migrating groups by direct transfer](#migrate-groups-by-direct-transfer-recommended). However, this feature is still recommended for migrating groups between -offline systems. To follow progress on an alternative solution for [offline environments](../../application_security/offline_deployments/index.md), see -[the relevant epic](https://gitlab.com/groups/gitlab-org/-/epics/8985). - -Prerequisites: - -- Owner role on the group to migrate. - -Using file exports, you can: - -- Export any group to a file and upload that file to another GitLab instance or to another location on the same instance. -- Use either the GitLab UI or the [API](../../../api/group_import_export.md). -- Migrate groups one by one, then export and import each project for the groups one by one. - -GitLab maps user contributions correctly when an admin access token is used to perform the import. GitLab does not map -user contributions correctly when you are importing from a self-managed instance to GitLab.com. Correct mapping of user -contributions when importing from a self-managed instance to GitLab.com can be preserved with paid involvement of -Professional Services team. - -Note the following: - -- Exports are stored in a temporary directory and are deleted every 24 hours by a specific worker. -- To preserve group-level relationships from imported projects, export and import groups first so that projects can - be imported into the desired group structure. -- Imported groups are given a `private` visibility level, unless imported into a parent group. -- If imported into a parent group, a subgroup inherits the same level of visibility unless otherwise restricted. -- You can export groups from the [Community Edition to the Enterprise Edition](https://about.gitlab.com/install/ce-or-ee/) - and vice versa. The Enterprise Edition retains some group data that isn't part of the Community Edition. If you're - exporting a group from the Enterprise Edition to the Community Edition, you may lose this data. For more information, - see [downgrading from EE to CE](../../../index.md). - -### Compatibility - -> Support for JSON-formatted project file exports [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/383682) in GitLab 15.8. - -Group file exports are in NDJSON format. - -You can import group file exports that were exported from a version of GitLab up to two -[minor](../../../policy/maintenance.md#versioning) versions behind, which is similar to our process for -[security releases](../../../policy/maintenance.md#security-releases). - -For example: - -| Destination version | Compatible source versions | -|:--------------------|:---------------------------| -| 13.0 | 13.0, 12.10, 12.9 | -| 13.1 | 13.1, 13.0, 12.10 | - -### Exported contents - -The [`import_export.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/import_export/group/import_export.yml) -file for groups lists items exported and imported when migrating groups using file exports. View this file in the branch -for your version of GitLab to check which items can be imported to the destination GitLab instance. For example, -[`import_export.yml` on the `14-10-stable-ee` branch](https://gitlab.com/gitlab-org/gitlab/-/blob/14-10-stable-ee/lib/gitlab/import_export/group/import_export.yml). - -Group items that are exported include: - -- Milestones -- Group Labels (_without_ associated label priorities) -- Boards and Board Lists -- Badges -- Subgroups (including all the aforementioned data) -- Epics - - Epic resource state events ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/291983) in GitLab 15.4) -- Events -- [Wikis](../../project/wiki/group.md) - ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/53247) in GitLab 13.9) -- Iterations cadences ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95372) in 15.4) - -Items that are **not** exported include: - -- Projects -- Runner tokens -- SAML discovery tokens - -### Preparation - -- To preserve the member list and their respective permissions on imported groups, review the users in these groups. Make -sure these users exist before importing the desired groups. -- Users must set a public email in the source GitLab instance that matches their confirmed primary email in the destination GitLab instance. Most users receive an email asking them to confirm their email address. - -### Enable export for a group - -Prerequisites: - -- You must have the Owner role for the group. - -To enable import and export for a group: - -1. On the left sidebar, at the bottom, select **Admin Area**. -1. Select **Settings > General**. -1. Expand **Visibility and access controls**. -1. In the **Import sources** section, select the checkboxes for the sources you want. - -### Export a group - -Prerequisites: - -- You must have the Owner role for the group. - -To export the contents of a group: - -1. On the left sidebar, select **Search or go to** and find your group. -1. Select **Settings > General**. -1. In the **Advanced** section, select **Export group**. -1. After the export is generated, you should receive an email with a link to the [exported contents](#exported-contents) - in a compressed tar archive, with contents in NDJSON format. -1. Alternatively, you can download the export from the UI: - - 1. Return to your group's **Settings > General** page. - 1. In the **Advanced** section, select **Download export**. - You can also generate a new file by selecting **Regenerate export**. - -You can also export a group [using the API](../../../api/group_import_export.md). - -### Import the group - -1. On the left sidebar, at the top, select **Create new** (**{plus}**) and **New subgroup**. -1. Select the **import an existing group** link. -1. Enter your group name. -1. Accept or modify the associated group URL. -1. Select **Choose file...**. -1. Select the file that you exported in the [Export a group](#export-a-group) section. -1. To begin importing, select **Import**. - -Your newly imported group page appears after the operation completes. - -NOTE: -The maximum import file size can be set by the administrator, default is `0` (unlimited). -As an administrator, you can modify the maximum import file size. To do so, use the `max_import_size` option in the -[Application settings API](../../../api/settings.md#change-application-settings) or the -[Admin Area](../../../administration/settings/account_and_limit_settings.md). -Default [modified](https://gitlab.com/gitlab-org/gitlab/-/issues/251106) from 50 MB to 0 in GitLab 13.8. - -### Rate limits - -To help avoid abuse, by default, users are rate limited to: - -| Request Type | Limit | -| ---------------- | ---------------------------------------- | -| Export | 6 groups per minute | -| Download export | 1 download per group per minute | -| Import | 6 groups per minute | - ## Automate group and project import **(PREMIUM ALL)** For information on automating user, group, and project import API calls, see diff --git a/doc/user/group/insights/img/insights_example_stacked_bar_chart_v15_4.png b/doc/user/group/insights/img/insights_example_stacked_bar_chart_v15_4.png Binary files differdeleted file mode 100644 index f7963c170e1..00000000000 --- a/doc/user/group/insights/img/insights_example_stacked_bar_chart_v15_4.png +++ /dev/null diff --git a/doc/user/group/insights/index.md b/doc/user/group/insights/index.md index 6ca37cb9a2c..0cb1ad093a5 100644 --- a/doc/user/group/insights/index.md +++ b/doc/user/group/insights/index.md @@ -1,94 +1,11 @@ --- -stage: Plan -group: Optimize -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments +redirect_to: '../../project/insights/index.md' +remove_date: '2024-04-20' --- -# Insights for groups **(ULTIMATE ALL)** +This document was moved to [another location](../../project/insights/index.md). -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/725) in GitLab 12.0. - -Configure insights to explore data about you group's activity, such as -triage hygiene, issues created or closed in a given period, and average time for merge -requests to be merged. -You can also create custom insights reports that are relevant for your group. - -## View group insights - -Prerequisites: - -- You must have [permission](../../permissions.md#group-members-permissions) to view the group. -- You must have access to a project to view information about its merge requests and issues, - and permission to view them if they are confidential. - -To access your group's insights: - -1. On the left sidebar, select **Search or go to** and find your group. -1. Select **Analyze > Insights**. - -## Interact with insights charts - -You can interact with the insights charts to view details about your group's activity. - - - -### Display different reports - -To display one of the available reports on the insights page, from the **Select report** dropdown list, -select the report you want to display. - -### View bar chart annotations - -To view annotations, hover over each bar in the chart. - -### Zoom in on chart - -Insights display data from the last 90 days. You can zoom in to display data only from a subset of the 90-day range. - -To do this, select the pause icons (**{status-paused}**) and slide them along the horizontal axis: - -- To change the start date, slide the left pause icon to the left or right. -- To change the end date, slide the right pause icon to the left or right. - -### Exclude dimensions from charts - -By default, insights display all available dimensions on the chart. - -To exclude a dimension, from the legend below the chart, select the name of the dimension. - -### Drill down on charts - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/372215/) in GitLab 16.7. - -You can drill down into the data of the **Bugs created per month by priority** and **Bugs created per month by severity** charts from the [default configuration file](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/fixtures/insights/default.yml). - -To view a drill-down report of the data for a specific priority or severity in a month: - -- On the chart, select the bar stack you want to drill down on. - -## Configure group insights - -GitLab reads insights from the -[default configuration file](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/fixtures/insights/default.yml). - -To configure group insights: - -1. Create a new file [`.gitlab/insights.yml`](../../project/insights/index.md#configure-project-insights) -in a project that belongs to your group. -1. On the left sidebar, select **Search or go to** and find your group. -1. Select **Settings > General**. -1. Expand **Analytics** and find the **Insights** section. -1. Select the project that contains your `.gitlab/insights.yml` configuration file. -1. Select **Save changes**. - -<!-- ## Troubleshooting - -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. - -Each scenario can be a third-level heading, for example `### 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. --> +<!-- This redirect file can be deleted after <YYYY-MM-DD>. --> +<!-- Redirects that point to other docs in the same project expire in three months. --> +<!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html --> diff --git a/doc/user/group/issues_analytics/img/enhanced_issue_analytics_v16_7.png b/doc/user/group/issues_analytics/img/enhanced_issue_analytics_v16_7.png Binary files differindex 519e56acaa5..b253fe336ee 100644 --- a/doc/user/group/issues_analytics/img/enhanced_issue_analytics_v16_7.png +++ b/doc/user/group/issues_analytics/img/enhanced_issue_analytics_v16_7.png diff --git a/doc/user/group/issues_analytics/index.md b/doc/user/group/issues_analytics/index.md index 28f4026b3e3..efd4a46c710 100644 --- a/doc/user/group/issues_analytics/index.md +++ b/doc/user/group/issues_analytics/index.md @@ -4,17 +4,18 @@ group: Optimize info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Issue analytics for groups **(PREMIUM ALL)** +# Issue analytics **(PREMIUM ALL)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7478) in GitLab 11.5. +> - Issue analytics for groups [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7478) in GitLab 11.5. +> - Issue analytics for projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/196561) in GitLab 12.9. Issue analytics is a bar graph which illustrates the number of issues created each month. -The default time span is 13 months, which includes the current month, and the 12 months -prior. +The default time span is 13 months, which includes the current month, and the 12 months prior. +Issue analytics is available for projects and groups. To access the chart: -1. On the left sidebar, select **Search or go to** and find your group. +1. On the left sidebar, select **Search or go to** and find your project or group. 1. Select **Analyze > Issue analytics**. You can also access the chart from the [Value Streams Dashboard](../../analytics/value_streams_dashboard.md) through the **New issues** drill-down report. @@ -39,12 +40,11 @@ shows a total of 15 months for the chart in the GitLab.org group. ## Enhanced issue analytics **(ULTIMATE ALL)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/233905/) in GitLab 16.4 [with a flag](../../../administration/feature_flags.md) named `issues_completed_analytics_feature_flag`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/233905/) in GitLab 16.3 [with a flag](../../../administration/feature_flags.md) named `issues_completed_analytics_feature_flag`. Disabled by default. +> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/437542) in GitLab 16.8. FLAG: -On self-managed GitLab, by default this feature is not available. To make it available, an administrator can -[enable the feature flag](../../../administration/feature_flags.md) named `issues_completed_analytics_feature_flag`. On GitLab.com, this feature is not -available. This feature is not ready for production use. +On self-managed GitLab, by default this feature is available. To hide the feature, an administrator can [disable the feature flag](../../../administration/feature_flags.md) named `issues_completed_analytics_feature_flag`. On GitLab.com, this feature is available. Enhanced issue analytics display the additional metric "Issues closed", which represents the total number of resolved issues in your group over a selected period. You can use this metric to improve the overall turn-around time and value delivered to your customers. diff --git a/doc/user/group/manage.md b/doc/user/group/manage.md index 877db58b716..58c3f837e26 100644 --- a/doc/user/group/manage.md +++ b/doc/user/group/manage.md @@ -165,7 +165,7 @@ Transferring groups moves them from one place to another in the same GitLab inst - Convert a subgroup into a top-level group by transferring it out of its current group. If you need to copy a group to a different GitLab instance, -[migrate the group by direct transfer](import/index.md#migrate-groups-by-direct-transfer-recommended). +[migrate the group by direct transfer](import/index.md). When transferring groups, note: @@ -449,11 +449,6 @@ for the ability to set merge request approval rules for groups is tracked in > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/408158) from GitLab Ultimate to GitLab Premium in 16.0. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/410801) from GitLab Premium to GitLab Free in 16.0. -WARNING: -This feature is in [Beta](../../policy/experiment-beta-support.md#beta). -Beta users should read about the [known limitations](../project/repository/code_suggestions/index.md#known-limitations). -We look forward to hearing your [feedback](../project/repository/code_suggestions/index.md#feedback). - You can give all users in a group and its subgroups access to [Code Suggestions](../project/repository/code_suggestions/index.md). This setting [cascades to all projects](../project/merge_requests/approvals/settings.md#settings-cascading) in the group. diff --git a/doc/user/group/saml_sso/troubleshooting.md b/doc/user/group/saml_sso/troubleshooting.md index a2576f37ac9..1e7c749a705 100644 --- a/doc/user/group/saml_sso/troubleshooting.md +++ b/doc/user/group/saml_sso/troubleshooting.md @@ -248,6 +248,11 @@ For GitLab.com, alternatively, when users need to [link SAML to their existing G ### Users receive a 404 **(PREMIUM SAAS)** +If the user receives a `404` after signing in successfully, check if you have IP restrictions configured. IP restriction settings are configured: + +- On GitLab.com, [at the group level](../../../user/group/access_and_permissions.md#restrict-group-access-by-ip-address). +- For GitLab self-managed, [at the instance level](../../../administration/reporting/ip_addr_restrictions.md). + Because SAML SSO for groups is a paid feature, your subscription expiring can result in a `404` error when you're signing in using SAML SSO on GitLab.com. If all users are receiving a `404` when attempting to sign in using SAML, confirm [there is an active subscription](../../../subscriptions/gitlab_com/index.md#view-your-gitlab-saas-subscription) being used in this SAML SSO namespace. diff --git a/doc/user/group/saml_sso/troubleshooting_scim.md b/doc/user/group/saml_sso/troubleshooting_scim.md index 3dcb2d93096..47b2144c7ff 100644 --- a/doc/user/group/saml_sso/troubleshooting_scim.md +++ b/doc/user/group/saml_sso/troubleshooting_scim.md @@ -111,6 +111,26 @@ Changing the SAML or SCIM configuration or provider can cause the following prob the SCIM app. 1. Use the same SCIM API to update the SCIM `extern_uid` for the user on GitLab.com. +## The member's email address is not allowed for this group + +SCIM provisioning may fail with HTTP status `412` and the following error message: + +```plaintext +The member's email address is not allowed for this group. Check with your administrator. +``` + +This error occurs when both of the following are true: + +- [Restrict group access by domain](../access_and_permissions.md) is configured + for the group. +- The user account being provisioned has an email domain that is not allowed. + +To resolve this issue, you can do either of the following: + +- Add the user account's email domain to the list of allowed domains. +- Disable the [Restrict group access by domain](../access_and_permissions.md) + feature by removing all domains. + ## Search Rails logs for SCIM requests **(PREMIUM SAAS)** GitLab.com administrators can search for SCIM requests in the `api_json.log` using the `pubsub-rails-inf-gprd-*` index in @@ -149,9 +169,9 @@ The first workaround is: 1. Have the end user [link SAML to their existing GitLab.com account](index.md#link-saml-to-your-existing-gitlabcom-account). 1. After the user has done this, initiate a SCIM sync from your identity provider. -If the SCIM sync completes without the same error, GitLab has -successfully linked the SCIM identity to the existing user account, and the user -should now be able to sign in using SAML SSO. + If the SCIM sync completes without the same error, GitLab has + successfully linked the SCIM identity to the existing user account, and the user + should now be able to sign in using SAML SSO. If the error persists, the user most likely already exists, has both a SAML and SCIM identity, and a SCIM identity that is set to `active: false`. To resolve @@ -166,7 +186,7 @@ this: If any of this information does not match, [contact GitLab Support](https://support.gitlab.com/). 1. Use the API to [update the SCIM provisioned user's `active` value to `true`](/ee/development/internal_api/index.md#update-a-single-scim-provisioned-user). 1. If the update returns a status code `204`, have the user attempt to sign in -using SAML SSO. + using SAML SSO. ## Azure Active Directory diff --git a/doc/user/group/subgroups/index.md b/doc/user/group/subgroups/index.md index a63d4a98fa2..a43de3ef73b 100644 --- a/doc/user/group/subgroups/index.md +++ b/doc/user/group/subgroups/index.md @@ -10,12 +10,12 @@ info: To determine the technical writer assigned to the Stage/Group associated w You can organize GitLab [groups](../index.md) into subgroups. You can use subgroups to: -- Separate internal and external organizations. Because every subgroup can have its own +- Separate internal and external content. Because every subgroup can have its own [visibility level](../../public_access.md), you can host groups for different purposes under the same parent group. -- Organize large projects. You can use subgroups to give different access to parts of +- Organize large projects. You can use subgroups to manage who can access parts of the source code. -- Manage people and control visibility. Give a user a different +- Manage permissions. Give a user a different [role](../../permissions.md#group-members-permissions) for each group they're [a member of](#subgroup-membership). Subgroups can: @@ -25,7 +25,7 @@ Subgroups can: - Be nested up to 20 levels. - Use [runners](../../../ci/runners/index.md) registered to parent groups: - Secrets configured for the parent group are available to subgroup jobs. - - Users with the Maintainer role in projects that belong to subgroups can see the details of runners registered to + - Users with at least the Maintainer role in projects that belong to subgroups can see the details of runners registered to parent groups. For example: @@ -52,7 +52,7 @@ graph TD Prerequisites: - To view private nested subgroups, you must be a direct or inherited member of -the private subgroup. + the private subgroup. To view the subgroups of a group: @@ -117,7 +117,7 @@ For more information, view the [permissions table](../../permissions.md#group-me ## Subgroup membership When you add a member to a group, that member is also added to all subgroups of that group. -The member's permissions are inherited from the group's parent. +The member's permissions are inherited from the group into all subgroups. Subgroup members can be: @@ -189,8 +189,8 @@ Members can be [filtered by inherited or direct membership](../index.md#filter-a Users with the Owner role in a subgroup can add members to it. -You can't give a user a role in a subgroup that is lower than the roles the user has in ancestor groups. -To override a user's role in an ancestor group, add the user to the subgroup again with a higher role. +You can't give a user a role in a subgroup that is lower than the roles the user has in parent groups. +To override a user's role in a parent group, add the user to the subgroup again with a higher role. For example: - If User 1 is added to group _Two_ with the Developer role, User 1 inherits that role in every subgroup of group _Two_. @@ -201,7 +201,7 @@ For example: ## Mention subgroups -Mentioning subgroups ([`@<subgroup_name>`](../../discussions/index.md#mentions)) in issues, commits, and merge requests +Mentioning subgroups ([`@<subgroup_name>`](../../discussions/index.md#mentions)) in epics, issues, commits, and merge requests notifies all direct members of that group. Inherited members of a subgroup are not notified by mentions. Mentioning works the same as for projects and groups, and you can choose the group of members to be notified. diff --git a/doc/user/group/value_stream_analytics/index.md b/doc/user/group/value_stream_analytics/index.md index 0fdd572ed7c..7e077c7065c 100644 --- a/doc/user/group/value_stream_analytics/index.md +++ b/doc/user/group/value_stream_analytics/index.md @@ -166,7 +166,7 @@ In this example, milestones have been created and CI/CD for testing and setting - 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). +- GitLab CI/CD takes 5 minutes to run scripts defined in the [`.gitlab-ci.yml` file](../../../ci/index.md#the-gitlab-ciyml-file). - 19:00: Merge the merge request. **Review** stage stops and **Staging** stage starts. - 19:30: Deployment to the `production` environment finishes. **Staging** stops. @@ -305,7 +305,7 @@ In GitLab 13.8 and earlier, deployment frequency metrics are calculated based on Prerequisites: - To view deployment metrics, you must have a -[production environment configured](#how-value-stream-analytics-identifies-the-production-environment). + [production environment configured](#how-value-stream-analytics-identifies-the-production-environment). To view lifecycle metrics: @@ -442,11 +442,11 @@ After you create a value stream, you can customize it to suit your purposes. To 1. In the upper-right corner, select the dropdown list, then select a value stream. 1. Next to the value stream dropdown list, select **Edit**. 1. Optional: - - Rename the value stream. - - Hide or re-order default stages. - - Remove existing custom stages. - - To add new stages, select **Add another stage**. - - Select the start and end events for the stage. + - Rename the value stream. + - Hide or re-order default stages. + - Remove existing custom stages. + - To add new stages, select **Add another stage**. + - Select the start and end events for the stage. 1. Optional. To undo any modifications, select **Restore value stream defaults**. 1. Select **Save Value Stream**. |
