Skip to content

Commit d98015e

Browse files
committed
added documentation
1 parent 673b095 commit d98015e

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
## Module Graphite
2+
3+
This module only configures the module in Icinga Web and not the graphite backend itself.
4+
5+
## Variables
6+
7+
### Module Configuration File
8+
9+
The general module parameter like `enabled` and `source` can be applied here.
10+
11+
For the **config** file, create a dictionary with sections as keys and the parameters as values.
12+
13+
Example:
14+
15+
```
16+
icingaweb2_modules:
17+
graphite:
18+
enabled: true
19+
source: package
20+
config:
21+
graphite: # This is the section
22+
url: 127.0.0.1:9000
23+
user: graphite
24+
password: graphitepw
25+
ui:
26+
default_time_range: 6
27+
28+
```
29+
30+
#### Section graphite
31+
32+
| Variable | Type | Example |
33+
|----------|--------|------------------|
34+
| url | string | "127.0.0.1:9000" |
35+
| user | string | "graphite" |
36+
| password | string | "password" |
37+
| insecure | number | "1" |
38+
39+
#### Section ui
40+
41+
| Variable | Type | Example |
42+
|-------------------------|--------|---------|
43+
| default_time_range | number | "1" |
44+
| defautl_time_range_unit | string | "hours" |
45+
| disable_no_graphs_found | bool | "0"/"1" |
46+
47+
48+
#### Section icinga
49+
50+
| Variable | Type | Example |
51+
|---------------------------------------|--------|----------------------|
52+
| graphite_writer_host_name_template | string | "$host.template$" |
53+
| graphite_writer_service_name_template | string | "$service.template$" |
54+
| customvar_obscured_check_command | string | "customvar" |
55+
56+
57+
### Custom Template Files
58+
59+
Custom templates are good to enhance the graphite basic template library. To include own
60+
graphs and modifications.
61+
62+
To copy them into the templates folder please use the `custom_template_files` dictionary.
63+
64+
The `src_path` will search within any `files/` directory in the Ansible environment.
65+
66+
67+
```
68+
icingaweb2_modules:
69+
graphite:
70+
enabled: true
71+
source: package
72+
custom_template_files:
73+
- name: mygraph.ini
74+
src_path: graphite_templates/mygraph.ini
75+
- name: myothergraph.ini
76+
src_path: graphite_templates/myothergraph.ini
77+
```

0 commit comments

Comments
 (0)