Commit 246852ee authored by Suzanne Selhorn's avatar Suzanne Selhorn

Merge branch 'rf-sast-template-ref-doc' into 'master'

Update SAST CI template refs to include Security

See merge request gitlab-org/gitlab!43011
parents 11cb76ff 48c4712c
...@@ -68,7 +68,7 @@ microservice_a: ...@@ -68,7 +68,7 @@ microservice_a:
trigger: trigger:
include: include:
- local: path/to/microservice_a.yml - local: path/to/microservice_a.yml
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
``` ```
NOTE: **Note:** NOTE: **Note:**
...@@ -82,7 +82,7 @@ microservice_a: ...@@ -82,7 +82,7 @@ microservice_a:
trigger: trigger:
include: include:
- local: path/to/microservice_a.yml - local: path/to/microservice_a.yml
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
strategy: depend strategy: depend
``` ```
......
...@@ -22,10 +22,10 @@ Testing (SAST), and Secret Detection by adding the following to your `.gitlab-ci ...@@ -22,10 +22,10 @@ Testing (SAST), and Secret Detection by adding the following to your `.gitlab-ci
```yaml ```yaml
include: include:
- template: Dependency-Scanning.gitlab-ci.yml - template: Security/Dependency-Scanning.gitlab-ci.yml
- template: License-Scanning.gitlab-ci.yml - template: Security/License-Scanning.gitlab-ci.yml
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
- template: Secret-Detection.gitlab-ci.yml - template: Security/Secret-Detection.gitlab-ci.yml
``` ```
To add Dynamic Application Security Testing (DAST) scanning, add the following to your To add Dynamic Application Security Testing (DAST) scanning, add the following to your
...@@ -33,7 +33,7 @@ To add Dynamic Application Security Testing (DAST) scanning, add the following t ...@@ -33,7 +33,7 @@ To add Dynamic Application Security Testing (DAST) scanning, add the following t
```yaml ```yaml
include: include:
- template: DAST.gitlab-ci.yml - template: Security/DAST.gitlab-ci.yml
variables: variables:
DAST_WEBSITE: https://staging.example.com DAST_WEBSITE: https://staging.example.com
...@@ -449,7 +449,7 @@ To fix this issue, you can either: ...@@ -449,7 +449,7 @@ To fix this issue, you can either:
```yaml ```yaml
include: include:
template: SAST.gitlab-ci.yml template: Security/SAST.gitlab-ci.yml
spotbugs-sast: spotbugs-sast:
stage: unit-tests stage: unit-tests
...@@ -490,7 +490,7 @@ would look similar to: ...@@ -490,7 +490,7 @@ would look similar to:
```yaml ```yaml
include: include:
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
# Ensure that the scanning is only executed on master or merge requests # Ensure that the scanning is only executed on master or merge requests
spotbugs-sast: spotbugs-sast:
...@@ -505,7 +505,7 @@ would be written as follows: ...@@ -505,7 +505,7 @@ would be written as follows:
```yaml ```yaml
include: include:
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
# Ensure that the scanning is only executed on master or merge requests # Ensure that the scanning is only executed on master or merge requests
spotbugs-sast: spotbugs-sast:
...@@ -519,7 +519,7 @@ it would look similar to: ...@@ -519,7 +519,7 @@ it would look similar to:
```yaml ```yaml
include: include:
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
# Ensure that the scanning is not executed on tags # Ensure that the scanning is not executed on tags
spotbugs-sast: spotbugs-sast:
...@@ -531,7 +531,7 @@ To transition to the new `rules` syntax, the override would be rewritten as: ...@@ -531,7 +531,7 @@ To transition to the new `rules` syntax, the override would be rewritten as:
```yaml ```yaml
include: include:
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
# Ensure that the scanning is not executed on tags # Ensure that the scanning is not executed on tags
spotbugs-sast: spotbugs-sast:
......
...@@ -53,7 +53,7 @@ In `.gitlab-ci.yml` define: ...@@ -53,7 +53,7 @@ In `.gitlab-ci.yml` define:
```yaml ```yaml
include: include:
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
variables: variables:
SECURE_ANALYZERS_PREFIX: my-docker-registry/gl-images SECURE_ANALYZERS_PREFIX: my-docker-registry/gl-images
...@@ -70,7 +70,7 @@ In `.gitlab-ci.yml` define: ...@@ -70,7 +70,7 @@ In `.gitlab-ci.yml` define:
```yaml ```yaml
include: include:
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
variables: variables:
SAST_DEFAULT_ANALYZERS: "bandit,flawfinder" SAST_DEFAULT_ANALYZERS: "bandit,flawfinder"
...@@ -86,7 +86,7 @@ default analyzers. In `.gitlab-ci.yml` define: ...@@ -86,7 +86,7 @@ default analyzers. In `.gitlab-ci.yml` define:
```yaml ```yaml
include: include:
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
variables: variables:
SAST_DEFAULT_ANALYZERS: "" SAST_DEFAULT_ANALYZERS: ""
......
...@@ -169,7 +169,7 @@ set the `SAST_GOSEC_LEVEL` variable to `2`: ...@@ -169,7 +169,7 @@ set the `SAST_GOSEC_LEVEL` variable to `2`:
```yaml ```yaml
include: include:
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
variables: variables:
SAST_GOSEC_LEVEL: 2 SAST_GOSEC_LEVEL: 2
...@@ -191,7 +191,7 @@ inclusion and specify any additional keys under it. For example, this enables `F ...@@ -191,7 +191,7 @@ inclusion and specify any additional keys under it. For example, this enables `F
```yaml ```yaml
include: include:
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
spotbugs-sast: spotbugs-sast:
variables: variables:
...@@ -222,7 +222,7 @@ Kubesec analyzer. In `.gitlab-ci.yml`, define: ...@@ -222,7 +222,7 @@ Kubesec analyzer. In `.gitlab-ci.yml`, define:
```yaml ```yaml
include: include:
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
variables: variables:
SCAN_KUBERNETES_MANIFESTS: "true" SCAN_KUBERNETES_MANIFESTS: "true"
...@@ -248,7 +248,7 @@ stages: ...@@ -248,7 +248,7 @@ stages:
- test - test
include: include:
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
build: build:
stage: build stage: build
...@@ -525,7 +525,7 @@ Add the following configuration to your `.gitlab-ci.yml` file. You must replace ...@@ -525,7 +525,7 @@ Add the following configuration to your `.gitlab-ci.yml` file. You must replace
```yaml ```yaml
include: include:
- template: SAST.gitlab-ci.yml - template: Security/SAST.gitlab-ci.yml
variables: variables:
SECURE_ANALYZERS_PREFIX: "localhost:5000/analyzers" SECURE_ANALYZERS_PREFIX: "localhost:5000/analyzers"
......
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