Skip to content

Commit ed4c8a6

Browse files
committed
Update Network Report section with images
1 parent 83a9c15 commit ed4c8a6

File tree

3 files changed

+20
-4
lines changed

3 files changed

+20
-4
lines changed

docs/vendor/testing-network-policy.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,12 +114,12 @@ Compatibility Matrix network reporting helps you understand your application's n
114114

115115
Network reporting is not enabled by default. For information about how to collect and view reports through the Vendor Portal or the Replicated CLI, see the sections below.
116116

117-
The following table describes the contents of the supported network report types:
117+
There are two types of network reports:
118118

119119
| Report Type | Contents |
120120
|---|---|
121-
| **Summary Report**<br />Aggregated analysis of<br />captured network events| <ul><li>Total Events Count</li><li>Time Range (start/end)</li><li>Report Creation Date</li><li>Domain Names Requested (Domain, Count)</li><li>Destination IP Addresses Connected To (IP, Port, Count)</li><li>Source Details (expandable): Source IP, Service, Command, Pod</li></ul> |
122-
| **Full Report**<br />See all network events<br />captured in near real-time | <ul><li>Timestamp (with microseconds)</li><li>Source IP, Source Port, Source PID</li><li>Source Command, Source Pod</li><li>Destination IP, Destination Port</li><li>DNS Query Name</li><li>Protocol</li><li>Likely Service</li></ul> |
121+
| **Running Report**<br />See all network events<br />captured in near real-time | <ul><li>Timestamp (with microseconds)</li><li>Source IP, Source Port, Source PID</li><li>Source Command, Source Pod</li><li>Destination IP, Destination Port</li><li>DNS Query Name</li><li>Protocol</li><li>Likely Service</li></ul> |
122+
| **Report Summary**<br />Aggregated analysis of<br />captured network events| <ul><li>Total Events Count</li><li>Time Range (start/end)</li><li>Report Creation Date</li><li>Domain Names Requested (Domain, Count)</li><li>Destination IP Addresses Connected To (IP, Port, Count)</li><li>Source Details (expandable): Source IP, Service, Command, Pod</li></ul> |
123123

124124
### Vendor Portal
125125

@@ -129,10 +129,26 @@ To set the network policy and collect and view reports in the Vendor Portal:
129129

130130
2. To collect a network report, toggle on the switch under **Reporting**.
131131

132-
3. Toggle from `open` to `airgap` under **Policy Type** to block all network egress.
132+
3. (Optional) Toggle from `open` to `airgap` under **Policy Type** to block all network egress.
133133

134134
4. Where available, click "View report" under **Report** to see the reporting table. You can also click "Export JSON" to download the raw report data.
135135

136+
:::note
137+
When reporting is **ON** for an active network, all network events display in a **Running Report**. Once the network is terminated, the **Report Summary** is automatically generated.
138+
:::
139+
140+
**Running Report**
141+
142+
![Network Policy page with running report, showing all network events captured](/images/cmx-network-report.png)
143+
144+
[View a larger version of this image](/images/cmx-network-report.png)
145+
146+
**Report Summary**
147+
148+
![Network Policy page with report summary, showing domain names and destination IPs](/images/cmx-network-report-summary.png)
149+
150+
[View a larger version of this image](/images/cmx-network-report-summary.png)
151+
136152
### CLI
137153

138154
To collect and view a network report from the CLI:
102 KB
Loading
123 KB
Loading

0 commit comments

Comments
 (0)