Skip to content

[kube-prometheus-stack] Document Grafana dashboard folder options - #7219

Open
VERNIERELoic wants to merge 1 commit into
prometheus-community:mainfrom
VERNIERELoic:kps-grafana-sidecar-folder-example
Open

[kube-prometheus-stack] Document Grafana dashboard folder options#7219
VERNIERELoic wants to merge 1 commit into
prometheus-community:mainfrom
VERNIERELoic:kps-grafana-sidecar-folder-example

Conversation

@VERNIERELoic

Copy link
Copy Markdown

What this PR does / why we need it

grafana.sidecar.dashboards in this chart is passed straight to the Grafana subchart, which supports grouping dashboards into Grafana folders via folderAnnotation + provider.foldersFromFilesStructure. Neither key appears in this chart's values.yaml, so users have no way to discover the feature without digging into the Grafana chart.

This adds both as commented examples next to the keys they belong to:

grafana:
  sidecar:
    dashboards:
      folderAnnotation: grafana_folder
      provider:
        foldersFromFilesStructure: true

Which issue this PR fixes

N/A

Special notes for your reviewer

Comments only — no change to rendered output with default values. Verified that setting both values renders the expected FOLDER_ANNOTATION env var on the dashboard sidecar and options.foldersFromFilesStructure: true in the dashboard provider configmap.

Checklist

  • DCO signed
  • Chart Version bumped (88.5.4 -> 88.5.5)
  • Variables are documented in values.yaml (this chart does not keep a values table in README.md)
  • Title of the PR starts with chart name (e.g. [prometheus-couchdb-exporter])

Add commented examples for `grafana.sidecar.dashboards.folderAnnotation`
and `grafana.sidecar.dashboards.provider.foldersFromFilesStructure`, which
let the Grafana sidecar group dashboards into folders. Both keys are
supported by the Grafana subchart but were not discoverable from this
chart's values.yaml.

Values-only documentation change, no rendered output changes by default.

Signed-off-by: Loic VERNIERE <loic.verniere@icloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant