Skip to content

Commit e919743

Browse files
committed
Add docs for environment variables
1 parent 4519dca commit e919743

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

doc/03-Configuration.md

+40
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,43 @@ Defined in the `prometheus` section of the configuration file.
5353
| Option | Description |
5454
|--------|--------------------------------------------------------------------------------------|
5555
| url | **Optional.** Prometheus server URL. If not set, metric synchronization is disabled. |
56+
57+
# Configuration via Environment Variables
58+
59+
**All** environment variables are prefixed with `ICINGA_FOR_KUBERNETES_`.
60+
The database type would therefore be `ICINGA_FOR_KUBERNETES_DATABASE_TYPE`.
61+
The configurations set by environment variables override the ones set by YAML.
62+
63+
## Database Configuration
64+
65+
| Env | Description |
66+
|-------------------|-------------------------------------------------------------------|
67+
| DATABASE_TYPE | **Optional.** Only `mysql` is supported yet which is the default. |
68+
| DATABASE_HOST | **Required.** Database host or absolute Unix socket path. |
69+
| DATABASE_PORT | **Optional.** Database port. By default, the MySQL port. |
70+
| DATABASE_DATABASE | **Required.** Database name. |
71+
| DATABASE_USER | **Required.** Database username. |
72+
| DATABASE_PASSWORD | **Optional.** Database password. |
73+
74+
## Logging Configuration
75+
76+
| Env | Description |
77+
|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
78+
| LOGGING_LEVEL | **Optional.** Default logging level. Can be set to `fatal`, `error`, `warn`, `info` or `debug`. If not set, defaults to `info`. |
79+
| LOGGING_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. |
80+
| LOGGING_INTERVAL | **Optional.** Interval for periodic logging defined as duration string. Valid units are `ms`, `s`, `m`, `h`. Defaults to `20s`. |
81+
82+
## Notifications Configuration
83+
84+
| Env | Description |
85+
|----------------------------------|-------------------------------------------------------------------------------------------------------|
86+
| NOTIFICATIONS_URL | **Optional.** Icinga Notifications daemon URL. If not set, notifications are disabled |
87+
| NOTIFICATIONS_USERNAME | **Optional.** Username for authenticating the Icinga for Kubernetes source in Icinga Notifications. |
88+
| NOTIFICATIONS_PASSWORD | **Optional.** Password for authenticating the Icinga for Kubernetes source in Icinga Notifications. |
89+
| NOTIFICATIONS_KUBERNETES_WEB_URL | **Optional.** The base URL of Icinga for Kubernetes Web used in generated Icinga Notification events. |
90+
91+
## Prometheus Configuration
92+
93+
| Env | Description |
94+
|----------------|--------------------------------------------------------------------------------------|
95+
| PROMETHEUS_URL | **Optional.** Prometheus server URL. If not set, metric synchronization is disabled. |

0 commit comments

Comments
 (0)