Updated Helm Installation Instructions

sustainable-computing-io / kepler-doc

Kepler uses eBPF to probe energy related system stats and exports as Prometheus metrics

https://sustainable-computing.io/

Apache License 2.0

13 stars 37 forks source link

Updated Helm Installation Instructions #145

Closed marvin-steinke closed 4 months ago

marvin-steinke commented 4 months ago

added helm Prometheus setup for users new to K8s who are not familiar with Prometheus Node Exporter which needs to be installed for Kepler to work. I recommend the installation of the kube-prometheus-stack.
clarified the usage of the serviceMonitor for the Kepler charts: The value serviceMonitor.enabled needs to be set to true and the value serviceMonitor.labels.release needs to be set to the release name of the kube-prometheus-stack installtion.
added some convenient post install instructions, also aimed at newer users.
added chinese version of this docs, translated by gpt-4. This is probably very wrong and should only serve as a draft for someone who speaks the language ^^

rootfs commented 4 months ago

@marvin-steinke thanks! can you sign DCO

Ensure you have a local copy of your branch by [checking out the pull request locally via command line](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally).
In your local branch, run: git rebase HEAD~2 --signoff
Force push your changes to overwrite the branch: git push --force-with-lease origin main

marvin-steinke commented 4 months ago

Can we try to have a link to prometheus install steps? Honestly I am not sure if we should cover prometheus steps in our document.... which means for any update on prometheus we should have an update ...

I'm afraid I don't know how to install the Kepler helm package for a non-helm prometheus installation regarding the release label that has to be set. Because of this I included specific instructions for a full helm install. The only way installation instructions for the kube-prometheus-stack are going to change is if the repository stops to exists in which case we would have to link another helm chart anyways, right?

SamYuan1990 commented 4 months ago

Can we try to have a link to prometheus install steps? Honestly I am not sure if we should cover prometheus steps in our document.... which means for any update on prometheus we should have an update ...

I'm afraid I don't know how to install the Kepler helm package for a non-helm prometheus installation regarding the release label that has to be set. Because of this I included specific instructions for a full helm install. The only way installation instructions for the kube-prometheus-stack are going to change is if the repository stops to exists in which case we would have to link another helm chart anyways, right?

ok, please go ahead to complete this PR and notify me after it's ready for review :-)