Skip to content

Commit

Permalink
Fixed wording accroding to review results
Browse files Browse the repository at this point in the history
  • Loading branch information
xingzhang-suse authored and sunilarjun committed Nov 20, 2024
1 parent 452e20e commit 6c38588
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 20 deletions.
16 changes: 8 additions & 8 deletions docs/15.ui_extension/01.dashboard/01.dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,33 +10,33 @@ slug: /ui_extension/dashboard

In the UI Extension in the Rancher portal, NeuVector's Dashboard works similar as its standalone page. It provides security risk score factors to let users know the security status of their clusters. In the bottom panel, it provides 4 tabs to let users switch the charts to monitor different categories.

In Security Events tab, the line chart shows a date-based event count in a timeline.
In the Security Events tab, the line chart shows a date-based event count in a timeline.
The top security events bar charts presents the top 5 source and destination endpoints.

![Dashboard](dashboard_security_events.png)

In Ingress and Egress Exposure tab, the stacked bar chart shows amount of exposed endpoints by actions.
On the right side, the exposure tables show egress and ingress endpoint service with scan informations.
In Ingress and Egress Exposure tab, the stacked bar chart shows the amount of exposed endpoints by actions.
On the right side, the exposure tables show egress and ingress endpoint service with scan information.

![Dashboard](dashboard_exposure.png)

Click on the row of egress/ingress table, the table shows conversations on specific service. The FQDN name / IP address is shown with geography location based national flag in External Host field.
Click on the row of egress/ingress table, the table shows conversations on specific services. The FQDN name / IP address is shown with a geography location based national flag in the External Host field.

![Dashboard](dashboard_conversations.png)

Click on the External Host, it redirects to whois.com to show the IP address' detail informations.
Click on the External Host, it redirects to whois.com to show the IP address' detail information.

![External](whois.png)

In Policy Mode tab, the pie charts shows the ratio and numbers of pods / services under different policy mode.
In the Policy Mode tab, the pie charts show the ratio and numbers of pods / services under different policy modes.

![Dashboard](dashboard_policy_mode.png)

In Top Vulnerable Assets tab, the bar charts shows the top 5 pods / nodes which contain high or medium severity vulnerabilities.
In the Top Vulnerable Assets tab, the bar charts show the top 5 pods / nodes which contain high or medium severity vulnerabilities.

![Dashboard](dashboard_top_vul_assets.png)

### Not included functions comparing with NeuVector standalone page
### Functions Not Included When Comparing with NeuVector Standalone Page

Score improvement dialog

Expand Down
14 changes: 7 additions & 7 deletions docs/15.ui_extension/02.runtime _security/runtime_security.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ slug: /ui_extension/runtime_security

### Assets Security Scan Result

As Rancher has its own Nodes and Workloads page to manage and monitor the assets' status, NeuVector injects components to display its runtime scan result.
As Rancher has its own Nodes and Workloads page to manage and monitor the assets statuses, NeuVector injects components to display its runtime scan result.

#### Nodes

In nodes summary table, vulnerabilities column is injected to show each node's detected vulnerabilities amount by high / medium severity.
In the nodes summary table, the vulnerabilities column is injected to show each node's detected vulnerabilities amount by high / medium severity.

![Nodes](nodes.png)

Click on the vulnerabilities cell, a slide panel comes from right side of the page to show scan result details. The database version of the scanner is shown as well as a filterable vulnerability list.
Click on the vulnerabilities cell, a slide panel will come from the right side of the page to show scan result details. The database version of the scanner is shown as well as a filterable vulnerability list.

![Nodes](nodes_vul.png)

Click on the node name cell on nodes table, it redirects to node detail page. NeuVector inject a tab to show vulnerability list.
Click on the node name cell on nodes table, it redirects to the node detail page. NeuVector injects a tab to show the vulnerability list.

![Nodes](node_detail_vul.png)

Expand All @@ -30,18 +30,18 @@ Click on the CVE name cell on the vulnerabilities table, it opens a popup to sho

![SUSE](suse_cve.png)

A CSV file downloading button is provided above the vulnerabilities table. The file data includes all the fields which are in the table.
A CSV file download button is provided above the vulnerabilities table. The file data includes all the fields which are in the table.

![CSV](download_vul.png)

![CSV](cve_csv.png)

#### Workloads

Temporarily, vulnerabilities column will not be injected in workloads table in v5.4 release due to potential performance concern. NeuVector team will work with Rancher team to deal with it and integrate it soon.
Temporarily, the vulnerabilities column will not be injected in the workloads table in the v5.4 release due to potential performance concern. The NeuVector team will work with the Rancher team to integrate it soon.

![Workload](pods.png)

Click on a pod name on the workloads table, it redirects to pod detail page. NeuVector inject a tab to show vulnerability list.
Click on a pod name in the workloads table, it redirects to the pod detail page. NeuVector injects a tab to show the vulnerability list.

![Workload](pod_detail_vul.png)
10 changes: 5 additions & 5 deletions docs/15.ui_extension/03.notifictions/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ slug: /ui_extension/notifications

#### Security Events

In UI Extension on Rancher portal, Security Events works similar as NeuVector standalone page.
The events can be triggered by several factors
In the UI Extension on the Rancher portal, Security Events work similar to the NeuVector standalone page.
The events can be triggered by several factors:

- Dangerous conversation or data transportation from somewhere to the endpoint (Node or pod)
- End-to-end violated connection against network policy
Expand All @@ -20,15 +20,15 @@ The events can be triggered by several factors

![Security Events](sec_events.png)

Slide left or / and right dot on the time slider to filter events by date.
Slide the dot left or right on the time slider to filter events by date.

![Security Events](sec_events_time_filter.png)

Type in keyword into quick filter box to filter any event which includes the keyword.
Type in keywords into the quick filter box to filter any event which includes the keyword.

![Security Events](sec_events_quick_filter.png)

Open the Advanced filter slide panel, there are multiple options supporting your searching.
Open the Advanced filter slide panel, and you will find multiple options supporting your search:

- Severity, Location and Category can be filtered according to the tags on the right side of the event title.
- Autocomplete list can support user to enter Host, Source, Destination
Expand Down

0 comments on commit 6c38588

Please sign in to comment.