From 71e0b90f8321f66130fd7c0f3b9cb5364b3557b1 Mon Sep 17 00:00:00 2001 From: Zohar Galor Date: Thu, 19 Oct 2017 15:33:10 +0300 Subject: Add nfs variables documentation to README file Add documentation of external nfs variables --- roles/openshift_prometheus/README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) (limited to 'roles') diff --git a/roles/openshift_prometheus/README.md b/roles/openshift_prometheus/README.md index c5a44bffb..ce72930ed 100644 --- a/roles/openshift_prometheus/README.md +++ b/roles/openshift_prometheus/README.md @@ -23,8 +23,8 @@ For default values, see [`defaults/main.yaml`](defaults/main.yaml). - `openshift_prometheus_image_`: specify image for the component -## Storage related variables -Each prometheus component (prometheus, alertmanager, alert-buffer, oauth-proxy) can set pv claim by setting corresponding role variable: +## PVC related variables +Each prometheus component (prometheus, alertmanager, alertbuffer) can set pv claim by setting corresponding role variable: ``` openshift_prometheus__storage_type: openshift_prometheus__pvc_(name|size|access_modes|pv_selector): @@ -37,6 +37,29 @@ openshift_prometheus_alertbuffer_pvc_size: 10G openshift_prometheus_pvc_access_modes: [ReadWriteOnce] ``` +## NFS PV Storage variables +Each prometheus component (prometheus, alertmanager, alertbuffer) can set nfs pv by setting corresponding variable: +``` +openshift_prometheus__storage_kind= +openshift_prometheus__storage_(access_modes|host|labels)= +openshift_prometheus__storage_volume_(name|size)= +openshift_prometheus__storage_nfs_(directory|options)= +``` +e.g +``` +openshift_prometheus_storage_kind=nfs +openshift_prometheus_storage_access_modes=['ReadWriteOnce'] +openshift_prometheus_storage_host=nfs.example.com #for external host +openshift_prometheus_storage_nfs_directory=/exports +openshift_prometheus_storage_alertmanager_nfs_options='*(rw,root_squash)' +openshift_prometheus_storage_volume_name=prometheus +openshift_prometheus_storage_alertbuffer_volume_size=10Gi +openshift_prometheus_storage_labels={'storage': 'prometheus'} +``` + +NOTE: Setting `openshift_prometheus__storage_labels` overrides `openshift_prometheus__pvc_pv_selector` + + ## Additional Alert Rules file variable An external file with alert rules can be added by setting path to additional rules variable: ``` -- cgit v1.2.3