Skip to content

Commit b59db0e

Browse files
committed
Add more config docs
1 parent c784fec commit b59db0e

File tree

1 file changed

+35
-14
lines changed

1 file changed

+35
-14
lines changed

doc/03-Configuration.md

+35-14
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Configuration
1+
# Configuration via YAML File
22

33
The configuration is stored in `/etc/icinga-kubernetes/config.yml`.
44
See [config.example.yml](../config.example.yml) for an example configuration.
@@ -9,19 +9,40 @@ Connection configuration for the database to which Icinga for Kubernetes synchro
99
This is also the database used in
1010
[Icinga for Kubernetes Web](https://icinga.com/docs/icinga-kubernetes-web) to view and work with the data.
1111

12-
| Option | Description |
13-
|----------|--------------------------------------------------------------------|
14-
| type | **Optional.** Only `mysql` is supported yet which is the default. |
15-
| host | **Required.** Database host or absolute Unix socket path. |
16-
| port | **Optional.** Database port. By default, the MySQL port. |
17-
| database | **Required.** Database name. |
18-
| user | **Required.** Database username. |
19-
| password | **Optional.** Database password. |
20-
| tls | **Optional.** Whether to use TLS. |
21-
| cert | **Optional.** Path to TLS client certificate. |
22-
| key | **Optional.** Path to TLS private key. |
23-
| ca | **Optional.** Path to TLS CA certificate. |
24-
| insecure | **Optional.** Whether not to verify the peer. |
12+
| Option | Description |
13+
|----------|-------------------------------------------------------------------|
14+
| type | **Optional.** Only `mysql` is supported yet which is the default. |
15+
| host | **Required.** Database host or absolute Unix socket path. |
16+
| port | **Optional.** Database port. By default, the MySQL port. |
17+
| database | **Required.** Database name. |
18+
| user | **Required.** Database username. |
19+
| password | **Optional.** Database password. |
20+
| tls | **Optional.** Whether to use TLS. |
21+
| cert | **Optional.** Path to TLS client certificate. |
22+
| key | **Optional.** Path to TLS private key. |
23+
| ca | **Optional.** Path to TLS CA certificate. |
24+
| insecure | **Optional.** Whether not to verify the peer. |
25+
26+
## Logging Configuration
27+
28+
| Env | Description |
29+
|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
30+
| level | **Optional.** Default logging level. Can be set to `fatal`, `error`, `warn`, `info` or `debug`. If not set, defaults to `info`. |
31+
| output | **Optional.** Logging output. Can be set to `console` (stderr) or `systemd-journald`. If not set, logs to systemd-journald when running under systemd, otherwise stderr. |
32+
| interval | **Optional.** Interval for periodic logging defined as duration string. Valid units are `ms`, `s`, `m`, `h`. Defaults to `20s`. |
33+
34+
## Notifications Configuration
35+
36+
Connection configuration for [Icinga Notifications](https://github.com/icinga/icinga-notifications) daemon.
37+
If one of `url`, `username`, or `password` is set, **all** must be set.
38+
Defined in the `notifications` section of the configuration file.
39+
40+
| Option | Description |
41+
|--------------------|-------------------------------------------------------------------------------------------------------|
42+
| url | **Optional.** Icinga Notifications daemon URL. If not set, notifications are disabled |
43+
| username | **Optional.** Username for authenticating the Icinga for Kubernetes source in Icinga Notifications. |
44+
| password | **Optional.** Password for authenticating the Icinga for Kubernetes source in Icinga Notifications. |
45+
| kubernetes_web_url | **Optional.** The base URL of Icinga for Kubernetes Web used in generated Icinga Notification events. |
2546

2647
## Prometheus Configuration
2748

0 commit comments

Comments
 (0)