Edit heading levels in alertmanager config docs

This commit is contained in:
Catherine Luse
2021-04-30 11:35:36 -07:00
parent 4160b24a67
commit 9f94885aaf
@@ -106,7 +106,7 @@ The following types of receivers can be configured in the Rancher UI:
The custom receiver option can be used to configure any receiver in YAML that cannot be configured by filling out the other forms in the Rancher UI.
### Slack
# Slack
| Field | Type | Description |
|------|--------------|------|
@@ -115,7 +115,7 @@ The custom receiver option can be used to configure any receiver in YAML that ca
| Proxy URL | String | Proxy for the webhook notifications. |
| Enable Send Resolved Alerts | Bool | Whether to send a follow-up notification if an alert has been resolved (e.g. [Resolved] High CPU Usage). |
### Email
# Email
| Field | Type | Description |
|------|--------------|------|
@@ -132,7 +132,7 @@ SMTP options:
| Username | String | Enter a username to authenticate with the SMTP server. |
| Password | String | Enter a password to authenticate with the SMTP server. |
### PagerDuty
# PagerDuty
| Field | Type | Description |
|------|------|-------|
@@ -141,7 +141,7 @@ SMTP options:
| Proxy URL | String | Proxy for the PagerDuty notifications. |
| Enable Send Resolved Alerts | Bool | Whether to send a follow-up notification if an alert has been resolved (e.g. [Resolved] High CPU Usage). |
### Opsgenie
# Opsgenie
| Field | Description |
|------|-------------|
@@ -156,7 +156,7 @@ Opsgenie Responders:
| Type | String | Schedule, Team, User, or Escalation. For more information on alert responders, refer to the [Opsgenie documentation.](https://docs.opsgenie.com/docs/alert-recipients-and-teams) |
| Send To | String | Id, Name, or Username of the Opsgenie recipient. |
### Webhook
# Webhook
| Field | Description |
|-------|--------------|
@@ -166,13 +166,13 @@ Opsgenie Responders:
<!-- TODO add info on webhook for teams and sms and link to them -->
### Custom
# Custom
The YAML provided here will be directly appended to your receiver within the Alertmanager Config Secret.
### Teams
# Teams
#### Enabling the Teams Receiver for Rancher Managed Clusters
### Enabling the Teams Receiver for Rancher Managed Clusters
The Teams receiver is not a native receiver and must be enabled before it can be used. You can enable the Teams receiver for a Rancher managed cluster by going to the Apps page and installing the rancher-alerting-drivers app with the Teams option selected.
@@ -183,7 +183,7 @@ The Teams receiver is not a native receiver and must be enabled before it can be
1. Select the **Teams** option and click **Install**.
1. Take note of the namespace used as it will be required in a later step.
#### Configure the Teams Receiver
### Configure the Teams Receiver
The Teams receiver can be configured by updating its ConfigMap. For example, the following is a minimal Teams receiver configuration.
@@ -204,9 +204,9 @@ url: http://rancher-alerting-drivers-prom2teams.ns-1.svc:8089/v2/teams-instance-
<!-- https://github.com/idealista/prom2teams -->
### SMS
# SMS
#### Enabling the SMS Receiver for Rancher Managed Clusters
### Enabling the SMS Receiver for Rancher Managed Clusters
The SMS receiver is not a native receiver and must be enabled before it can be used. You can enable the SMS receiver for a Rancher managed cluster by going to the Apps page and installing the rancher-alerting-drivers app with the SMS option selected.
@@ -217,7 +217,7 @@ The SMS receiver is not a native receiver and must be enabled before it can be u
1. Select the **SMS** option and click **Install**.
1. Take note of the namespace used as it will be required in a later step.
#### Configure the SMS Receiver
### Configure the SMS Receiver
The SMS receiver can be configured by updating its ConfigMap. For example, the following is a minimal SMS receiver configuration.