Skip to content

Commit d64957f

Browse files
xenolinuxxenolinux
committed
OSDOCS#4612: Document the understanding Network Observability page
1 parent b10d0b8 commit d64957f

File tree

4 files changed

+122
-0
lines changed

4 files changed

+122
-0
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1317,6 +1317,8 @@ Topics:
13171317
File: installing-operators
13181318
- Name: Observing the network traffic
13191319
File: observing-network-traffic
1320+
- Name: Understanding Network Observability Operator
1321+
File: understanding-network-observability-operator
13201322
---
13211323
Name: Storage
13221324
Dir: storage

‎modules/nw-network-observability-operator.adoc

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
// Module included in the following assemblies:
2+
// * networking/network_observability/understanding-network-observability-operator.adoc
3+
4+
:_content-type: PROCEDURE
5+
[id="nw-network-observability-operator_{context}"]
6+
= Network Observability Operator
7+
8+
When you deploy flow collector, the Operator provides dashboards, metrics, and keeps flows accessible in the Grafana Loki log store. When a flow collector is deployed, new dashboards are available in the {product-title} console.
9+
10+
.Procedure
11+
12+
. Run the following command to view the state of `flowcollector`:
13+
+
14+
[source,terminal]
15+
----
16+
$ oc get flowcollector/cluster
17+
----
18+
+
19+
.Example output
20+
----
21+
NAME AGENT SAMPLING (EBPF) DEPLOYMENT MODEL STATUS
22+
cluster EBPF 50 DIRECT Ready
23+
----
24+
25+
. Check the status of pods running in the `netobserv` namespace by entering the following command:
26+
+
27+
[source,terminal]
28+
----
29+
$ oc get pods -n netobserv
30+
----
31+
+
32+
.Example output
33+
----
34+
NAME READY STATUS RESTARTS AGE
35+
flowlogs-pipeline-56hbp 1/1 Running 0 147m
36+
flowlogs-pipeline-9plvv 1/1 Running 0 147m
37+
flowlogs-pipeline-h5gkb 1/1 Running 0 147m
38+
flowlogs-pipeline-hh6kf 1/1 Running 0 147m
39+
flowlogs-pipeline-w7vv5 1/1 Running 0 147m
40+
netobserv-plugin-cdd7dc6c-j8ggp 1/1 Running 0 147m
41+
----
42+
43+
`flowlogs-pipeline` pods collect flows, enriches the collected flows, then send flows to the Loki storage.
44+
`netobserv-plugin` pods create a visualization plugin for the {product-title} Console.
45+
46+
. Check the status of pods running in the namespace `netobserv-privileged` by entering the following command:
47+
+
48+
[source,terminal]
49+
----
50+
$ oc get pods -n netobserv-privileged
51+
----
52+
+
53+
.Example output
54+
----
55+
NAME READY STATUS RESTARTS AGE
56+
netobserv-ebpf-agent-4lpp6 1/1 Running 0 151m
57+
netobserv-ebpf-agent-6gbrk 1/1 Running 0 151m
58+
netobserv-ebpf-agent-klpl9 1/1 Running 0 151m
59+
netobserv-ebpf-agent-vrcnf 1/1 Running 0 151m
60+
netobserv-ebpf-agent-xf5jh 1/1 Running 0 151m
61+
----
62+
63+
`netobserv-ebpf-agent` pods monitor network interfaces of the nodes to get flows and send them to `flowlogs-pipeline` pods.
64+
65+
. If you are using a Loki Operator, check the status of pods running in the `openshift-operators-redhat` namespace by entering the following command:
66+
+
67+
[source,terminal]
68+
----
69+
$ oc get pods -n openshift-operators-redhat
70+
----
71+
+
72+
.Example output
73+
----
74+
NAME READY STATUS RESTARTS AGE
75+
loki-operator-controller-manager-5f6cff4f9d-jq25h 2/2 Running 0 18h
76+
lokistack-compactor-0 1/1 Running 0 18h
77+
lokistack-distributor-654f87c5bc-qhkhv 1/1 Running 0 18h
78+
lokistack-distributor-654f87c5bc-skxgm 1/1 Running 0 18h
79+
lokistack-gateway-796dc6ff7-c54gz 2/2 Running 0 18h
80+
lokistack-index-gateway-0 1/1 Running 0 18h
81+
lokistack-index-gateway-1 1/1 Running 0 18h
82+
lokistack-ingester-0 1/1 Running 0 18h
83+
lokistack-ingester-1 1/1 Running 0 18h
84+
lokistack-ingester-2 1/1 Running 0 18h
85+
lokistack-querier-66747dc666-6vh5x 1/1 Running 0 18h
86+
lokistack-querier-66747dc666-cjr45 1/1 Running 0 18h
87+
lokistack-querier-66747dc666-xh8rq 1/1 Running 0 18h
88+
lokistack-query-frontend-85c6db4fbd-b2xfb 1/1 Running 0 18h
89+
lokistack-query-frontend-85c6db4fbd-jm94f 1/1 Running 0 18h
90+
----

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// Module included in the following assemblies:
2+
// * networking/network_observability/understanding-network-observability-operator.adoc
3+
4+
:_content-type: PROCEDURE
5+
[id="nw-status-configuration-network-observability-operator_{context}"]
6+
= Viewing Network Observability Operator status and configuration
7+
8+
You can inspect the status and view the details of the `flowcollector` using the `oc describe` command.
9+
10+
.Procedure
11+
12+
. Run the following command to view the status and configuration of the Network Observability Operator:
13+
+
14+
[source,terminal]
15+
----
16+
$ oc describe flowcollector/cluster
17+
----

‎networking/network_observability/understanding-network-observability-operator.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:_content-type: ASSEMBLY
2+
[id="nw-network-observability-operator"]
3+
= Network Observability Operator in {product-title}
4+
include::_attributes/common-attributes.adoc[]
5+
:context: nw-network-observability-operator
6+
7+
toc::[]
8+
9+
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.
10+
11+
include::modules/nw-network-observability-operator.adoc[leveloffset=+1]
12+
13+
include::modules/nw-view-status-configuration-network-observability-operator.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)