diff options
| author | Scott Dodson <sdodson@redhat.com> | 2017-10-23 16:26:47 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-23 16:26:47 -0400 |
| commit | 9d62027ef74197cfe0dd52ed2ca9bd9b0319a496 (patch) | |
| tree | d4eb88d29b82db56d8fb6c1acbf19f0352e5599b | |
| parent | 211f4465aac819029beee118dfc0644c3c959a10 (diff) | |
| parent | 71e0b90f8321f66130fd7c0f3b9cb5364b3557b1 (diff) | |
| download | openshift-9d62027ef74197cfe0dd52ed2ca9bd9b0319a496.tar.gz openshift-9d62027ef74197cfe0dd52ed2ca9bd9b0319a496.tar.bz2 openshift-9d62027ef74197cfe0dd52ed2ca9bd9b0319a496.tar.xz openshift-9d62027ef74197cfe0dd52ed2ca9bd9b0319a496.zip | |
Merge pull request #5811 from zgalor/add_nfs_to_readme
Add nfs variables documentation to README file
| -rw-r--r-- | roles/openshift_prometheus/README.md | 27 |
1 files changed, 25 insertions, 2 deletions
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_<COMPONENT>`: 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_<COMPONENT>_storage_type: <VALUE> openshift_prometheus_<COMPONENT>_pvc_(name|size|access_modes|pv_selector): <VALUE> @@ -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_<COMPONENT>_storage_kind=<VALUE> +openshift_prometheus_<COMPONENT>_storage_(access_modes|host|labels)=<VALUE> +openshift_prometheus_<COMPONENT>_storage_volume_(name|size)=<VALUE> +openshift_prometheus_<COMPONENT>_storage_nfs_(directory|options)=<VALUE> +``` +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_<COMPONENT>_storage_labels` overrides `openshift_prometheus_<COMPONENT>_pvc_pv_selector` + + ## Additional Alert Rules file variable An external file with alert rules can be added by setting path to additional rules variable: ``` |