Skip to content

Commit 9ae8ec5

Browse files
authored
docs: improve include filter description (#2263)
1 parent f21f743 commit 9ae8ec5

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

charts/registry-scanner/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Sysdig Registry Scanner
44
type: application
55
home: https://www.sysdig.com/
66
icon: https://avatars.githubusercontent.com/u/5068817?s=200&v=4
7-
version: 1.7.2
7+
version: 1.7.3
88
appVersion: 0.8.1
99
maintainers:
1010
- name: sysdiglabs

charts/registry-scanner/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ The following table lists the configurable parameters of the Sysdig Registry Sca
8484
| config.secureOnPrem | Specify that Sysdig Secure installation is on-prem. | <code>false</code> |
8585
| config.secureSkipTLS | Ignore Sysdig Secure TLS certificate errors. | <code>false</code> |
8686
| config.maxWorkers | The maximum number of parallel job scan workers to spawn. | <code>5</code> |
87-
| config.filter.include | The list of regular expressions.<br/>Images matching any of these expressions are *always* included when scanning. | <code>[]</code> |
87+
| config.filter.include | The list of regular expressions.<br/>Images matching any of these expressions are *always* included when scanning. To ensure that only included images are scanned and all others are explicitly excluded, set `exclude` to [".*"]. | <code>[]</code> |
8888
| config.filter.exclude | The list of regular expressions.<br/>Images matching any of these expressions are excluded when scanning. | <code>[]</code> |
8989
| config.filter.maxAgeDays | Based on its creation date, excludes images older than the specified number of days.<br/>The maximum is 365 days. | <code>90</code> |
9090
| config.filter.maxTagsPerRepository | Based on its creation date, newer ones take precedence, the maximum number of tags to scan per repository.<br/>The maximum is 50. | <code>5</code> |
@@ -137,7 +137,7 @@ Use the following command to deploy:
137137
helm upgrade --install registry-scanner \
138138
--namespace sysdig-agent \
139139
--create-namespace \
140-
--version=1.7.2 \
140+
--version=1.7.3 \
141141
--set config.secureBaseURL=<SYSDIG_SECURE_URL> \
142142
--set config.secureAPIToken=<SYSDIG_SECURE_API_TOKEN> \
143143
--set config.secureSkipTLS=true \

charts/registry-scanner/values.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ config:
7373
maxWorkers: 5
7474
filter:
7575
# The list of regular expressions.<br/>Images matching any of these expressions are *always* included when scanning.
76+
# To ensure that only included images are scanned and all others are explicitly excluded, set `exclude` to [".*"].
7677
include: []
7778
# The list of regular expressions.<br/>Images matching any of these expressions are excluded when scanning.
7879
exclude: []

0 commit comments

Comments
 (0)