diff --git a/Documentation/README.md b/Documentation/README.md index 83156534..e0a2893e 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -1,12 +1,12 @@ # Kube-router Documentation -## General overview +## Architecture -Kube-router consist of 3 core components +Kube-router is built around concept of watchers and controllers. Watchers use Kubernetes watch API to get notification on events related to create, update, delete of Kubernetes objects. Each watcher gets notification related to a particular API object. On receiving an event from API server, watcher broadcasts events. Controller registers to get event updates from the watchers and act up on the events. -* [Network Services Controller](#network-services-controller) -* [Network Policy Controller](#network-policy-controller) -* [Network Routes Controller](#network-routes-controller) +Kube-router consists of 3 core controllers and multiple watchers as depicted in below diagram. + +![Arch](./img/kube-router-arch.png) #### Network Services Controller diff --git a/Documentation/img/kube-router-arch.png b/Documentation/img/kube-router-arch.png new file mode 100644 index 00000000..93ea3221 Binary files /dev/null and b/Documentation/img/kube-router-arch.png differ diff --git a/README.md b/README.md index 5c122537..2e2dfa6d 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ If you experience any problems please reach us on gitter [community forum](https Use below guides to get started. +- [Architecture](./Documentation/README.md#architecture) - [Users Guide](./Documentation/README.md#user-guide) - [Developers Guide](./Documentation/README.md#develope-guide)