bytheway / k8s-monitoring-helm

Kubernetes Monitoring Helm Charts

Maintainers

Name	Email	Url
petewall	[email protected]
skl	[email protected]

Usage

Helm must be installed to use the chart. Please refer to Helm's documentation to get started.

Once Helm is set up properly, add the repo as follows:

helm repo add grafana https://grafana.github.io/helm-charts

See the Chart Documentation for chart install instructions.

Contributing

We welcome contributions and improvements! Feel free to submit PRs.

If you make changes to this chart, please ensure that you've done the following:

• Use Helm Docs to check for updates to the chart documentation
  • cd charts/k8s-monitoring; helm-docs
• Check for updates to the example outputs
  • make test
  • If changes are acceptable, regenerate the outputs and re-test:
  • make regenerate-example-outputs test

Required tools:

• chart-testing
• Helm
• helm-docs
• Grafana Agent (used for linting the generated config files)
• yamllint
• yq

Run make install-deps to install all requirements (Mac supported only at the moment using Brew).

Bumping Dependent Chart Versions

• Update the dependency's version in Chart.yaml.
• cd charts/k8s-monitoring; helm dependency update
• Follow the steps above in Contributing to update the k8s-monitoring chart version and docs.
• Finally, take a moment to inspect the generated output for anything that might cause trouble.

Links

• Kubernetes Monitoring on Grafana Cloud
• Grafana Agent
• Kube State Metrics
• Node Exporter
• OpenCost