From 9d2bd248a57d915b7c9a257523925f5816f19a1a Mon Sep 17 00:00:00 2001 From: Ian Howell Date: Wed, 20 Mar 2019 15:46:51 -0500 Subject: [PATCH] Clean up documentation Signed-off-by: Ian Howell --- docs/charts.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/charts.md b/docs/charts.md index 611654119..17418682a 100644 --- a/docs/charts.md +++ b/docs/charts.md @@ -766,7 +766,7 @@ Also, global variables of parent charts take precedence over the global variable ### Schema Files -Sometimes, a chart writer might want to define a structure on their values. +Sometimes, a chart maintainer might want to define a structure on their values. This can be done by defining a schema in the `values.schema.yaml` file. A schema is the yaml representation of a [JSON Schema](https://json-schema.org/). It might look something like this: @@ -797,7 +797,15 @@ required: - port ``` -This schema will be applied to the values to validate it. An example of a +This schema will be applied to the values to validate it. Validation occurs +when any of the following commands are invoked: + +* `helm install` +* `helm upgrade` +* `helm lint` +* `helm template` + +An example of a `values.yaml` file that meets the requirements of this schema might look something like this: