helm/docs/chart_best_practices/README.md

The Chart Best Practices Guide

This guide covers the Helm Team's considered best practices for creating charts. It focuses on how charts should be structured.

We focus primarily on best practices for charts that may be publicly deployed. We know that many charts are for internal-use only, and authors of such charts may find that their internal interests override our suggestions here.

Table of Contents

• General Conventions: Learn about general chart conventions.
• Values Files: See the best practices for structuring values.yaml.
• Templates: Learn some of the best techniques for writing templates.
• Requirements: Follow best practices for requirements.yaml files.
• Labels and Annotations: Helm has a heritage of labeling and annotating.
• Kubernetes Resources:
  • Pods and Pod Specs: See the best practices for working with pod specifications.
  • Third Party Resources: Third Party Resources (TPRs) have their own associated best practices.