Merge pull request #6409 from bmcelvee/Trello-630-Follow-up

Trello-630-Follow-up Continuing Development of Prometheus Content

Author: bmcelvee

install_config/cluster_metrics.adoc

@@ -903,65 +903,66 @@ $ ansible-playbook -vvv -i ${INVENTORY_FILE} playbooks/byo/openshift-cluster/ope
 The Prometheus server automatically exposes a Web UI at `localhost:9090`. You
 can access the Prometheus Web UI with the `view` role.
 
-[openshift-prometheus-config]
+[[openshift-prometheus-config]]
 ==== Configuring Prometheus for OpenShift
-
-Example Prometheus rules file:
-----
-# additional prometheus rules file
-openshift_prometheus_additional_rules_file: null
-
-# All the required exports
-openshift_prometheus_pv_exports:
--  prometheus
--  prometheus-alertmanager
--  prometheus-alertbuffer
-# PV template files and their created object names
-  openshift_prometheus_pv_data:
-  -  pv_name: prometheus
-     pv_template: prom-pv-server.yml
-     pv_label: Prometheus Server PV
-  -  pv_name: prometheus-alertmanager
-     pv_template: prom-pv-alertmanager.yml
-     pv_label: Prometheus Alertmanager PV
-  -  pv_name: prometheus-alertbuffer
-     pv_template: prom-pv-alertbuffer.yml
-     pv_label: Prometheus Alert Buffer PV
-
-# Hostname/IP of the NFS server.
-openshift_prometheus_storage_host
-openshift_prometheus_alertmanager_storage_host
-openshift_prometheus_alertbuffer_storage_host
-
-# storage
-openshift_prometheus_storage_type: pvc
-openshift_prometheus_pvc_name: prometheus
-openshift_prometheus_pvc_size: 10G
-openshift_prometheus_pvc_access_modes: [ReadWriteOnce]
-openshift_prometheus_pvc_pv_selector: {}
-
-openshift_prometheus_alertmanager_storage_type: pvc
-openshift_prometheus_alertmanager_pvc_name: prometheus-alertmanager
-openshift_prometheus_alertmanager_pvc_size: 10G
-openshift_prometheus_alertmanager_pvc_access_modes: [ReadWriteOnce]
-openshift_prometheus_alertmanager_pvc_pv_selector: {}
-openshift_prometheus_cpu_limit: null
-openshift_prometheus_memory_limit: null
-openshift_prometheus_cpu_requests: null
-openshift_prometheus_memory_requests: null
-openshift_prometheus_alertmanager_cpu_limit: null
-openshift_prometheus_alertmanager_memory_limit: null
-openshift_prometheus_alertmanager_cpu_requests: null
-openshift_prometheus_alertmanager_memory_requests: null
-openshift_prometheus_alertbuffer_cpu_limit: null
-openshift_prometheus_alertbuffer_memory_limit: null
-openshift_prometheus_alertbuffer_cpu_requests: null
-openshift_prometheus_alertbuffer_memory_requests: null
-openshift_prometheus_oauth_proxy_cpu_limit: null
-openshift_prometheus_oauth_proxy_memory_limit: null
-openshift_prometheus_oauth_proxy_cpu_requests: null
-openshift_prometheus_oauth_proxy_memory_requests: null
-----
+//
+// Example Prometheus rules file:
+// ----
+// # additional prometheus rules file
+// openshift_prometheus_additional_rules_file: null
+//
+// # All the required exports
+// openshift_prometheus_pv_exports:
+// -  prometheus
+// -  prometheus-alertmanager
+// -  prometheus-alertbuffer
+// # PV template files and their created object names
+//   openshift_prometheus_pv_data:
+//   -  pv_name: prometheus
+//      pv_template: prom-pv-server.yml
+//      pv_label: Prometheus Server PV
+//   -  pv_name: prometheus-alertmanager
+//      pv_template: prom-pv-alertmanager.yml
+//      pv_label: Prometheus Alertmanager PV
+//   -  pv_name: prometheus-alertbuffer
+//      pv_template: prom-pv-alertbuffer.yml
+//      pv_label: Prometheus Alert Buffer PV
+//
+// # Hostname/IP of the NFS server.
+// openshift_prometheus_storage_host
+// openshift_prometheus_alertmanager_storage_host
+// openshift_prometheus_alertbuffer_storage_host
+//
+// # storage
+// openshift_prometheus_storage_type: pvc
+// openshift_prometheus_pvc_name: prometheus
+// openshift_prometheus_pvc_size: 10G
+// openshift_prometheus_pvc_access_modes: [ReadWriteOnce]
+// openshift_prometheus_pvc_pv_selector: {}
+//
+// openshift_prometheus_alertmanager_storage_type: pvc
+// openshift_prometheus_alertmanager_pvc_name: prometheus-alertmanager
+// openshift_prometheus_alertmanager_pvc_size: 10G
+// openshift_prometheus_alertmanager_pvc_size: 10G
+// openshift_prometheus_alertmanager_pvc_access_modes: [ReadWriteOnce]
+// openshift_prometheus_alertmanager_pvc_pv_selector: {}
+// openshift_prometheus_cpu_limit: null
+// openshift_prometheus_memory_limit: null
+// openshift_prometheus_cpu_requests: null
+// openshift_prometheus_memory_requests: null
+// openshift_prometheus_alertmanager_cpu_limit: null
+// openshift_prometheus_alertmanager_memory_limit: null
+// openshift_prometheus_alertmanager_cpu_requests: null
+// openshift_prometheus_alertmanager_memory_requests: null
+// openshift_prometheus_alertbuffer_cpu_limit: null
+// openshift_prometheus_alertbuffer_memory_limit: null
+// openshift_prometheus_alertbuffer_cpu_requests: null
+// openshift_prometheus_alertbuffer_memory_requests: null
+// openshift_prometheus_oauth_proxy_cpu_limit: null
+// openshift_prometheus_oauth_proxy_memory_limit: null
+// openshift_prometheus_oauth_proxy_cpu_requests: null
+// openshift_prometheus_oauth_proxy_memory_requests: null
+// ----
 
 *Prometheus Storage Related Variables*
 
@@ -1018,7 +1019,8 @@ Prometheus].
 
 [NOTE]
 ====
-Metrics can be gathered from the `http://${POD_IP}:7575/metrics` endpoint.
+Once `openshift_metrics_project: openshift-infra` is installed, metrics can be
+gathered from the `http://${POD_IP}:7575/metrics` endpoint.
 ====
 
 [[openshift-prometheus-undeploy]]
@@ -1027,5 +1029,5 @@ Metrics can be gathered from the `http://${POD_IP}:7575/metrics` endpoint.
 To undeploy Prometheus, run:
 
 ----
-$ ansible-playbook -vvv -i ${INVENTORY_FILE} playbooks/byo/openshift-cluster/openshift-prometheus.yml
+$ ansible-playbook -vvv -i ${INVENTORY_FILE} playbooks/byo/openshift-cluster/openshift-prometheus.yml -e openshift_prometheus_state=absent
 ----