Skip to content

Commit 22b95e6

Browse files
committed
Updates to docs for RHCOS scanning with Scanner V4
1 parent 3cbefd7 commit 22b95e6

File tree

6 files changed

+30
-3
lines changed

6 files changed

+30
-3
lines changed

modules/rhcos-analyse-detect.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ The Compliance container was already a part of earlier {product-title-short} ver
1111
However, the Node-inventory container is new with {product-title-short} 4.0 and works only with {ocp} cluster nodes.
1212

1313
Upon start-up, the Compliance and Node-inventory containers begin the first inventory scan of {op-system-first} software components within five minutes. Next, the Node-inventory container scans the node's file system to identify installed RPM packages and report on {op-system} software components. Afterward, inventory scanning occurs at periodic intervals, typically every four hours. You can customize the default interval by configuring the ROX_NODE_SCANNING_INTERVAL environment variable for the Compliance container.
14+
//needs updating for 4.6?
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * operating/manage-vulnerabilities/scan-rhcos-node-host.adoc
4+
// * cloud_service/upgrading-cloud/upgrade-cloudsvc-roxctl.adoc
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="rhcos-enable-node-scan-scannerv4_{context}"]
7+
= Enabling {op-system} node scanning with Scanner V4
8+
9+
[role="_abstract"]
10+
If you use {ocp}, you can enable scanning of {op-system-first} nodes for vulnerabilities by using {rh-rhacs-first}.
11+
12+
:FeatureName: RHCOS node scanning with Scanner V4
13+
include::snippets/technology-preview.adoc[]
14+
15+
.Prerequisites
16+
* 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].
17+
//what action does user have to take to enable Scanner V4 for node scanning?
18+
19+
.Procedure

modules/rhcos-enable-node-scan.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
// * cloud_service/upgrading-cloud/upgrade-cloudsvc-roxctl.adoc
55
:_mod-docs-content-type: PROCEDURE
66
[id="rhcos-enable-node-scan_{context}"]
7-
= Enabling {op-system} node scanning
7+
= Enabling {op-system} node scanning with the StackRox Scanner
88

99
[role="_abstract"]
1010
If you use {ocp}, you can enable scanning of {op-system-first} nodes for vulnerabilities by using {rh-rhacs-first}.
1111

1212
.Prerequisites
13-
* For scanning {op-system} node hosts of the Secured cluster, you must have installed Secured cluster 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].
13+
* 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].
1414
1515
.Procedure
1616
. Run one of the following commands to update the compliance container.

modules/rhcos-environment-variables.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
[role="_abstract"]
99
You can use the following environment variables to configure {op-system} node scanning on {product-title-short}.
1010

11+
//needs updating for 4.6 with new variables?
12+
1113
.Node-inventory configuration
1214
[options="header", cols="1m,2"]
1315
|====

modules/rhcos-match-vulnerability.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@
99
Central services, which include Central and Scanner, perform vulnerability matching. Scanner uses Red{nbsp}Hat's Open Vulnerability and Assessment Language (OVAL) v2 security data streams to match vulnerabilities on {op-system-first} software components.
1010

1111
Unlike the earlier versions, {product-title-short} 4.0 no longer uses the Kubernetes node metadata to find the kernel and container runtime versions. Instead, it uses the installed {op-system} RPMs to assess that information.
12+
//changes made in https://github.com/openshift/openshift-docs/pull/83406 for 4.6

operating/manage-vulnerabilities/scan-rhcos-node-host.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ include::modules/common-attributes.adoc[]
77
toc::[]
88

99
[role="_abstract"]
10-
For {ocp}, {op-system-first} is the only supported operating system for control plane. Whereas, for node hosts, {ocp} supports both {op-system} and {op-system-base-full}.
10+
For {ocp}, {op-system-first} is the only supported operating system for control plane. For node hosts, {ocp} supports both {op-system} and {op-system-base-full}.
1111
With {rh-rhacs-first}, you can scan {op-system} nodes for vulnerabilities and detect potential security threats.
1212

13+
//Any changes needed for 4.6 Scanner V4 for RHCOS nodes?
14+
1315
{product-title-short} scans {op-system} RPMs installed on the node host, as part of the {op-system} installation, for any known vulnerabilities.
1416

1517
First, {product-title-short} analyzes and detects {op-system} components. Then it matches vulnerabilities for identified components by using {op-system-base} and OpenShift 4.X Open Vulnerability and Assessment Language (OVAL) v2 security data streams.
@@ -25,6 +27,8 @@ First, {product-title-short} analyzes and detects {op-system} components. Then i
2527
2628
include::modules/rhcos-enable-node-scan.adoc[leveloffset=+1]
2729

30+
include::modules/rhcos-enable-node-scan-scannerv4.adoc[leveloffset=+1]
31+
2832
include::modules/rhcos-analyse-detect.adoc[leveloffset=+1]
2933

3034
include::modules/rhcos-match-vulnerability.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)