public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-25 20:48:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix tables of contents, headers and formatting

Browse Source
This commit is contained in:
Catherine Luse
2022-09-10 00:26:51 -07:00
parent 11ebb7d341
commit 5fdfa52386
336 changed files with 1249 additions and 3710 deletions
Download Patch File Download Diff File Expand all files Collapse all files
versioned_docs/version-2.5/reference-guides/monitoring-v2-configuration/helm-chart-options.md
+4 -11
View File
@@ -3,15 +3,8 @@ title: Helm Chart Options
weight: 8
---
- [Configuring Resource Limits and Requests](#configuring-resource-limits-and-requests)
- [Trusted CA for Notifiers](#trusted-ca-for-notifiers)
- [Additional Scrape Configurations](#additional-scrape-configurations)
- [Configuring Applications Packaged within Monitoring V2](#configuring-applications-packaged-within-monitoring-v2)
- [Increase the Replicas of Alertmanager](#increase-the-replicas-of-alertmanager)
- [Configuring the Namespace for a Persistent Grafana Dashboard](#configuring-the-namespace-for-a-persistent-grafana-dashboard)
# Configuring Resource Limits and Requests
## Configuring Resource Limits and Requests
The resource requests and limits can be configured when installing `rancher-monitoring`.
@@ -32,7 +25,7 @@ The default values in the table below are the minimum required resource limits a
At least 50Gi storage is recommended.
# Trusted CA for Notifiers
## Trusted CA for Notifiers
If you need to add a trusted CA to your notifier, follow these steps:
@@ -43,7 +36,7 @@ If you need to add a trusted CA to your notifier, follow these steps:
**Result:** The default Alertmanager custom resource will have access to your trusted CA.
# Additional Scrape Configurations
## Additional Scrape Configurations
If the scrape configuration you want cannot be specified via a ServiceMonitor or PodMonitor at the moment, you can provide an `additionalScrapeConfigSecret` on deploying or upgrading `rancher-monitoring`.
@@ -52,7 +45,7 @@ A [scrape_config section](https://prometheus.io/docs/prometheus/latest/configura
An example of where this might be used is with Istio. For more information, see [this section.](https://rancher.com/docs/rancher/v2.5/en/istio/configuration-reference/selectors-and-scrape)
# Configuring Applications Packaged within Monitoring v2
## Configuring Applications Packaged within Monitoring v2
We deploy kube-state-metrics and node-exporter with monitoring v2. Node exporter are deployed as DaemonSets. In the monitoring v2 helm chart, in the values.yaml, each of the things are deployed as sub charts.
versioned_docs/version-2.5/reference-guides/monitoring-v2-configuration/receivers.md
+14 -32
View File
@@ -17,26 +17,8 @@ The [Alertmanager Config](https://prometheus.io/docs/alerting/latest/configurati
> This section assumes familiarity with how monitoring components work together. For more information about Alertmanager, see [this section.](../../explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md#3-how-alertmanager-works)
- [Creating Receivers in the Rancher UI](#creating-receivers-in-the-rancher-ui)
- [Receiver Configuration](#receiver-configuration)
- [Slack](#slack)
- [Email](#email)
- [PagerDuty](#pagerduty)
- [Opsgenie](#opsgenie)
- [Webhook](#webhook)
- [Custom](#custom)
- [Teams](#teams)
- [SMS](#sms)
- [Route Configuration](#route-configuration)
- [Receiver](#receiver)
- [Grouping](#grouping)
- [Matching](#matching)
- [Configuring Multiple Receivers](#configuring-multiple-receivers)
- [Example Alertmanager Config](examples.md#example-alertmanager-config)
- [Example Route Config for CIS Scan Alerts](#example-route-config-for-cis-scan-alerts)
- [Trusted CA for Notifiers](#trusted-ca-for-notifiers)
# Creating Receivers in the Rancher UI
## Creating Receivers in the Rancher UI
_Available as of v2.5.4_
> **Prerequisites:**
@@ -53,7 +35,7 @@ To create notification receivers in the Rancher UI,
**Result:** Alerts can be configured to send notifications to the receiver(s).
# Receiver Configuration
## Receiver Configuration
The notification integrations are configured with the `receiver`, which is explained in the [Prometheus documentation.](https://prometheus.io/docs/alerting/latest/configuration/#receiver)
@@ -91,7 +73,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 |
|------|--------------|------|
@@ -100,7 +82,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 |
|------|--------------|------|
@@ -117,7 +99,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 |
|------|------|-------|
@@ -126,7 +108,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 |
|------|-------------|
@@ -141,7 +123,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 |
|-------|--------------|
@@ -151,11 +133,11 @@ 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
@@ -189,7 +171,7 @@ 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
@@ -315,7 +297,7 @@ The Alertmanager must be configured in YAML, as shown in these [examples.](#exam
</TabItem>
</Tabs>
# Configuring Multiple Receivers
## Configuring Multiple Receivers
By editing the forms in the Rancher UI, you can set up a Receiver resource with all the information Alertmanager needs to send alerts to your notification system.
@@ -324,7 +306,7 @@ It is also possible to send alerts to multiple notification systems. One way is
You can also set up multiple receivers by using the `continue` option for a route, so that the alerts sent to a receiver continue being evaluated in the next level of the routing tree, which could contain another receiver.
# Example Alertmanager Configs
## Example Alertmanager Configs
### Slack
To set up notifications via Slack, the following Alertmanager Config YAML can be placed into the `alertmanager.yaml` key of the Alertmanager Config Secret, where the `api_url` should be updated to use your Webhook URL from Slack:
@@ -371,7 +353,7 @@ receivers:
- service_key: 'database-integration-key'
```
# Example Route Config for CIS Scan Alerts
## Example Route Config for CIS Scan Alerts
While configuring the routes for `rancher-cis-benchmark` alerts, you can specify the matching using the key-value pair `job: rancher-cis-scan`.
@@ -396,6 +378,6 @@ spec:
For more information on enabling alerting for `rancher-cis-benchmark`, see [this section.](../../pages-for-subheaders/cis-scan-guides.md#enabling-alerting-for-rancher-cis-benchmark)
# Trusted CA for Notifiers
## Trusted CA for Notifiers
If you need to add a trusted CA to your notifier, follow the steps in [this section.](helm-chart-options.md#trusted-ca-for-notifiers)
versioned_docs/version-2.5/reference-guides/monitoring-v2-configuration/routes.md
+3 -7
View File
@@ -15,13 +15,9 @@ For more information about configuring routes, refer to the [official Alertmanag
> This section assumes familiarity with how monitoring components work together. For more information, see [this section.](../../explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md)
- [Route Restrictions](#route-restrictions)
- [Route Configuration](#route-configuration)
- [Receiver](#receiver)
- [Grouping](#grouping)
- [Matching](#matching)
# Route Restrictions
## Route Restrictions
Alertmanager proxies alerts for Prometheus based on its receivers and a routing tree that filters alerts to certain receivers based on labels.
@@ -31,7 +27,7 @@ In the Rancher UI for configuring routes and receivers, you can configure routin
Each receiver is for one or more notification providers. So if you know that every alert for Slack should also go to PagerDuty, you can configure both in the same receiver.
# Route Configuration
## Route Configuration
### Note on Labels and Annotations