From 431df7650a7ffe7a08daba1280c9632e66b451f1 Mon Sep 17 00:00:00 2001 From: Gwynne Monahan Date: Fri, 5 Dec 2025 10:46:25 -0600 Subject: [PATCH] OSDOCS-17455 [NETOBSERV] Module short descriptions for network-observability-overview.adoc --- modules/network-observability-cli.adoc | 5 ++++- modules/network-observability-dashboards.adoc | 3 +++ ...ervability-dependency-network-observability-operator.adoc | 5 ++++- .../network-observability-openshift-console-integration.adoc | 5 ++++- modules/network-observability-operator.adoc | 5 ++++- modules/network-observability-topology-views.adoc | 5 ++++- modules/network-observability-traffic-flow-tables.adoc | 5 ++++- 7 files changed, 27 insertions(+), 6 deletions(-) diff --git a/modules/network-observability-cli.adoc b/modules/network-observability-cli.adoc index 0bc54f77d54e..8ab118b9b565 100644 --- a/modules/network-observability-cli.adoc +++ b/modules/network-observability-cli.adoc @@ -6,4 +6,7 @@ [id="network-observability-cli_{context}"] = Network Observability CLI -You can quickly debug and troubleshoot networking issues with network observability by using the Network Observability command-line interface (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. \ No newline at end of file +[role="_abstract"] +The Network Observability CLI (`oc netobserv`) is a lightweight tool that streams flow and packet data for quick, live insight into networking issues without requiring the full Network Observability Operator installation. + +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. \ No newline at end of file diff --git a/modules/network-observability-dashboards.adoc b/modules/network-observability-dashboards.adoc index 3ccaaf6189da..9f79f9650801 100644 --- a/modules/network-observability-dashboards.adoc +++ b/modules/network-observability-dashboards.adoc @@ -6,6 +6,9 @@ [id="network-observability-dashboards_{context}"] = Network observability metrics dashboards +[role="_abstract"] +Review the network observability metrics dashboards in the {product-title} console, which provide overall traffic flow aggregation, filtering options, and dedicated dashboards for monitoring operator health. + In the {product-title} console on the *Overview* tab, you can view the overall aggregated metrics of the network traffic flow on the cluster. You can choose to display the information by cluster, node, namespace, owner, pod, and service. Filters and display options can further refine the metrics. For more information, see "Observing the network traffic from the Overview view". In *Observe* -> *Dashboards*, the *Netobserv* dashboards provide a quick overview of the network flows in your {product-title} cluster. The *Netobserv/Health* dashboard provides metrics about the health of the Operator. For more information, see "Network observability metrics" and "Viewing health information". \ No newline at end of file diff --git a/modules/network-observability-dependency-network-observability-operator.adoc b/modules/network-observability-dependency-network-observability-operator.adoc index 3338fc08cbd4..57c541fb0851 100644 --- a/modules/network-observability-dependency-network-observability-operator.adoc +++ b/modules/network-observability-dependency-network-observability-operator.adoc @@ -6,7 +6,10 @@ [id="network-observability-dependency-network-observability-operator_{context}"] = Optional dependencies of the Network Observability Operator -You can optionally integrate the Network Observability Operator with other components to enhance its functionality and scalability. Supported optional dependencies include the {loki-op} for flow storage, and AMQ Streams for large-scale data handling with Kafka. +[role="_abstract"] +Integrate the Network Observability Operator with optional dependencies, such as the {loki-op} for flow storage and AMQ Streams (Kafka) for resilient, large-scale data handling and scalability. + +Supported optional dependencies include the {loki-op} for flow storage, and AMQ Streams for large-scale data handling with Kafka. {loki-op}:: You can use Loki as the backend to store all collected flows with a maximal level of details. It is recommended to use the Red Hat supported {loki-op} to install Loki. You can also choose to use network observability without Loki, but you need to consider some factors. For more information, see "Network observability without Loki". diff --git a/modules/network-observability-openshift-console-integration.adoc b/modules/network-observability-openshift-console-integration.adoc index a3e5f122f7ea..f4ba39190f85 100644 --- a/modules/network-observability-openshift-console-integration.adoc +++ b/modules/network-observability-openshift-console-integration.adoc @@ -6,7 +6,10 @@ [id="network-observability-openshift-console-integration_{context}"] = {product-title} console integration -{product-title} console integration offers an overview, a topology view, and traffic flow tables. The Network observability metrics dashboards in *Observe* -> *Dashboards* are available only to users with administrator access. +[role="_abstract"] +The Network Observability Operator integrates with the {product-title} console, providing an overview, topology view, and traffic flow tables. + +The Network observability metrics dashboards in *Observe* -> *Dashboards* are available only to users with administrator access. [NOTE] ==== diff --git a/modules/network-observability-operator.adoc b/modules/network-observability-operator.adoc index 1e63b481e3f8..8ef1ea1fccc3 100644 --- a/modules/network-observability-operator.adoc +++ b/modules/network-observability-operator.adoc @@ -6,6 +6,9 @@ [id="network-observability-operator_{context}"] = Network Observability Operator -The Network Observability Operator provides the `FlowCollector` API custom resource. A `FlowCollector` instance is a cluster-scoped resource that enables configuration of network flow collection. This instance deploys pods and services that form a monitoring pipeline. +[role="_abstract"] +The Network Observability Operator provides the cluster-scoped `FlowCollector` API custom resource, which manages a pipeline of eBPF agents and services that collect, enrich, and store network flows in Loki or Prometheus. + +A `FlowCollector` instance deploys pods and services that form a monitoring pipeline. The `eBPF` agent is deployed as a `daemonset` object and creates the network flows. The pipeline collects and enriches network flows with Kubernetes metadata before storing them in Loki or generating Prometheus metrics. \ No newline at end of file diff --git a/modules/network-observability-topology-views.adoc b/modules/network-observability-topology-views.adoc index a3517d2b842c..bec3d7a8bb62 100644 --- a/modules/network-observability-topology-views.adoc +++ b/modules/network-observability-topology-views.adoc @@ -6,4 +6,7 @@ [id="network-observability-topology-views_{context}"] = Network observability topology views -The {product-title} console offers the *Topology* tab which displays a graphical representation of the network flows and the amount of traffic. The topology view represents traffic between the {product-title} components as a network graph. You can refine the graph by using the filters and display options. You can access the information for cluster, zone, udn, node, namespace, owner, pod, and service. \ No newline at end of file +[role="_abstract"] +The network observability topology view in the {product-title} console displays a graphical representation of traffic flow between components, which you can refine using various filters and display options. + +The {product-title} console offers the *Topology* tab which represents traffic between the {product-title} components as a network graph. You can refine the graph by using the filters and display options. You can access the information for cluster, zone, udn, node, namespace, owner, pod, and service. \ No newline at end of file diff --git a/modules/network-observability-traffic-flow-tables.adoc b/modules/network-observability-traffic-flow-tables.adoc index 13c8fdb54304..e9bb90126e23 100644 --- a/modules/network-observability-traffic-flow-tables.adoc +++ b/modules/network-observability-traffic-flow-tables.adoc @@ -6,4 +6,7 @@ [id="traffic-flow-tables_{context}"] = Traffic flow tables -The *Traffic flow* table view provides a view for raw flows, non aggregated filtering options, and configurable columns. The {product-title} console offers the *Traffic flows* tab which displays the data of the network flows and the amount of traffic. \ No newline at end of file +[role="_abstract"] +The *Traffic flow* tables in the {product-title} web console provide a detailed view of raw network flows, offering powerful filtering options and configurable columns for in-depth analysis. + +The *Traffic flows* tab in the {product-title} web console displays the data of the network flows and the amount of traffic. \ No newline at end of file