diff --git a/README.md b/README.md index cb67bac5..5089a652 100644 --- a/README.md +++ b/README.md @@ -242,6 +242,18 @@ Per default, the neighbourhood filtering is set to 10 nodes, which means that on cluster with more than 10 nodes, each kubenurse will query 10 nodes, as described above. +Finally, here's an example with 6 nodes and neighbour filtering set to 3: + +![node filtering drawing](./doc/node_filtering.png) + +##### Neighbourhood incoming checks metric + +It is possible to check that each node receives the proper number of +neighbourhood queries with the `kubenurse_neighbourhood_incoming_checks` +metric. If you have the neighbourhood limit set to e.g. 10, then this +metric should be equal to 10 on all nodes, with some variations during a +rollout restart. + To bypass the node filtering feature, you simply need to set the `KUBENURSE_NEIGHBOUR_LIMIT` environment variable to 0. diff --git a/doc/node_filtering.png b/doc/node_filtering.png new file mode 100644 index 00000000..2235e2ac Binary files /dev/null and b/doc/node_filtering.png differ