diff --git a/README.md b/README.md index f36e177..cc50d3c 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 @@ -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 diff --git a/doc/kubenurse.png b/doc/kubenurse.png deleted file mode 100644 index 630dbe6..0000000 Binary files a/doc/kubenurse.png and /dev/null differ diff --git a/doc/kubenurse.svg b/doc/kubenurse.svg new file mode 100644 index 0000000..92b646a --- /dev/null +++ b/doc/kubenurse.svg @@ -0,0 +1,24 @@ + + + + + + + + + + + kubenurseme_ingressme_servicekubenurse ingress->ingress controllerkubenurse serviceapi_server_directapi_server_dnsKubernetes API servere.g. 10.127.0.1Kubernetes API serverkubernetes.default.svcpath_<neighbouring nodes>node-01node-02node-03node-04node-05path_node-01path_node-02path_node-03path_node-04path_node-05Kubenurse request_type labels \ No newline at end of file diff --git a/doc/kubenurse_node_filtering.svg b/doc/kubenurse_node_filtering.svg new file mode 100644 index 0000000..eb2289a --- /dev/null +++ b/doc/kubenurse_node_filtering.svg @@ -0,0 +1,24 @@ + + + + + + + + + + + node-01node-02node-03node-04node-05node-06837bcf03ec9fdeb837f3fe5999f82576ba823422c917f48fnode-03node-01node-04node-05node-06node-0237f3fe59837bcf0399f82576ba823422c917f48fec9fdeb8wraps around6 nodes example, with KUBENURSE_NEIGHBOUR_LIMIT = 3neighbours checked by node-05: 06, 02, and 03compute sha256sumsort by checksum \ No newline at end of file diff --git a/doc/node_filtering.png b/doc/node_filtering.png deleted file mode 100644 index 5252d81..0000000 Binary files a/doc/node_filtering.png and /dev/null differ