Commit 4cded415 authored by Sam Beckham's avatar Sam Beckham Committed by Achilleas Pipinellis

Adds documentation for the Group Security Dashboard

parent 49166425
......@@ -185,7 +185,7 @@ Alternatively, you can [lock the sharing with group feature](#share-with-group-l
In GitLab Enterprise Edition it is possible to manage GitLab group memberships using LDAP groups.
See [the GitLab Enterprise Edition documentation](../../integration/ldap.md) for more information.
## Epics
## Epics **[ULTIMATE]**
> Introduced in [GitLab Ultimate][ee] 10.2.
......@@ -195,6 +195,12 @@ milestones.
[Learn more about Epics.](epics/index.md)
## Group Security Dashboard **[ULTIMATE]**
Get an overview of the vulnerabilities of all the projects in a group and its subgroups.
[Learn more about the Group Security Dashboard.](security_dashboard/index.md)
## Transfer groups to another group
From 10.5 there are two different ways to transfer a group:
......
---
description: "The Group Security Dashboard gives an overview of the vulnerabilities of all the projects in a group and its subgroups."
---
# Group Security Dashboard **[ULTIMATE]**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/6709) in
[GitLab Ultimate](https://about.gitlab.com/pricing) 11.5.
The Group Security Dashboard gives an overview of the vulnerabilities of all the
projects in a group and its subgroups.
## Overview
To use the Group Security Dashboard, you need a group that has at least one
project with [Static Application Security Testing](../../project/merge_requests/sast.md)
enabled.
The Dashboard is a good place to get an overview of the security vulnerabilities in your projects.
You can also drill down into a vulnerability and get extra information, see which
project it comes from, the file it's in, and various metadata to help you analyze
the risk. You can also action these vulnerabilities by creating an issue for them, or by dismissing them.
Having your vulnerabilities in GitLab allows you to keep track of them and action them, all in the same application.
## Use cases
You want to measure how secure your projects are without having to look into
each one separately.
## Requirements
To use the group security dashboard:
1. At least one project inside a group must be configured with
[Static Application Security Testing](../../project/merge_requests/sast.md).
2. The configured jobs must use the [new `reports` syntax](../../../ci/yaml/README.md#artifactsreports).
## Viewing the vulnerabilities
First, navigate to the Security Dashboard found under your group's
**Overview > Security Dashboard**.
Once you're on the dashboard, on the top you should see an overview of all the
vulnerabilities, grouped by severity. Underneath these overviews is a list of
all the vulnerabilities in the group, sorted by severity.
![dashboard with action buttons](img/dashboard.png)
In that list, you can see the severity of the vulnerability, its name, its
confidence (likelihood of the vulnerability to be a positive one), and the project
it's from.
If you hover over a row, there will appear some actions you can take:
- "More info"
- "Create issue"
- "Dismiss vulnerability"
### Getting more information for a vulnerability
Clicking the "More info" button opens a modal with more information about the
selected vulnerability where you can get a better description, as well as the
file it came from, and a possible solution. You get access to the
["Dismiss vulnerability"](#dismissing-a-vulnerability) and
["Create issue"](#creating-an-issue-for-a-vulnerability) buttons inside this
modal as well.
![more info modal](img/modal.png)
### Creating an issue for a vulnerability
You can create an issue for a vulnerability by selecting the "Create issue"
button from the action buttons to the right of a vulnerability row.
This will create an issue on the project this vulnerability came from and pre-fill
it with some useful information.
Once the issue is created, you will be redirected to it so you can edit, assign,
or comment on it. Upon returning to the dashboard you'll see that the vulnerability
will now have an associated issue next to the name.
![linked issue](img/issue.png)
You can get the same result if you select the **Create issue** button from inside
the "More info" modal.
### Dismissing a vulnerability
You can also dismiss vulnerabilities by clicking the "Dismiss vulnerability" button.
This will dismiss the vulnerability and re-render it to reflect its dismissed state.
If you wish to undo this dismissal, you can click the "Revert dismissal" button.
You can get the same behaviour if you dismiss a vulnerability from within the
"More info" modal.
......@@ -3,4 +3,4 @@
#js-group-security-dashboard{ data: { vulnerabilities_endpoint: group_security_vulnerabilities_path(@group),
vulnerabilities_summary_endpoint: summary_group_security_vulnerabilities_path(@group),
dashboard_documentation: help_page_path('user/group/security_dashboard') } }
dashboard_documentation: help_page_path('user/group/security_dashboard/index') } }
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment