Skip to content

Commit d6cdbe0

Browse files
authored
Merge pull request #103678 from gwynnemonahan/manual-cherry-pick-enterprise-4-16-OSDOCS-17455
[enterprise-4.16] OSDOCS-17455 [NETOBSERV] Module short descriptions for network-observability-overview.adoc
2 parents 633f284 + 20d99aa commit d6cdbe0

7 files changed

+27
-6
lines changed

modules/network-observability-cli.adoc

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

9-
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.
9+
[role="_abstract"]
10+
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.
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. This enables quick, live insight into packets and flow data without installing the Network Observability Operator.

modules/network-observability-dashboards.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
[id="network-observability-dashboards_{context}"]
77
= Network observability metrics dashboards
88

9+
[role="_abstract"]
10+
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.
11+
912
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".
1013

1114
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".

modules/network-observability-dependency-network-observability-operator.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66
[id="network-observability-dependency-network-observability-operator_{context}"]
77
= Optional dependencies of the Network Observability Operator
88

9-
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.
9+
[role="_abstract"]
10+
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.
11+
12+
Supported optional dependencies include the {loki-op} for flow storage, and AMQ Streams for large-scale data handling with Kafka.
1013

1114
{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".
1215

modules/network-observability-openshift-console-integration.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66
[id="network-observability-openshift-console-integration_{context}"]
77
= {product-title} console integration
88

9-
{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.
9+
[role="_abstract"]
10+
The Network Observability Operator integrates with the {product-title} console, providing an overview, topology view, and traffic flow tables.
11+
12+
The Network observability metrics dashboards in *Observe* -> *Dashboards* are available only to users with administrator access.
1013

1114
[NOTE]
1215
====

modules/network-observability-operator.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
[id="network-observability-operator_{context}"]
77
= Network Observability Operator
88

9-
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.
9+
[role="_abstract"]
10+
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.
11+
12+
A `FlowCollector` instance deploys pods and services that form a monitoring pipeline.
1013

1114
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.

modules/network-observability-topology-views.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,7 @@
66
[id="network-observability-topology-views_{context}"]
77
= Network observability topology views
88

9-
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.
9+
[role="_abstract"]
10+
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.
11+
12+
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.

modules/network-observability-traffic-flow-tables.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,7 @@
66
[id="traffic-flow-tables_{context}"]
77
= Traffic flow tables
88

9-
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.
9+
[role="_abstract"]
10+
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.
11+
12+
The *Traffic flows* tab in the {product-title} web console displays the data of the network flows and the amount of traffic.

0 commit comments

Comments
 (0)