From 752db9d2e65b7018b90e9b0cd69560087d934ef3 Mon Sep 17 00:00:00 2001 From: Paul Czarkowski Date: Sat, 1 Jun 2019 10:39:05 -0500 Subject: [PATCH] make `install` command doc more explicit The `helm install` command can have unexpected behavior when running `helm install stable/foo` which could be both a local chart directory or a chart reference. Providing some notes to this effect seems prudent. Signed-off-by: Paul Czarkowski --- docs/helm/helm_install.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/helm/helm_install.md b/docs/helm/helm_install.md index 12ae81b78..4b01e86ee 100644 --- a/docs/helm/helm_install.md +++ b/docs/helm/helm_install.md @@ -57,6 +57,8 @@ There are five different ways you can express the chart you want to install: 4. By absolute URL: helm install https://example.com/charts/nginx-1.2.3.tgz 5. By chart reference and repo url: helm install --repo https://example.com/charts/ nginx +> Note: When installing a chart from the local filesystem it is advised that you use an absolute path like `./stable/mariadb/` to avoid the ambiguity of `stable/mariadb` being both a valid chart directory and a valid chart reference. Likewise when installing a chart from a chart reference, ensure you don't have a path in your working directory that matches the chart repo to avoid inadvertently installing from a local chart directory instead. + CHART REFERENCES A chart reference is a convenient way of reference a chart in a chart repository.