Skip to content

Commit 68b87e5

Browse files
authored
Merge pull request #103023 from gwynnemonahan/OSDOCS-17449
OSDOCS-17449 [NETOBSERV] Module short descriptions for netobserv_cli
2 parents 586108e + c800581 commit 68b87e5

5 files changed

+16
-9
lines changed

modules/network-observability-cli-capturing-flows.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66
[id="network-observability-cli-capturing-flows_{context}"]
77
= Capturing flows
88

9-
You can capture flows and filter on any resource or zone in the data to solve use cases, such as displaying Round-Trip Time (RTT) between two zones. Table visualization in the CLI provides viewing and flow search capabilities.
9+
[role="_abstract"]
10+
Capture network flows and apply filters based on resources or zones directly in the CLI. This helps you solve complex use cases, such as visualizing the Round-Trip Time (RTT) between two different zones.
11+
12+
Table visualization in the CLI provides viewing and flow search capabilities.
1013

1114
.Prerequisites
1215
* Install the {oc-first}.
@@ -20,13 +23,13 @@ You can capture flows and filter on any resource or zone in the data to solve us
2023
$ oc netobserv flows --enable_filter=true --action=Accept --cidr=0.0.0.0/0 --protocol=TCP --port=49051
2124
----
2225
. Add filters to the `live table filter` prompt in the terminal to further refine the incoming flows. For example:
23-
+
26+
+
2427
[source,terminal]
2528
----
2629
live table filter: [SrcK8S_Zone:us-west-1b] press enter to match multiple regular expressions at once
2730
----
2831
. Use the *PageUp* and *PageDown* keys to toggle between *None*, *Resource*, *Zone*, *Host*, *Owner* and *all of the above*.
29-
. To stop capturing, press kbd:[Ctrl+C]. The data that was captured is written to two separate files in an `./output` directory located in the same path used to install the CLI.
32+
. To stop capturing, press kbd:[Ctrl+C]. The data that was captured is written to two separate files in an `./output` directory located in the same path used to install the CLI.
3033
. View the captured data in the `./output/flow/<capture_date_time>.json` JSON file, which contains JSON arrays of the captured data.
3134
+
3235
.Example JSON file

modules/network-observability-cli-capturing-metrics.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
[id="network-observability-cli-capturing-metrics_{context}"]
77
= Capturing metrics
88

9-
You can generate on-demand dashboards in Prometheus by using a service monitor for network observability.
9+
[role="_abstract"]
10+
Generate on-demand network observability dashboards in Prometheus using a service monitor. This allows you to quickly view and analyze network metrics.
1011

1112
.Prerequisites
1213
* Install the {oc-first}.

modules/network-observability-cli-capturing-packets.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
[id="network-observability-cli-capturing-packets_{context}"]
77
= Capturing packets
88

9-
You can capture packets using the Network Observability CLI.
9+
[role="_abstract"]
10+
Use the Network Observability CLI to capture network packets. You can apply filters and refine them live in the terminal for accurate, real-time debugging.
1011

1112
.Prerequisites
1213
* Install the {oc-first}.

modules/network-observability-netobserv-cli-about.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66
[id="network-observability-netoberv-cli-about_{context}"]
77
= About the Network Observability CLI
88

9-
You can quickly debug and troubleshoot networking issues by using the Network Observability CLI (`oc netobserv`). The Network Observability CLI is a flow and packet visualization tool that relies on eBPF agents to stream collected data to an ephemeral collector pod. It requires no persistent storage during the capture. After the run, the output is transferred to your local machine. This enables quick, live insight into packets and flow data without installing the Network Observability Operator.
9+
[role="_abstract"]
10+
Use the Network Observability CLI (`oc netobserv`) to quickly debug and troubleshoot networking issues. This tool provides instant, live insight into flows and packets without installing the Network Observability Operator.
11+
12+
The Network Observability CLI is a flow and packet visualization tool that relies on eBPF agents to stream collected data to an ephemeral collector pod. It requires no persistent storage during the capture. After the run, the output is transferred to your local machine.
1013

1114
[IMPORTANT]
1215
====

modules/network-observability-netobserv-cli-cleaning.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@
66
[id="network-observability-cli-uninstall_{context}"]
77
= Cleaning the Network Observability CLI
88

9-
You can manually clean the CLI workload by running `oc netobserv cleanup`. This command removes all the CLI components from your cluster.
10-
11-
When you end a capture, this command is run automatically by the client. You might be required to manually run it if you experience connectivity issues.
9+
[role="_abstract"]
10+
Use `oc netobserv cleanup` to manually remove all components installed by the Network Observability CLI from your cluster. While the client runs this command automatically after a capture, you may need to run it manually if you face connectivity issues.
1211

1312
.Procedure
1413
* Run the following command:

0 commit comments

Comments
 (0)