Example Documentation: Helm Chart
Goal
Use a small manifest as a Helm chart with values.yaml, templates, upgrade and rollback.
What Is Done
The chart renders a Deployment and a Service. Configuration such as image, replicas, service port and resources lives in values.yaml.
Typical Commands
helm lint chart/
helm template workshop-web chart/
helm upgrade --install workshop-web chart/ --namespace helm-lab --create-namespace
helm status workshop-web --namespace helm-lab
helm rollback workshop-web 1 --namespace helm-lab
Validate Success
helm lintreports no error.helm templaterenders valid Kubernetes resources.- Helm keeps release history.
Common Mistakes
- Templates are applied directly with
kubectl apply. - Values are hard-coded into templates.
- Release name and resource name are confused.