From 605102bb6a8a3b48f0c66d817614eec0ef42e017 Mon Sep 17 00:00:00 2001 From: opensource-tnbt Date: Tue, 20 Oct 2020 14:41:59 +0530 Subject: DOCS: Cleanup for Jerma Release. This patch cleans up documentation folder. 1. Broken links are fixed. 2. LMA docs reorganized. 3. Placeholder for K8S and Openstack Support. Remove tls_verify = False line JIRA: VSPERF-627 Signed-off-by: Sridhar K. N. Rao Change-Id: I5ef93919755d351b79fa0bd0416d7d6baeb134a9 --- docs/lma/metrics/devguide.rst | 35 +++++++++++++++-------------------- 1 file changed, 15 insertions(+), 20 deletions(-) (limited to 'docs/lma/metrics/devguide.rst') diff --git a/docs/lma/metrics/devguide.rst b/docs/lma/metrics/devguide.rst index 93d33016..40162397 100644 --- a/docs/lma/metrics/devguide.rst +++ b/docs/lma/metrics/devguide.rst @@ -1,17 +1,12 @@ -==================== -Metrics Dev Guide -==================== -Table of Contents -================= -.. contents:: -.. section-numbering:: - +======================= +Metrics Developer Guide +======================= Anible File Organization -============================ +======================== Ansible-Server ----------------- +-------------- Please follow the following file structure: @@ -82,7 +77,7 @@ Please follow the following file structure: Ansible - Client ------------------- +---------------- Please follow the following file structure: @@ -113,25 +108,25 @@ Please follow the following file structure: Summary of Roles -================== +================ A brief description of the Ansible playbook roles, which are used to deploy the monitoring cluster Ansible Server Roles ----------------------- +-------------------- Ansible Server, this part consists of the roles used to deploy Prometheus Alertmanager Grafana stack on the server-side Role: Monitoring -~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~ Deployment and configuration of PAG stack along with collectd-exporter, cadvisor and node-exporter. Role: Clean-Monitoring -~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~ Removes all the components deployed by the Monitoring role. @@ -163,7 +158,7 @@ Configurable Parameters: File: alertmanager-deployment.yaml -''''''''''''''''''''''''''''''''' +'''''''''''''''''''''''''''''''''' Path : monitoring/files/alertmanager/alertmanager-deployment.yaml Task: Deploys alertmanager instance @@ -315,7 +310,7 @@ Kube State Metrics ^^^^^^^^^^^^^^^^^^^^ File: kube-state-metrics-deployment.yaml -'''''''''''''''''''''''''''''''''''''''''' +'''''''''''''''''''''''''''''''''''''''' Path : monitoring/files/kube-state-metrics/kube-state-metrics-deployment.yaml Task: To create a kube-state-metrics instance @@ -327,7 +322,7 @@ Configurable Parameters: File: kube-state-metrics-service.yaml -''''''''''''''''''''''''''''''''' +''''''''''''''''''''''''''''''''''''' Path : monitoring/files/kube-state-metrics/kube-state-metrics-service.yaml Task: To create a collectd service @@ -343,7 +338,7 @@ Node Exporter ^^^^^^^^^^^^^^^ File: node-exporter-daemonset.yaml -''''''''''''''''''''''''''''''''' +'''''''''''''''''''''''''''''''''' Path : monitoring/files/node-exporter/node-exporter-daemonset.yaml Task: To create a node exporter daemonset @@ -467,7 +462,7 @@ Task: Install collectd along with prerequisites Associated template file: -- collectd.conf.j2 +collectd.conf.j2 Path: collectd/files/collectd.conf.j2 Summary: Edit this file to change the default configuration to -- cgit 1.2.3-korg