Skip to content

Commit efa7d64

Browse files
Merge pull request #89484 from openshift-cherrypick-robot/cherry-pick-88841-to-rhacs-docs-4.7
[rhacs-docs-4.7] ROX:27773: Update docs for Vuln Mgt changes
2 parents 365a1fe + 84355d7 commit efa7d64

24 files changed

+603
-348
lines changed

modules/analyze-images-and-deployments-with-observed-cves.adoc

Lines changed: 0 additions & 9 deletions
This file was deleted.

modules/analyze-images-and-deployments-without-observed-cves.adoc

Lines changed: 80 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,94 @@
22
//
33
// * operating/manage-vulnerabilities/common-vuln-management-tasks.adoc
44

5-
:_mod-docs-content-type: CONCEPT
5+
:_mod-docs-content-type: PROCEDURE
66
[id="analyze-images-and-deployments-without-observed-cves_{context}"]
77
= Analyze images and deployments without observed CVEs
88

9-
When you select *Images without vulnerabilities*, the *Workload CVEs* page shows the images that meet at least one of the following conditions:
9+
When you view the list of images without vulnerabilities, {product-title-short} shows the images that meet at least one of the following conditions:
1010

1111
** Images that do not have CVEs
1212
** Images that report a scanner error that may result in a false negative of no CVEs
1313

1414
[NOTE]
1515
====
16-
An image that actually contains vulnerabilities can appear in this list inadvertently. For example, if Scanner was able to scan the image and it is known to {rh-rhacs-first}, but the scan was not successfully completed, {product-title-short} cannot detect vulnerabilities.
16+
An image that actually contains vulnerabilities can appear in this list inadvertently. For example, if Scanner was able to scan the image and it is known to {rh-rhacs-first}, but the scan was not successfully completed, {product-title-short} cannot detect vulnerabilities.
1717
1818
This scenario occurs if an image has an operating system that {product-title-short} Scanner does not support. {product-title-short} displays scan errors when you hover over an image in the image list or click the image name for more information.
19-
====
19+
====
20+
21+
.Procedure
22+
23+
. In the {product-title-short} portal, go to *Vulnerability Management* -> *Results*.
24+
. Click *More Views* and select *Images without CVEs*.
25+
. To filter the list of results by entity, for example, to search for a specific image, select the appropriate filters and attributes.
26+
+
27+
To select multiple entities and attributes, click the right arrow icon to add another criteria. Depending on your choices, enter the appropriate information such as text, or select a date or object.
28+
+
29+
The filter entities and attributes are listed in the following table.
30+
+
31+
[NOTE]
32+
====
33+
The *Filtered view* icon indicates that the displayed results were filtered based on the criteria that you selected. You can click *Clear filters* to remove all filters, or remove individual filters by clicking on them.
34+
====
35+
+
36+
.Filter options
37+
[cols="2",options="header"]
38+
|===
39+
|Entity|Attributes
40+
41+
|Image
42+
a|
43+
* *Name*: The name of the image.
44+
* *Operating system*: The operating system of the image.
45+
* *Tag*: The tag for the image.
46+
* *Label*: The label for the image.
47+
* *Registry*: The registry where the image is located.
48+
49+
|Image Component
50+
a|
51+
52+
* *Name*: The name of the image component, for example, `activerecord-sql-server-adapter`
53+
* *Source*:
54+
** OS
55+
** Python
56+
** Java
57+
** Ruby
58+
** Node.js
59+
** Go
60+
** Dotnet Core Runtime
61+
** Infrastructure
62+
63+
* *Version*: Version of the image component; for example, `3.4.21`. You can use this to search for a specific version of a component, for example, in conjunction with a component name.
64+
|Deployment
65+
a|
66+
* *Name*: Name of the deployment.
67+
* *Label*: Label for the deployment.
68+
* *Annotation*: The annotation for the deployment.
69+
* *Status*: Whether the deployment is inactive or active.
70+
|Namespace
71+
a|
72+
* *ID*: The `metadata.uid` of the namespace that is created by Kubernetes.
73+
* *Name*: The name of the namespace.
74+
* *Label*: The label for the namespace.
75+
* *Annotation*: The annotation for the namespace.
76+
|Cluster
77+
a|
78+
* *ID*: The alphanumeric ID for the cluster. This is an internal identifier that {product-title-short} assigns for tracking purposes.
79+
* *Name*: The name of the cluster.
80+
* *Label*: The label for the cluster.
81+
* *Type*: The cluster type, for example, OCP.
82+
* *Platform type*: The platform type, for example, OpenShift 4 cluster.
83+
|===
84+
. Click one of the following tabs to view the data that you want:
85+
* *<number> Images*: Displays images that contain discovered vulnerabilities.
86+
* *<number> Deployments*: Displays deployments that contain discovered vulnerabilities.
87+
. Optional: Choose the appropriate method to re-organize the information in the page:
88+
* To select the categories that you want to display in the table, perform the following steps:
89+
.. Click *Columns*.
90+
.. Choose the appropriate method to manage the columns:
91+
*** To view all the categories, click *Select all*.
92+
*** To reset to the default categories, click *Reset to default*.
93+
*** To view only the selected categories, select the one or more categories that you want to view, and then click *Save*.
94+
*** To sort the table in ascending or descending order, select a column heading.
95+
. In the list of results, click an image name or deployment name to view more information about the item.

modules/cves-tab.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ The CVEs view organizes information into the following groups:
1717
====
1818
You can see the *Top NVD CVSS* column only if you have enabled Scanner V4.
1919
====
20+
* *EPSS probability*: The likelihood that the vulnerability will be exploited according to the link:https://www.first.org/epss/model[Exploit Prediction Scoring System (EPSS)]. This EPSS data provides a percentage estimate of the probability that exploitation of this vulnerability will be observed in the next 30 days. The EPSS collects data of observed exploitation activity from partners, and exploitation activity does not mean that an attempted exploitation was successful. The EPSS score should be used as a single data point _along with other information_, such as the age of the CVE, to help you prioritize the vulnerabilities to address. For more information, see link:https://access.redhat.com/articles/7106599[{product-title-short} and EPSS].
2021
* *Affected images*: Displays the number of container images affected by specific CVEs to assess the scope of vulnerabilities.
2122
* *First discovered*: Shows the date each vulnerability was first discovered in the environment to measure the duration of its exposure.
2223
* *Published*: Indicates when the CVE was publicly disclosed.

modules/identify-dockerfile-line-component-cve.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ You can identify specific Dockerfile lines in an image that introduced component
1313

1414
To view a problematic line:
1515

16-
. In the {product-title-short} portal, click *Vulnerability Management* -> *Workload CVEs*.
16+
. In the {product-title-short} portal, click *Vulnerability Management* -> *Results*.
17+
. Click *User Workloads*.
1718
. Click the tab to view the type of CVEs. The following tabs are available:
1819
* *Observed*
1920
* *Deferred*

modules/namespace-conditions-for-platform-components.adoc

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,34 @@ By understanding the namespace conditions for platform components, you can ident
1111
.Namespace conditions for platform components
1212
[cols="1,3", options="header"]
1313
|===
14-
|Platform component
14+
|Platform component
1515
|Namespace condition
1616

17-
|{ocp}
17+
|{ocp}
1818
a| * Namespace starts with `openshift-`
1919
* Namespace starts with `kube-`
2020

21-
|Layered products
21+
|Layered products
2222
a| * namespace = `stackrox`
2323
* Namespace starts with `rhacs-operator`
2424
* Namespace starts with `open-cluster-management`
2525
* namespace = `multicluster-engine`
2626
* namespace = `aap`
2727
* namespace = `hive`
2828

29-
|Third party partners
29+
|Third party partners
3030
a| * namespace = `nvidia-gpu-operator`
3131
|===
3232

33-
{rh-rhacs-first} identifies the workloads belonging to platform components by using the following regex pattern:
33+
{rh-rhacs-first} identifies the workloads belonging to platform components by using the following regex pattern:
3434

3535
[source,text]
3636
----
3737
^kube-.*|^openshift-.*|^stackrox$|^rhacs-operator$|^open-cluster-management$|^multicluster-engine$|^aap$|^hive$|^nvidia-gpu-operator$
38-
----
38+
----
39+
40+
The platform definition is not yet customizable. You can see the impact of the definition in your environment by using the global search. To do a global search, follow these steps:
41+
42+
. Click *Search*.
43+
. Select *Show Orchestrator Components*.
44+
. Apply the filter `Platform Component: true`.

modules/prioritizing-and-managing-scanned-cves-across-images-and-deployments.adoc

Lines changed: 0 additions & 135 deletions
This file was deleted.

modules/scan-inactive-images.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ You can also configure {product-title-short} to scan inactive (not deployed) ima
1313

1414
.Procedure
1515

16-
. In the {product-title-short} portal, click *Vulnerability Management* -> *Workload CVEs*.
16+
. In the {product-title-short} portal, click *Vulnerability Management* -> *Results*.
17+
. Click *More Views* -> *Inactive images*.
1718
. Click *Manage watched images*.
1819
. In the *Image name* field, enter the fully-qualified image name that begins with the registry and ends with the image tag, for example, `docker.io/library/nginx:latest`.
1920
. Click *Add image to watch list*.
@@ -25,4 +26,4 @@ In the {product-title-short} portal, click *Platform Configuration* -> *System C
2526

2627
All the data related to the image removed from the watched image list continues to appear in the {product-title-short} portal for the number of days mentioned on the *System Configuration* page and is only removed after that period is over.
2728
====
28-
. Click *Close* to return to the *Workload CVEs* page.
29+
. Click *Close* to return to the *Inactive images* page.

modules/viewing-node-cves.adoc

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="viewing-node-cves_{context}"]
7-
= Viewing Node CVEs
7+
= Viewing vulnerabilities in nodes
88

99
You can identify vulnerabilities in your nodes by using {product-title-short}. The vulnerabilities that are identified include the following:
1010

@@ -13,19 +13,21 @@ You can identify vulnerabilities in your nodes by using {product-title-short}. T
1313
1414
For more information about operating systems that {product-title-short} can scan, see "Supported operating systems".
1515

16+
{product-title-short} currently supports scanning nodes with the StackRox scanner and Scanner V4. Depending on which scanner is configured, different results might appear in the list of vulnerabilities. For more information, see "Understanding differences in scanning results between the StackRox Scanner and Scanner V4".
17+
1618
.Procedure
17-
. In the {product-title-short} portal, click *Vulnerability Management* -> *Node CVEs*.
18-
. To view the data, do any of the following tasks:
19-
* To view a list of all the CVEs affecting all of your nodes, select *<number> CVEs*.
20-
* To view a list of nodes that contain CVEs, select *<number> Nodes*.
19+
20+
. In the {product-title-short} portal, go to *Vulnerability Management* -> *Results*.
21+
. Select the *Nodes* tab.
22+
. Optional: The page defaults to a list of observed CVEs. Click *Show snoozed CVEs* to view them.
2123
. Optional: To filter CVEs according to entity, select the appropriate filters and attributes. To add more filtering criteria, follow these steps:
2224
.. Select the entity or attribute from the list.
2325
.. Depending on your choices, enter the appropriate information such as text, or select a date or object.
2426
.. Click the right arrow icon.
2527
.. Optional: Select additional entities and attributes, and then click the right arrow icon to add them.
2628
The filter entities and attributes are listed in the following table.
2729
+
28-
.CVE filtering
30+
.Filter options
2931
[cols="2",options="header"]
3032
|===
3133
|Entity|Attributes
@@ -41,7 +43,7 @@ a|
4143
a|
4244
* *Name*: The name of the CVE.
4345
* *Discovered time*: The date when {product-title-short} discovered the CVE.
44-
* *CVSS*: The severity level for the CVE.
46+
* *CVSS*: The severity level for the CVE.
4547
+
4648
The following values are associated with the severity level for the CVE:
4749
+
@@ -56,6 +58,7 @@ a|
5658
* *Version*: The version of the component, for example, `4.15.0-2024`. You can use this to search for a specific version of a component, for example, in conjunction with a component name.
5759
|Cluster
5860
a|
61+
* *ID*: The alphanumeric ID for the cluster. This is an internal identifier that {product-title-short} assigns for tracking purposes.
5962
* *Name*: The name of the cluster.
6063
* *Label*: The label for the cluster.
6164
* *Type*: The type of cluster, for example, OCP.
@@ -64,4 +67,7 @@ a|
6467
. Optional: To refine the list of results, do any of the following tasks:
6568
* Click *CVE severity*, and then select one or more levels.
6669
* Click *CVE status*, and then select *Fixable* or *Not fixable*.
67-
. Optional: To view the details of the node and information about the CVEs according to the CVSS score and fixable CVEs for that node, click a node name in the list of nodes.
70+
. To view the data, click one of the following tabs:
71+
* *<number> CVEs*: Displays a list of all the CVEs affecting all of your nodes.
72+
* *<number> Nodes*: Displays a list of nodes that contain CVEs.
73+
. To view the details of the node and information about the CVEs according to the CVSS score and fixable CVEs for that node, click a node name in the list of nodes.

0 commit comments

Comments
 (0)