Skip to content

Commit bad8485

Browse files
committed
[WIP]OSDOCS#4603: Adds the overview page for Network Observability
1 parent 5636ad9 commit bad8485

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1295,6 +1295,8 @@ Topics:
12951295
- Name: Network Observability
12961296
Dir: network_observability
12971297
Topics:
1298+
- Name: Network Observability overview
1299+
File: network-observability-overview
12981300
- Name: Installing Network Observability operators
12991301
File: installing-operators
13001302
---
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
:_content-type: ASSEMBLY
2+
[id="network-observability-overview"]
3+
= About Network Observability
4+
include::_attributes/common-attributes.adoc[]
5+
:context: network-observability-overview
6+
7+
toc::[]
8+
9+
Red Hat offers cluster administrators the Network Observability Operator to observe the network traffic for {product-title} clusters. The Network Observability uses the eBPF technology to create network flows. The network flows are then enriched with {product-title} information and stored in Loki. You can view and analyze the stored netflow information in the {product-title} console for further insight and troubleshooting.
10+
11+
[id="dependency-network-observability"]
12+
== Dependency of Network Observability Operator
13+
14+
The Network Observability Operator requires the following Operators:
15+
16+
* Loki: You must install Loki. Loki is the backend that is used to store all collected flows. It is recommended to install Loki by installing the Red Hat Loki Operator for the installation of Network Observability Operator.
17+
18+
[id="optional-dependency-network-observability"]
19+
== Optional dependencies of the Network Observability Operator
20+
21+
* Grafana: You can install Grafana for using custom dashboards and querying capabilities, by using the Grafana Operator. Red Hat does not support Grafana Operator.
22+
* Kafka: It provides scalability, resiliency and high availability in the {product-title} cluster. It is recommended to install Kafka using the AMQ Streams operator for large scale deployments.
23+
24+
[id="network-observability-operator"]
25+
== Network Observability Operator
26+
27+
The Network Observability Operator deploys a monitoring pipeline to collect and enrich the network flows. The eBPF agent, which is deployed as a `daemonset` object, creates the network flows. The network flows are then collected and enriched with the Kubernetes metadata, before storing in Loki.
28+
29+
[id="no-console-integration"]
30+
== {product-title} console integration
31+
32+
{product-title} console integration offers overview, topology view and traffic flow tables.
33+
34+
[id="network-observability-dashboards"]
35+
=== Network Observability metrics
36+
37+
By using Network Observability metrics, you can refine the stats by using the filters and display options. The {product-title} console offers the *Overview* tab which displays the overall aggregated metrics of the network traffic flow on the cluster. You can access the information for node, namespace, owner, pod, and service.
38+
39+
[id="network-observability-topology-views"]
40+
=== Network Observability topology views
41+
42+
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 node, namespace, owner, pod, and service.
43+
44+
[id="traffic-flow-tables"]
45+
=== Traffic flow tables
46+
47+
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.
48+
49+
50+

0 commit comments

Comments
 (0)