Skip to content

Commit 9d29af8

Browse files
committed
Update docs for Scanner V4 installed by default
1 parent 079ecdd commit 9d29af8

File tree

40 files changed

+149
-195
lines changed

40 files changed

+149
-195
lines changed

modules/rhcos-restore-node-scan-with-stackrox-scanner.adoc renamed to _unused_topics/rhcos-restore-node-scan-with-stackrox-scanner.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ If you use {ocp}, you can enable scanning of {op-system-first} nodes for vulnera
1111
This feature is available with both the StackRox Scanner and Scanner V4.
1212
Follow this procedure if you want to use the StackRox Scanner to scan {op-system-first} nodes,
1313
but you want to keep using Scanner V4 to scan other nodes.
14+
//Should this module be deleted? Why would the user want to keep scanning nodes with StackRox scanner since Scanner V4 now scans nodes and is installed by default?
1415

1516
.Prerequisites
1617
* For scanning {op-system} node hosts of the secured cluster, you must have installed Secured Cluster services on {ocp} {ocp-supported-version} or later. For information about supported platforms and architecture, see the link:https://access.redhat.com/articles/7045053[{product-title} Support Matrix]. For life cycle support information for {product-title-short}, see the link:https://access.redhat.com/support/policy/updates/rhacs[{product-title} Support Policy].

architecture/acs-architecture.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ include::modules/acs-architecture-overview.adoc[leveloffset=+1]
1212
[role="_additional-resources"]
1313
.Additional resources
1414
* xref:../architecture/acs-architecture.adoc#external-components_acs-architecture[External components]
15+
* xref:../operating/examine-images-for-vulnerabilities.adoc#enabling_scanner_v4_examine-images-for-vulnerabilities[Enabling Scanner V4]
1516

1617
include::modules/acs-central-services-overview.adoc[leveloffset=+1]
1718

cloud_service/acscs-architecture.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Discover {rh-rhacscs-first} architecture and concepts.
1010

1111
include::modules/acscs-architecture-overview.adoc[leveloffset=+1]
1212

13+
[role="_additional-resources"]
14+
.Additional resources
15+
* xref:../operating/examine-images-for-vulnerabilities.adoc#enabling_scanner_v4_examine-images-for-vulnerabilities[Enabling Scanner V4]
16+
1317
include::modules/acscs-central-overview.adoc[leveloffset=+1]
1418

1519
include::modules/con-vuln-sources.adoc[leveloffset=+2]

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+

installing/installing_other/install-central-other.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ You can install {product-title-short} on your {osp} cluster without any customiz
2828

2929
include::modules/adding-helm-repository.adoc[leveloffset=+3]
3030
include::modules/acs-quick-install-using-helm.adoc[leveloffset=+3]
31+
include::modules/automatically-generated-ca.adoc[leveloffset=+3]
3132

3233
[id="install-using-helm-customizations-other"]
3334
=== Install Central using Helm charts with customizations

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

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -27,38 +27,27 @@ Red{nbsp}Hat supports the following container image registries:
2727

2828
This enhanced support gives you greater flexibility and choice in managing your container images in your preferred registry.
2929

30-
[discrete]
31-
== Supported Scanners
32-
33-
You can set up {product-title-short} to obtain image vulnerability data from the following commercial container image vulnerability scanners:
34-
35-
[discrete]
36-
=== Scanners included in {product-title-short}
30+
[id="rhacs-scanners_{context}"]
31+
== Scanners included in {product-title-short}
3732

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-
====
33+
* 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].
34+
* 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. If delegated scanning is configured and only the StackRox Scanner is installed on secured clusters, StackRox Scanner must also be enabled on the cluster where Central is installed or delegated scanning will not work.
4535

46-
[discrete]
47-
=== Alternative scanners
36+
[id="alternative-scanners_{context}"]
37+
== Alternative scanners
4838

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.
50-
* link:https://cloud.google.com/container-registry/docs/container-analysis[Google Container Analysis]
39+
* link:https://github.com/quay/clair[Clair]: Scanner V4 in {product-title-short} offers functionality provided by Claircore, which also powers the Clair V4 scanner. You can configure {product-title-short} to use Clair V4 instead of Scanner V4 by configuring an integration.
40+
* link:https://cloud.google.com/artifact-analysis/docs/artifact-analysis[Google Artifact Analysis]
5141
* link:https://quay.io[Red{nbsp}Hat Quay]
5242

5343
[IMPORTANT]
5444
====
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].
45+
Scanner V4 is the preferred image vulnerability scanner to use with {product-title-short}, because only Scanner V4 provides full functionality and features.
5746
====
5847

59-
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.
48+
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. However, Scanner V4 provides functionality and features that alternative scanners might not offer.
6049

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.
50+
If multiple scanners are configured, {product-title-short} tries to use the non-StackRox/{product-title-short} and non-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.
6251

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

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+
include::snippets/scannerv4-default-secured-clusters.adoc[]

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-secured-cluster-services-overview.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ 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 retrieves and scans images and indexes them. It is the default scanner for {product-title-short} and contains the following components:
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. The Indexer finds the base operating system, if one 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.
2831
* *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.
3232
+
3333
[NOTE]
3434
====

modules/acscs-architecture-overview.adoc

Lines changed: 4 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

@@ -24,3 +25,5 @@ You deploy your Central service through the link:https://console.redhat.com/[Red
2425
The clusters you secure, called Secured Clusters, are managed by you, and not by Red{nbsp}Hat.
2526
Secured Cluster services include optional vulnerability scanning services, admission control services, and data collection services used for runtime monitoring and compliance.
2627
You install Secured Cluster services on any OpenShift or Kubernetes cluster you want to secure.
28+
29+
include::snippets/scannerv4-default-secured-clusters.adoc[]

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

0 commit comments

Comments
 (0)