From eee40683d5580f6fe24c3dd5750ed5901344b715 Mon Sep 17 00:00:00 2001 From: Antonin Bas Date: Tue, 19 Apr 2022 17:16:33 -0700 Subject: [PATCH] Improve flow visibility documentation * fix link to ClickHouse operator YAML manifest * add note about traffic which is excluded by default in Grafana dashboards Signed-off-by: Antonin Bas --- docs/network-flow-visibility.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/network-flow-visibility.md b/docs/network-flow-visibility.md index 3d202f5f47a..85ffcbcbc60 100644 --- a/docs/network-flow-visibility.md +++ b/docs/network-flow-visibility.md @@ -585,7 +585,7 @@ for more information about the ClickHouse Operator. Current checked-in yaml is b will install ClickHouse Operator into `kube-system` Namespace. ```bash -kubectl apply -f https://raw.githubusercontent.com/antrea-io/antrea/main/build/yamls/clickhouse-operator-install-bundle.yaml +kubectl apply -f https://raw.githubusercontent.com/antrea-io/antrea/main/build/yamls/clickhouse-operator-install-bundle.yml ``` To deploy a released version of the Grafana Flow Collector, find a deployment manifest @@ -677,7 +677,7 @@ To stop the Grafana Flow Collector, run the following commands: ```shell kubectl delete -f flow-visibility.yml -kubectl delete -f https://raw.githubusercontent.com/antrea-io/antrea/main/build/yamls/clickhouse-operator-install-bundle.yaml -n kube-system +kubectl delete -f https://raw.githubusercontent.com/antrea-io/antrea/main/build/yamls/clickhouse-operator-install-bundle.yml -n kube-system ``` ##### Credentials Configuration @@ -831,6 +831,15 @@ visualization. They can be found in the Home page of Grafana, by clicking the Magnifier button on the left menu bar. Grafana Search Dashboards Guide +Note that all pre-built dashboards (except for the "Flow Records Dashboard") +filter out Pod traffic for which the source or destination Namespace is one of +`kube-system`, `flow-visibility`, or `flow-aggregator`. The primary motivation +for this is to avoid showing the connections between the Antrea Agents and the +Flow Aggregator, between the Flow Aggregator and ClickHouse, and between +ClickHouse and Grafana. If you want to stop filtering traffic like this, you +will need to [customize dashboards](#dashboards-customization) and edit the +ClickHouse SQL query for each individual panel. + ##### Flow Records Dashboard Flow Records Dashboard displays the number of flow records being captured in the