Skip to content

Latest commit

 

History

History
39 lines (31 loc) · 1.9 KB

requirements.md

File metadata and controls

39 lines (31 loc) · 1.9 KB

Requirements

Contributions to this repository must adhere to the following technical and documentation requirements.

Technical requirements

Musts

  • Must submit all chart dependencies separately.
  • Must pass the linter (helm lint).
  • Must successfully launch with default values (helm install .).
    • All pods go to the running state (or NOTES.txt provides further instructions if a required value is missing).
    • All services have at least one endpoint.
  • Must include source GitHub repositories for images used in the chart.
  • Must be up-to-date with the latest stable Helm/Kubernetes features.
    • Use Deployments instead of ReplicationControllers.

Nice-to-haves

  • Images should not have any major security vulnerabilities.
  • Should follow Kubernetes best practices.
  • Provide a method for data persistence (if applicable).
  • Support application upgrades.
  • Allow customization of the application configuration.
  • Provide a secure default configuration.
  • Do not leverage alpha features of Kubernetes.
  • Follow best practices (especially for labels and values).

Documentation requirements

  • Must include an in-depth README.md, including:
    • Short description of the chart
    • Any prerequisites/requirements
    • Customization options in values.yaml and their defaults
  • Must include a short NOTES.txt, including:
    • Any relevant post-install information for the chart
    • Instructions on how to access the application or service provided by the chart