From 5d0b566eb5f5a385353a8c1141eaa4e400615a33 Mon Sep 17 00:00:00 2001 From: davidmirror-ops Date: Wed, 10 Apr 2024 11:25:26 -0500 Subject: [PATCH] Improve format for steps Signed-off-by: davidmirror-ops --- docs/deployment/configuration/monitoring.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/deployment/configuration/monitoring.rst b/docs/deployment/configuration/monitoring.rst index 0653f15cf6..7b0d9ddc0b 100644 --- a/docs/deployment/configuration/monitoring.rst +++ b/docs/deployment/configuration/monitoring.rst @@ -101,12 +101,13 @@ The corresponding JSON files for each dashboard are also located at ``deployment The dashboards are basic dashboards and do not include all the metrics exposed by Flyte. Feel free to use the scripts provided `here `__ to improve and -hopefully- contribute the improved dashboards. -To consume the dashboards, we recommend installing and configuring the Prometheus operator as described in `their docs `__. -This is especially true if you plan to use the Service Monitors provided by the `flyte-core `__ Helm chart. +How to use the dashboards +~~~~~~~~~~~~~~~~~~~~~~~~~ -.. note:: +1. We recommend installing and configuring the Prometheus operator as described in `their docs `__. +This is especially true if you plan to use the Service Monitors provided by the `flyte-core `__ Helm chart. - Enable the Prometheus instance to use Service Monitors in the namespace where Flyte is running, configuring the following keys in the ``prometheus`` resource: +2. Enable the Prometheus instance to use Service Monitors in the namespace where Flyte is running, configuring the following keys in the ``prometheus`` resource: .. code-block:: yaml @@ -118,7 +119,7 @@ This is especially true if you plan to use the Service Monitors provided by the The above example configuration lets Prometheus use any ``ServiceMonitor`` in any namespace in the cluster. Adjust the configuration to reduce the scope if needed. -Once you have installed and configured the Prometheus operator, enable the Service Monitors in the Helm chart by configuring the following keys in your ``values`` file: +3. Once you have installed and configured the Prometheus operator, enable the Service Monitors in the Helm chart by configuring the following keys in your ``values`` file: .. code-block:: yaml