Fix descriptions in config objects, make them single line (#15610)
Fotis Voutsas committed
Jul 28, 2023 at 11:47 UTC
869fa63317a78730d2362f3ae7b576ad84a11229
1 file changed
+7
-13
health/notifications/alerta/metadata.yaml
+7
-13
@@ -33,35 +33,29 @@
33
list:
34
- name: 'SEND_ALERTA'
35
default_value: ''
36
- description: |
37
- Set `SEND_ALERTA` to YES
36
+ description: "Set `SEND_ALERTA` to YES"
37
required: true
38
- name: 'ALERTA_WEBHOOK_URL'
39
default_value: ''
41
- description: |
42
- set `ALERTA_WEBHOOK_URL` to the API url you defined when you installed the Alerta server.
40
+ description: "set `ALERTA_WEBHOOK_URL` to the API url you defined when you installed the Alerta server."
41
required: true
42
- name: 'ALERTA_API_KEY'
43
default_value: ''
46
- description: |
47
- Set `ALERTA_API_KEY` to your API key.
44
+ description: "Set `ALERTA_API_KEY` to your API key."
45
required: true
49
- detailed_description: |
46
+ detailed_description: >
47
You will need an API key to send messages from any source, if Alerta is configured to use authentication (recommended). To create a new API key:
48
1. Go to Configuration > API Keys.
49
2. Create a new API key called "netdata" with `write:alerts` permission.
50
- name: 'DEFAULT_RECIPIENT_ALERTA'
51
default_value: ''
55
- description: |
56
- Set `DEFAULT_RECIPIENT_ALERTA` to the default recipient environment you want the alert notifications to be sent to.
57
- All roles will default to this variable if left unconfigured.
52
+ description: "Set `DEFAULT_RECIPIENT_ALERTA` to the default recipient environment you want the alert notifications to be sent to. All roles will default to this variable if left unconfigured."
53
required: true
54
- name: 'DEFAULT_RECIPIENT_CUSTOM'
55
default_value: ''
61
- description: |
62
- Set different recipient environments per role, by editing `DEFAULT_RECIPIENT_CUSTOM` with the environment name of your choice
56
+ description: "Set different recipient environments per role, by editing `DEFAULT_RECIPIENT_CUSTOM` with the environment name of your choice"
57
required: false
64
- detailed_description: |
58
+ detailed_description: >
59
The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:
60
61
```