Skip to content

Commit 98bdde9

Browse files
Add doc for how to install rancher-alerting-drivers (#713)
Signed-off-by: Cooper Tseng <[email protected]> Co-authored-by: Jillian Maroket <[email protected]>
1 parent 85d69cc commit 98bdde9

File tree

3 files changed

+138
-0
lines changed

3 files changed

+138
-0
lines changed

docs/monitoring/harvester-monitoring.md

+46
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,52 @@ Fill in the required parameters and click `Create`.
181181

182182
![](/img/v1.2/monitoring/webhook-receiver-2.png)
183183

184+
To set up Microsoft Teams or SMS webhooks, first install the rancher-alerting-drivers app using the following commands:
185+
186+
```shell
187+
helm repo add rancher-charts https://charts.rancher.io/
188+
helm repo update
189+
helm install rancher-charts/rancher-alerting-drivers \
190+
--set sachet.enabled=false \ # Set to true if you want to use SMS Webhook
191+
--set prom2teams.enabled=true \ # Set to true if you want to use MS Teams Webhook
192+
--namespace cattle-monitoring-system \
193+
--generate-name
194+
```
195+
196+
For detailed configuration instructions, see [Rancher Monitoring Receiver Configuration](https://ranchermanager.docs.rancher.com/reference-guides/monitoring-v2-configuration/receivers) in the Rancher documentation.
197+
198+
If your environment does not have direct internet access (air-gapped), you must manually download the Helm chart and related container images, and then upload them to the Harvester cluster.
199+
200+
1. Download the rancher-alerting-drivers Helm chart and package it.
201+
202+
```
203+
helm pull rancher-charts/rancher-alerting-drivers --version <VERSION>
204+
```
205+
206+
1. Download the required images.
207+
208+
```
209+
docker save -o sachet.tar rancher/mirrored-messagebird-sachet:<VERSION>
210+
docker save -o prom2teams.tar rancher/mirrored-idealista-prom2teams:<VERSION>
211+
```
212+
213+
1. Upload the chart and images to the Harvester cluster.
214+
215+
1. Load the images on all Harvester nodes.
216+
217+
```
218+
docker load -i sachet.tar
219+
docker load -i prom2teams.tar
220+
```
221+
222+
1. Install rancher-alerting-drivers on the Harvester cluster.
223+
224+
:::info important
225+
226+
Harvester does not manage upgrades of the rancher-alerting-drivers app, which is not part of the Harvester project. You must upgrade the app manually.
227+
228+
:::
229+
184230
#### Configure AlertmanagerConfig from CLI
185231
186232
You can also add `AlertmanagerConfig` from the CLI.

versioned_docs/version-v1.3/monitoring/harvester-monitoring.md

+46
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,52 @@ Fill in the required parameters and click `Create`.
181181

182182
![](/img/v1.2/monitoring/webhook-receiver-2.png)
183183

184+
To set up Microsoft Teams or SMS webhooks, first install the rancher-alerting-drivers app using the following commands:
185+
186+
```shell
187+
helm repo add rancher-charts https://charts.rancher.io/
188+
helm repo update
189+
helm install rancher-charts/rancher-alerting-drivers \
190+
--set sachet.enabled=false \ # Set to true if you want to use SMS Webhook
191+
--set prom2teams.enabled=true \ # Set to true if you want to use MS Teams Webhook
192+
--namespace cattle-monitoring-system \
193+
--generate-name
194+
```
195+
196+
For detailed configuration instructions, see [Rancher Monitoring Receiver Configuration](https://ranchermanager.docs.rancher.com/reference-guides/monitoring-v2-configuration/receivers) in the Rancher documentation.
197+
198+
If your environment does not have direct internet access (air-gapped), you must manually download the Helm chart and related container images, and then upload them to the Harvester cluster.
199+
200+
1. Download the rancher-alerting-drivers Helm chart and package it.
201+
202+
```
203+
helm pull rancher-charts/rancher-alerting-drivers --version <VERSION>
204+
```
205+
206+
1. Download the required images.
207+
208+
```
209+
docker save -o sachet.tar rancher/mirrored-messagebird-sachet:<VERSION>
210+
docker save -o prom2teams.tar rancher/mirrored-idealista-prom2teams:<VERSION>
211+
```
212+
213+
1. Upload the chart and images to the Harvester cluster.
214+
215+
1. Load the images on all Harvester nodes.
216+
217+
```
218+
docker load -i sachet.tar
219+
docker load -i prom2teams.tar
220+
```
221+
222+
1. Install rancher-alerting-drivers on the Harvester cluster.
223+
224+
:::info important
225+
226+
Harvester does not manage upgrades of the rancher-alerting-drivers app, which is not part of the Harvester project. You must upgrade the app manually.
227+
228+
:::
229+
184230
#### Configure AlertmanagerConfig from CLI
185231
186232
You can also add `AlertmanagerConfig` from the CLI.

versioned_docs/version-v1.4/monitoring/harvester-monitoring.md

+46
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,52 @@ Fill in the required parameters and click `Create`.
181181

182182
![](/img/v1.2/monitoring/webhook-receiver-2.png)
183183

184+
To set up Microsoft Teams or SMS webhooks, first install the rancher-alerting-drivers app using the following commands:
185+
186+
```shell
187+
helm repo add rancher-charts https://charts.rancher.io/
188+
helm repo update
189+
helm install rancher-charts/rancher-alerting-drivers \
190+
--set sachet.enabled=false \ # Set to true if you want to use SMS Webhook
191+
--set prom2teams.enabled=true \ # Set to true if you want to use MS Teams Webhook
192+
--namespace cattle-monitoring-system \
193+
--generate-name
194+
```
195+
196+
For detailed configuration instructions, see [Rancher Monitoring Receiver Configuration](https://ranchermanager.docs.rancher.com/reference-guides/monitoring-v2-configuration/receivers) in the Rancher documentation.
197+
198+
If your environment does not have direct internet access (air-gapped), you must manually download the Helm chart and related container images, and then upload them to the Harvester cluster.
199+
200+
1. Download the rancher-alerting-drivers Helm chart and package it.
201+
202+
```
203+
helm pull rancher-charts/rancher-alerting-drivers --version <VERSION>
204+
```
205+
206+
1. Download the required images.
207+
208+
```
209+
docker save -o sachet.tar rancher/mirrored-messagebird-sachet:<VERSION>
210+
docker save -o prom2teams.tar rancher/mirrored-idealista-prom2teams:<VERSION>
211+
```
212+
213+
1. Upload the chart and images to the Harvester cluster.
214+
215+
1. Load the images on all Harvester nodes.
216+
217+
```
218+
docker load -i sachet.tar
219+
docker load -i prom2teams.tar
220+
```
221+
222+
1. Install rancher-alerting-drivers on the Harvester cluster.
223+
224+
:::info important
225+
226+
Harvester does not manage upgrades of the rancher-alerting-drivers app, which is not part of the Harvester project. You must upgrade the app manually.
227+
228+
:::
229+
184230
#### Configure AlertmanagerConfig from CLI
185231
186232
You can also add `AlertmanagerConfig` from the CLI.

0 commit comments

Comments
 (0)