Documents

This repo contains various documents related to network observability (a.k.a. netobserv):

Repositories

• netobserv-operator OpenShift / Kubernetes operator for network observability. This operator will deloy the following components:
  • eBPF Agent: An eBPF agent that captures and exports network flows.
  • flowlogs-pipeline: A configurable flow collector, enricher and metrics producer.
  • netobserv-plugin: The NetObserv plugin for the Openshift Console.
• nflow-generator: A fake legacy v5 netflow generator
• etc.

Get started

The easiest way to get started is to use the NetObserv Operator that will deploy all the components for you. It is available via OLM.

You can either:

• Deploy an existing image
• Build from sources

Development

You will need a Kubernetes cluster, such as Kind or OpenShift.

If you don't need the entire stack, you can just check components above.

Other links

• Blogs: Blog articles
• Examples: Various example configurations
• Hack: Hack scripts
• ACM: Setup Advanced Cluster Management with NetObserv metrics
• CNO: Hacks to deploy development version of the CNO and OVN-Kubernetes
• DEX: Hacks on Dex
• Kafka: Deploy Kafka on Openshift using Strimzi Operator
• Kind: Setup ovn-kubernetes on KIND
• Loki config: Custom Loki Configuration for NetObserv
• Loki microservices: Scalable loki deployment
• Loki operator: Deploying NetObserv with the Loki Operator
• Loki simple: Automatic deployment Loki with the Network Observability Operator
• Next: Informal doc gathering ideas about potential next steps.
• Openshift: Deploy using OpenShift Container Platform
• Sample apps: a few suggestions to generate traffic, useful for testing NetObserv.