diff --git a/README.md b/README.md index 1fe30954..311fbbf3 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,41 @@ consisting of ![Icinga for Kubernetes Overview](doc/res/icinga-kubernetes-overview.png) -Any of the Icinga for Kubernetes components can run either inside or outside Kubernetes clusters, -including the database. -At the moment it is only possible to monitor one Kubernetes cluster per Icinga for Kubernetes installation. +Though any of the Icinga for Kubernetes components can run either inside or outside Kubernetes clusters, +including the database, common setup approaches include the following: + +* All components run inside a Kubernetes cluster. +* All components run outside a Kubernetes cluster. +* Only the Icinga for Kubernetes daemon runs inside a Kubernetes cluster, + requiring configuration for an external service to connect to the database outside the cluster. + +Please **note** that at the moment it is only possible to monitor one Kubernetes cluster per +Icinga for Kubernetes installation. ![Icinga for Kubernetes Web Stateful Set](doc/res/icinga-kubernetes-web-stateful-set.png) ![Icinga for Kubernetes Web Service](doc/res/icinga-kubernetes-web-service.png) ![Icinga for Kubernetes Web Pod](doc/res/icinga-kubernetes-web-pod.png) +## Vision and Roadmap + +Although every Kubernetes cluster is different, Icinga for Kubernetes aims to provide a zero-configuration baseline for +monitoring Kubernetes. Our goal is to make it easy to understand the complete state of clusters, including resources, +workloads, relations, and performance. We strive to offer comprehensive monitoring that provides a clear and +intuitive view of clusters' health, helping to identify problems and potential bottlenecks. + +The Kubernetes API is leveraged to retrieve information about resources and watch ongoing changes. +This data is stored in a database to reduce pressure on the Kubernetes API and +to enable powerful filtering through a relational model. + +Currently, Icinga for Kubernetes utilizes all available information from the Kubernetes API to +determine the state of resources and clusters. In future versions, we plan to integrate metrics. +Upcoming features will also include the use of Icinga Notifications for sending alerts and +supporting multiple clusters. + +We welcome your ideas on what should be included in the baseline. +Do not hesitate to share your key metrics, important thresholds, +or correlations used to set up alarms in your environments. + ## Documentation Icinga for Kubernetes documentation is available at [icinga.com/docs](https://icinga.com/docs/icinga-kubernetes). diff --git a/doc/res/icinga-kubernetes-web-pod.png b/doc/res/icinga-kubernetes-web-pod.png index b889f268..ad38c810 100644 Binary files a/doc/res/icinga-kubernetes-web-pod.png and b/doc/res/icinga-kubernetes-web-pod.png differ diff --git a/doc/res/icinga-kubernetes-web-service.png b/doc/res/icinga-kubernetes-web-service.png index 8188ed50..28c0921e 100644 Binary files a/doc/res/icinga-kubernetes-web-service.png and b/doc/res/icinga-kubernetes-web-service.png differ diff --git a/doc/res/icinga-kubernetes-web-stateful-set.png b/doc/res/icinga-kubernetes-web-stateful-set.png index b03d12da..c069bed8 100644 Binary files a/doc/res/icinga-kubernetes-web-stateful-set.png and b/doc/res/icinga-kubernetes-web-stateful-set.png differ