diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-09-15 00:09:47 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-09-15 00:09:47 +0000 |
commit | 09bd62c59d070ab2bbcb4079a44dcb78c76666b5 (patch) | |
tree | 6ae40e0c522f977d6f3abb97cba997ec87d7cdb4 /doc | |
parent | 9689350c651e2428924ea1096905278536f1dc7a (diff) | |
download | gitlab-ce-09bd62c59d070ab2bbcb4079a44dcb78c76666b5.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/user/analytics/merge_request_analytics.md | 4 | ||||
-rw-r--r-- | doc/user/application_security/dast/index.md | 100 | ||||
-rw-r--r-- | doc/user/project/clusters/add_remove_clusters.md | 14 |
3 files changed, 96 insertions, 22 deletions
diff --git a/doc/user/analytics/merge_request_analytics.md b/doc/user/analytics/merge_request_analytics.md index 40210cc8200..2c2199240a8 100644 --- a/doc/user/analytics/merge_request_analytics.md +++ b/doc/user/analytics/merge_request_analytics.md @@ -15,7 +15,7 @@ Merge Request Analytics helps you understand the efficiency of your code review Merge Request Analytics displays information that will help you evaluate the efficiency and productivity of your merge request process. -The Throughput chart shows the number of completed merge requests, by month. Merge request throughput is +The Throughput chart shows the number of merge requests merged, by month. Merge request throughput is a common measure of productivity in software engineering. Although imperfect, the average throughput can be a meaningful benchmark of your team's overall productivity. @@ -40,7 +40,7 @@ The following visualizations and data are available, representing all merge requ ### Throughput chart -The throughput chart shows the number of completed merge requests per month. +The throughput chart shows the number of merge requests merged per month. ![Throughput chart](img/mr_throughput_chart_v13_3.png "Merge Request Analytics - Throughput chart showing merge requests merged in the past 12 months") diff --git a/doc/user/application_security/dast/index.md b/doc/user/application_security/dast/index.md index 94952d7df9f..13dc001220c 100644 --- a/doc/user/application_security/dast/index.md +++ b/doc/user/application_security/dast/index.md @@ -643,7 +643,72 @@ To delete an existing site profile: 1. Click **Manage** in the **DAST Profiles** row. 1. Click **{remove}** in the row of the profile to delete. -## On-Demand Scans +## Scanner profile + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/222767) in GitLab 13.4. +> - [Deployed behind a feature flag](../../feature_flags.md), enabled by default. +> - Enabled on GitLab.com. +> - Can be enabled or disabled per-project. +> - Recommended for production use. +> - For GitLab self-managed instances, GitLab administrators can [disable this feature](#enable-or-disable-dast-scanner-profiles). + +A scanner profile defines the scanner settings used to run an on-demand scan: + +- **Profile name:** A name you give the scanner profile. For example, "Spider_15". +- **Spider timeout:** The maximum number of minutes allowed for the spider to traverse the site. +- **Target timeout:** The maximum number of seconds DAST waits for the site to be available before + starting the scan. + +### Create a scanner profile + +To create a scanner profile: + +1. From your project's home page, go to **Security & Compliance > Configuration**. +1. Click **Manage** in the **DAST Profiles** row. +1. Click **New Profile > Scanner Profile**. +1. Enter a unique **Profile name**, the desired **Spider timeout**, and the **Target timeout**. +1. Click **Save profile**. + +### Edit a scanner profile + +To edit a scanner profile: + +1. From your project's home page, go to **Security & Compliance > Configuration**. +1. Click **Manage** in the **DAST Profiles** row. +1. Click **Edit** in the scanner profile's row. + +### Delete a scanner profile + +To delete a scanner profile: + +1. From your project's home page, go to **Security & Compliance > Configuration**. +1. Click **Manage** in the **DAST Profiles** row. +1. Click **{remove}** in the scanner profile's row. + +### Enable or disable DAST scanner profiles + +The scanner profile feature is ready for production use. It's deployed behind a feature flag that +is **enabled by default**. [GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md) can opt to disable it. + +To disable it: + +```ruby +# Instance-wide +Feature.disable(:security_on_demand_scans_scanner_profiles) +# or by project +Feature.disable(:security_on_demand_scans_scanner_profiles, Project.find(<project id>)) +``` + +To enable it: + +```ruby +# Instance-wide +Feature.enable(:security_on_demand_scans_scanner_profiles) +# or by project +Feature.enable(:security_on_demand_scans_scanner_profiles, Project.find(<project ID>)) +``` + +## On-demand scans > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218465) in GitLab 13.2. > - [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/218465) in GitLab 13.3. @@ -652,37 +717,46 @@ To delete an existing site profile: > - It's able to be enabled or disabled per-project. > - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-on-demand-scans). -You can run a passive DAST scan against a target website, outside the DevOps life cycle. These scans -are always associated with the default branch of your project and the results are available in the -project's dashboard. An on-demand DAST scan has a fixed timeout of 60 seconds. +An on-demand DAST scan runs outside the DevOps life cycle. Changes in your repository don't trigger +the scan. You must start it manually. + +An on-demand DAST scan: -### Run an on-demand scan +- Uses settings in the site profile and scanner profile you select when you run the scan, + instead of those in the `.gitlab-ci.yml` file. +- Is associated with your project's default branch. + +### Run an on-demand DAST scan NOTE: **Note:** You must have permission to run an on-demand DAST scan against a protected branch. The default branch is automatically protected. For more details, see [Pipeline security on protected branches](../../../ci/pipelines/index.md#pipeline-security-on-protected-branches). -To run an on-demand scan, you need a site profile for the target URL. +To run an on-demand DAST scan, you need: + +- A [scanner profile](#create-a-scanner-profile). +- A [site profile](#create-a-site-profile). 1. From your project's home page, go to **Security & Compliance > On-demand Scans** in the left sidebar. 1. Click **Create new DAST scan**. -1. Select a site profile from the profiles dropdown. +1. In **Scanner settings**, select a scanner profile from the dropdown. +1. In **Site profiles**, select a site profile from the dropdown. 1. Click **Run scan**. -The on-demand scan runs and the project's dashboard shows the results. +The on-demand DAST scan runs and the project's dashboard shows the results. ### Enable or disable On-demand Scans -On-demand Scans is enabled by default. You can disable On-demand Scans +The On-demand DAST Scans feature is enabled by default. You can disable on-demand scans instance-wide, or disable it for specific projects if you prefer. -Use of On-demand Scans requires the `security_on_demand_scans_feature_flag` -feature flag enabled. +To run on-demand DAST scans, an administrator must enable the +`security_on_demand_scans_feature_flag` feature flag. [GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md) can disable or enable the feature flags. -To disable On-demand Scans: +To disable On-demand DAST Scans: ```ruby # Instance-wide @@ -691,7 +765,7 @@ Feature.disable(:security_on_demand_scans_feature_flag) Feature.disable(:security_on_demand_scans_feature_flag, Project.find(<project id>)) ``` -To enable On-demand Scans: +To enable On-demand DAST Scans: ```ruby # Instance-wide diff --git a/doc/user/project/clusters/add_remove_clusters.md b/doc/user/project/clusters/add_remove_clusters.md index 9c6af728857..18d9fa67ee1 100644 --- a/doc/user/project/clusters/add_remove_clusters.md +++ b/doc/user/project/clusters/add_remove_clusters.md @@ -206,7 +206,7 @@ To add a Kubernetes cluster to your project, group, or instance: apiVersion: v1 kind: ServiceAccount metadata: - name: gitlab-admin + name: gitlab namespace: kube-system --- apiVersion: rbac.authorization.k8s.io/v1beta1 @@ -219,7 +219,7 @@ To add a Kubernetes cluster to your project, group, or instance: name: cluster-admin subjects: - kind: ServiceAccount - name: gitlab-admin + name: gitlab namespace: kube-system ``` @@ -245,23 +245,23 @@ To add a Kubernetes cluster to your project, group, or instance: Output: ```shell - serviceaccount "gitlab-admin" created + serviceaccount "gitlab" created clusterrolebinding "gitlab-admin" created ``` - 1. Retrieve the token for the `gitlab-admin` service account: + 1. Retrieve the token for the `gitlab` service account: ```shell - kubectl -n kube-system describe secret $(kubectl -n kube-system get secret | grep gitlab-admin | awk '{print $1}') + kubectl -n kube-system describe secret $(kubectl -n kube-system get secret | grep gitlab | awk '{print $1}') ``` Copy the `<authentication_token>` value from the output: ```yaml - Name: gitlab-admin-token-b5zv4 + Name: gitlab-token-b5zv4 Namespace: kube-system Labels: <none> - Annotations: kubernetes.io/service-account.name=gitlab-admin + Annotations: kubernetes.io/service-account.name=gitlab kubernetes.io/service-account.uid=bcfe66ac-39be-11e8-97e8-026dce96b6e8 Type: kubernetes.io/service-account-token |