Skip to content

Commit c7443c4

Browse files
committed
even more netutrality
1 parent dd8ba7f commit c7443c4

File tree

3 files changed

+9
-11
lines changed

3 files changed

+9
-11
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ Flow data is then available in multiple ways, each optional:
2020
You can install the NetObserv Operator using [Helm](https://helm.sh/), or directly from sources.
2121

2222
> [!TIP]
23-
> If you are running on OpenShift, please refer to the [product documentation](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/network_observability/installing-network-observability-operators) instead. NetObserv is referred to as the Network Observability operator there.
23+
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:
24+
>
25+
> - On OpenShift: [see Network Observability operator](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/network_observability/installing-network-observability-operators).
2426
2527
### Pre-requisite
2628

@@ -56,8 +58,6 @@ helm install my-netobserv -n netobserv --create-namespace --set install.loki=tru
5658

5759
# OR minimal install (Prometheus/Loki must be installed separately)
5860
helm install my-netobserv -n netobserv --create-namespace netobserv/netobserv-operator
59-
60-
# If you're in OpenShift, you can use "--set standaloneConsole.enable=false" to use the Console plugin instead.
6161
```
6262

6363
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:
@@ -93,7 +93,6 @@ EOF
9393
```
9494

9595
A few remarks:
96-
- `spec.consolePlugin.standalone` can be set to true to deploy the [web console](https://github.com/netobserv/network-observability-console-plugin) as a standalone.
9796
- 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).
9897
- 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.
9998
- 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,7 +140,7 @@ Historically, Grafana Loki was a strict dependency but it isn't anymore. If you
141140

142141
### Web Console
143142

144-
When `FlowCollector` is installed, a standalone web console is deployed or, if running in OpenShift, an OpenShift Console plugin. It provides the following views:
143+
When `FlowCollector` is installed, a standalone web console is deployed or, when available, a console plugin. It provides the following views:
145144

146145
#### Overview metrics
147146

@@ -257,7 +256,7 @@ More information about multi-tenancy can be found on [this page](https://github.
257256

258257
For a production deployment, it is highly recommended to lock down the `netobserv` namespace (or wherever NetObserv is installed) using network policies.
259258

260-
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 with OVN-Kubernetes.
259+
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.
261260

262261
A simple example of network policy is [provided here](https://github.com/netobserv/documents/blob/main/examples/lockdown-netobserv.yaml).
263262

RELEASE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ When all component drafts are ready, you can test the helm chart on your cluster
4545
helm repo add cert-manager https://charts.jetstack.io
4646
helm install my-cert-manager cert-manager/cert-manager --set crds.enabled=true
4747

48-
helm install my-netobserv -n netobserv --create-namespace --set --set install.loki=true --set install.prom-stack=true ./helm
48+
helm install my-netobserv -n netobserv --create-namespace --set install.loki=true --set install.prom-stack=true ./helm
4949

5050
cat <<EOF | kubectl apply -f -
5151
apiVersion: flows.netobserv.io/v1beta2

helm/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Flow data is then available in multiple ways, each optional:
1616
You can install the NetObserv Operator using [Helm](https://helm.sh/), or directly from sources.
1717

1818
> [!TIP]
19-
> If you are running on OpenShift, please refer to the [product documentation](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/network_observability/installing-network-observability-operators) instead. NetObserv is referred to as the Network Observability operator there.
19+
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:
20+
>
21+
> - On OpenShift: [see Network Observability operator](https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/network_observability/installing-network-observability-operators).
2022
2123
### Pre-requisite
2224

@@ -52,8 +54,6 @@ helm install my-netobserv -n netobserv --create-namespace --set install.loki=tru
5254

5355
# OR minimal install (Prometheus/Loki must be installed separately)
5456
helm install my-netobserv -n netobserv --create-namespace netobserv/netobserv-operator
55-
56-
# If you're in OpenShift, you can use "--set standaloneConsole.enable=false" to use the Console plugin instead.
5757
```
5858

5959
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:
@@ -89,7 +89,6 @@ EOF
8989
```
9090

9191
A few remarks:
92-
- `spec.consolePlugin.standalone` can be set to true to deploy the [web console](https://github.com/netobserv/network-observability-console-plugin) as a standalone.
9392
- 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).
9493
- 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.
9594
- 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).

0 commit comments

Comments
 (0)