diff options
Diffstat (limited to 'doc/user')
| -rw-r--r-- | doc/user/application_security/index.md | 2 | ||||
| -rw-r--r-- | doc/user/application_security/security_dashboard/index.md | 51 | ||||
| -rw-r--r-- | doc/user/application_security/vulnerability_report/pipeline.md | 57 | ||||
| -rw-r--r-- | doc/user/clusters/agent/install/index.md | 6 | ||||
| -rw-r--r-- | doc/user/permissions.md | 2 | ||||
| -rw-r--r-- | doc/user/project/milestones/burndown_and_burnup_charts.md | 2 | ||||
| -rw-r--r-- | doc/user/project/milestones/img/milestones_promote_milestone.png | bin | 49288 -> 0 bytes | |||
| -rw-r--r-- | doc/user/project/milestones/index.md | 110 | ||||
| -rw-r--r-- | doc/user/tasks.md | 2 |
9 files changed, 141 insertions, 91 deletions
diff --git a/doc/user/application_security/index.md b/doc/user/application_security/index.md index 218799ac217..be98cc36174 100644 --- a/doc/user/application_security/index.md +++ b/doc/user/application_security/index.md @@ -224,7 +224,7 @@ From the merge request security widget, select **Expand** to unfold the widget, A pipeline's security tab lists all findings in the current branch. It includes new findings introduced by this branch and existing vulnerabilities that were already present when the branch was created. These results likely do not match the findings displayed in the Merge Request security widget as those do not include the existing vulnerabilities (with the exception of showing any existing vulnerabilities that are no longer detected in the feature branch). -For more details, see [security tab](security_dashboard/index.md#view-vulnerabilities-in-a-pipeline). +For more details, see [security tab](vulnerability_report/pipeline.md#view-vulnerabilities-in-a-pipeline). ## View security scan information in the Security Dashboard diff --git a/doc/user/application_security/security_dashboard/index.md b/doc/user/application_security/security_dashboard/index.md index 3cb4bd4a02d..f3c834e06c7 100644 --- a/doc/user/application_security/security_dashboard/index.md +++ b/doc/user/application_security/security_dashboard/index.md @@ -42,57 +42,6 @@ To reduce false negatives in [dependency scans](../../../user/application_securi - Python projects can have lock files, but GitLab Secure tools don't support them. - Configure your project for [Continuous Delivery](../../../ci/introduction/index.md). -## View vulnerabilities in a pipeline - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13496) in GitLab 12.3. - -To view vulnerabilities in a pipeline: - -1. On the top bar, select **Menu > Projects** and find your project. -1. On the left sidebar, select **CI/CD > Pipelines**. -1. From the list, select the pipeline you want to check for vulnerabilities. -1. Select the **Security** tab. - -**Scan details** shows vulnerabilities introduced by the merge request, in addition to existing vulnerabilities -from the latest successful pipeline in your project's default branch. - -A pipeline consists of multiple jobs, such as SAST and DAST scans. If a job fails to finish, -the security dashboard doesn't show SAST scanner output. For example, if the SAST -job finishes but the DAST job fails, the security dashboard doesn't show SAST results. On failure, -the analyzer outputs an [exit code](../../../development/integrations/secure.md#exit-code). - -## View total number of vulnerabilities per scan - -To view the total number of vulnerabilities per scan: - -1. On the top bar, select **Menu > Projects** and find your project. -1. On the left sidebar, select **CI/CD > Pipelines**. -1. Select the **Status** of a branch. -1. Select the **Security** tab. - -**Scan details** shows vulnerabilities introduced by the merge request, in addition to existing vulnerabilities -from the latest successful pipeline in your project's default branch. - -### Download security scan outputs - -> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3728) in GitLab 13.10. -> - [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/333660) in GitLab 14.2. - -Depending on the type of security scanner, you can download: - -- A JSON artifact that contains the security scanner [report](../../../development/integrations/secure.md#report). -- A CSV file that contains URLs and endpoints scanned by the security scanner. - -To download a security scan output: - -1. On the top bar, select **Menu > Projects** and find your project. -1. On the left sidebar, select **CI/CD > Pipelines**. -1. Select the **Status** of a branch. -1. Select the **Security** tab. -1. In **Scan details**, select **Download results**: - - To download a JSON file, select the JSON artifact. - - To download a CSV file, select **Download scanned resources**. - ## View vulnerabilities over time for a project > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235558) in GitLab 13.6. diff --git a/doc/user/application_security/vulnerability_report/pipeline.md b/doc/user/application_security/vulnerability_report/pipeline.md new file mode 100644 index 00000000000..980bd99f8c8 --- /dev/null +++ b/doc/user/application_security/vulnerability_report/pipeline.md @@ -0,0 +1,57 @@ +--- +type: reference, howto +stage: Secure +group: Threat Insights +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +--- + +# View vulnerabilities in a pipeline + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13496) in GitLab 12.3. + +To view vulnerabilities in a pipeline: + +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **CI/CD > Pipelines**. +1. From the list, select the pipeline you want to check for vulnerabilities. +1. Select the **Security** tab. + +**Scan details** shows vulnerabilities introduced by the merge request, in addition to existing vulnerabilities +from the latest successful pipeline in your project's default branch. + +A pipeline consists of multiple jobs, such as SAST and DAST scans. If a job fails to finish, +the security dashboard doesn't show SAST scanner output. For example, if the SAST +job finishes but the DAST job fails, the security dashboard doesn't show SAST results. On failure, +the analyzer outputs an [exit code](../../../development/integrations/secure.md#exit-code). + +## View total number of vulnerabilities per scan + +To view the total number of vulnerabilities per scan: + +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **CI/CD > Pipelines**. +1. Select the **Status** of a branch. +1. Select the **Security** tab. + +**Scan details** shows vulnerabilities introduced by the merge request, in addition to existing vulnerabilities +from the latest successful pipeline in your project's default branch. + +## Download security scan outputs + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3728) in GitLab 13.10. +> - [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/333660) in GitLab 14.2. + +Depending on the type of security scanner, you can download: + +- A JSON artifact that contains the security scanner [report](../../../development/integrations/secure.md#report). +- A CSV file that contains URLs and endpoints scanned by the security scanner. + +To download a security scan output: + +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **CI/CD > Pipelines**. +1. Select the **Status** of a branch. +1. Select the **Security** tab. +1. In **Scan details**, select **Download results**: + - To download a JSON file, select the JSON artifact. + - To download a CSV file, select **Download scanned resources**. diff --git a/doc/user/clusters/agent/install/index.md b/doc/user/clusters/agent/install/index.md index 4130b2f6221..9282ac7fb40 100644 --- a/doc/user/clusters/agent/install/index.md +++ b/doc/user/clusters/agent/install/index.md @@ -89,8 +89,12 @@ You must register an agent before you can install the agent in your cluster. To - If you want to create a configuration with CI/CD defaults, type a name. - If you already have an [agent configuration file](#create-an-agent-configuration-file), select it from the list. 1. Select **Register an agent**. -1. GitLab generates an access token for the agent. Securely store this token. You need it to install the agent +1. GitLab generates an access token for the agent. You need this token to install the agent in your cluster and to [update the agent](#update-the-agent-version) to another version. + + WARNING: + Securely store the agent access token. A bad actor can use this token to access source code in the agent's configuration project, access source code in any public project on the GitLab instance, or even, under very specific conditions, obtain a Kubernetes manifest. + 1. Copy the command under **Recommended installation method**. You need it when you use the one-liner installation method to install the agent in your cluster. diff --git a/doc/user/permissions.md b/doc/user/permissions.md index 91df2a03863..b01bfbef3aa 100644 --- a/doc/user/permissions.md +++ b/doc/user/permissions.md @@ -264,7 +264,7 @@ More details about the permissions for some project-level features follow. | View pipeline details page | ✓ (*1*) | ✓ (*2*) | ✓ | ✓ | ✓ | ✓ | | View pipelines page | ✓ (*1*) | ✓ (*2*) | ✓ | ✓ | ✓ | ✓ | | View pipelines tab in MR | ✓ (*3*) | ✓ (*3*) | ✓ | ✓ | ✓ | ✓ | -| [View vulnerabilities in a pipeline](application_security/security_dashboard/index.md#view-vulnerabilities-in-a-pipeline) | | ✓ (*2*) | ✓ | ✓ | ✓ | ✓ | +| [View vulnerabilities in a pipeline](application_security/vulnerability_report/pipeline.md#view-vulnerabilities-in-a-pipeline) | | ✓ (*2*) | ✓ | ✓ | ✓ | ✓ | | View and download project-level [Secure Files](../api/secure_files.md) | | | | ✓ | ✓ | ✓ | | Cancel and retry jobs | | | | ✓ | ✓ | ✓ | | Create new [environments](../ci/environments/index.md) | | | | ✓ | ✓ | ✓ | diff --git a/doc/user/project/milestones/burndown_and_burnup_charts.md b/doc/user/project/milestones/burndown_and_burnup_charts.md index d6fcd9fbb16..298eea8639c 100644 --- a/doc/user/project/milestones/burndown_and_burnup_charts.md +++ b/doc/user/project/milestones/burndown_and_burnup_charts.md @@ -66,7 +66,7 @@ A burndown chart is available for every project or group milestone that has been date** and a **due date**. NOTE: -You're able to [promote project](index.md#promoting-project-milestones-to-group-milestones) to group milestones and still see the **burndown chart** for them, respecting license limitations. +You're able to [promote project](index.md#promote-a-project-milestone-to-a-group-milestone) to group milestones and still see the **burndown chart** for them, respecting license limitations. The chart indicates the project's progress throughout that milestone (for issues assigned to it). diff --git a/doc/user/project/milestones/img/milestones_promote_milestone.png b/doc/user/project/milestones/img/milestones_promote_milestone.png Binary files differdeleted file mode 100644 index 2ef85c5951d..00000000000 --- a/doc/user/project/milestones/img/milestones_promote_milestone.png +++ /dev/null diff --git a/doc/user/project/milestones/index.md b/doc/user/project/milestones/index.md index b0f3179961d..3ecee86b978 100644 --- a/doc/user/project/milestones/index.md +++ b/doc/user/project/milestones/index.md @@ -23,87 +23,127 @@ Additionally, you can integrate milestones with the [Releases feature](../releas ## Project milestones and group milestones -You can assign **project milestones** to issues or merge requests in that project only. -To view the project milestone list, in a project, go to **{issues}** **Issues > Milestones**. +A milestone can belong to [project](../index.md) or [group](../../group/index.md). +You can assign **project milestones** to issues or merge requests in that project only. You can assign **group milestones** to any issue or merge request of any project in that group. -To view the group milestone list, in a group, go to **{issues}** **Issues > Milestones**. - -You can also view all milestones you have access to in the dashboard milestones list. -To view both project milestones and group milestones you have access to, select **Menu > Milestones** -on the top bar. For information about project and group milestones API, see: - [Project Milestones API](../../../api/milestones.md) - [Group Milestones API](../../../api/group_milestones.md) -NOTE: -If you're in a group and select **Issues > Milestones**, GitLab displays group milestones -and the milestones of projects in this group. -If you're in a project and select **Issues > Milestones**, GitLab displays only this project's milestones. +### View project or group milestones + +To view the milestone list: + +1. On the top bar, select **Menu > Projects** and find your project or + **Menu > Groups** and find your group. +1. Select **Issues > Milestones**. + +In a project, GitLab displays milestones that belong to the project. +In a group, GitLab displays milestones that belong to the group and all projects in the group. + +### View all milestones -## Creating milestones +You can view all the milestones you have access to in the entire GitLab namespace. +You might not see some milestones because they're in projects or groups you're not a member of. + +To do so, on the top bar select **Menu > Milestones**. + +## Create a milestone > [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. -Milestones can be created either at project or group level. +You can create a milestone either in a project or a group. Prerequisites: -- You must have at least the Reporter role for a group. +- You must have at least the Reporter role for the project or group the milestone belongs to. To create a milestone: 1. On the top bar, select **Menu > Projects** and find your project or **Menu > Groups** and find your group. 1. On the left sidebar, select **Issues > Milestones**. 1. Select **New milestone**. -1. Enter the title, an optional description, an optional start date, and an optional due date. +1. Enter the title. +1. Optional. Enter description, start date, and due date. 1. Select **New milestone**.  -## Editing milestones +## Edit a milestone > [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. -Users with at least the Reporter role can edit milestones. - Prerequisites: -- You must have at least the Reporter role for a group. +- You must have at least the Reporter role for the project or group the milestone belongs to. To edit a milestone: -1. In a project or group, go to **{issues}** **Issues > Milestones**. +1. On the top bar, select **Menu > Projects** and find your project or **Menu > Groups** and find your group. 1. Select a milestone's title. 1. Select **Edit**. +1. Edit the title, start date, due date, or description. +1. Select **Save changes**. + +## Delete a milestone + +> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0. -You can delete a milestone by selecting the **Delete** button. +Prerequisites: + +- You must have at least the Reporter role for the project or group the milestone belongs to. + +To edit a milestone: + +1. On the top bar, select **Menu > Projects** and find your project or **Menu > Groups** and find your group. +1. Select a milestone's title. +1. Select **Delete**. +1. Select **Delete milestone**. -### Promoting project milestones to group milestones +## Promote a project milestone to a group milestone If you are expanding the number of projects in a group, you might want to share the same milestones -among this group's projects. You can also promote project milestones to group milestones in order to +among this group's projects. You can also promote project milestones to group milestones to make them available to other projects in the same group. -From the project milestone list page, you can promote a project milestone to a group milestone. -This merges all project milestones across all projects in this group with the same name into a single -group milestones. All issues and merge requests that were previously assigned to one of these project -milestones is assigned the new group milestones. This action cannot be reversed and the changes are -permanent. +Promoting a milestone merges all project milestones across all projects in this group with the same +name into a single group milestone. +All issues and merge requests that were previously assigned to one of these project +milestones become assigned to the new group milestone. WARNING: -From GitLab 12.4 and earlier, some information is lost when you promote a project milestone to a -group milestone. Not all features on the project milestone view are available on the group milestone -view. If you promote a project milestone to a group milestone, you lose these features. Visit -[Milestone view](#milestone-view) to learn which features are missing from the group milestone view. +This action cannot be reversed and the changes are permanent. + +Prerequisites: + +- You must have at least the Reporter role for the group. + +To promote a project milestone: + +1. On the top bar, select **Menu > Projects** and find your project. +1. Either: + - Select **Promote to Group Milestone** (**{level-up}**). + - Select the milestone title, and then select **Promote**. +1. Select **Promote Milestone**. + +## Assign a milestone to an issue or merge request + +Every issue and merge request can be assigned one milestone. +The milestones are visible on every issue and merge request page, on the right sidebar. +They are also visible in the issue board. - +To assign or unassign a milestone: -## Assigning milestones from the sidebar +1. View an issue or a merge request. +1. On the right sidebar, next to **Milestones**, select **Edit**. +1. In the **Assign milestone** list, search for a milestone by typing its name. + You can select from both project and group milestones. +1. Select the milestone you want to assign. -Every issue and merge request can be assigned a milestone. The milestones are visible on every issue and merge request page, in the sidebar. They are also visible in the issue board. From the sidebar, you can assign or unassign a milestones to the object. You can also perform this as a [quick action](../quick_actions.md) in a comment. [As mentioned](#project-milestones-and-group-milestones), for a given issue or merge request, both project milestones and group milestones can be selected and assigned to the object. +You can also use the `/assign` [quick action](../quick_actions.md) in a comment. ## Filtering issues and merge requests by milestone diff --git a/doc/user/tasks.md b/doc/user/tasks.md index 306afd85261..36236f2969e 100644 --- a/doc/user/tasks.md +++ b/doc/user/tasks.md @@ -49,4 +49,4 @@ To edit a task: To delete a task: 1. In the issue description, select the task. -1. From the options menu (**{ellipsis_v}**), select **Delete work item**. +1. From the options menu (**{ellipsis_v}**), select **Delete task**. |
