Skip to content

Commit 001040c

Browse files
committed
Update docs for Scanner V4 installed by default
1 parent 0bd6e9d commit 001040c

File tree

36 files changed

+112
-151
lines changed

36 files changed

+112
-151
lines changed

cloud_service/upgrading-cloud/upgrade-cloudsvc-roxctl.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,5 @@ include::modules/rhcos-enable-node-scan.adoc[leveloffset=+1]
5757
.Additional resources
5858
* xref:../../operating/manage-vulnerabilities/scan-rhcos-node-host.adoc#scan-rhcos-node-host[Scanning {op-system} node hosts]
5959

60+
* xref:../../operating/examine-images-for-vulnerabilities.adoc#enabling_scanner_v4_examine-images-for-vulnerabilities[Enabling Scanner V4]
61+

integration/integrate-with-image-vulnerability-scanners.adoc

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,30 +35,27 @@ You can set up {product-title-short} to obtain image vulnerability data from the
3535
[discrete]
3636
=== Scanners included in {product-title-short}
3737

38-
* 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-
* StackRox Scanner: This scanner is the default scanner in {product-title-short}. It originates from a fork of the Clair v2 open source scanner.
40-
+
41-
[IMPORTANT]
42-
====
43-
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-
====
38+
* 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. Scanner V4 is enabled by default during installation beginning in release 4.8. 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+
* StackRox Scanner: This scanner was the default scanner in {product-title-short} before being replaced by Scanner V4. It originates from a fork of the Clair v2 open source scanner.
40+
//Do we need to tell users to disable the StackRox scanner or should they keep it enabled for the time being until it is removed?
4541

4642
[discrete]
4743
=== Alternative scanners
4844

49-
* 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.
45+
* link:https://github.com/quay/clair[Clair]: Scanner V4 in {product-title-short} provides functionality provided by ClairCore, which also powers the Clair V4 scanner. You can configure Clair V4 instead as the scanner by configuring an integration. However, for full functionality, use the included default scanner in {product-title-short}, which is Scanner V4.
5046
* link:https://cloud.google.com/container-registry/docs/container-analysis[Google Container Analysis]
5147
* link:https://quay.io[Red{nbsp}Hat Quay]
5248

5349
[IMPORTANT]
5450
====
55-
The StackRox Scanner, in conjunction with Scanner V4 (optional), is the preferred image vulnerability scanner to use with {product-title-short}.
56-
For more information about scanning container images with the StackRox Scanner and Scanner V4, see xref:../operating/examine-images-for-vulnerabilities.adoc#scanning-images_examine-images-for-vulnerabilities[Scanning images].
51+
Scanner V4 is the preferred image vulnerability scanner to use with {product-title-short}.
5752
====
53+
//removed link in above paragraph because it repeated the link that is in "Scanners included in RHACS"
5854

5955
If you use one of these alternative scanners in your DevOps workflow, you can use the {product-title-short} portal to configure an integration with your vulnerability scanner. After the integration, the {product-title-short} portal shows the image vulnerabilities and you can triage them easily.
6056

61-
If multiple scanners are configured, {product-title-short} tries to use the non-StackRox/{product-title-short} and Clair scanners. If those scanners fail, {product-title-short} tries to use a configured Clair scanner. If that fails, {product-title-short} tries to use Scanner V4, if configured. If Scanner V4 is not configured, {product-title-short} tries to use the StackRox Scanner.
57+
If multiple scanners are configured, {product-title-short} tries to use the non-StackRox/{product-title-short} and Clair scanners. If those scanners fail, {product-title-short} tries to use a configured Clair scanner. If that fails, {product-title-short} tries to use Scanner V4. If Scanner V4 is not enabled, {product-title-short} tries to use the StackRox Scanner.
58+
//any changes needed here?
6259

6360
include::modules/integrate-with-clair.adoc[leveloffset=+1]
6461

modules/acs-architecture-overview.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@
99

1010
.{product-title-short} architecture
1111

12-
The following graphic shows the architecture with the StackRox Scanner and Scanner V4 components. Installation of Scanner V4 is optional, but provides additional benefits.
12+
The following graphic shows the product architecture, including the scanner components.
1313

1414
image::acs-architecture-scannerv4.png[{product-title} architecture for Kubernetes]
1515

16+
//Needs changes:
17+
// Change lines around Scanner V4 parts from dotted to solid in Cluster 1
18+
// ^^^ Cluster N
19+
1620
You install {product-title-short} as a set of containers in your {ocp} or Kubernetes cluster. {product-title-short} includes the following services:
1721

1822
* Central services you install on one cluster
1923
* Secured cluster services you install on each cluster you want to secure by {product-title-short}
2024
2125
In addition to these primary services, {product-title-short} also interacts with other external components to enhance your clusters' security.
2226

23-
[discrete]
24-
[id="installation-differences-architecture_{context}"]
25-
== Installation differences
26-
27-
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.
27+
When you install {product-title-short} on {ocp} by using the Operator, or on {ocp} or Kubernetes by using Helm with the `secured-cluster-services` Helm chart, {product-title-short} installs Scanner V4 components on every secured cluster. This enables the scanning of images in the integrated OpenShift image registry or in registries known to the secured cluster on non-OCP systems.

modules/acs-central-services-overview.adoc

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,4 @@
99
You install Central services on a single cluster.
1010
These services include the following components:
1111

12-
* *Central*: Central is the {product-title-short} application management interface and services.
13-
It handles API interactions and user interface ({product-title-short} Portal) access.
14-
You can use the same Central instance to secure multiple {ocp} or Kubernetes clusters.
15-
* *Central DB*: Central DB is the database for {product-title-short} and handles all data persistence. It is currently based on PostgreSQL 15.
16-
* *Scanner V4*: Beginning with version 4.4, {product-title-short} contains the Scanner V4 vulnerability scanner for scanning container images. Scanner V4 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. For version 4.4, you must use this scanner in conjunction with the StackRox Scanner to provide node and platform scanning capabilities until Scanner V4 support those capabilities. Scanner V4 contains the Indexer, Matcher, and DB components.
17-
** *Scanner V4 Indexer*: The Scanner V4 Indexer performs image indexing, previously known as image analysis. Given an image and registry credentials, the Indexer pulls the image from the registry. It finds the base operating system, if it exists, and looks for packages. It stores and outputs an index report, which contains the findings for the given image.
18-
** *Scanner V4 Matcher*: The Scanner V4 Matcher performs vulnerability matching. If the Central services Scanner V4 Indexer indexed the image, then the Matcher fetches the index report from the Indexer and matches the report with the vulnerabilities stored in the Scanner V4 database. If a Secured Cluster services Scanner V4 Indexer performed the indexing, then the Matcher uses the index report that was sent from that Indexer, and then matches against vulnerabilities. The Matcher also fetches vulnerability data and updates the Scanner V4 database with the latest vulnerability data. The Scanner V4 Matcher outputs a vulnerability report, which contains the final results of an image.
19-
** *Scanner V4 DB*: This database stores information for Scanner V4, including all vulnerability data and index reports. A persistent volume claim (PVC) is required for Scanner V4 DB on the cluster where Central is installed.
20-
* *StackRox Scanner*: The StackRox Scanner is the default scanner in {product-title-short}. Version 4.4 adds a new scanner, Scanner V4. The StackRox Scanner originates from a fork of the Clair v2 open source scanner. You must continue using this scanner for RHCOS node scanning and platform scanning.
21-
* *Scanner-DB*: This database contains data for the StackRox Scanner.
22-
23-
{product-title-short} scanners analyze each image layer to determine the base operating system and identify programming language packages and packages that were installed by the operating system package manager. They match the findings against known vulnerabilities from various vulnerability sources. In addition, the StackRox Scanner identifies vulnerabilities in the node's operating system and platform. These capabilities are planned for Scanner V4 in a future release.
24-
//moved vulnerability source info to its own module - con-vuln-sources.adoc
12+
include::snippets/central-components.adoc[]

modules/acs-cloud-requirements.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@ Memory:: 6 GiB of RAM is required.
4343
See the default memory and CPU requirements for each component and ensure that the node size can support them.
4444
====
4545

46-
Storage:: For {product-title-managed-short}, a persistent volume claim (PVC) is not required. However, a PVC is strongly recommended if you have secured clusters with Scanner V4 enabled. Use Solid-State Drives (SSDs) for best performance. However, you can use another storage type if you do not have SSDs available.
46+
Storage:: For {product-title-managed-short}, a persistent volume claim (PVC) is not required. However, a PVC is strongly recommended if you have secured clusters with Scanner V4 enabled.
47+
//Do we want to change this advice since Scanner V4 is now installed by default?
48+
Use Solid-State Drives (SSDs) for best performance. However, you can use another storage type if you do not have SSDs available.
4749
+
4850
[IMPORTANT]
4951
====

modules/acs-requirements.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@ Memory:: 6 GiB of RAM is required.
4343
See the default memory and CPU requirements for each component and ensure that the node size can support them.
4444
====
4545

46-
Storage:: A persistent volume claim (PVC) is required on the cluster where Central is installed. It is strongly recommended on the secured clusters where Scanner V4 is enabled. Use Solid-State Drives (SSDs) for best performance. However, you can use another storage type if you do not have SSDs available.
46+
Storage:: A persistent volume claim (PVC) is required on the cluster where Central is installed. It is strongly recommended on the secured clusters where Scanner V4 is enabled.
47+
//Do we want to change this advice since Scanner V4 is now installed by default?
48+
Use Solid-State Drives (SSDs) for best performance. However, you can use another storage type if you do not have SSDs available.
4749
+
4850
[IMPORTANT]
4951
====

modules/acs-secured-cluster-services-overview.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,13 @@ In addition, Sensor is responsible for all cluster interactions, such as applyin
2424
* *Admission controller*: The Admission controller prevents users from creating workloads that violate security policies in {short-title}.
2525
* *Collector*: Collector analyzes and monitors container activity on cluster nodes.
2626
It collects container runtime and network activity information and sends the collected data to Sensor.
27+
* *Scanner V4*: Scanner V4 components are installed on the secured cluster by default.
28+
** *Scanner V4 Indexer*: The Scanner V4 Indexer performs image indexing, previously known as image analysis. Given an image and registry credentials, the Indexer pulls the image from the registry. It finds the base operating system, if it exists, and looks for packages. It stores and outputs an index report, which contains the findings for the given image.
29+
** *Scanner V4 DB*: This database stores information for Scanner V4, including index reports. For best performance, configure a persistent volume claim (PVC) for Scanner V4 DB.
2730
* *StackRox Scanner*: In Kubernetes, the secured cluster services include Scanner-slim as an optional component. However, on {ocp}, {short-title} installs a Scanner-slim version on each secured cluster to scan images in the {ocp} integrated registry and optionally other registries.
31+
//Is this still true or does it now just install Scanner V4?
2832
* *Scanner-DB*: This database contains data for the StackRox Scanner.
29-
* *Scanner V4*: Scanner V4 components are installed on the secured cluster if enabled.
30-
** *Scanner V4 Indexer*: The Scanner V4 Indexer performs image indexing, previously known as image analysis. Given an image and registry credentials, the Indexer pulls the image from the registry. It finds the base operating system, if it exists, and looks for packages. It stores and outputs an index report, which contains the findings for the given image.
31-
** *Scanner V4 DB*: This component is installed if Scanner V4 is enabled. This database stores information for Scanner V4, including index reports. For best performance, configure a persistent volume claim (PVC) for Scanner V4 DB.
33+
//changes needed - should this be required?
3234
+
3335
[NOTE]
3436
====

modules/acscs-architecture-overview.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ You can also integrate it with your existing DevOps tools and workflows to impro
1313

1414
.{product-title-managed-short} architecture
1515

16-
The following graphic shows the architecture with the StackRox Scanner and Scanner V4. Installation of Scanner V4 is optional, but provides additional benefits.
16+
The following graphic shows the architecture with the StackRox Scanner and Scanner V4.
17+
//Does this graphic need updates to change Scanner V4 components to non-dotted lines since they are now not optional?
1718

1819
image::acscs-architecture-scannerv4.png[{product-title-managed-short}]
1920

modules/acscs-central-overview.adoc

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,4 @@
88
Red{nbsp}Hat manages Central, the control plane for {product-title-managed-short}.
99
These services include the following components:
1010

11-
* *Central*: Central is the {product-title-short} application management interface and services.
12-
It handles API interactions and user interface ({product-title-short} Portal) access.
13-
* *Central DB*: Central DB is the database for {product-title-short} and handles all data persistence. It is currently based on PostgreSQL 15.
14-
* *Scanner V4*: Beginning with version 4.4, {product-title-short} contains the Scanner V4 vulnerability scanner for scanning container images. Scanner V4 is built on link:https://github.com/quay/claircore[ClairCore], which also powers the link:https://github.com/quay/clair[Clair] scanner. Scanner V4 includes the Indexer, Matcher, and Scanner V4 DB components, which are used in scanning.
15-
* *StackRox Scanner*: The StackRox Scanner is the default scanner in {product-title-short}. The StackRox Scanner originates from a fork of the Clair v2 open source scanner.
16-
* *Scanner-DB*: This database contains data for the StackRox Scanner.
17-
18-
{product-title-short} scanners analyze each image layer to determine the base operating system and identify programming language packages and packages that were installed by the operating system package manager. They match the findings against known vulnerabilities from various vulnerability sources. In addition, the StackRox Scanner identifies vulnerabilities in the node's operating system and platform. These capabilities are planned for Scanner V4 in a future release.
19-
//moved vulnerability source info to its own module - con-vuln-sources.adoc
11+
include::snippets/central-components.adoc[]

modules/automatically-generated-ca.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="automatically-generated-ca_{context}"]
77
= Retrieving the automatically generated certificate authority
88

9-
When installing {product-title-short}, a certificate authority (CA) is automatically generated and stored in a Kubernetes secret on the cluster. If you later change your installation by using Helm, you might need to supply this CA. For example, enabling Scanner V4 requires that you provide this CA.
9+
When installing {product-title-short}, a certificate authority (CA) is automatically generated and stored in a Kubernetes secret on the cluster. If you later change your installation by using Helm, you might need to supply this CA. For example, enabling an {product-title-short} component that was initially disabled at installation time requires that you provide this CA.
1010

1111
The automatically generated CA is stored in a secret that is usually named similar to `stackrox-generated-_suffix_`, where _suffix_ is a randomly generated string.
1212

modules/central-configuration-options-operator.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ Ensure that this value does not exceed the maximum number of connections support
193193
|Use `Enabled` to enable monitoring for the StackRox Scanner. When you enable monitoring, {product-title-short} creates a new monitoring service on port number `9090`. The default value is `Disabled`.
194194

195195
| `scanner.scannerComponent`
196-
| If you do not want to deploy the StackRox Scanner, you can disable it by using this parameter. If you disable the StackRox Scanner, all other settings in this section have no effect. Red{nbsp}Hat does not recommend disabling {product-title} the StackRox Scanner. Do not disable the StackRox Scanner if you have enabled Scanner V4. Scanner V4 requires that the StackRox Scanner is also enabled to provide the necessary scanning capabilities.
196+
| If you do not want to deploy the StackRox Scanner, you can disable it by using this parameter. If you disable the StackRox Scanner, all other settings in this section have no effect.
197197

198198
|===
199199

@@ -287,7 +287,8 @@ The default value is `scanner-v4-db`.
287287
| Configures a monitoring endpoint for Scanner V4. The monitoring endpoint allows other services to collect metrics from Scanner V4, provided in a Prometheus-compatible format. Use `Enabled` to expose the monitoring endpoint. When you enable monitoring, {product-title-short} creates a new service, `monitoring`, with port 9090, and a network policy allowing inbound connections to the port. By default, this is not enabled.
288288

289289
| `scannerV4.scannerComponent`
290-
| Enables Scanner V4. The default value is `default`, which is disabled. To enable Scanner V4, set this parameter to `Enabled`.
290+
| If this setting is not specified, by default during installation, Scanner V4 is enabled.
291+
//Is there a way to disable Scanner V4 with this parameter? If so, should we point out the danger of disabling Scanner V4? Does disabling Scanner V4 mean that then only the StackRox Scanner will be used and they won't have capabilities of Scanner V4? I assume that StackRox Scanner will still work until it is removed, but is that a valid assumption?
291292

292293
|===
293294

0 commit comments

Comments
 (0)