diff --git a/docs/how-to-guides/monitoring-with-prometheus-operator.md b/docs/how-to-guides/monitoring-with-prometheus-operator.md index bcbf41415..2bdbe7823 100644 --- a/docs/how-to-guides/monitoring-with-prometheus-operator.md +++ b/docs/how-to-guides/monitoring-with-prometheus-operator.md @@ -1,20 +1,27 @@ -# Setting up monitoring on Lokomotive +# Set up monitoring on Lokomotive ## Contents * [Introduction](#introduction) * [Prerequisites](#prerequisites) -* [Deploy Prometheus Operator](#deploy-prometheus-operator) - * [Configure Prometheus Operator](#configure-prometheus-operator) - * [Install Prometheus Operator](#install-prometheus-operator) -* [Accessing Prometheus, Alertmanager and Grafana](#accessing-prometheus-operator-sub-components) - * [Accessing Prometheus](#accessing-prometheus) +* [Steps: Deploy Prometheus Operator](#steps-deploy-prometheus-operator) + * [Step 1: Configure Prometheus Operator](#step-1-configure-prometheus-operator) + * [Step 2: Install Prometheus Operator](#step-2-install-prometheus-operator) +* [Access Prometheus, Alertmanager and Grafana](#access-prometheus-alertmanager-and-grafana) + * [Access Prometheus](#access-prometheus) * [Using port forward](#using-port-forward) * [Using Ingress](#using-ingress) - * [Accessing Alertmanager](#accessing-alertmanager) - * [Accessing Grafana](#accessing-grafana) + * [Access Alertmanager](#access-alertmanager) + * [Access Grafana](#access-grafana) * [Using port forward](#using-port-forward-1) * [Using Ingress](#using-ingress-1) +* [Add custom Grafana dashboards](#add-custom-grafana-dashboards) +* [Add new ServiceMonitors](#add-new-service-monitors) + * [Default Prometheus operator setting](#default-prometheus-operator-setting) + * [Custom Prometheus operator setting](#custom-prometheus-operator-setting) +* [Add custom alerts for Alertmanager](#add-custom-alerts-for-alertmanager) + * [Default Prometheus operator setting](#default-prometheus-operator-setting-1) + * [Custom Prometheus operator setting](#custom-prometheus-operator-setting-1) * [Additional resources](#additional-resources) ## Introduction @@ -26,10 +33,10 @@ This guide provides the steps for deploying a monitoring stack using the `promet * A Lokomotive cluster deployed on a supported provider and accessible via `kubectl`. -* A storage provider component (`rook` and `rook-ceph`, or `openebs-operator` and `openebs-storage-class`) deployed with a default storage class that can provision volumes for the [PVCs](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) created by Alertmanager and Prometheus. +* A storage provider component ([`rook` and `rook-ceph`](./rook-ceph-storage.md), or `openebs-operator` and `openebs-storage-class`) deployed with a default storage class that can provision volumes for the [PVCs](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) created by Alertmanager and Prometheus.