From 8794bdfd8102a6af16377a6d6e6425b5d7f088e6 Mon Sep 17 00:00:00 2001 From: Eric Lippmann Date: Fri, 13 Sep 2024 09:49:49 +0200 Subject: [PATCH] `Docs`: Refine `Metric Sync` --- README.md | 9 +++++++++ doc/01-About.md | 9 +++++++++ doc/03-Configuration.md | 13 ++++++------- doc/04-Features.md | 14 -------------- 4 files changed, 24 insertions(+), 21 deletions(-) delete mode 100644 doc/04-Features.md diff --git a/README.md b/README.md index 311fbbf3..3ad06e5c 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,15 @@ 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. +## Optional Features + +### Metric Sync + +Icinga for Kubernetes integrates with Prometheus to synchronize predefined metrics and display charts in the UI. +In future versions, we plan to incorporate these metrics into state evaluation and alerting. +To enable this feature you just have to configure a Prometheus server URL +that collects metrics from your Kubernetes cluster. + ## Documentation Icinga for Kubernetes documentation is available at [icinga.com/docs](https://icinga.com/docs/icinga-kubernetes). diff --git a/doc/01-About.md b/doc/01-About.md index c4eb9a0e..e80a7520 100644 --- a/doc/01-About.md +++ b/doc/01-About.md @@ -18,6 +18,15 @@ At the moment it is only possible to monitor one Kubernetes cluster per Icinga f ![Icinga for Kubernetes Web Service](res/icinga-kubernetes-web-service.png) ![Icinga for Kubernetes Web Pod](res/icinga-kubernetes-web-pod.png) +## Optional Features + +### Metric Sync + +Icinga for Kubernetes integrates with Prometheus to synchronize predefined metrics and display charts in the UI. +In future versions, we plan to incorporate these metrics into state evaluation and alerting. +To enable this feature you have to [configure a Prometheus server URL](03-Configuration.md#prometheus-configuration) +that collects metrics from your Kubernetes cluster. + ## Installation To install Icinga for Kubernetes see [Installation](02-Installation.md). diff --git a/doc/03-Configuration.md b/doc/03-Configuration.md index b20b0679..1134fd64 100644 --- a/doc/03-Configuration.md +++ b/doc/03-Configuration.md @@ -25,11 +25,10 @@ This is also the database used in ## Prometheus Configuration -Icinga for Kubernetes can synchronize metrics from Prometheus using the Prometheus API. -The configuration for Prometheus is stored in the `prometheus` section of the [config.example.yml](../config.example.yml) file. +Connection configuration for a Prometheus instance that collects metrics from your Kubernetes cluster, +from which Icinga for Kubernetes [synchronizes predefined metrics](01-About.md#metric-sync) to display charts in the UI. +Defined in the `prometheus` section of the configuration file. -| Option | Description | -|--------|-------------------------------------------------------------------| -| url | **Required.** The URL (`[Host]:[Port]`) of the Prometheus server. | - -Ensure that the URL points to a running Prometheus instance that collects metrics from your Kubernetes cluster. \ No newline at end of file +| Option | Description | +|--------|--------------------------------------------------------------------------------------| +| url | **Optional.** Prometheus server URL. If not set, metric synchronization is disabled. | diff --git a/doc/04-Features.md b/doc/04-Features.md deleted file mode 100644 index 5ad026ad..00000000 --- a/doc/04-Features.md +++ /dev/null @@ -1,14 +0,0 @@ -# Features of Icinga for Kubernetes - -## Metric Sync - -Icinga for Kubernetes integrates with Prometheus to provide metric synchronization. -This feature allows Icinga to collect and visualize real-time metrics from Kubernetes clusters, -enabling more comprehensive monitoring and alerting capabilities. - -### Key Benefits: -- **Improved Monitoring**: Collect detailed metrics from Kubernetes, such as resource utilization and pod health, and display them in Icinga. -- **Enhanced Alerts**: Use the synced metrics to create custom alerts for critical thresholds. -- **Visibility into Cluster Performance**: Gain insights into the performance of your Kubernetes clusters to optimize resource usage and troubleshoot issues faster. - -By configuring the Prometheus `url` in the `config.yml`, you can enable this feature to retrieve valuable metrics that enhance the overall monitoring experience in Icinga. \ No newline at end of file