Skip to content

Commit

Permalink
docs(README): add background to drawings
Browse files Browse the repository at this point in the history
Signed-off-by: Clément Nussbaumer <[email protected]>
  • Loading branch information
clementnuss committed Apr 5, 2024
1 parent aa8c556 commit bb1a24d
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,15 @@

- [Kubenurse](#kubenurse)
- [Deployment](#deployment)
- [Helm deployment](#helm-deployment)
- [Configuration](#configuration)
- [http Endpoints](#http-endpoints)
- [Health Checks](#health-checks)
- [API Server Direct](#api-server-direct)
- [API Server DNS](#api-server-dns)
- [Me Ingress](#me-ingress)
- [Me Service](#me-service)
- [Neighbourhood](#neighbourhood)
- [Metrics](#metrics)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
Expand All @@ -25,7 +31,7 @@ exports those metrics in Prometheus format.
Here's an overview of the checks performed by kubenurse, which are exposed as
labels for the various duration/error prometheus metrics.

![kubenurse request types](./doc/kubenurse.png)
![kubenurse request types](./doc/kubenurse.svg)

## Deployment

Expand Down Expand Up @@ -243,7 +249,7 @@ To combat this, a node filtering feature was implemented, which works as follows

Here's an example with 6 nodes, where each node queries the next 3 nodes:

![node filtering drawing](./doc/node_filtering.png)
![node filtering drawing](./doc/kubenurse_node_filtering.svg)

Thanks to this, every node is making queries to the same 10 nodes, unless one
of those nodes disappears, in which case kubenurse will pick the next node in
Expand Down
Binary file removed doc/kubenurse.png
Binary file not shown.
24 changes: 24 additions & 0 deletions doc/kubenurse.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions doc/kubenurse_node_filtering.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/node_filtering.png
Binary file not shown.

0 comments on commit bb1a24d

Please sign in to comment.