From b5f04eec047969e7c6c67b1a6c10f26910e087b9 Mon Sep 17 00:00:00 2001 From: Martin Hickey Date: Tue, 12 Feb 2019 16:07:22 +0000 Subject: [PATCH] Update the docs Signed-off-by: Martin Hickey --- docs/charts.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/charts.md b/docs/charts.md index 34d92b850..096b8ae6f 100644 --- a/docs/charts.md +++ b/docs/charts.md @@ -44,6 +44,7 @@ name: The name of the chart (required) version: A SemVer 2 version (required) kubeVersion: A SemVer range of compatible Kubernetes versions (optional) description: A single-sentence description of this project (optional) +type: It is the type of chart (optional) keywords: - A list of keywords about this project (optional) home: The URL of this project's home page (optional) @@ -117,6 +118,15 @@ project is: - Release the new chart version in the Chart Repository - Remove the chart from the source repository (e.g. git) +### Chart Types + +The `type` field defines the type of chart. There are 2 types: `application` +and `library`. Application is the default type and it is the standard chart +which can be operated on fully. The [library or helper chart](https://github.com/helm/charts/tree/master/incubator/common) +provides utilities or functions for the chart builder. A library chart differs +from an application chart because it has no resource object and is therefore not +installable. + ## Chart LICENSE, README and NOTES Charts can also contain files that describe the installation, configuration, usage and license of a