You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/20-admins/30-operation/100-session-alerts.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,6 @@ title: Session Alerts
4
4
5
5
Renku can receive alerts and display them to users within the Renku session interface. This allows users to be alerted to issues with their active sessions, such as high memory usage, low disk space, or out-of-memory kills.
In addition to dedicated endpoints for creating, listing, and resolving alerts, Renku has built-in support for handling alerts sent from Prometheus Alertmanager via a webhook integration. Support for other alerting systems may be added in the future.
@@ -45,26 +43,26 @@ The integration works as follows:
45
43
46
44
## Prerequisites
47
45
48
-
Prometheus and Alertmanager deployed in your cluster
49
-
Renku Data Services with the alerts feature enabled
46
+
- [Prometheus](https://prometheus.io/) with [Prometheus Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) and [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics) deployed in your cluster
47
+
- Renku deployed in your cluster with the `alerts.alertmanager.enabled=true` Helm value set
50
48
51
49
## Setting up Alertmanager Webhook Integration
52
50
53
51
The following steps configure Alertmanager to send session-related alerts to Renku.
54
52
55
53
### OAuth2 Authentication
56
54
57
-
The Alertmanager webhook endpoint requires authentication using OAuth2 client credentials. An initialization script has already created:
55
+
The Alertmanager webhook endpoint requires authentication using OAuth2 client credentials. An initialization script has already created the following Keycloak resources in the `Renku` realm:
58
56
59
-
- alertmanager OAuth2 client: Enables Alertmanager to authenticate webhook requests to Renku Data Services
60
-
- alertmanager-webhook realm role: Assigned to the client's service account to control access to the webhook endpoint
61
-
- Token audience configuration: The client is configured to include "renku" in the token audience claim, as required by Renku Data Services
57
+
- `alertmanager-webhook` OAuth2 client: Enables Alertmanager to authenticate webhook requests to Renku Data Services
58
+
- `alertmanager-webhook` realm role: Assigned to the client's service account to control access to the webhook endpoint
59
+
- Token audience configuration: The client is configured to include `renku` in the token audience claim
62
60
63
61
You will need the client secret from this client to proceed.
64
62
65
63
## Step 1: Store the Client Secret in Kubernetes
66
64
67
-
Create a Kubernetes secret for the OAuth2 client secret:
65
+
Create a Kubernetes secret for the OAuth2 client secret in the namespace where Prometheus Alertmanager is deployed (e.g., `monitoring`):
0 commit comments