Skip to content

feat(helm): add grafana dashboard#4686

Merged
Skarlso merged 4 commits intoexternal-secrets:mainfrom
onedr0p:include-grafana-dashboard
Apr 18, 2025
Merged

feat(helm): add grafana dashboard#4686
Skarlso merged 4 commits intoexternal-secrets:mainfrom
onedr0p:include-grafana-dashboard

Conversation

@onedr0p
Copy link
Copy Markdown
Contributor

@onedr0p onedr0p commented Apr 18, 2025

Problem Statement

The Helm chart does not include a Grafana Dashboard as an option to deploy. Having the Grafana dashboards be included in the Helm chart would be awesome as it would bundle them up as a straightforward way to deploy and get updates.

Related Issue

Can open a issue if needed

Proposed Changes

Include the Grafana dashboard as an option to enable in the Helm chart. Some examples of charts already doing this:

Dashboard was copied from

https://raw.githubusercontent.com/external-secrets/external-secrets/main/docs/snippets/dashboard.json

Checklist

  • I have read the contribution guidelines
  • All commits are signed with git commit --signoff
  • My changes have reasonable test coverage
  • All tests pass with make test
  • I ensured my PR is ready for review with make reviewable

@onedr0p onedr0p requested a review from a team as a code owner April 18, 2025 12:48
@onedr0p onedr0p requested a review from knelasevero April 18, 2025 12:48
@Skarlso
Copy link
Copy Markdown
Contributor

Skarlso commented Apr 18, 2025

I'm not against this per-say, however, this would mean that now, if we ship it, we maintain it. And I, personally, don't want to keep a grafana dashboard maintained. :D So I'm on the fence. :) @gusfcarvalho what are your thoughts?

@onedr0p
Copy link
Copy Markdown
Contributor Author

onedr0p commented Apr 18, 2025

While I am not a maintainer here, for the foreseeable future I can help maintain the dashboard and this feature. It should be pretty low maintenance especially given a 1.0 release appears to be incoming?

Edit: I swore I saw a 1.0.0-rc tag a few days ago 😆

@Skarlso
Copy link
Copy Markdown
Contributor

Skarlso commented Apr 18, 2025

@onedr0p I appreciate that, however, I'm thinking more long term. :) Will you be available in 1-2 years too? :D

@onedr0p
Copy link
Copy Markdown
Contributor Author

onedr0p commented Apr 18, 2025

I can't predict the future but I have been using ESO for the past 3+ years at the workplace and homelab, and cannot see myself migrating away any time soon or quitting the industry and starting a Llama farm.

onedr0p and others added 2 commits April 18, 2025 09:24
Signed-off-by: Devin Buhl <devin@buhl.casa>
Signed-off-by: Devin Buhl <devin@buhl.casa>
@onedr0p onedr0p force-pushed the include-grafana-dashboard branch from 5d5bdfc to 82ddf85 Compare April 18, 2025 13:24
@Skarlso
Copy link
Copy Markdown
Contributor

Skarlso commented Apr 18, 2025

Okay then. I have no concerns with adding one. Can you paste in a screenshot of the dashboard by any chance please? :) 🙇

Signed-off-by: Devin Buhl <devin@buhl.casa>
@onedr0p
Copy link
Copy Markdown
Contributor Author

onedr0p commented Apr 18, 2025

Sure, it's the same one provided in the docs here, probably could use some updating but maybe that can be tackled in another PR.

image

Signed-off-by: Devin Buhl <devin@buhl.casa>
@sonarqubecloud
Copy link
Copy Markdown

@Skarlso Skarlso merged commit 22cc2dd into external-secrets:main Apr 18, 2025
25 checks passed
@onedr0p onedr0p deleted the include-grafana-dashboard branch April 18, 2025 17:40
@gusfcarvalho
Copy link
Copy Markdown
Member

gusfcarvalho commented Apr 18, 2025

🥲 I am a bit concerned with our ability to provide support for users that don’t have a clue on whats going on. But maybe this helps issues like #4615

@gusfcarvalho
Copy link
Copy Markdown
Member

Also, would this render with flux/argocd? 🧐

@onedr0p
Copy link
Copy Markdown
Contributor Author

onedr0p commented Apr 18, 2025

I don't see why this wouldn't render with those? I'm using other charts with Flux that implement this just fine. I can't speak to Argo though

@gusfcarvalho
Copy link
Copy Markdown
Member

Iirc Argocd does not implement the full feature set for helm templating. Iirc things like lookup for sure does not work, so I was wondering if get file would, as I think (IIRC) we don’t ship the dashboard within our helm chart package

@onedr0p
Copy link
Copy Markdown
Contributor Author

onedr0p commented Apr 18, 2025

I know some of the nuances with Argo and Helm, and honestly it's not something that should hold back chart developers to implement features. If there are easy enough workarounds sure, then it makes sense to implement but anything hacky I'd argue Argo folks can workaround the issue themselves.

@gusfcarvalho
Copy link
Copy Markdown
Member

I know some of the nuances with Argo and Helm, and honestly it's not something that should hold back chart developers to implement features. If there are easy enough workarounds sure, then it makes sense to implement but anything hacky I'd argue Argo folks can workaround the issue themselves.

if only that were really true… 🥹

related to this PR: I believe we missed adding the JSON file to our helm packages. I’m almost 100% sure if users did helm install external-secrets external-secrets/external-secrets —set… that will fail because there’s no file path available for helm to find and consume

@onedr0p
Copy link
Copy Markdown
Contributor Author

onedr0p commented Apr 19, 2025

related to this PR: I believe we missed adding the JSON file to our helm packages. I’m almost 100% sure if users did helm install external-secrets external-secrets/external-secrets —set… that will fail because there’s no file path available for helm to find and consume

Can you explain a bit further? I based this PR off of work done in the Cilium and CNPG helm charts and those don't have that issue. I don't see any reason why it's not packaged, there's nothing in the .helmignore telling it to ignore the JSON file.

@gusfcarvalho
Copy link
Copy Markdown
Member

Take a look on our latest helm release (unpack the .tgz)

My belief here is that there will be no json file for helm to render, which either will generate no dashboards or throw a helm error.

something to look at when we release 😁

@gusfcarvalho
Copy link
Copy Markdown
Member

Nvm me I completely missed the file addition there. All good!!

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.

3 participants