github.com/koderover/helm@v2.17.0+incompatible/docs/chart_best_practices/README.md (about)

     1  # The Chart Best Practices Guide
     2  
     3  This guide covers the Helm Team's considered best practices for creating charts.
     4  It focuses on how charts should be structured.
     5  
     6  We focus primarily on best practices for charts that may be publicly deployed.
     7  We know that many charts are for internal-use only, and authors of such charts
     8  may find that their internal interests override our suggestions here.
     9  
    10  ## Table of Contents
    11  
    12  - [General Conventions](conventions.md): Learn about general chart conventions.
    13  - [Values Files](values.md): See the best practices for structuring `values.yaml`.
    14  - [Templates](templates.md): Learn some of the best techniques for writing templates.
    15  - [Requirements](requirements.md): Follow best practices for `requirements.yaml` files.
    16  - [Labels and Annotations](labels.md): Helm has a _heritage_ of labeling and annotating.
    17  - Kubernetes Resources:
    18  	- [Pods and Pod Specs](pods.md): See the best practices for working with pod specifications.
    19  	- [Role-Based Access Control](rbac.md): Guidance on creating and using service accounts, roles, and role bindings.
    20  	- [Custom Resource Definitions](custom_resource_definitions.md): Custom Resource Definitions (CRDs) have their own associated best practices.
    21