{"id":21511495,"url":"https://github.com/netobserv/documents","last_synced_at":"2025-03-17T15:22:24.190Z","repository":{"id":37906228,"uuid":"425901565","full_name":"netobserv/documents","owner":"netobserv","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-14T10:16:17.000Z","size":18057,"stargazers_count":0,"open_issues_count":0,"forks_count":14,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-14T11:25:32.873Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netobserv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-08T15:56:26.000Z","updated_at":"2025-03-14T10:16:21.000Z","dependencies_parsed_at":"2025-03-14T11:34:05.971Z","dependency_job_id":null,"html_url":"https://github.com/netobserv/documents","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netobserv%2Fdocuments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netobserv%2Fdocuments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netobserv%2Fdocuments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netobserv%2Fdocuments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netobserv","download_url":"https://codeload.github.com/netobserv/documents/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244056431,"owners_count":20390720,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-23T22:14:27.313Z","updated_at":"2025-03-17T15:22:24.165Z","avatar_url":"https://github.com/netobserv.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Documents\nThis repo contains various documents related to network observability (a.k.a. netobserv):\n\n### Repositories\n* [netobserv-operator](https://github.com/netobserv/network-observability-operator)\n    OpenShift / Kubernetes operator for network observability.\n    This operator will deloy the following components:\n    * [eBPF Agent](https://github.com/netobserv/netobserv-ebpf-agent): An eBPF agent that captures and exports network flows.\n    * [flowlogs-pipeline](https://github.com/netobserv/flowlogs-pipeline): A configurable flow collector, enricher and metrics producer.\n    * [netobserv-plugin](https://github.com/netobserv/network-observability-console-plugin):\n    The NetObserv plugin for the Openshift Console.\n* [nflow-generator](https://github.com/netobserv/nflow-generator):\nA fake legacy v5 netflow generator\n* etc.\n\n### Get started\nThe 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).\n\nYou can either:\n- [Deploy an existing image](https://github.com/netobserv/network-observability-operator#deploy-an-existing-image)\n- [Build from sources](https://github.com/netobserv/network-observability-operator#build--push--deploy)\n\n### Development\n\nYou will need a Kubernetes cluster, such as [Kind](./kind.md) or [OpenShift](./openshift.md).\n\nIf you don't need the entire stack, you can just [check components](#repositories) above.\n\n### Other links\n\n- [Blogs](./blogs/index.md): Blog articles\n- [Examples](./examples/): Various example configurations\n- [Hack](./hack/): Hack scripts\n- [ACM](./acm.md): Setup Advanced Cluster Management with NetObserv metrics\n- [CNO](./hack_cno.md): Hacks to deploy development version of the CNO and OVN-Kubernetes\n- [DEX](./hack_dex.md): Hacks on Dex\n- [Kafka](./kafka.md): Deploy Kafka on Openshift using Strimzi Operator\n- [Kind](./kind.md): Setup ovn-kubernetes on KIND\n- [Loki config](./loki_config.md): Custom Loki Configuration for NetObserv\n- [Loki microservices](./loki_microservices.md): Scalable loki deployment\n- [Loki operator](./loki_operator.md): Deploying NetObserv with the Loki Operator\n- [Loki simple](./loki_simple.md): Automatic deployment Loki with the Network Observability Operator\n- [Next](./next.md): Informal doc gathering ideas about potential next steps.\n- [Openshift](./openshift.md): Deploy using OpenShift Container Platform\n- [Sample apps](./sample_apps.md): a few suggestions to generate traffic, useful for testing NetObserv.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetobserv%2Fdocuments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetobserv%2Fdocuments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetobserv%2Fdocuments/lists"}