You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: integration/integrate-with-image-vulnerability-scanners.adoc
+4-8Lines changed: 4 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,8 +9,7 @@ toc::[]
9
9
[role="_abstract"]
10
10
{rh-rhacs-first} integrates with vulnerability scanners to enable you to import your container images and watch them for vulnerabilities.
11
11
12
-
[discrete]
13
-
== Supported container image registries
12
+
Supported container image registries::
14
13
15
14
Red{nbsp}Hat supports the following container image registries:
16
15
@@ -27,13 +26,11 @@ Red{nbsp}Hat supports the following container image registries:
27
26
28
27
This enhanced support gives you greater flexibility and choice in managing your container images in your preferred registry.
29
28
30
-
[discrete]
31
-
== Supported Scanners
29
+
Supported Scanners::
32
30
33
31
You can set up {product-title-short} to obtain image vulnerability data from the following commercial container image vulnerability scanners:
34
32
35
-
[discrete]
36
-
=== Scanners included in {product-title-short}
33
+
Scanners included in {product-title-short}::
37
34
38
35
* Scanner V4: Beginning with {product-title-short} version 4.4, a new scanner is introduced that is built on link:https://github.com/quay/claircore[ClairCore], which also powers the link:https://github.com/quay/clair[Clair] scanner. Scanner V4 supports scanning of language and OS-specific image components. You do not have to create an integration to use this scanner, but you must enable it during or after installation. For version 4.4, if you enable this scanner, you must also enable the StackRox Scanner. For more information about Scanner V4, including links to the installation documentation, see xref:../operating/examine-images-for-vulnerabilities.adoc#about-scanner-v4_examine-images-for-vulnerabilities[About {product-title-short} Scanner V4].
39
36
* StackRox Scanner: This scanner is the default scanner in {product-title-short}. It originates from a fork of the Clair v2 open source scanner.
@@ -43,8 +40,7 @@ You can set up {product-title-short} to obtain image vulnerability data from the
43
40
Even if you have Scanner V4 enabled, at this time, the StackRox Scanner must still be enabled to provide scanning of RHCOS nodes and platform vulnerabilities such as {osp}, Kubernetes, and Istio. Support for that functionality in Scanner V4 is planned for a future release. Do not disable the StackRox Scanner.
44
41
====
45
42
46
-
[discrete]
47
-
=== Alternative scanners
43
+
Alternative scanners::
48
44
49
45
* link:https://github.com/quay/clair[Clair]: As of version 4.4, you can enable Scanner V4 in {product-title-short} to provide functionality provided by ClairCore, which also powers the Clair V4 scanner. However, you can configure Clair V4 as the scanner by configuring an integration.
When you install {product-title-short} on {ocp} by using the Operator, {product-title-short} installs a lightweight version of Scanner on every secured cluster. The lightweight Scanner enables the scanning of images in the integrated OpenShift image registry. When you install {product-title-short} on {ocp} or Kubernetes by using the Helm install method with the _default_ values, the lightweight version of Scanner is not installed. To install the lightweight Scanner on the secured cluster by using Helm, you must set the `scanner.disable=false` parameter. You cannot install the lightweight Scanner by using the `roxctl` installation method.
26
+
When you install {product-title-short} on {ocp} by using the Operator, {product-title-short} installs a lightweight version of Scanner on every secured cluster. The lightweight Scanner enables the scanning of images in the integrated OpenShift image registry. When you install {product-title-short} on {ocp} or Kubernetes by using the Helm install method with the _default_ values, the lightweight version of Scanner is not installed. To install the lightweight Scanner on the secured cluster by using Helm, you must set the `scanner.disable=false` parameter. You cannot install the lightweight Scanner by using the `roxctl` installation method.
Copy file name to clipboardExpand all lines: modules/common-search-queries.adoc
+11-22Lines changed: 11 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,7 @@
7
7
8
8
Here are some common search queries you can run with {product-title}.
9
9
10
-
[discrete]
11
-
== Finding deployments that are affected by a specific CVE
10
+
Finding deployments that are affected by a specific CVE::
12
11
13
12
|===
14
13
| Query | Example
@@ -17,8 +16,7 @@ Here are some common search queries you can run with {product-title}.
17
16
| `CVE:CVE-2018-11776`
18
17
|===
19
18
20
-
[discrete]
21
-
== Finding privileged running deployments
19
+
Finding privileged running deployments::
22
20
23
21
|===
24
22
| Query | Example
@@ -27,8 +25,7 @@ Here are some common search queries you can run with {product-title}.
27
25
| `Privileged:true`
28
26
|===
29
27
30
-
[discrete]
31
-
== Finding deployments that have external network exposure
28
+
Finding deployments that have external network exposure::
32
29
33
30
|===
34
31
| Query | Example
@@ -37,8 +34,7 @@ Here are some common search queries you can run with {product-title}.
37
34
| `Exposure Level:External`
38
35
|===
39
36
40
-
[discrete]
41
-
== Finding deployments that are running specific processes
37
+
Finding deployments that are running specific processes::
42
38
43
39
|===
44
40
| Query | Example
@@ -47,8 +43,7 @@ Here are some common search queries you can run with {product-title}.
47
43
| `Process Name:bash`
48
44
|===
49
45
50
-
[discrete]
51
-
== Finding deployments that have serious but fixable vulnerabilities
46
+
Finding deployments that have serious but fixable vulnerabilities::
52
47
53
48
|===
54
49
| Query | Example
@@ -57,8 +52,7 @@ Here are some common search queries you can run with {product-title}.
57
52
| `CVSS:>=6``Fixable:.*`
58
53
|===
59
54
60
-
[discrete]
61
-
== Finding deployments that use passwords exposed through environment variables
55
+
Finding deployments that use passwords exposed through environment variables::
62
56
63
57
|===
64
58
| Query | Example
@@ -67,8 +61,7 @@ Here are some common search queries you can run with {product-title}.
67
61
| `Environment Key:r/.\*pass.*`
68
62
|===
69
63
70
-
[discrete]
71
-
== Finding running deployments that have particular software components in them
64
+
Finding running deployments that have particular software components in them::
72
65
73
66
|===
74
67
| Query | Example
@@ -77,14 +70,12 @@ Here are some common search queries you can run with {product-title}.
77
70
| `Component:libgpg-error` or `Component:sudo`
78
71
|===
79
72
80
-
[discrete]
81
-
== Finding users or groups
73
+
Finding users or groups::
82
74
83
75
Use Kubernetes link:https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/[Labels and Selectors], and link:https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/[Annotations] to attach metadata to your deployments.
84
76
You can then query based on the applied annotations and labels to identify individuals or groups.
85
77
86
-
[discrete]
87
-
=== Finding who owns a particular deployment
78
+
Finding who owns a particular deployment::
88
79
89
80
|===
90
81
| Query | Example
@@ -93,8 +84,7 @@ You can then query based on the applied annotations and labels to identify indiv
93
84
| `Deployment:app-server``Label:team=backend`
94
85
|===
95
86
96
-
[discrete]
97
-
=== Finding who is deploying images from public registries
87
+
Finding who is deploying images from public registries::
98
88
99
89
|===
100
90
| Query | Example
@@ -103,8 +93,7 @@ You can then query based on the applied annotations and labels to identify indiv
103
93
| `Image Registry:docker.io``Label:team=backend`
104
94
|===
105
95
106
-
[discrete]
107
-
=== Finding who is deploying into the default namespace
96
+
Finding who is deploying into the default namespace::
Copy file name to clipboardExpand all lines: modules/configuration-details-tab.adoc
+5-9Lines changed: 5 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,7 @@
8
8
9
9
The *Configuration details* tab displays information about the scan schedule information such as the essential parameters, cluster status, associated profiles, and email delivery destinations.
10
10
11
-
[discrete]
12
-
== Parameters section
11
+
Parameters section::
13
12
14
13
The *Parameters* section organizes information into the following groups:
15
14
@@ -19,24 +18,21 @@ The *Parameters* section organizes information into the following groups:
19
18
* *Last scanned*: The timestamp of the last compliance scan performed.
20
19
* *Last updated*: The last date and time that the compliance scan data was modified.
21
20
22
-
[discrete]
23
-
== Clusters section
21
+
Clusters section::
24
22
25
23
The *Clusters* section organizes information into the following groups:
26
24
27
25
* *Cluster*: Lists the one or more clusters associated with a compliance scan.
28
26
* *Operator status*: Indicates the current health or operational status of the Operator.
29
27
30
-
[discrete]
31
-
== Profiles section
28
+
Profiles section::
32
29
33
30
The *Profiles* section lists the one or more profiles associated with a compliance scan.
34
31
35
-
[discrete]
36
-
== Delivery destinations section
32
+
Delivery destinations section::
37
33
38
34
The *Delivery destinations* section organizes information into the following groups:
39
35
40
36
* *Email notifier*: Specifies the email notification system or tool set up to distribute reports or alerts.
41
37
* *Distribution list*: Lists the recipients who should receive the notifications or reports.
42
-
* *Email template*: Specifies the email format used for the notifications. You can use the default or customize the email subject and body as needed.
38
+
* *Email template*: Specifies the email format used for the notifications. You can use the default or customize the email subject and body as needed.
Copy file name to clipboardExpand all lines: modules/default-requirements-central-services.adoc
+6-12Lines changed: 6 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,8 +43,7 @@ However, you can use another storage type if you do not have SSDs available.
43
43
For security reasons, you should deploy Central in a cluster with limited administrative access.
44
44
====
45
45
46
-
[discrete]
47
-
== CPU, memory, and storage requirements
46
+
CPU, memory, and storage requirements::
48
47
49
48
The following table lists the minimum CPU and memory values required to install and run Central.
50
49
@@ -84,8 +83,7 @@ Scanner is responsible for scanning images, nodes, and the platform for vulnerab
84
83
85
84
Beginning with version 4.4, {product-title-short} includes two image vulnerability scanners: StackRox Scanner and Scanner V4. StackRox Scanner is planned to be removed in a future release, but is still required at this time to perform node and platform scanning. Scanner V4 is the preferred image scanner because it provides additional features over the StackRox Scanner, such as expanded language and operating system support and data from additional vulnerability sources.
86
85
87
-
[discrete]
88
-
== CPU, memory, and storage requirements
86
+
CPU, memory, and storage requirements::
89
87
90
88
The following table lists the minimum CPU and memory values required to install and run Scanner. The requirements in this table are based on the default of 3 replicas.
91
89
@@ -121,11 +119,9 @@ The StackRox Scanner requires Scanner DB (PostgreSQL 15) to store data. This dat
121
119
122
120
Scanner V4 is the preferred image scanner because it provides additional features over the StackRox Scanner, such as expanded language and operating system support and data from additional vulnerability sources.
123
121
124
-
[discrete]
125
-
== CPU, memory, and storage requirements
122
+
CPU, memory, and storage requirements::
126
123
127
-
[discrete]
128
-
=== Scanner V4 Indexer
124
+
Scanner V4 Indexer::
129
125
130
126
The requirements in this table are based on the default of 3 replicas.
131
127
@@ -141,8 +137,7 @@ The requirements in this table are based on the default of 3 replicas.
141
137
| 9 GiB
142
138
|===
143
139
144
-
[discrete]
145
-
=== Scanner V4 Matcher
140
+
Scanner V4 Matcher::
146
141
147
142
The requirements in this table are based on the default of 2 replicas.
148
143
@@ -158,8 +153,7 @@ The requirements in this table are based on the default of 2 replicas.
158
153
| 4 GiB
159
154
|===
160
155
161
-
[discrete]
162
-
=== Scanner V4 DB
156
+
Scanner V4 DB::
163
157
164
158
Scanner V4 requires Scanner V4 DB (PostgreSQL 15) to store data. For Scanner V4 DB, a PVC is required to ensure optimal performance. The following table lists the minimum CPU, memory, and storage values required to install and run Scanner V4 DB.
Copy file name to clipboardExpand all lines: modules/default-requirements-external-db.adoc
+4-8Lines changed: 4 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,28 +18,24 @@ When you use an external database, note the following guidance:
18
18
19
19
If you select an external database, your database instance and the user connecting to it must meet the requirements listed in the following sections.
20
20
21
-
[discrete]
22
-
== Database type and version
21
+
Database type and version::
23
22
The database must be a PostgreSQL-compatible database that supports PostgreSQL 13 or later.
24
23
25
-
[discrete]
26
-
== User permissions
24
+
User permissions::
27
25
The user account that Central uses to connect to the database must be a `superuser` account with connection rights to the database and the following permissions:
28
26
29
27
* `Usage` and `Create` permissions on the schema.
30
28
* `Select`, `Insert`, `Update`, and `Delete` permissions on all tables in the schema.
31
29
* `Usage` permissions on all sequences in the schema.
32
30
* The ability to create and delete databases as a `superuser`.
33
31
34
-
[discrete]
35
-
== Connection string
32
+
Connection string::
36
33
Central connects to the external database by using a connection string, which must be in `keyword=value` format. The connection string should specify details such as the host, port, database name, user, and SSL/TLS mode. For example, `host=<host> port=5432 database=stackrox user=stackrox sslmode=verify-ca`.
37
34
38
35
[NOTE]
39
36
====
40
37
Connections through *PgBouncer* are not supported.
41
38
====
42
39
43
-
[discrete]
44
-
== CA certificates
40
+
CA certificates::
45
41
If your external database uses a certificate issued by a private or untrusted Certificate Authority (CA), you might need to specify the CA certificate so that Central trusts the database certificate. You can add this by using a TLS block in the Central custom resource configuration.
0 commit comments