Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jhoxhaa committed Dec 18, 2024
1 parent 3044b9a commit 4939260
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 8 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,18 @@ including the database, common setup approaches include the following:
* 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 Deployment](doc/res/icinga-kubernetes-web-deployment.png)
![Icinga for Kubernetes Web Replica Set](doc/res/icinga-kubernetes-web-replica-set.png)
![Icinga for Kubernetes Web Pod](doc/res/icinga-kubernetes-web-pod.png)

## Multi-Cluster Support

Icinga for Kubernetes supports multiple Kubernetes clusters by deploying several daemons,
each connecting to a different cluster but writing data into the same database.
The web interface accesses this database to display resource information and state,
offering the flexibility to view aggregated data from all clusters or focus on a specific cluster.
This setup ensures scalable monitoring and a unified view of resources across multiple Kubernetes environments.

## Vision and Roadmap

Although every Kubernetes cluster is different, Icinga for Kubernetes aims to provide a zero-configuration baseline for
Expand Down
13 changes: 8 additions & 5 deletions doc/01-About.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,18 @@ including the database, common setup approaches include the following:
* 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 Deployment](res/icinga-kubernetes-web-deployment.png)
![Icinga for Kubernetes Web Replica Set](res/icinga-kubernetes-web-replica-set.png)
![Icinga for Kubernetes Web Pod](res/icinga-kubernetes-web-pod.png)

## Multi-Cluster Support

Icinga for Kubernetes supports multiple Kubernetes clusters by deploying several daemons,
each connecting to a different cluster but writing data into the same database.
The web interface accesses this database to display resource information and state,
offering the flexibility to view aggregated data from all clusters or focus on a specific cluster.
This setup ensures scalable monitoring and a unified view of resources across multiple Kubernetes environments.

## Vision and Roadmap

Although every Kubernetes cluster is different, Icinga for Kubernetes aims to provide a zero-configuration baseline for
Expand All @@ -38,8 +43,6 @@ 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,
Expand Down

0 comments on commit 4939260

Please sign in to comment.