Altinity / Altinity/clickhouse-operator

Grafana Dashboards not being installed as expected

Open
#1,875 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
2.6k
Forks
574
Avg merge
8d 6h
Merged PRs (30d)
6

Description

I am using the latest operator (0.25.5) and when I enable the creation of Grafana dashboards, then I am getting the following error:

The ConfigMap "clickhouse-operator-dashboards" is invalid: metadata.annotations: Too long: may not be more than 262144 bytes

I am using the following values.yaml when applying the operator Helm chart:

nameOverride: clickhouse-operator
serviceMonitor:
  enabled: true
  additionalLabels:
    release: kube-prometheus-stack
    team: "platform"
dashboards:
  enabled: true
  additionalLabels:
    grafana_dashboard: "1"
    release: kube-prometheus-stack
  grafana_folder: "clickhouse"

Currently my workaround is to output the manifests to disk and then I break out the dashboard ConfigMap into its own yaml file so I can apply it using the --server-side flag:

kubectl apply --server-side -f dashboards.yaml

However, I noticed that even then the dashboards were not put into the specified "clickhouse" folder.

It seems that the setting grafana_folder: "clickhouse" doesn't do anything. I pulled the chart locally and did a search across the entire chart for grafana_folder and indeed this value is not being used in any of the templates of the chart at the moment.

Hope that helps! Let me know if there is any more information I can provide. Thank you for creating this operator and making it OSS!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with values.yaml and the chart templates that render the dashboard ConfigMap; inspect the rendered annotations and how grafana_folder is handled. Reproduce the install with dashboards enabled, then verify the ConfigMap applies without the annotation-size error and that dashboards are placed in the requested clickhouse folder.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes, yaml
Domain
infrastructure, observability
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.