[docs] Chart.yaml change some fields from optional

to recommended
pull/3803/head
Shane Starcher 8 years ago committed by GitHub
parent 531deec220
commit e9459e606a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -49,7 +49,7 @@ kubeVersion: A SemVer range of compatible Kubernetes versions (optional)
description: A single-sentence description of this project (optional) description: A single-sentence description of this project (optional)
keywords: keywords:
- A list of keywords about this project (optional) - A list of keywords about this project (optional)
home: The URL of this project's home page (optional) home: The URL of this project's home page (recommended)
sources: sources:
- A list of URLs to source code for this project (optional) - A list of URLs to source code for this project (optional)
maintainers: # (optional) maintainers: # (optional)
@ -57,12 +57,14 @@ maintainers: # (optional)
email: The maintainer's email (optional for each maintainer) email: The maintainer's email (optional for each maintainer)
url: A URL for the maintainer (optional for each maintainer) url: A URL for the maintainer (optional for each maintainer)
engine: gotpl # The name of the template engine (optional, defaults to gotpl) engine: gotpl # The name of the template engine (optional, defaults to gotpl)
icon: A URL to an SVG or PNG image to be used as an icon (optional). icon: A URL to an SVG or PNG image to be used as an icon (recommended).
appVersion: The version of the app that this contains (optional). This needn't be SemVer. appVersion: The version of the app that this contains (recommended). This needn't be SemVer.
deprecated: Whether this chart is deprecated (optional, boolean) deprecated: Whether this chart is deprecated (optional, boolean)
tillerVersion: The version of Tiller that this chart requires. This should be expressed as a SemVer range: ">2.0.0" (optional) tillerVersion: The version of Tiller that this chart requires. This should be expressed as a SemVer range: ">2.0.0" (optional)
``` ```
Recommended fields if missing will fail linting.
If you are familiar with the `Chart.yaml` file format for Helm Classic, you will If you are familiar with the `Chart.yaml` file format for Helm Classic, you will
notice that fields specifying dependencies have been removed. That is because notice that fields specifying dependencies have been removed. That is because
the new Chart format expresses dependencies using the `charts/` directory. the new Chart format expresses dependencies using the `charts/` directory.

Loading…
Cancel
Save