From bd2fad1987d42c88d331d541e385321e3caf6bf6 Mon Sep 17 00:00:00 2001 From: Christoph Blecker Date: Sat, 11 Mar 2017 15:57:37 -0800 Subject: [PATCH] Add docs info to dependency.go --- cmd/helm/dependency.go | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/cmd/helm/dependency.go b/cmd/helm/dependency.go index b5b22f6ce..44cb29e4d 100644 --- a/cmd/helm/dependency.go +++ b/cmd/helm/dependency.go @@ -45,12 +45,12 @@ For example, this requirements file declares two dependencies: # requirements.yaml dependencies: - - name: nginx - version: "1.2.3" - repository: "https://example.com/charts" - - name: memcached - version: "3.2.1" - repository: "https://another.example.com/charts" + - name: nginx + version: "1.2.3" + repository: "https://example.com/charts" + - name: memcached + version: "3.2.1" + repository: "https://another.example.com/charts" The 'name' should be the name of a chart, where that name must match the name in that chart's 'Chart.yaml' file. @@ -61,6 +61,20 @@ The 'repository' URL should point to a Chart Repository. Helm expects that by appending '/index.yaml' to the URL, it should be able to retrieve the chart repository's index. Note: 'repository' cannot be a repository alias. It must be a URL. + +Starting from 2.2.0, repository can be defined as the path to the directory of +the dependency charts stored locally. The path should start with a prefix of +"file://". For example, + + # requirements.yaml + dependencies: + - name: nginx + version: "1.2.3" + repository: "file://../dependency_chart/nginx" + +If the dependency chart is retrieved locally, it is not required to have the +repository added to helm by "helm add repo". Version matching is also supported +for this case. ` const dependencyListDesc = `