Skip to content
Snippets Groups Projects
Verified Commit 4f3f1dbd authored by Russell Dickenson's avatar Russell Dickenson Committed by GitLab
Browse files

Merge branch 'sk/fix-policy-scope-docs' into 'master'

Fix policy_scope schema in security policies docs

See merge request !147434



Merged-by: default avatarRussell Dickenson <rdickenson@gitlab.com>
Approved-by: default avatarRussell Dickenson <rdickenson@gitlab.com>
Co-authored-by: Sashi Kumar Kumaresan's avatarSashi Kumar <skumar@gitlab.com>
parents 2835b71e cc26c977
No related branches found
No related tags found
1 merge request!147434Fix policy_scope schema in security policies docs
Pipeline #1221484478 passed
......@@ -475,8 +475,8 @@ You can refine a security policy's scope to:
| Field | Type | Possible values | Description |
|-------|------|-----------------|-------------|
| `compliance_frameworks` | `object` | `ids` | List of IDs of the compliance frameworks in scope of enforcement, in an `ids` array. |
| `projects` | `object` | `including`, `excluding` | Use `excluding:` or `including:` then list the IDs of the projects you wish to include or exclude, in an `ids` array. |
| `compliance_frameworks` | `array` | | List of IDs of the compliance frameworks in scope of enforcement, in an array of objects with key `id`. |
| `projects` | `object` | `including`, `excluding` | Use `excluding:` or `including:` then list the IDs of the projects you wish to include or exclude, in an array of objects with key `id`. |
#### Example `policy.yml` with security policy scopes
......@@ -496,9 +496,8 @@ scan_execution_policy:
site_profile: Site Profile B
policy_scope:
compliance_frameworks:
ids:
- 2
- 11
- id: 2
- id: 11
- name: Enforce Secret Detection and Container Scanning in every default branch pipeline
description: This policy enforces pipeline configuration to have a job with Secret Detection and Container Scanning scans for the default branch
enabled: true
......@@ -514,7 +513,6 @@ scan_execution_policy:
policy_scope:
projects:
excluding:
ids:
- 24
- 27
- id: 24
- id: 27
```
......@@ -409,8 +409,8 @@ You can refine a security policy's scope to:
| Field | Type | Possible values | Description |
|-------|------|-----------------|-------------|
| `compliance_frameworks` | `object` | `ids` | List of IDs of the compliance frameworks in scope of enforcement, in an `ids` array. |
| `projects` | `object` | `including`, `excluding` | Use `excluding:` or `including:` then list the IDs of the projects you wish to include or exclude, in an `ids` array. |
| `compliance_frameworks` | `array` | | List of IDs of the compliance frameworks in scope of enforcement, in an array of objects with key `id`. |
| `projects` | `object` | `including`, `excluding` | Use `excluding:` or `including:` then list the IDs of the projects you wish to include or exclude, in an array of objects with key `id`. |
#### Example `policy.yml` with security policy scopes
......@@ -438,14 +438,12 @@ approval_policy:
- adalberto.dare
policy_scope:
compliance_frameworks:
ids:
- 2
- 11
- id: 2
- id: 11
projects:
including:
ids:
- 24
- 27
- id: 24
- id: 27
```
## Troubleshooting
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment