summaryrefslogtreecommitdiffstats
path: root/roles/openshift_metrics/README.md
diff options
context:
space:
mode:
authorJose David Martin Nieto <j.david.nieto@gmail.com>2016-03-10 12:30:44 +0100
committerJose David Martin Nieto <j.david.nieto@gmail.com>2016-04-20 16:41:21 +0200
commit55e36e376858d023203f4a3d7884c830109bc122 (patch)
tree4f695d1a586be8cd135aa675fbb985470d70a8ed /roles/openshift_metrics/README.md
parent1f490c2374038669df3d2bfcb01af54361f8907e (diff)
downloadopenshift-55e36e376858d023203f4a3d7884c830109bc122.tar.gz
openshift-55e36e376858d023203f4a3d7884c830109bc122.tar.bz2
openshift-55e36e376858d023203f4a3d7884c830109bc122.tar.xz
openshift-55e36e376858d023203f4a3d7884c830109bc122.zip
added new openshift-metrics service
Diffstat (limited to 'roles/openshift_metrics/README.md')
-rw-r--r--roles/openshift_metrics/README.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/roles/openshift_metrics/README.md b/roles/openshift_metrics/README.md
new file mode 100644
index 000000000..610917d7d
--- /dev/null
+++ b/roles/openshift_metrics/README.md
@@ -0,0 +1,51 @@
+OpenShift Metrics with Hawkular
+====================
+
+OpenShift Metrics Installation
+
+Requirements
+------------
+It requires subdomain fqdn to be set.
+If persistence is enabled, then it also requires NFS
+
+Role Variables
+--------------
+
+From this role:
+| Name | Default value | |
+|-------------------------------------------------|-----------------------|-------------------------------------------------------------|
+| openshift_hosted_metrics_deploy | False | If metrics should be deployed |
+| openshift_hosted_metrics_storage_nfs_directory | /exports | Root export directory. |
+| openshift_hosted_metrics_storage_volume_name | metrics | Metrics volume within openshift_hosted_metrics_volume_dir |
+| openshift_hosted_metrics_storage_volume_size | 10Gi | Metrics volume size |
+| openshift_hosted_metrics_storage_nfs_options | *(rw,root_squash) | NFS options for configured exports. |
+
+
+From openshift_common:
+| Name | Default Value | |
+|---------------------------------------|----------------|----------------------------------------|
+| openshift_master_default_subdomain | null | Subdomain FQDN (Mandatory) |
+
+
+Dependencies
+------------
+openshift_facts
+openshift_examples
+
+Example Playbook
+----------------
+
+- name: Configure openshift-metrics
+ hosts: oo_first_master
+ roles:
+ - role: openshift_metrics
+
+License
+-------
+
+Apache License, Version 2.0
+
+Author Information
+------------------
+
+Jose David Martín (j.david.nieto@gmail.com)