mirror/nttgin-BGPalerter
1
0
Fork 0
mirror of https://github.com/nttgin/BGPalerter.git synced 2024-05-19 06:50:08 +00:00
Code Issues Releases Wiki Activity

minor fixes in the documentation

Browse Source
This commit is contained in:
Massimo Candela
2020-01-12 05:53:55 +01:00
committed by GitHub
parent 683ed90c14
commit 009e526828
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/configuration.md
View File

@@ -256,7 +256,7 @@ Parameters for this report module:
|---|---| |---|---|
|colors| A dictionary having as key the event channel and as value a hex color (string). These colors will be used to make messages in Slack distinguishable. | |colors| A dictionary having as key the event channel and as value a hex color (string). These colors will be used to make messages in Slack distinguishable. |
|hooks| A dictionary containing Slack WebHooks grouped by user group (key: group, value: WebHook).| |hooks| A dictionary containing Slack WebHooks grouped by user group (key: group, value: WebHook).|
|hooks.default| The default user group. Each user group is a WebHook (url). | |hooks.default| The WebHook (URL) of the default user group.|
#### reportKafka #### reportKafka
@@ -296,6 +296,6 @@ Parameters for this report module:
|environment| The Alerta environment name. If not specified, it'll use the BGPalerter environment name. | |environment| The Alerta environment name. If not specified, it'll use the BGPalerter environment name. |
|key| Optional, the Alerta API key to use for authenticated requests. | |key| Optional, the Alerta API key to use for authenticated requests. |
|token| Optional value used when executing HTTP requests to the Alerta API with bearer authentication. | |token| Optional value used when executing HTTP requests to the Alerta API with bearer authentication. |
|resource_templates| A dictionary of string templates for each BGPalerter channels to generate the content of the `resource` field for the alert. If a channel doesn't have a template defined, the `default` template will be used (see `config.yml.example` for more details. | |resource_templates| A dictionary of string templates for each BGPalerter channels to generate the content of the `resource` field for the alert. If a channel doesn't have a template defined, the `default` template will be used (see `config.yml.example` for more details). |
|urls| A dictionary containing Alerta API URLs grouped by user group (key: group, value: API URL). | |urls| A dictionary containing Alerta API URLs grouped by user group (key: group, value: API URL). |
|urls.default| The default user group. Each user group is an Alerta API URL. | |urls.default| The Alerta API URL of the default user group. |