Add docs info to dependency.go

pull/2105/head
Christoph Blecker 8 years ago
parent 7b1a383950
commit bd2fad1987
No known key found for this signature in database
GPG Key ID: B34A59A9D39F838B

@ -45,12 +45,12 @@ For example, this requirements file declares two dependencies:
# requirements.yaml # requirements.yaml
dependencies: dependencies:
- name: nginx - name: nginx
version: "1.2.3" version: "1.2.3"
repository: "https://example.com/charts" repository: "https://example.com/charts"
- name: memcached - name: memcached
version: "3.2.1" version: "3.2.1"
repository: "https://another.example.com/charts" repository: "https://another.example.com/charts"
The 'name' should be the name of a chart, where that name must match the name The 'name' should be the name of a chart, where that name must match the name
in that chart's 'Chart.yaml' file. 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 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 repository's index. Note: 'repository' cannot be a repository alias. It must be
a URL. 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 = ` const dependencyListDesc = `

Loading…
Cancel
Save