Skip to content

Commit c6d0ed4

Browse files
committed
Final edits for Network Reports
1 parent dc8b7ab commit c6d0ed4

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

docs/vendor/testing-network-policy.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -118,28 +118,26 @@ To set the network policy of a VM:
118118
```
119119
120120
1. (Optional) To verify that there is no outbound connectivity from the VM, enable network reporting and view network events. See [Collect and View Network Reports](#collect-and-view-network-reports).
121-
122121
## Collect and View Network Reports
123122
124-
Compatibility Matrix network reporting helps you understand your application's network activity. Even when the network policy is set to `airgap` and network egress is blocked, all connection attempts and DNS queries are still captured in the report. This helps you identify unexpected network calls which might be inappropriate in an air-gapped environment.
123+
Compatibility Matrix network reporting helps you understand your application's network activity. Even when the network policy is set to `airgap` and network egress is blocked, all connection attempts and DNS queries are still captured in the report. This helps you identify unexpected network calls before deploying to an air-gapped environment.
125124

126125
| Report Type | Contents |
127126
|---|---|
128-
| **Summary Report**<br />Aggregated analysis of<br />captured network events| <ul><li>Total Events Count</li><li>Time Range (start/end)</li><li>Domain Names Requested (Domain, Count)</li><li>Destination IP Addresses Connected To (IP, Port, Count)</li><li>Details: Source IP, Service, Command, Pod</li></ul> |
129-
| **Full Report**<br />See all network events<br />captured in near real-time | <ul><li>Timestamp</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> |
127+
| **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> |
128+
| **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> |
130129

131130
### Vendor Portal
132131

133132
In Vendor Portal, you can set network policy, and collect network reports:
134133

135134
1. Go to **Compatibility Matrix** > **Network Policy**.
136135

137-
1. To collect a network report, toggle on the switch under **Reporting**.
138-
139-
1. Toggle from `open` to `airgap` under **Policy Type** to block all network egress.
136+
2. To collect a network report, toggle on the switch under **Reporting**.
140137

141-
1. Where available, click "View" under **Report** to see the reporting table.
138+
3. Toggle from `open` to `airgap` under **Policy Type** to block all network egress.
142139

140+
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.
143141

144142
### CLI
145143

@@ -152,7 +150,7 @@ To collect and view a network report from the CLI:
152150
```
153151
Where `NETWORK_ID` is the ID of the network. You can get the network ID by running `replicated network ls`.
154152

155-
1. (Optional) Confirm that reporting is `on` for the network:
153+
1. (Optional) Confirm that reporting is **ON** for the network:
156154

157155
```bash
158156
replicated network ls
@@ -186,7 +184,7 @@ To collect and view a network report from the CLI:
186184
```
187185

188186
:::note
189-
Network events might have a one to two second delay before appearing in network reports.
187+
Network events are batched for display in the report, so appear with a short delay.
190188
:::
191189

192190

0 commit comments

Comments
 (0)