Skip to content

Commit abd3e22

Browse files
kcarmichael08kcarmichael08
committed
Update docs for VM2.0
1 parent 2b0b6f5 commit abd3e22

6 files changed

+115
-31
lines changed

‎modules/understanding-vulnerability-scores.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
// * operating/examine-images-for-vulnerabilities.adoc
44
:_mod-docs-content-type: CONCEPT
55
[id="understanding-understanding-vulnerability-scores_{context}"]
6-
= Understanding vulnerability scores
6+
= Understanding vulnerability scores in the Dashboard
77

88
[role="_abstract"]
9-
The {product-title} portal shows a single Common Vulnerability Scoring System (CVSS) base score for each vulnerability.
9+
The Vulnerability Management Dashboard in the {product-title} portal shows a single Common Vulnerability Scoring System (CVSS) base score for each vulnerability.
1010
{product-title-short} shows the CVSS score based on the following criteria:
1111

1212
* If a CVSS v3 score is available, {product-title-short} shows the score and lists `v3` along with it.

‎modules/vulnerability-management-asset-assessment.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ When you install {product-title} on your Kubernetes or {ocp} cluster, it first a
1717
Important assets that should be monitored by the organization's vulnerability management process using {product-title-short} include:
1818

1919
* *Components*: Components are software packages that may be used as part of an image or run on a node. Components are the lowest level where vulnerabilities are present. Therefore, organizations must upgrade, modify or remove software components in some way to remediate vulnerabilities.
20-
* *Image*: A collection of software components and code that create an environment to run an executable portion of code. Images are where you upgrade components to fix vulnerabilities.
20+
* *Images*: A collection of software components and code that create an environment to run an executable portion of code. Images are where you upgrade components to fix vulnerabilities.
2121
* *Nodes*: A server used to manage and run applications using OpenShift or Kubernetes and the components that make up the {ocp} or Kubernetes service.
2222
23-
{product-title} groups these assets into the following structures:
23+
{product-title-short} groups these assets into the following structures:
2424

2525
* *Deployment*: A definition of an application in Kubernetes that may run pods with containers based on one or many images.
2626
* *Namespace*: A grouping of resources such as Deployments that support and isolate an application.
2727
* *Cluster*: A group of nodes used to run applications using OpenShift or Kubernetes.
2828
29-
{product-title} scans the assets for known vulnerabilities and uses the Common Vulnerabilities and Exposures (CVE) data to assess the impact of a known vulnerability.
29+
{product-title-short} scans the assets for known vulnerabilities and uses the Common Vulnerabilities and Exposures (CVE) data to assess the impact of a known vulnerability.

‎modules/vulnerability-management-view-applications-vulnerability.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
// * operating/manage-vulnerabilities.adoc
44
:_mod-docs-content-type: PROCEDURE
55
[id="vulnerability-management-view-applications-vulnerability_{context}"]
6-
= Viewing application vulnerabilities
6+
= Viewing application vulnerabilities by using the Dashboard
77

88
[role="_abstract"]
9-
You can view application vulnerabilities in {product-title}.
9+
You can view application vulnerabilities in {product-title} by using the *Dashboard*.
1010

1111
.Procedure
1212

13-
. In the {product-title-short} portal, go to *Vulnerability Management 1.0* -> *Dashboard*.
13+
. In the {product-title-short} portal, go to *Vulnerability Management* -> *Dashboard*.
1414
. On the *Dashboard* view header, select *Application & Infrastructure* -> *Namespaces* or *Deployments*.
1515
. From the list, search for and select the *Namespace* or *Deployment* you want to review.
1616
. To get more information about the application, select an entity from *Related entities* on the right.

‎modules/vulnerability-management-view-image-vulnerability.adoc‎ renamed to ‎modules/vulnerability-management-view-image-vulnerability-dashboard.adoc‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
//
33
// * operating/manage-vulnerabilities.adoc
44
:_mod-docs-content-type: PROCEDURE
5-
[id="vulnerability-management-view-image-vulnerability_{context}"]
6-
= Viewing image vulnerabilities
5+
[id="vulnerability-management-view-image-vulnerability-dashboard_{context}"]
6+
= Viewing vulnerabilities by image using the Dashboard
77

88
[role="_abstract"]
9-
You can view image vulnerabilities in {product-title}.
9+
You can view image vulnerabilities in {product-title} by using the *Dashboard*.
1010

1111
.Procedure
12-
. In the {product-title-short} portal, go to *Vulnerability Management 1.0* -> *Dashboard*.
13-
. On the *Dashboard* view header, select *Images*.
12+
. In the {product-title-short} portal, go to *Vulnerability Management* -> *Dashboard*.
13+
. On the *Dashboard* view header, select *<number> Images*.
1414
. From the list of images, select the image you want to investigate. You can also filter the list by performing one of the following steps:
1515
.. Enter *Image* in the search bar and then select the *Image* attribute.
1616
.. Enter the image name in the search bar.

‎modules/vulnerability-management20-view-cve.adoc‎

Lines changed: 94 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,109 @@
33
// * operating/manage-vulnerabilities/vulnerability-management.adoc
44
:_mod-docs-content-type: PROCEDURE
55
[id="vulnerability-management20-view-workload-cve_{context}"]
6-
= Viewing workload CVEs in Vulnerability Management (2.0)
6+
= Viewing workload CVEs
77

88
[role="_abstract"]
9-
You can view a comprehensive list of vulnerabilities, or CVEs, in {product-title-short} across images and deployments. You can use the search filter bar to select specific CVEs, images, deployments, namespaces, or clusters.
9+
10+
You can view vulnerabilities across images and deployments found by {product-title} in the *Vulnerability Management* -> *Workload CVEs* page.
11+
12+
From the *View image vulnerabilities* menu, you can select from the following choices:
13+
14+
* Image vulnerabilities: Displays images and deployments in which {product-title-short} has discovered CVEs.
15+
* Images without CVEs: Displays images that meet the following conditions:
16+
** Images that do not have CVEs
17+
** Images that report a scanner error that may result in a false negative of no CVEs
18+
** Images that have all known CVEs marked as *Deferred* or *False positive*
19+
+
20+
[NOTE]
21+
====
22+
An image that actually contains vulnerabilities can appear in this list by mistake. For example, if the {product-title-short} scanner was able to scan the image and it is known to {product-title-short}, but the scan did not successfully complete, vulnerabilities would not be detected. This scenario can occur if an image has an operating system that is not supported by the {product-title-short} scanner. Scan errors are displayed when you hover over an image in the image list or click the image name for more information.
23+
====
1024
1125
.Procedure
12-
. In the {product-title-short} portal, go to *Vulnerability Management (2.0)* -> *Workload CVEs*.
13-
. From the drop-down list, select the search criteria you want to use. You can select an item type, such as a cluster, from the list, and then select the specific name of the item. You can add additional items to the filter by selecting another item from the list and selecting the specific name of the new item. For example, you can select a specific image and a specific cluster to limit results to those selections. You can filter on the following items:
14-
* CVE
15-
* Image
16-
* Deployment
17-
* Namespace
18-
* Cluster
19-
* Component
20-
* Component source
21-
. Optional: Use the *CVE severity* list to select the severities of the CVEs that you want to display.
22-
. Click the relevant button to view a list of vulnerabilities, images, or deployments in the system.
26+
27+
. To show all CVEs across all images, click *View image vulnerabilities* -> *Image vulnerabilities*.
28+
. You can filter CVEs by entity by selecting the appropriate filters and attributes. You can choose multiple entities and attributes by clicking the right arrow to add another criteria. Depending on your choices, enter the appropriate information such as text, or select a date or object. The filter entities and attributes are listed in the following table.
2329
+
30+
.CVE filtering
31+
32+
|===
33+
|Entity|Attributes
34+
35+
|Image
36+
a|
37+
38+
* Name
39+
* Operating system
40+
* Tag
41+
* CVSS
42+
* Label
43+
* Created Time
44+
* Scan Time
45+
|Registry|
46+
|Deployment|
47+
|Namespace|
48+
|Cluster|
49+
|Node
50+
a|
51+
52+
* CVSS
53+
** is greater than
54+
** is greater than
55+
** is greater than or equal to
56+
** is equal to
57+
** is less than or equal to
58+
** is less than
59+
60+
a|Image CVE|
61+
62+
* ID
63+
* Discovered Time
64+
** calendar input
65+
* CVSS
66+
** is greater than
67+
** is greater than
68+
** is greater than or equal to
69+
** is equal to
70+
** is less than or equal to
71+
** is less than
72+
* Type
73+
74+
|Node CVE
75+
a|
76+
77+
* ID
78+
* Discovered Time
79+
* CVSS
80+
* Snoozed
81+
82+
|Platform CVE|
83+
|Image Component
84+
a|
85+
86+
* Name
87+
* Source
88+
** OS
89+
** Python
90+
** Java
91+
** Ruby
92+
** Node.js
93+
** Dotnet Core Runtime
94+
** Infrastructure
95+
96+
* Version
97+
|Node Component|Name: Select from the list, or begin entering text to use autocomplete
98+
|===
99+
100+
. To filter by severity, click *CVE severity* and select one or more levels.
101+
. To filter by CVE status, click *CVE status* and select *Fixable* or *Not fixable*.
102+
. To ???????, click *Prioritize by namespace view*.
103+
24104
[NOTE]
25105
====
26106
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.
27107
====
108+
28109
. In the list of results, click a CVE, image name, or deployment name to view more information about the item. For example, depending on the item type, you can view the following information:
29110
+
30111
* Whether a CVE is fixable

‎operating/manage-vulnerabilities/vulnerability-management.adoc‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,17 @@ include::modules/vulnerability-management-asset-assessment.adoc[leveloffset=+2]
1717
[id="viewing-vulnerabilities"]
1818
== Viewing vulnerabilities
1919

20-
{product-title-short} provides the following methods to view vulnerabilities discovered in your system:
20+
{product-title-short} provides two ways to view vulnerabilities discovered in your system.
2121

22-
* To view application vulnerabilities by namespace or deployment, or to view vulnerabilities in an image, in the {product-title-short} web portal, go to *Vulnerability Management (1.0)* -> *Dashboard*.
23-
* To view vulnerabilities in applications running on clusters in your system, go to *Vulnerability Management (2.0)* -> *Workload CVEs*. You can filter vulnerabilities by image, deployment, namespace, and cluster.
22+
The *Vulnerability Management Dashboard* provides information about vulnerabilities. You can view vulnerabilities by image, node, or platform. You can further view vulnerabilities by clusters, namespaces, deployments, node components, and image components. To access the dashboard, go to *Vulnerability Management* -> *Dashboard*.
2423

25-
include::modules/vulnerability-management-view-applications-vulnerability.adoc[leveloffset=+2]
24+
The *Workload CVEs* page provides information about vulnerabilities in applications running on clusters in your system. You can view vulnerability information across images and deployments. The Workload CVEs page provides more advanced capabilities than the Dashboard for filtering, including the ability to view images and deployments with vulnerabilities and filter by image, deployment, namespace, cluster, CVE, component, and component source. To access the Workload CVEs page, go to *Vulnerability Management* -> *Workload CVEs*.
2625

27-
include::modules/vulnerability-management-view-image-vulnerability.adoc[leveloffset=+2]
26+
[id="using-the-vm-dashboard"]
27+
=== Using the Dashboard
28+
29+
include::modules/vulnerability-management-view-applications-vulnerability.adoc[leveloffset=+3]
30+
include::modules/vulnerability-management-view-image-vulnerability-dashboard.adoc[leveloffset=+3]
2831

2932
[role="additional-resources"]
3033
.Additional resources

0 commit comments

Comments
 (0)