Doc: more vendor neutrality (#2459)

* Doc: more vendor neutrality

* even more netutrality

Author: jotak

README.md

@@ -4,29 +4,29 @@
 [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/NetObserv)](https://artifacthub.io/packages/helm/netobserv/netobserv-operator)
 [![Go Report Card](https://goreportcard.com/badge/github.com/netobserv/network-observability-operator)](https://goreportcard.com/report/github.com/netobserv/network-observability-operator)
 
-NetObserv Operator is a Kubernetes / OpenShift operator for network observability. It deploys a monitoring pipeline that consists in:
-- an eBPF agent, that generates network flows from captured packets
-- flowlogs-pipeline, a component that collects, enriches and exports these flows
-- when used in OpenShift, a Console plugin for flows visualization with powerful filtering options, a topology representation and more
+NetObserv Operator is a Kubernetes operator for network observability. It deploys a monitoring pipeline that consists in:
+- An eBPF agent, that generates network flows from captured packets.
+- Flowlogs-pipeline, a component that collects, enriches and exports these flows.
+- A web console for flows visualization with powerful filtering options, a topology representation, a network health view, etc.
 
 Flow data is then available in multiple ways, each optional:
 
-- As Prometheus metrics
-- As raw flow logs stored in Loki
-- As raw flow logs exported to a collector
+- As Prometheus metrics.
+- As raw flow logs stored in Loki.
+- As raw flow logs exported to a collector via Kafka, OpenTelemetry or IPFIX.
 
 ## Getting Started
 
 You can install the NetObserv Operator using [Helm](https://helm.sh/), or directly from sources.
 
-In OpenShift, NetObserv is named Network Observability operator and can be found in OperatorHub as an OLM operator. This section does not apply to it: please refer to the [OpenShift documentation](docs.redhat.com/en/documentation/openshift_container_platform/latest/html/network_observability/installing-network-observability-operators) in that case.
-
-> [!IMPORTANT]
-> NetObserv community was previously distributed via [OperatorHub](https://operatorhub.io/operator/netobserv-operator). This installation method is replaced with a helm chart. If you previously installed NetObserv community from OperatorHub, we recommend that you uninstall it, and re-install using the helm chart. The operation should not cause any data loss.
+> [!TIP]
+NetObserv can be used in downstream products, which may provide their own documentation. If you are using such a product, please refer to that documentation instead:
+> 
+> - On OpenShift: [see Network Observability operator](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/network_observability/installing-network-observability-operators).
 
 ### Pre-requisite
 
-The following architectures are supported: amd64, arm64, ppc64le and s390x.
+The following architectures are supported: _amd64_, _arm64_, _ppc64le_ and _s390x_.
 
 NetObserv has a couple of dependencies that must be installed on your cluster:
 
@@ -54,12 +54,10 @@ Loki is not mandatory but improves the overall experience with NetObserv.
 helm repo add netobserv https://netobserv.io/static/helm/ --force-update
 
 # Standalone install, including dependencies:
-helm install my-netobserv -n netobserv --create-namespace --set standaloneConsole.enable=true --set install.loki=true --set install.prom-stack=true netobserv/netobserv-operator
+helm install my-netobserv -n netobserv --create-namespace --set install.loki=true --set install.prom-stack=true netobserv/netobserv-operator
 
 # OR minimal install (Prometheus/Loki must be installed separately)
-helm install my-netobserv -n netobserv --create-namespace --set standaloneConsole.enable=true netobserv/netobserv-operator
-
-# If you're in OpenShift, you can omit "--set standaloneConsole.enable=true" to use the Console plugin instead.
+helm install my-netobserv -n netobserv --create-namespace netobserv/netobserv-operator
 ```
 
 You can now create a `FlowCollector` resource. Refer to the [Configuration section](#configuration) of this document. A short `FlowCollector` should work, using most default values, plus with the standalone console enabled:
@@ -95,7 +93,6 @@ EOF
 ```
 
 A few remarks:
-- `spec.consolePlugin.standalone` can be set to true to deploy the [web console](https://github.com/netobserv/network-observability-console-plugin) as a standalone, as opposed to an OpenShift Console plugin. If you're in OpenShift, it's not recommended to set this mode, so you get a more integrated experience with the Console.
 - You can change the Prometheus and Loki URLs depending on your installation. This example works if you use the "standalone" installation described above, with `install.loki=true` and `install.prom-stack=true`. Check more configuration options for [Prometheus](https://github.com/netobserv/network-observability-operator/blob/main/docs/FlowCollector.md#flowcollectorspecprometheus-1) and [Loki](https://github.com/netobserv/network-observability-operator/blob/main/docs/FlowCollector.md#flowcollectorspecloki-1).
 - You can enable networkPolicy, which makes the operator lock down the namespaces that it manages; however, this is highly dependent on your cluster topology, and may cause malfunctions, such as preventing NetObserv pods from communicating with the Kube API server.
 - The processor env `SERVER_NOTLS` means that the communication between eBPF agents and Flowlogs-pipeline won't be encrypted. To enable TLS, you need to supply the TLS certificates to Flowlogs-pipeline (a Secret named `flowlogs-pipeline-cert`), and the CA to the eBPF agents (a ConfigMap named `flowlogs-pipeline-ca` in the privileged namespace). [Check this issue](https://github.com/netobserv/network-observability-operator/issues/2360) if you want to help making it simpler.
@@ -141,11 +138,9 @@ Refer to the [Configuration section](#configuration) of this document.
 
 Historically, Grafana Loki was a strict dependency but it isn't anymore. If you don't want to install it, you can still get the Prometheus metrics, and/or export raw flows to a custom collector. But be aware that some of the Console plugin features will be disabled. For instance, you will not be able to view raw flows there, and the metrics / topology will have a more limited level of details, missing information such as pods or IPs.
 
-### OpenShift Console
-
-_Pre-requisite: OpenShift 4.10 or above_
+### Web Console
 
-If the OpenShift Console is detected in the cluster, a console plugin is deployed when a `FlowCollector` is installed. It adds new pages and tabs to the console:
+When `FlowCollector` is installed, a standalone web console is deployed or, when available, a console plugin. It provides the following views:
 
 #### Overview metrics
 
@@ -168,12 +163,6 @@ The table view shows raw flows, ie. non aggregated, still with the same filterin
 
 ![Flow table](./docs/assets/network-traffic-main.png)
 
-#### Integration with existing console views
-
-These views are accessible directly from the main menu, and also as contextual tabs for any Pod, Deployment, Service (etc.) in their details page, with filters set to focus on that particular resource.
-
-![Contextual topology](./docs/assets/topology-pod.png)
-
 ## Configuration
 
 The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](./docs/FlowCollector.md), and a full sample file [there](./config/samples/flows_v1beta2_flowcollector.yaml).
@@ -267,7 +256,7 @@ More information about multi-tenancy can be found on [this page](https://github.
 
 For a production deployment, it is highly recommended to lock down the `netobserv` namespace (or wherever NetObserv is installed) using network policies.
 
-You can set `spec.networkPolicy.enable` to `true` to make NetObserv install automatically a network policy. The policy may need to be fined-tuned for your environment (e.g. for access to kube apiserver, or Prometheus). It has been mostly tested on OpenShift.
+You can set `spec.networkPolicy.enable` to `true` to make NetObserv install automatically a network policy. The policy may need to be fined-tuned for your environment (e.g. for access to kube apiserver, or Prometheus), by adding authorized namespaces.
 
 A simple example of network policy is [provided here](https://github.com/netobserv/documents/blob/main/examples/lockdown-netobserv.yaml).
 

RELEASE.md

@@ -45,7 +45,7 @@ When all component drafts are ready, you can test the helm chart on your cluster
 helm repo add cert-manager https://charts.jetstack.io
 helm install my-cert-manager cert-manager/cert-manager --set crds.enabled=true
 
-helm install my-netobserv -n netobserv --create-namespace --set standaloneConsole.enable=true --set install.loki=true --set install.prom-stack=true ./helm
+helm install my-netobserv -n netobserv --create-namespace --set install.loki=true --set install.prom-stack=true ./helm
 
 cat <<EOF | kubectl apply -f -
 apiVersion: flows.netobserv.io/v1beta2

helm/README.md

@@ -1,25 +1,28 @@
 # NetObserv Operator
 
-NetObserv Operator is a Kubernetes / OpenShift operator for network observability. It deploys a monitoring pipeline that consists in:
-- an eBPF agent, that generates network flows from captured packets
-- flowlogs-pipeline, a component that collects, enriches and exports these flows
-- when used in OpenShift, a Console plugin for flows visualization with powerful filtering options, a topology representation and more
+NetObserv Operator is a Kubernetes operator for network observability. It deploys a monitoring pipeline that consists in:
+- An eBPF agent, that generates network flows from captured packets.
+- Flowlogs-pipeline, a component that collects, enriches and exports these flows.
+- A web console for flows visualization with powerful filtering options, a topology representation, a network health view, etc.
 
 Flow data is then available in multiple ways, each optional:
 
-- As Prometheus metrics
-- As raw flow logs stored in Loki
-- As raw flow logs exported to a collector
+- As Prometheus metrics.
+- As raw flow logs stored in Loki.
+- As raw flow logs exported to a collector via Kafka, OpenTelemetry or IPFIX.
 
 ## Getting Started
 
 You can install the NetObserv Operator using [Helm](https://helm.sh/), or directly from sources.
 
-In OpenShift, NetObserv is named Network Observability operator and can be found in OperatorHub as an OLM operator. This section does not apply to it: please refer to the [OpenShift documentation](docs.redhat.com/en/documentation/openshift_container_platform/latest/html/network_observability/installing-network-observability-operators) in that case.
+> [!TIP]
+NetObserv can be used in downstream products, which may provide their own documentation. If you are using such a product, please refer to that documentation instead:
+> 
+> - On OpenShift: [see Network Observability operator](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/network_observability/installing-network-observability-operators).
 
 ### Pre-requisite
 
-The following architectures are supported: amd64, arm64, ppc64le and s390x.
+The following architectures are supported: _amd64_, _arm64_, _ppc64le_ and _s390x_.
 
 NetObserv has a couple of dependencies that must be installed on your cluster:
 
@@ -47,12 +50,10 @@ Loki is not mandatory but improves the overall experience with NetObserv.
 helm repo add netobserv https://netobserv.io/static/helm/ --force-update
 
 # Standalone install, including dependencies:
-helm install my-netobserv -n netobserv --create-namespace --set standaloneConsole.enable=true --set install.loki=true --set install.prom-stack=true netobserv/netobserv-operator
+helm install my-netobserv -n netobserv --create-namespace --set install.loki=true --set install.prom-stack=true netobserv/netobserv-operator
 
 # OR minimal install (Prometheus/Loki must be installed separately)
-helm install my-netobserv -n netobserv --create-namespace --set standaloneConsole.enable=true netobserv/netobserv-operator
-
-# If you're in OpenShift, you can omit "--set standaloneConsole.enable=true" to use the Console plugin instead.
+helm install my-netobserv -n netobserv --create-namespace netobserv/netobserv-operator
 ```
 
 You can now create a `FlowCollector` resource ([full API reference](https://github.com/netobserv/network-observability-operator/blob/main/docs/FlowCollector.md#flowsnetobserviov1beta2)). A short `FlowCollector` should work, using most default values, plus with the standalone console enabled:
@@ -88,7 +89,6 @@ EOF
 ```
 
 A few remarks:
-- `spec.consolePlugin.standalone` can be set to true to deploy the [web console](https://github.com/netobserv/network-observability-console-plugin) as a standalone, as opposed to an OpenShift Console plugin. If you're in OpenShift, it's not recommended to set this mode, so you get a more integrated experience with the Console.
 - You can change the Prometheus and Loki URLs depending on your installation. This example works if you use the "standalone" installation described above, with `install.loki=true` and `install.prom-stack=true`. Check more configuration options for [Prometheus](https://github.com/netobserv/network-observability-operator/blob/main/docs/FlowCollector.md#flowcollectorspecprometheus-1) and [Loki](https://github.com/netobserv/network-observability-operator/blob/main/docs/FlowCollector.md#flowcollectorspecloki-1).
 - You can enable networkPolicy, which makes the operator lock down the namespaces that it manages; however, this is highly dependent on your cluster topology, and may cause malfunctions, such as preventing NetObserv pods from communicating with the Kube API server.
 - The processor env `SERVER_NOTLS` means that the communication between eBPF agents and Flowlogs-pipeline won't be encrypted. To enable TLS, you need to supply the TLS certificates to Flowlogs-pipeline (a Secret named `flowlogs-pipeline-cert`), and the CA to the eBPF agents (a ConfigMap named `flowlogs-pipeline-ca` in the privileged namespace).

helm/values.yaml

@@ -16,7 +16,7 @@ consolePlugin:
   image: quay.io/netobserv/network-observability-console-plugin
   version: v1.11.0-community
 standaloneConsole:
-  enable: false
+  enable: true
   image: quay.io/netobserv/network-observability-standalone-frontend
   version: v1.11.0-community
 operator: