summaryrefslogtreecommitdiffstats
path: root/roles/openshift_metrics/README.md
blob: 30a0a608db39a8e7dd9cb308d9b703c452d4a026 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
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_public_url             | null                  | Hawkular metrics public url                                 |
| 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.                         |
| openshift_hosted_metrics_duration               | `7`                   | Metrics query duration                                      |
| openshift_hosted_metrics_resolution             | `10s`                 | Metrics resolution                                          |


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)