Skip to content

Commit 2982d3d

Browse files
authored
Merge pull request #103572 from gwynnemonahan/OSDOCS-17459
OSDOCS-17459 [NETOBSERV] Module short descriptions for understanding-network-observability-operator.adoc
2 parents 5f86cf4 + 2a924c6 commit 2982d3d

File tree

3 files changed

+8
-1
lines changed

3 files changed

+8
-1
lines changed

modules/network-observability-architecture.adoc

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

9+
[role="_abstract"]
10+
Review the Network Observability Operator architecture, detailing how the `FlowCollector` resource manages the `eBPF agent`, which collects and enriches flows, sending the data to Loki for storage or Prometheus for metrics.
11+
912
The Network Observability Operator provides the `FlowCollector` API, which is instantiated at installation and configured to reconcile the `eBPF agent`, the `flowlogs-pipeline`, and the `netobserv-plugin` components. Only a single `FlowCollector` per cluster is supported.
1013

1114
The `eBPF agent` runs on each cluster node with some privileges to collect network flows. The `flowlogs-pipeline` receives the network flows data and enriches the data with Kubernetes identifiers. If you choose to use Loki, the `flowlogs-pipeline` sends flow logs data to Loki for storing and indexing. The `netobserv-plugin`, which is a dynamic {product-title} web console plugin, queries Loki to fetch network flows data. Cluster-admins can view the data in the web console.

modules/nw-network-observability-operator.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
[id="nw-network-observability-operator_{context}"]
66
= Viewing statuses
77

8+
[role="_abstract"]
9+
View the operational status of the Network Observability Operator by using the `oc get` command to check the `FlowCollector` resource status, as well as the status of the `eBPF agent`, `flowlogs-pipeline`, and console plugin Pods.
10+
811
The Network Observability Operator provides the Flow Collector API. When a Flow Collector resource is created, it deploys pods and services to create and store network flows in the Loki log store, as well as to display dashboards, metrics, and flows in the {product-title} web console.
912

1013
.Procedure

modules/nw-view-status-configuration-network-observability-operator.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
[id="nw-status-configuration-network-observability-operator_{context}"]
66
= Viewing Network Observability Operator status and configuration
77

8-
You can inspect the status and view the details of the `FlowCollector` using the `oc describe` command.
8+
[role="_abstract"]
9+
Inspect the current status, configuration details, and generated resources of the Network Observability Operator by using the `oc describe flowcollector/cluster` command.
910

1011
.Procedure
1112

0 commit comments

Comments
 (0)