Awesome

<h1> <img src="https://github.com/sighupio/fury-distribution/blob/main/docs/assets/fury-epta-white.png?raw=true" align="left" width="90" style="margin-right: 15px"/> Kubernetes Fury Monitoring </h1>

License

Kubernetes Fury Monitoring provides a fully-fledged monitoring stack for the Kubernetes Fury Distribution (KFD). This module extends and improves upon the Kube-Prometheus project.

If you are new to KFD please refer to the official documentation on how to get started with KFD.

Overview

This module is designed to give you full control and visibility over your cluster operations. Metrics from the cluster and the applications are collected and clean analytics are offered via a visualization platform, Grafana.

The centerpiece of this module is the [prometheus-operator], which offers the easy deployment of the following as controllers:

Prometheus: An open-source monitoring and alerting toolkit for cloud-native applications
Alertmanager: Manages alerts sent by the Prometheus server and route them through receiver integrations such as email, Slack, or PagerDuty
ServiceMonitor: Declaratively specifies how groups of services should be monitored, by automatically generating Prometheus scrape configuration based on the definition

Since the export of certain metrics can be heavily cloud-provider specific, we provide a bunch of cloud-provider specific configurations. The setups we currently support include:

Google Kubernetes Engine (GKE)
Azure Kubernetes Service (AKS)
Elastic Kubernetes Service (EKS)
on-premises or self-managed cloud clusters

Most of the components in this module are deployed in namespace monitoring, unless the functionality requires permissions that force it to be deployed in the namespace kube-system.

Packages

Kubernetes Fury Monitoring provides the following packages:

Package	Version	Description
prometheus-operator	`0.67.1`	Operator to deploy and manage Prometheus and related resources
prometheus-operated	`2.46.0`	Prometheus instance deployed with Prometheus Operator's CRD
alertmanager-operated	`0.26.0`	Alertmanager instance deployed with Prometheus Operator's CRD
blackbox-exporter	`0.24.0`	Prometheus exporter that allows blackbox probing of endpoints over HTTP, HTTPS, DNS, TCP, ICMP and gRPC.
grafana	`9.5.5`	Grafana deployment to query and visualize metrics collected by Prometheus
karma	`0.113`	Karma deployment to visualize alerts sent by AlertManager
kube-proxy-metrics	`0.14.0`	RBAC proxy to securely expose kube-proxy metrics
kube-state-metrics	`2.9.2`	Service that generates metrics from Kubernetes API objects
node-exporter	`1.6.1`	Prometheus exporter for hardware and OS metrics exposed by *NIX kernels
prometheus-adapter	`0.11.1`	Kubernetes resource metrics, custom metrics, and external metrics APIs implementation.
thanos (DEPRECATED)	`0.34.0`	Thanos is a high-availability Prometheus setup that provides long term storage via an external object store
x509-exporter	`3.12.0`	Provides monitoring for certificates
mimir	`2.11.0`	Mimir is an open source, horizontally scalable, highly available, multi-tenant TSDB for long-term storage for Prometheus.
haproxy	`N.A.`	Grafana dashboards and prometheus rules (alerts) for HAproxy.

Integration with cloud providers

One of the following components can be used to enable service monitoring in each cloud environment:

Component	Description
aks-sm	ServiceMonitor to collect Kubernetes components metrics from AKS
gke-sm	ServiceMonitor to collect Kubernetes components metrics from GKE
eks-sm	ServiceMonitor to collect Kubernetes components metrics from EKS
kubeadm-sm	ServiceMonitors, Prometheus rules and alerts for Kubernetes components of self-managed or on-premises clusters

Please refer to the individual package documentation for further details.

Compatibility

Kubernetes Version	Compatibility	Notes
`1.27.x`	:white_check_mark:	No known issues
`1.28.x`	:white_check_mark:	No known issues
`1.29.x`	:white_check_mark:	No known issues

Check the compatibility matrix for additional information about previous releases of the modules.

Usage

Prerequisites

Tool	Version	Description
furyctl	`>=0.25.0`	The recommended tool to download and manage KFD modules and their packages. To learn more about `furyctl` read the official documentation.
kustomize	`>=3.5.3`	Packages are customized using `kustomize`. To learn how to create your customization layer with `kustomize`, please refer to the repository.

Deployment

List the packages you want to deploy and their version in a Furyfile.yml

versions:
 monitoring: v3.2.0

bases:
    - name: monitoring/prometheus-operator
    - name: monitoring/prometheus-operated
    - name: monitoring/alertmanager-operated
    - name: monitoring/blackbox-exporter
    - name: monitoring/kube-proxy-metrics
    - name: monitoring/kube-state-metrics
    - name: monitoring/grafana
    - name: monitoring/node-exporter
    - name: monitoring/prometheus-adapter
    - name: monitoring/x509-exporter

Along with the primary components, include one of the following components, based on your cloud provider for service monitoring:

ServiceMonitor for AWS EKS cluster

  ...
  - name: monitoring/eks-sm

ServiceMonitor for Azure AKS cluster

  ...
  - name: monitoring/aks-sm

ServiceMonitor for GCP GKE cluster

  ...
  - name: monitoring/gke-sm

ServiceMonitor for on-premises and self-managed cluster

  ...
  - name: monitoring/kubeadm-sm

See furyctl documentation for additional details about Furyfile.yml format.

Execute furyctl legacy vendor -H to download the packages
Inspect the download packages under ./vendor/katalog/monitoring.
To deploy the packages to your cluster, define a kustomization.yaml with the following content:

bases:
    - ./vendor/katalog/monitoring/prometheus-operator
    - ./vendor/katalog/monitoring/prometheus-operated
    - ./vendor/katalog/monitoring/alertmanager-operated
    - ./vendor/katalog/monitoring/blackbox-exporter
    - ./vendor/katalog/monitoring/kube-proxy-metrics
    - ./vendor/katalog/monitoring/kube-state-metrics
    - ./vendor/katalog/monitoring/grafana
    - ./vendor/katalog/monitoring/node-exporter
    - ./vendor/katalog/monitoring/prometheus-adapter
    - ./vendor/katalog/monitoring/x509-exporter

Include in the kustomization also the ServiceMonitor package specific to each service provider as follows:

For AWS EKS

  ...
  - ./vendor/katalog/monitoring/eks-sm

For GCP GKE

  ...
  - ./vendor/katalog/monitoring/gke-sm

For Azure AKS

  ...
  - ./vendor/katalog/monitoring/aks-sm

For on-premises and self-managed

  ...
  - ./vendor/katalog/monitoring/kubeadm-sm

To deploy the packages to your cluster, execute:

kustomize build . | kubectl apply -f - --server-side

Examples

To see examples of how to customize Fury Kubernetes Monitoring packages, please go to the examples directory.

Contributing

Before contributing, please read first the Contributing Guidelines.

Reporting Issues

In case you experience any problems with the module, please open a new issue.

License

This module is open-source and it's released under the following LICENSE