Skip to content

Commit

Permalink
feat(pyrra): add Grafana dashboards (#161)
Browse files Browse the repository at this point in the history
Signed-off-by: Sebastian Gaiser <[email protected]>
  • Loading branch information
sebastiangaiser authored May 2, 2024
1 parent 0ef0e04 commit 3aaed58
Show file tree
Hide file tree
Showing 8 changed files with 1,145 additions and 2 deletions.
2 changes: 1 addition & 1 deletion charts/pyrra/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ type: application
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)

version: 0.12.3
version: 0.13.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
Expand Down
12 changes: 11 additions & 1 deletion charts/pyrra/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pyrra

![Version: 0.12.3](https://img.shields.io/badge/Version-0.12.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.7.5](https://img.shields.io/badge/AppVersion-v0.7.5-informational?style=flat-square)
![Version: 0.13.0](https://img.shields.io/badge/Version-0.13.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.7.5](https://img.shields.io/badge/AppVersion-v0.7.5-informational?style=flat-square)

SLO manager and alert generator

Expand All @@ -12,11 +12,21 @@ Additionaly, you (most likely) will need to specify prometheusExternalUrl with U
Pyrra can be configured to validate SLOs and SLO groups using a webhook admission controller. This is an optional feature that can be enabled by setting the `validatingWebhookConfiguration.enabled` value to `true`. The webhook admission controller will validate SLOs when they are created or updated.
If the SLO object is invalid, the admission controller will reject the request and provide a reason for the failure. This requires cert-manager to be installed in the cluster. If cert-manager is not installed, the webhook admission controller will not be created.

## Grafana dashboards
Pyrra provides Grafana dashboards additionally to it's own UI.
The dashboards can be deployed using a ConfigMap and get's automatically [reloaded by a Grafana sidecar](https://github.com/grafana/helm-charts/tree/main/charts/grafana#sidecar-for-dashboards).

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| additionalLabels | object | `{}` | |
| dashboards.annotations | object | `{}` | |
| dashboards.enabled | bool | `false` | enables Grafana dashboards being deployed via configmap |
| dashboards.extraLabels | object | `{}` | |
| dashboards.label | string | `"grafana_dashboard"` | default value from the Grafana chart |
| dashboards.labelValue | string | `"1"` | default value from the Grafana chart |
| dashboards.namespace | string | `nil` | |
| extraApiArgs | list | `[]` | Extra args for Pyrra's API container |
| extraKubernetesArgs | list | `[]` | Extra args for Pyrra's Kubernetes container |
| fullnameOverride | string | `""` | Overrides helm-generated chart fullname |
Expand Down
4 changes: 4 additions & 0 deletions charts/pyrra/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ Additionaly, you (most likely) will need to specify prometheusExternalUrl with U
Pyrra can be configured to validate SLOs and SLO groups using a webhook admission controller. This is an optional feature that can be enabled by setting the `validatingWebhookConfiguration.enabled` value to `true`. The webhook admission controller will validate SLOs when they are created or updated.
If the SLO object is invalid, the admission controller will reject the request and provide a reason for the failure. This requires cert-manager to be installed in the cluster. If cert-manager is not installed, the webhook admission controller will not be created.

## Grafana dashboards
Pyrra provides Grafana dashboards additionally to it's own UI.
The dashboards can be deployed using a ConfigMap and get's automatically [reloaded by a Grafana sidecar](https://github.com/grafana/helm-charts/tree/main/charts/grafana#sidecar-for-dashboards).

{{ template "chart.valuesSection" . }}

## Upgrading
Expand Down
1 change: 1 addition & 0 deletions charts/pyrra/files/grafana-dashboards/.templateignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.json
Loading

0 comments on commit 3aaed58

Please sign in to comment.