From 3b798bc5d9ab730b80d8699f42de2416b5c77cd6 Mon Sep 17 00:00:00 2001 From: Jay Montal Date: Wed, 7 Jun 2023 10:14:04 -0600 Subject: [PATCH 1/3] Rename compliance report page - Renames the compliance report page to compliance center - Updates docs/specs to reflect updated page Changelog: changed --- .gitlab/CODEOWNERS | 1 + data/whats_new/202204210001_14_10.yml | 2 +- data/whats_new/202303220001_15_10.yml | 2 +- data/whats_new/202304220001_15_11.yml | 2 +- doc/administration/compliance.md | 2 +- doc/development/export_csv.md | 16 +- .../compliance/compliance_center/index.md | 299 +++++++++++++++++ .../compliance/compliance_report/index.md | 300 +----------------- doc/user/compliance/index.md | 2 +- doc/user/group/index.md | 2 +- doc/user/group/manage.md | 2 +- .../merge_requests/approvals/settings.md | 2 +- .../components/group_settings/app.vue | 2 +- .../components/reports_app.vue | 16 +- .../_merge_request_approvals.html.haml | 2 +- .../compliance_dashboards/show.html.haml | 4 +- ...merge_request_approvals_settings.html.haml | 2 +- .../groups/menus/security_compliance_menu.rb | 2 +- ee/spec/features/groups/navbar_spec.rb | 2 +- .../components/group_settings/app_spec.js | 2 +- .../components/reports_app_spec.js | 16 +- ...eate_compliance_violations_service_spec.rb | 4 +- .../merge_requests/post_merge_service_spec.rb | 4 +- locale/gitlab.pot | 22 +- qa/qa/ee/page/group/menu.rb | 2 +- .../group/sub_menus/super_sidebar/secure.rb | 2 +- 26 files changed, 366 insertions(+), 348 deletions(-) create mode 100644 doc/user/compliance/compliance_center/index.md diff --git a/.gitlab/CODEOWNERS b/.gitlab/CODEOWNERS index 788df1c2bd5072..616329455b86a7 100644 --- a/.gitlab/CODEOWNERS +++ b/.gitlab/CODEOWNERS @@ -854,6 +854,7 @@ lib/gitlab/checks/** /doc/user/award_emojis.md @msedlakjakubowski /doc/user/clusters/ @phillipwells /doc/user/compliance/ @rdickenson +/doc/user/compliance/compliance_center/ @eread /doc/user/compliance/compliance_report/ @eread /doc/user/compliance/index.md @eread /doc/user/crm/ @msedlakjakubowski diff --git a/data/whats_new/202204210001_14_10.yml b/data/whats_new/202204210001_14_10.yml index c4028662f59b09..029dd19bcc71fc 100644 --- a/data/whats_new/202204210001_14_10.yml +++ b/data/whats_new/202204210001_14_10.yml @@ -5,7 +5,7 @@ self-managed: true gitlab-com: true available_in: [Ultimate] - documentation_link: 'https://docs.gitlab.com/ee/user/compliance/compliance_report/' + documentation_link: 'https://docs.gitlab.com/ee/user/compliance/compliance_center/' image_url: 'https://about.gitlab.com/images/14_10/manage_compliance_report_individual_violation.png' published_at: 2022-04-22 release: 14.10 diff --git a/data/whats_new/202303220001_15_10.yml b/data/whats_new/202303220001_15_10.yml index d2598fc8e2d0bd..cefd469fe411e4 100644 --- a/data/whats_new/202303220001_15_10.yml +++ b/data/whats_new/202303220001_15_10.yml @@ -38,7 +38,7 @@ self-managed: true gitlab-com: true available_in: [Ultimate] - documentation_link: 'https://docs.gitlab.com/ee/user/compliance/compliance_report/#compliance-frameworks-report' + documentation_link: 'https://docs.gitlab.com/ee/user/compliance/compliance_center/#compliance-frameworks-report' image_url: 'https://about.gitlab.com/images/15_10/govern-compliance-framework-report.png' published_at: 2023-03-22 release: 15.10 diff --git a/data/whats_new/202304220001_15_11.yml b/data/whats_new/202304220001_15_11.yml index 38e5d8bef31c9d..b9281c5a99ec82 100644 --- a/data/whats_new/202304220001_15_11.yml +++ b/data/whats_new/202304220001_15_11.yml @@ -22,7 +22,7 @@ self-managed: true gitlab-com: true available_in: [Ultimate] - documentation_link: 'https://docs.gitlab.com/ee/user/compliance/compliance_report/#compliance-frameworks-report' + documentation_link: 'https://docs.gitlab.com/ee/user/compliance/compliance_center/#compliance-frameworks-report' image_url: 'https://about.gitlab.com/images/15_11/govern-compliance-frameworks-report-management.png' published_at: 2023-04-22 release: 15.11 diff --git a/doc/administration/compliance.md b/doc/administration/compliance.md index 79133d5a6c7ec0..407ea51bc6acf4 100644 --- a/doc/administration/compliance.md +++ b/doc/administration/compliance.md @@ -57,7 +57,7 @@ These features can help provide visibility into GitLab and audit what is happeni | [Audit events](audit_events.md) | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | To maintain the integrity of your code, audit events give administrators the ability to view any modifications made in the GitLab server in an advanced audit events system, so you can control, analyze, and track every change. | | [Audit reports](audit_reports.md) | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | Create and access reports based on the audit events that have occurred. Use pre-built GitLab reports or the API to build your own. | | [Auditor users](auditor_users.md) | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Auditor users are users who are given read-only access to all projects, groups, and other resources on the GitLab instance. | -| [Compliance report](../user/compliance/compliance_report/index.md) | **{dotted-circle}** No | **{check-circle}** Yes | **{dotted-circle}** No | Quickly get visibility into the compliance posture of your organization. | +| [Compliance center](../user/compliance/compliance_center/index.md) | **{dotted-circle}** No | **{check-circle}** Yes | **{dotted-circle}** No | Quickly get visibility into the compliance posture of your organization. | ## Other compliance features diff --git a/doc/development/export_csv.md b/doc/development/export_csv.md index 971159e83b9bd5..9b0205166bf960 100644 --- a/doc/development/export_csv.md +++ b/doc/development/export_csv.md @@ -8,14 +8,14 @@ info: To determine the technical writer assigned to the Stage/Group associated w This document lists the different implementations of CSV export in GitLab codebase. -| Export type | How it works | Advantages | Disadvantages | Existing examples | -|---|---|---|---|---| -| Streaming | - Query and yield data in batches to a response stream.
- Download starts immediately. | - Report available immediately. | - No progress indicator.
- Requires a reliable connection. | [Export Audit Event Log](../administration/audit_events.md#export-to-csv) | -| Downloading | - Query and write data in batches to a temporary file.
- Loads the file into memory.
- Sends the file to the client. | - Report available immediately. | - Large amount of data might cause request timeout.
- Memory intensive.
- Request expires when user navigates to a different page. | - [Export Chain of Custody Report](../user/compliance/compliance_report/index.md#chain-of-custody-report)
- [Export License Usage File](../subscriptions/self_managed/index.md#export-your-license-usage) | -| As email attachment | - Asynchronously process the query with background job.
- Email uses the export as an attachment. | - Asynchronous processing. | - Requires users use a different app (email) to download the CSV.
- Email providers may limit attachment size. | - [Export issues](../user/project/issues/csv_export.md)
- [Export merge requests](../user/project/merge_requests/csv_export.md) | -| As downloadable link in email (*) | - Asynchronously process the query with background job.
- Email uses an export link. | - Asynchronous processing.
- Bypasses email provider attachment size limit. | - Requires users use a different app (email).
- Requires additional storage and cleanup. | [Export User Permissions](https://gitlab.com/gitlab-org/gitlab/-/issues/1772) | -| Polling (non-persistent state) | - Asynchronously processes the query with the background job.
- Frontend(FE) polls every few seconds to check if CSV file is ready. | - Asynchronous processing.
- Automatically downloads to local machine on completion.
- In-app solution. | - Non-persistable request - request expires when user navigates to a different page.
- API is processed for each polling request. | [Export Vulnerabilities](../user/application_security/vulnerability_report/index.md#export-vulnerability-details) | -| Polling (persistent state) (*) | - Asynchronously processes the query with background job.
- Backend (BE) maintains the export state
- FE polls every few seconds to check status.
- FE shows 'Download link' when export is ready.
- User can download or regenerate a new report. | - Asynchronous processing.
- No database calls made during the polling requests (HTTP 304 status is returned until export status changes).
- Does not require user to stay on page until export is complete.
- In-app solution.
- Can be expanded into a generic CSV feature (such as dashboard / CSV API). | - Requires to maintain export states in DB.
- Does not automatically download the CSV export to local machine, requires users to select 'Download'. | [Export Merge Commits Report](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/43055) | +| Export type | How it works | Advantages | Disadvantages | Existing examples | +|---|---|---|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Streaming | - Query and yield data in batches to a response stream.
- Download starts immediately. | - Report available immediately. | - No progress indicator.
- Requires a reliable connection. | [Export Audit Event Log](../administration/audit_events.md#export-to-csv) | +| Downloading | - Query and write data in batches to a temporary file.
- Loads the file into memory.
- Sends the file to the client. | - Report available immediately. | - Large amount of data might cause request timeout.
- Memory intensive.
- Request expires when user navigates to a different page. | - [Export Chain of Custody Report](../user/compliance/compliance_center/index.md#chain-of-custody-report)
- [Export License Usage File](../subscriptions/self_managed/index.md#export-your-license-usage) | +| As email attachment | - Asynchronously process the query with background job.
- Email uses the export as an attachment. | - Asynchronous processing. | - Requires users use a different app (email) to download the CSV.
- Email providers may limit attachment size. | - [Export issues](../user/project/issues/csv_export.md)
- [Export merge requests](../user/project/merge_requests/csv_export.md) | +| As downloadable link in email (*) | - Asynchronously process the query with background job.
- Email uses an export link. | - Asynchronous processing.
- Bypasses email provider attachment size limit. | - Requires users use a different app (email).
- Requires additional storage and cleanup. | [Export User Permissions](https://gitlab.com/gitlab-org/gitlab/-/issues/1772) | +| Polling (non-persistent state) | - Asynchronously processes the query with the background job.
- Frontend(FE) polls every few seconds to check if CSV file is ready. | - Asynchronous processing.
- Automatically downloads to local machine on completion.
- In-app solution. | - Non-persistable request - request expires when user navigates to a different page.
- API is processed for each polling request. | [Export Vulnerabilities](../user/application_security/vulnerability_report/index.md#export-vulnerability-details) | +| Polling (persistent state) (*) | - Asynchronously processes the query with background job.
- Backend (BE) maintains the export state
- FE polls every few seconds to check status.
- FE shows 'Download link' when export is ready.
- User can download or regenerate a new report. | - Asynchronous processing.
- No database calls made during the polling requests (HTTP 304 status is returned until export status changes).
- Does not require user to stay on page until export is complete.
- In-app solution.
- Can be expanded into a generic CSV feature (such as dashboard / CSV API). | - Requires to maintain export states in DB.
- Does not automatically download the CSV export to local machine, requires users to select 'Download'. | [Export Merge Commits Report](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/43055) | NOTE: Export types marked as * are currently work in progress. diff --git a/doc/user/compliance/compliance_center/index.md b/doc/user/compliance/compliance_center/index.md new file mode 100644 index 00000000000000..b01d1a019d955c --- /dev/null +++ b/doc/user/compliance/compliance_center/index.md @@ -0,0 +1,299 @@ +--- +type: reference, howto +stage: Govern +group: Compliance +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- + +# Compliance center **(ULTIMATE)** + +> [Renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122931) from Compliance report in GitLab 16.2. + +See report and manage standards adherence, violations, and compliance frameworks for the group + +## Compliance violations report + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36524) in GitLab 12.8 as Compliance Dashboard. +> - Compliance violation drawer [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299357) in GitLab 14.1. +> - [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/299360) to compliance report in GitLab 14.2. +> - [Replaced](https://gitlab.com/groups/gitlab-org/-/epics/5237) by merge request violations in GitLab 14.6 [with a flag](../../../administration/feature_flags.md) named `compliance_violations_report`. Disabled by default. +> - GraphQL API [introduced](https://gitlab.com/groups/gitlab-org/-/epics/7222) in GitLab 14.9. +> - [Generally available](https://gitlab.com/groups/gitlab-org/-/epics/5237) in GitLab 14.10. [Feature flag `compliance_violations_report`](https://gitlab.com/gitlab-org/gitlab/-/issues/346266) removed. +> - [Renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112111) to compliance violations report in GitLab 15.9. +> - [Added](https://gitlab.com/gitlab-org/gitlab/-/issues/394950) ability to create/edit compliance frameworks in GitLab 16.0. + +With compliance violations report, you can see a high-level view of merge request activity for all projects in the group. + +When you select a row in the compliance report, a drawer appears that provides: + +- The project name and [compliance framework label](../../project/settings/index.md#add-a-compliance-framework-to-a-project), + if the project has one assigned. +- A link to the merge request that introduced the violation. +- The merge request's branch path in the format `[source] into [target]`. +- A list of users that committed changes to the merge request. +- A list of users that commented on the merge request. +- A list of users that approved the merge request. +- The user that merged the merge request. + +### View the compliance violations report for a group + +> Target branch search [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358414) in GitLab 16.0. + +Prerequisites: + +- You must be an administrator or have the Owner role for the group. + +To view the compliance violations report: + +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Secure > Compliance center**. + +You can sort the compliance report on: + +- Severity level. +- Type of violation. +- Merge request title. + +You can filter the compliance violations report on: + +- Project. +- Date range of merge. +- Target branch. + +Select a row to see details of the compliance violation. + +#### Severity levels + +Each compliance violation has one of the following severities. + + + +| Icon | Severity level | +|:----------------------------------------------|:---------------| +| **{severity-critical, 18, gl-fill-red-800}** | Critical | +| **{severity-high, 18, gl-fill-red-600}** | High | +| **{severity-medium, 18, gl-fill-orange-400}** | Medium | +| **{severity-low, 18, gl-fill-orange-300}** | Low | +| **{severity-info, 18, gl-fill-blue-400}** | Info | + + + +#### Violation types + +From [GitLab 14.10](https://gitlab.com/groups/gitlab-org/-/epics/6870), these are the available compliance violations. + +| Violation | Severity level | Category | Description | +|:----------------------------------|:---------------|:----------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Author approved merge request | High | [Separation of duties](#separation-of-duties) | Author of the merge request approved their own merge request. For more information, see [Prevent approval by author](../../project/merge_requests/approvals/settings.md#prevent-approval-by-author). | +| Committers approved merge request | High | [Separation of duties](#separation-of-duties) | Committers of the merge request approved the merge request they contributed to. For more information, see [Prevent approvals by users who add commits](../../project/merge_requests/approvals/settings.md#prevent-approvals-by-users-who-add-commits). | +| Fewer than two approvals | High | [Separation of duties](#separation-of-duties) | Merge request was merged with fewer than two approvals. For more information, see [Merge request approval rules](../../project/merge_requests/approvals/rules.md). | + +The following are unavailable compliance violations that are tracked in [epic 5237](https://gitlab.com/groups/gitlab-org/-/epics/5237). + + + +| Violation | Severity level | Category | Description | +|:-------------------------------------|:---------------|:---------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------| +| Pipeline failed | Medium | [Pipeline results](../../../ci/pipelines/index.md) | Merge requests pipeline failed and was merged. | +| Pipeline passed with warnings | Info | [Pipeline results](../../../ci/pipelines/index.md) | Merge request pipeline passed with warnings and was merged. | +| Code coverage down more than 10% | High | [Code coverage](../../../ci/testing/code_coverage.md#view-code-coverage-results-in-the-mr) | Code coverage report for the merge request indicates a reduction in coverage of more than 10%. | +| Code coverage down between 5% to 10% | Medium | [Code coverage](../../../ci/testing/code_coverage.md#view-code-coverage-results-in-the-mr) | Code coverage report for the merge request indicates a reduction in coverage of between 5% to 10%. | +| Code coverage down between 1% to 5% | Low | [Code coverage](../../../ci/testing/code_coverage.md#view-code-coverage-results-in-the-mr) | Code coverage report for the merge request indicates a reduction in coverage of between 1% to 5%. | +| Code coverage down less than 1% | Info | [Code coverage](../../../ci/testing/code_coverage.md#view-code-coverage-results-in-the-mr) | Code coverage report for the merge request indicates a reduction in coverage of less than 1%. | + + + +##### Separation of duties + +GitLab supports a separation of duties policy between users who create and approve merge requests. Our criteria for the +separation of duties is: + +- [A merge request author is **not** allowed to approve their merge request](../../project/merge_requests/approvals/settings.md#prevent-approval-by-author). +- [A merge request committer is **not** allowed to approve a merge request they have added commits to](../../project/merge_requests/approvals/settings.md#prevent-approvals-by-users-who-add-commits). +- [The minimum number of approvals required to merge a merge request is **at least** two](../../project/merge_requests/approvals/rules.md). + +### Chain of Custody report + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213364) in GitLab 13.3. +> - Chain of Custody reports sent using email [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342594) in GitLab 15.3 with a flag named `async_chain_of_custody_report`. Disabled by default. +> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/370100) in GitLab 15.5. Feature flag `async_chain_of_custody_report` removed. +> - Chain of Custody report includes all commits (instead of just merge commits) [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267601) in GitLab 15.9 with a flag named `all_commits_compliance_report`. Disabled by default. +> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112092) in GitLab 15.9. Feature flag `all_commits_compliance_report` removed. + +The Chain of Custody report provides a 1 month trailing window of all commits to a project under the group. + +To generate the report for all commits, GitLab: + +1. Fetches all projects under the group. +1. For each project, fetches the last 1 month of commits. Each project is capped at 1024 commits. If there are more than + 1024 commits in the 1-month window, they are truncated. +1. Writes the commits to a CSV file. The file is truncated at 15 MB because the report is emailed as an attachment + (GitLab 15.5 and later). + +The report includes: + +- Commit SHA. +- Commit author. +- Committer. +- Date committed. +- Group. +- Project. + +If the commit has a related merge commit, then the following are also included: + +- Merge commit SHA. +- Merge request ID. +- User who merged the merge request. +- Merge date. +- Pipeline ID. +- Merge request approvers. + +#### Generate Chain of Custody report + +To generate the Chain of Custody report: + +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Secure > Compliance center**. +1. Select **List of all merge commits**. + +Depending on your version of GitLab, the Chain of Custody report is either sent through email or available for download. + +#### Generate commit-specific Chain of Custody report + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267629) in GitLab 13.6. +> - Support for including all commits instead of only merge commits [added](https://gitlab.com/gitlab-org/gitlab/-/issues/393446) in GitLab 15.10. + +You can generate a commit-specific Chain of Custody report for a given commit SHA. This report provides only the +details for the provided commit SHA. + +To generate a commit-specific Chain of Custody report: + +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Secure > Compliance center**. +1. At the top of the compliance report, to the right of **List of all commits**, select the down arrow + (**{chevron-lg-down}**). +1. Enter the commit SHA, and then select **Export commit custody report**. + +Depending on your version of GitLab, the Chain of Custody report is either sent through email or available for download. + +Alternatively, use a direct link: `https://gitlab.com/groups//-/security/merge_commit_reports.csv?commit_sha={optional_commit_sha}`, +passing in an optional value to the `commit_sha` query parameter. + +## Compliance frameworks report + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387910) in GitLab 15.10. + +With compliance frameworks report, you can see the compliance frameworks that are applied to projects in a group. Each row of the report shows: + +- Project name. +- Project path. +- Compliance framework label if the project has one assigned. + +The default framework for the group has a **default** badge. + +### View the compliance frameworks report for a group + +Prerequisites: + +- You must be an administrator or have the Owner role for the group. + +To view the compliance frameworks report: + +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Secure > Compliance center**. +1. On the page, select the **Frameworks** tab. + +### Apply a compliance framework to projects in a group + +> - Adding compliance frameworks using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383209) in GitLab 15.11. +> - Adding compliance frameworks without using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394795) in GitLab 16.0. + +You can apply a compliance framework to projects in a group. + +Prerequisites: + +- You must have the Owner role for the group. + +To apply a compliance framework to one project in a group: + +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Secure > Compliance center**. +1. On the page, select the **Frameworks** tab. +1. Next to the project you want to add the compliance framework to, select **{plus}** **Add framework**. +1. Select an existing compliance framework or create a new one. + +To apply a compliance framework to multiple projects in a group: + +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Secure > Compliance center**. +1. On the page, select the **Frameworks** tab. +1. Select multiple projects. +1. From the **Choose one bulk action** dropdown list, select **Apply framework to selected projects**. +1. Select framework to apply. +1. Select **Apply**. + +### Remove a compliance framework from projects in a group + +> - Removing compliance frameworks using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383209) in GitLab 15.11. +> - Removing compliance frameworks without using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394795) in GitLab 16.0. + +You can remove a compliance framework from projects in a group. + +Prerequisites: + +- You must have the Owner role for the group. + +To remove a compliance framework from one project in a group: + +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Secure > Compliance center**. +1. On the page, select the **Frameworks** tab. +1. Next to the compliance framework to remove from the project, select **{close}** on the framework label. + +To remove a compliance framework from multiple projects in a group: + +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Secure > Compliance center**. +1. On the page, select the **Frameworks** tab. +1. Select multiple projects. +1. From the **Choose one bulk action** dropdown list, select **Remove framework from selected projects**. +1. Select **Remove**. + +### Export a report of compliance frameworks on projects in a group + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387912) in GitLab 16.0. + +Export a report of compliance frameworks that are applied to projects in a group. Reports: + +- Do not use filters on the framework report. +- Are truncated at 15 MB so the email attachment too large. + +Prerequisites: + +- You must be an administrator or have the Owner role for the group. + +To export a report of compliance frameworks on projects in a group: + +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Secure > Compliance center**. +1. On the page, select the **Frameworks** tab. +1. On the Frameworks tab, select the **Export as CSV** action in the top right corner + +A report is compiled and delivered to your email inbox as an attachment. + +#### Filter the compliance frameworks report + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387911) in GitLab 15.11. + +To filter the list of compliance frameworks: + +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. +1. On the left sidebar, select **Secure > Compliance center**. +1. On the page, select the **Frameworks** tab. +1. In the search field: + 1. Select the attribute you want to filter by. + 1. Select an operator. + 1. Select from the list of options or enter text for the search. +1. Select **Search** (**{search}**). + +Repeat this process to filter by multiple attributes. diff --git a/doc/user/compliance/compliance_report/index.md b/doc/user/compliance/compliance_report/index.md index ab80fbbba8e790..20f16cd28240f7 100644 --- a/doc/user/compliance/compliance_report/index.md +++ b/doc/user/compliance/compliance_report/index.md @@ -1,297 +1,11 @@ --- -type: reference, howto -stage: Govern -group: Compliance -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +redirect_to: 'compliance_center/index.md' +remove_date: '2023-09-20' --- -# Compliance reports **(ULTIMATE)** +This document was moved to [another location](../compliance_center/index.md). -See reports about compliance violations and compliance frameworks for the group. - -## Compliance violations report - -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36524) in GitLab 12.8 as Compliance Dashboard. -> - Compliance violation drawer [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/299357) in GitLab 14.1. -> - [Renamed](https://gitlab.com/gitlab-org/gitlab/-/issues/299360) to compliance report in GitLab 14.2. -> - [Replaced](https://gitlab.com/groups/gitlab-org/-/epics/5237) by merge request violations in GitLab 14.6 [with a flag](../../../administration/feature_flags.md) named `compliance_violations_report`. Disabled by default. -> - GraphQL API [introduced](https://gitlab.com/groups/gitlab-org/-/epics/7222) in GitLab 14.9. -> - [Generally available](https://gitlab.com/groups/gitlab-org/-/epics/5237) in GitLab 14.10. [Feature flag `compliance_violations_report`](https://gitlab.com/gitlab-org/gitlab/-/issues/346266) removed. -> - [Renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112111) to compliance violations report in GitLab 15.9. -> - [Added](https://gitlab.com/gitlab-org/gitlab/-/issues/394950) ability to create/edit compliance frameworks in GitLab 16.0. - -With compliance violations report, you can see a high-level view of merge request activity for all projects in the group. - -When you select a row in the compliance report, a drawer appears that provides: - -- The project name and [compliance framework label](../../project/settings/index.md#add-a-compliance-framework-to-a-project), - if the project has one assigned. -- A link to the merge request that introduced the violation. -- The merge request's branch path in the format `[source] into [target]`. -- A list of users that committed changes to the merge request. -- A list of users that commented on the merge request. -- A list of users that approved the merge request. -- The user that merged the merge request. - -### View the compliance violations report for a group - -> Target branch search [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/358414) in GitLab 16.0. - -Prerequisites: - -- You must be an administrator or have the Owner role for the group. - -To view the compliance violations report: - -1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. -1. On the left sidebar, select **Secure > Compliance report**. - -You can sort the compliance report on: - -- Severity level. -- Type of violation. -- Merge request title. - -You can filter the compliance violations report on: - -- Project. -- Date range of merge. -- Target branch. - -Select a row to see details of the compliance violation. - -#### Severity levels - -Each compliance violation has one of the following severities. - - - -| Icon | Severity level | -|:----------------------------------------------|:---------------| -| **{severity-critical, 18, gl-fill-red-800}** | Critical | -| **{severity-high, 18, gl-fill-red-600}** | High | -| **{severity-medium, 18, gl-fill-orange-400}** | Medium | -| **{severity-low, 18, gl-fill-orange-300}** | Low | -| **{severity-info, 18, gl-fill-blue-400}** | Info | - - - -#### Violation types - -From [GitLab 14.10](https://gitlab.com/groups/gitlab-org/-/epics/6870), these are the available compliance violations. - -| Violation | Severity level | Category | Description | -|:----------------------------------|:---------------|:----------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Author approved merge request | High | [Separation of duties](#separation-of-duties) | Author of the merge request approved their own merge request. For more information, see [Prevent approval by author](../../project/merge_requests/approvals/settings.md#prevent-approval-by-author). | -| Committers approved merge request | High | [Separation of duties](#separation-of-duties) | Committers of the merge request approved the merge request they contributed to. For more information, see [Prevent approvals by users who add commits](../../project/merge_requests/approvals/settings.md#prevent-approvals-by-users-who-add-commits). | -| Fewer than two approvals | High | [Separation of duties](#separation-of-duties) | Merge request was merged with fewer than two approvals. For more information, see [Merge request approval rules](../../project/merge_requests/approvals/rules.md). | - -The following are unavailable compliance violations that are tracked in [epic 5237](https://gitlab.com/groups/gitlab-org/-/epics/5237). - - - -| Violation | Severity level | Category | Description | -|:-------------------------------------|:---------------|:---------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------| -| Pipeline failed | Medium | [Pipeline results](../../../ci/pipelines/index.md) | Merge requests pipeline failed and was merged. | -| Pipeline passed with warnings | Info | [Pipeline results](../../../ci/pipelines/index.md) | Merge request pipeline passed with warnings and was merged. | -| Code coverage down more than 10% | High | [Code coverage](../../../ci/testing/code_coverage.md#view-code-coverage-results-in-the-mr) | Code coverage report for the merge request indicates a reduction in coverage of more than 10%. | -| Code coverage down between 5% to 10% | Medium | [Code coverage](../../../ci/testing/code_coverage.md#view-code-coverage-results-in-the-mr) | Code coverage report for the merge request indicates a reduction in coverage of between 5% to 10%. | -| Code coverage down between 1% to 5% | Low | [Code coverage](../../../ci/testing/code_coverage.md#view-code-coverage-results-in-the-mr) | Code coverage report for the merge request indicates a reduction in coverage of between 1% to 5%. | -| Code coverage down less than 1% | Info | [Code coverage](../../../ci/testing/code_coverage.md#view-code-coverage-results-in-the-mr) | Code coverage report for the merge request indicates a reduction in coverage of less than 1%. | - - - -##### Separation of duties - -GitLab supports a separation of duties policy between users who create and approve merge requests. Our criteria for the -separation of duties is: - -- [A merge request author is **not** allowed to approve their merge request](../../project/merge_requests/approvals/settings.md#prevent-approval-by-author). -- [A merge request committer is **not** allowed to approve a merge request they have added commits to](../../project/merge_requests/approvals/settings.md#prevent-approvals-by-users-who-add-commits). -- [The minimum number of approvals required to merge a merge request is **at least** two](../../project/merge_requests/approvals/rules.md). - -### Chain of Custody report - -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/213364) in GitLab 13.3. -> - Chain of Custody reports sent using email [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/342594) in GitLab 15.3 with a flag named `async_chain_of_custody_report`. Disabled by default. -> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/370100) in GitLab 15.5. Feature flag `async_chain_of_custody_report` removed. -> - Chain of Custody report includes all commits (instead of just merge commits) [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267601) in GitLab 15.9 with a flag named `all_commits_compliance_report`. Disabled by default. -> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112092) in GitLab 15.9. Feature flag `all_commits_compliance_report` removed. - -The Chain of Custody report provides a 1 month trailing window of all commits to a project under the group. - -To generate the report for all commits, GitLab: - -1. Fetches all projects under the group. -1. For each project, fetches the last 1 month of commits. Each project is capped at 1024 commits. If there are more than - 1024 commits in the 1-month window, they are truncated. -1. Writes the commits to a CSV file. The file is truncated at 15 MB because the report is emailed as an attachment - (GitLab 15.5 and later). - -The report includes: - -- Commit SHA. -- Commit author. -- Committer. -- Date committed. -- Group. -- Project. - -If the commit has a related merge commit, then the following are also included: - -- Merge commit SHA. -- Merge request ID. -- User who merged the merge request. -- Merge date. -- Pipeline ID. -- Merge request approvers. - -#### Generate Chain of Custody report - -To generate the Chain of Custody report: - -1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. -1. On the left sidebar, select **Secure > Compliance report**. -1. Select **List of all merge commits**. - -Depending on your version of GitLab, the Chain of Custody report is either sent through email or available for download. - -#### Generate commit-specific Chain of Custody report - -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267629) in GitLab 13.6. -> - Support for including all commits instead of only merge commits [added](https://gitlab.com/gitlab-org/gitlab/-/issues/393446) in GitLab 15.10. - -You can generate a commit-specific Chain of Custody report for a given commit SHA. This report provides only the -details for the provided commit SHA. - -To generate a commit-specific Chain of Custody report: - -1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. -1. On the left sidebar, select **Secure > Compliance report**. -1. At the top of the compliance report, to the right of **List of all commits**, select the down arrow - (**{chevron-lg-down}**). -1. Enter the commit SHA, and then select **Export commit custody report**. - -Depending on your version of GitLab, the Chain of Custody report is either sent through email or available for download. - -Alternatively, use a direct link: `https://gitlab.com/groups//-/security/merge_commit_reports.csv?commit_sha={optional_commit_sha}`, -passing in an optional value to the `commit_sha` query parameter. - -## Compliance frameworks report - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387910) in GitLab 15.10. - -With compliance frameworks report, you can see the compliance frameworks that are applied to projects in a group. Each row of the report shows: - -- Project name. -- Project path. -- Compliance framework label if the project has one assigned. - -The default framework for the group has a **default** badge. - -### View the compliance frameworks report for a group - -Prerequisites: - -- You must be an administrator or have the Owner role for the group. - -To view the compliance frameworks report: - -1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. -1. On the left sidebar, select **Secure > Compliance report**. -1. On the page, select the **Frameworks** tab. - -### Apply a compliance framework to projects in a group - -> - Adding compliance frameworks using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383209) in GitLab 15.11. -> - Adding compliance frameworks without using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394795) in GitLab 16.0. - -You can apply a compliance framework to projects in a group. - -Prerequisites: - -- You must have the Owner role for the group. - -To apply a compliance framework to one project in a group: - -1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. -1. On the left sidebar, select **Secure > Compliance report**. -1. On the page, select the **Frameworks** tab. -1. Next to the project you want to add the compliance framework to, select **{plus}** **Add framework**. -1. Select an existing compliance framework or create a new one. - -To apply a compliance framework to multiple projects in a group: - -1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. -1. On the left sidebar, select **Secure > Compliance report**. -1. On the page, select the **Frameworks** tab. -1. Select multiple projects. -1. From the **Choose one bulk action** dropdown list, select **Apply framework to selected projects**. -1. Select framework to apply. -1. Select **Apply**. - -### Remove a compliance framework from projects in a group - -> - Removing compliance frameworks using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/383209) in GitLab 15.11. -> - Removing compliance frameworks without using bulk actions [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/394795) in GitLab 16.0. - -You can remove a compliance framework from projects in a group. - -Prerequisites: - -- You must have the Owner role for the group. - -To remove a compliance framework from one project in a group: - -1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. -1. On the left sidebar, select **Secure > Compliance report**. -1. On the page, select the **Frameworks** tab. -1. Next to the compliance framework to remove from the project, select **{close}** on the framework label. - -To remove a compliance framework from multiple projects in a group: - -1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. -1. On the left sidebar, select **Secure > Compliance report**. -1. On the page, select the **Frameworks** tab. -1. Select multiple projects. -1. From the **Choose one bulk action** dropdown list, select **Remove framework from selected projects**. -1. Select **Remove**. - -### Export a report of compliance frameworks on projects in a group - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387912) in GitLab 16.0. - -Export a report of compliance frameworks that are applied to projects in a group. Reports: - -- Do not use filters on the framework report. -- Are truncated at 15 MB so the email attachment too large. - -Prerequisites: - -- You must be an administrator or have the Owner role for the group. - -To export a report of compliance frameworks on projects in a group: - -1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. -1. On the left sidebar, select **Secure > Compliance report**. -1. On the page, select the **Frameworks** tab. -1. On the Frameworks tab, select the **Export as CSV** action in the top right corner - -A report is compiled and delivered to your email inbox as an attachment. - -#### Filter the compliance frameworks report - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/387911) in GitLab 15.11. - -To filter the list of compliance frameworks: - -1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your group. -1. On the left sidebar, select **Secure > Compliance report**. -1. On the page, select the **Frameworks** tab. -1. In the search field: - 1. Select the attribute you want to filter by. - 1. Select an operator. - 1. Select from the list of options or enter text for the search. -1. Select **Search** (**{search}**). - -Repeat this process to filter by multiple attributes. + + + + diff --git a/doc/user/compliance/index.md b/doc/user/compliance/index.md index ad36684d987978..ae705b5edc6dd7 100644 --- a/doc/user/compliance/index.md +++ b/doc/user/compliance/index.md @@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w The compliance tools provided by GitLab help you keep an eye on various aspects of your project, including: -- [Compliance report](compliance_report/index.md). +- [Compliance center](compliance_center/index.md). - [License approval policies](license_approval_policies.md). - [License list](license_list.md). - [License scanning of CycloneDX files](license_scanning_of_cyclonedx_files/index.md). diff --git a/doc/user/group/index.md b/doc/user/group/index.md index 479771e520c451..d6961adfc63e65 100644 --- a/doc/user/group/index.md +++ b/doc/user/group/index.md @@ -27,7 +27,7 @@ organization view of all groups, [see epic 9266](https://gitlab.com/groups/gitla A single top-level group provides insights in your entire organization via a complete [Security Dashboard and Center](../application_security/security_dashboard/index.md), [Vulnerability](../application_security/vulnerability_report/index.md#vulnerability-report) and -[Compliance Report](../compliance/compliance_report/index.md), and +[Compliance center](../compliance/compliance_center/index.md), and [Value stream analytics](../group/value_stream_analytics/index.md). ## Group visibility diff --git a/doc/user/group/manage.md b/doc/user/group/manage.md index 1de2f075592ce8..25c901ece46a27 100644 --- a/doc/user/group/manage.md +++ b/doc/user/group/manage.md @@ -15,7 +15,7 @@ organization view of all groups, [see epic 9266](https://gitlab.com/groups/gitla A single top-level group provides insights in your entire organization via a complete [Security Dashboard and Center](../application_security/security_dashboard/index.md), [Vulnerability](../application_security/vulnerability_report/index.md#vulnerability-report) and -[Compliance Report](../compliance/compliance_report/index.md), and +[Compliance center](../compliance/compliance_center/index.md), and [Value stream analytics](../group/value_stream_analytics/index.md). ## Add a group README diff --git a/doc/user/project/merge_requests/approvals/settings.md b/doc/user/project/merge_requests/approvals/settings.md index 6c079dc9319374..31602f0ef12b66 100644 --- a/doc/user/project/merge_requests/approvals/settings.md +++ b/doc/user/project/merge_requests/approvals/settings.md @@ -172,5 +172,5 @@ that inherited them. ## Related topics - [Instance-level merge request approval settings](../../../admin_area/merge_requests_approvals.md) -- [Compliance report](../../../compliance/compliance_report/index.md) +- [Compliance center](../../../compliance/compliance_center/index.md) - [Merge request approvals API](../../../../api/merge_request_approvals.md) diff --git a/ee/app/assets/javascripts/approvals/components/group_settings/app.vue b/ee/app/assets/javascripts/approvals/components/group_settings/app.vue index 1dc1581d7a2c9b..712329a1765aae 100644 --- a/ee/app/assets/javascripts/approvals/components/group_settings/app.vue +++ b/ee/app/assets/javascripts/approvals/components/group_settings/app.vue @@ -27,7 +27,7 @@ export default { }, links: { groupSettingsDocsPath: helpPagePath('user/project/merge_requests/approvals/index.md'), - separationOfDutiesDocsPath: helpPagePath('user/compliance/compliance_report/index', { + separationOfDutiesDocsPath: helpPagePath('user/compliance/compliance_center/index', { anchor: 'separation-of-duties', }), }, diff --git a/ee/app/assets/javascripts/compliance_dashboard/components/reports_app.vue b/ee/app/assets/javascripts/compliance_dashboard/components/reports_app.vue index 2be2f1bcb4947a..8ffedbd4e43e4f 100644 --- a/ee/app/assets/javascripts/compliance_dashboard/components/reports_app.vue +++ b/ee/app/assets/javascripts/compliance_dashboard/components/reports_app.vue @@ -69,22 +69,22 @@ export default { ROUTE_VIOLATIONS, ROUTE_FRAMEWORKS, i18n: { - export: s__('Compliance Report|Export full report as CSV'), + export: s__('Compliance Center|Export full report as CSV'), exportTitle: { frameworks: s__( - 'Compliance Report|Export frameworks as CSV. You will be emailed after the export is processed.', + 'Compliance Center|Export frameworks as CSV. You will be emailed after the export is processed.', ), violations: s__( - 'Compliance Report|Export merge request violations as CSV. You will be emailed after the export is processed.', + 'Compliance Center|Export merge request violations as CSV. You will be emailed after the export is processed.', ), }, - frameworksTab: s__('Compliance Report|Frameworks'), - heading: __('Compliance report'), - standardsAdherenceTab: s__('Compliance Report|Standards Adherence'), + frameworksTab: s__('Compliance Center|Frameworks'), + heading: __('Compliance center'), + standardsAdherenceTab: s__('Compliance Center|Standards Adherence'), subheading: __('Compliance violations and compliance frameworks for the group.'), - violationsTab: s__('Compliance Report|Violations'), + violationsTab: s__('Compliance Center|Violations'), }, - documentationPath: helpPagePath('user/compliance/compliance_report/index.md'), + documentationPath: helpPagePath('user/compliance/compliance_center/index.md'), };