Skip to content

feat: Ship optional default Grafana dashboard via Helm #3445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sameerdattav wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Ship optional default Grafana dashboard via Helm #3445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions charts/kubeflow-trainer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,19 @@ manager:
traffic.sidecar.istio.io/excludeInboundPorts: "9443"
```

### Grafana dashboard

The chart can optionally install a default Grafana dashboard (as a ConfigMap) for controller health and TrainJob controller activity.
This is disabled by default and is intended for clusters that run Grafana with a dashboard sidecar that imports dashboards from labeled ConfigMaps.

```bash
helm install kubeflow-trainer oci://ghcr.io/kubeflow/charts/kubeflow-trainer \
--version 2.1.0 \
--set grafanaDashboard.enabled=true
```
Comment on lines +118 to +121
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Helm install snippet pins --version 2.1.0, but the chart version in this repo is 2.2.0; this will mislead users and should either omit --version or be regenerated from the templated README source.

Copilot uses AI. Check for mistakes.

If your Grafana sidecar uses a different label selector, override `grafanaDashboard.labels` accordingly.

## Values

| Key | Type | Default | Description |
Expand Down Expand Up @@ -141,6 +154,10 @@ manager:
| manager.config.statusServer.qps | int | `5` | QPS rate limit for the TrainJob Status Server api client |
| manager.config.statusServer.burst | int | `10` | Burst rate limit for the TrainJob Status Server api client |
| webhook.failurePolicy | string | `"Fail"` | Specifies how unrecognized errors are handled. Available options are `Ignore` or `Fail`. |
| grafanaDashboard | object | `{"annotations":{},"enabled":false,"labels":{"grafana_dashboard":"1"}}` | |
| grafanaDashboard.enabled | bool | `false` | Whether to install the default Grafana dashboard ConfigMap. This is intended for environments that run Grafana with a dashboard sidecar (ConfigMap import). |
| grafanaDashboard.labels | object | `{"grafana_dashboard":"1"}` | Labels applied to the dashboard ConfigMap. Set this to match your Grafana sidecar label selector. |
| grafanaDashboard.annotations | object | `{}` | Optional annotations applied to the dashboard ConfigMap. Example: set a folder via grafana sidecar conventions. |
| dataCache.enabled | bool | `false` | Enable/disable data cache support (LWS dependency, ClusterRole). Set to `true` to install data cache components. |
| dataCache.lws.install | bool | `true` | Whether to install LeaderWorkerSet as a dependency. Set to `false` if LeaderWorkerSet is already installed in the cluster. |
| dataCache.lws.fullnameOverride | string | `"lws"` | String to fully override LeaderWorkerSet release name. |
Expand Down
13 changes: 13 additions & 0 deletions charts/kubeflow-trainer/README.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,19 @@ manager:
traffic.sidecar.istio.io/excludeInboundPorts: "9443"
```

### Grafana dashboard

The chart can optionally install a default Grafana dashboard (as a ConfigMap) for controller health and TrainJob controller activity.
This is disabled by default and is intended for clusters that run Grafana with a dashboard sidecar that imports dashboards from labeled ConfigMaps.

```bash
helm install kubeflow-trainer oci://ghcr.io/kubeflow/charts/kubeflow-trainer \
--version 2.1.0 \
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Helm install snippet pins --version 2.1.0, but the chart version in this repo is 2.2.0; this will mislead users and should either omit --version or template it from the chart version and regenerate README.md.

Suggested change
--version 2.1.0 \
--version {{ .Version }} \

Copilot uses AI. Check for mistakes.
--set grafanaDashboard.enabled=true
```

If your Grafana sidecar uses a different label selector, override `grafanaDashboard.labels` accordingly.

{{ template "chart.valuesSection" . }}

{{- define "chart.maintainersTable" -}}
Expand Down
Loading
Loading