https://github.com/netobserv/documents
https://github.com/netobserv/documents
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/netobserv/documents
- Owner: netobserv
- Created: 2021-11-08T15:56:26.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-14T10:16:17.000Z (over 1 year ago)
- Last Synced: 2025-03-14T11:25:32.873Z (over 1 year ago)
- Language: Shell
- Size: 17.2 MB
- Stars: 0
- Watchers: 3
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
## Documents
This repo contains various documents related to network observability (a.k.a. netobserv):
### Repositories
* [netobserv-operator](https://github.com/netobserv/network-observability-operator)
OpenShift / Kubernetes operator for network observability.
This operator will deloy the following components:
* [eBPF Agent](https://github.com/netobserv/netobserv-ebpf-agent): An eBPF agent that captures and exports network flows.
* [flowlogs-pipeline](https://github.com/netobserv/flowlogs-pipeline): A configurable flow collector, enricher and metrics producer.
* [netobserv-plugin](https://github.com/netobserv/network-observability-console-plugin):
The NetObserv plugin for the Openshift Console.
* [nflow-generator](https://github.com/netobserv/nflow-generator):
A fake legacy v5 netflow generator
* etc.
### Get started
The easiest way to get started is to use the [NetObserv Operator](https://github.com/netobserv/network-observability-operator) that will deploy all the components for you. It is available via [OLM](https://operatorhub.io/operator/netobserv-operator).
You can either:
- [Deploy an existing image](https://github.com/netobserv/network-observability-operator#deploy-an-existing-image)
- [Build from sources](https://github.com/netobserv/network-observability-operator#build--push--deploy)
### Development
You will need a Kubernetes cluster, such as [Kind](./kind.md) or [OpenShift](./openshift.md).
If you don't need the entire stack, you can just [check components](#repositories) above.
### Other links
- [Blogs](./blogs/index.md): Blog articles
- [Examples](./examples/): Various example configurations
- [Hack](./hack/): Hack scripts
- [ACM](./acm.md): Setup Advanced Cluster Management with NetObserv metrics
- [CNO](./hack_cno.md): Hacks to deploy development version of the CNO and OVN-Kubernetes
- [DEX](./hack_dex.md): Hacks on Dex
- [Kafka](./kafka.md): Deploy Kafka on Openshift using Strimzi Operator
- [Kind](./kind.md): Setup ovn-kubernetes on KIND
- [Loki config](./loki_config.md): Custom Loki Configuration for NetObserv
- [Loki microservices](./loki_microservices.md): Scalable loki deployment
- [Loki operator](./loki_operator.md): Deploying NetObserv with the Loki Operator
- [Loki simple](./loki_simple.md): Automatic deployment Loki with the Network Observability Operator
- [Next](./next.md): Informal doc gathering ideas about potential next steps.
- [Openshift](./openshift.md): Deploy using OpenShift Container Platform
- [Sample apps](./sample_apps.md): a few suggestions to generate traffic, useful for testing NetObserv.