Chapter 5. Network Observability Operator in OpenShift Container Platform
Network Observability is an OpenShift operator that deploys a monitoring pipeline to collect and enrich network traffic flows that are produced by the Network Observability eBPF agent.
5.1. Viewing statuses Copy linkLink copied to clipboard!
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 OpenShift Container Platform web console.
Procedure
Run the following command to view the state of
FlowCollector
:oc get flowcollector/cluster
$ oc get flowcollector/cluster
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
NAME AGENT SAMPLING (EBPF) DEPLOYMENT MODEL STATUS cluster EBPF 50 DIRECT Ready
NAME AGENT SAMPLING (EBPF) DEPLOYMENT MODEL STATUS cluster EBPF 50 DIRECT Ready
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Check the status of pods running in the
netobserv
namespace by entering the following command:oc get pods -n netobserv
$ oc get pods -n netobserv
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
Copy to Clipboard Copied! Toggle word wrap Toggle overflow The
flowlogs-pipeline
pods collect flows, enriches the collected flows, then send flows to the Loki storage.netobserv-plugin
pods create a visualization plugin for the OpenShift Container Platform Console.Check the status of pods running in the namespace
netobserv-privileged
by entering the following command:oc get pods -n netobserv-privileged
$ oc get pods -n netobserv-privileged
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
Copy to Clipboard Copied! Toggle word wrap Toggle overflow The
netobserv-ebpf-agent
pods monitor network interfaces of the nodes to get flows and send them toflowlogs-pipeline
pods.If you are using the Loki Operator, check the status of the
component
pods ofLokiStack
custom resource in thenetobserv
namespace by entering the following command:oc get pods -n netobserv
$ oc get pods -n netobserv
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.2. Network Observablity Operator architecture Copy linkLink copied to clipboard!
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.
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 OpenShift Container Platform web console plugin, queries Loki to fetch network flows data. Cluster-admins can view the data in the web console.
If you do not use Loki, you can generate metrics with Prometheus. Those metrics and their related dashboards are accessible in the web console. For more information, see "Network Observability without Loki".
If you are using the Kafka option, the eBPF agent sends the network flow data to Kafka, and the flowlogs-pipeline
reads from the Kafka topic before sending to Loki, as shown in the following diagram.
5.3. Viewing Network Observability Operator status and configuration Copy linkLink copied to clipboard!
You can inspect the status and view the details of the FlowCollector
using the oc describe
command.
Procedure
Run the following command to view the status and configuration of the Network Observability Operator:
oc describe flowcollector/cluster
$ oc describe flowcollector/cluster
Copy to Clipboard Copied! Toggle word wrap Toggle overflow