From c27333fd4ce4301df49322100b905ccc4a9eec17 Mon Sep 17 00:00:00 2001 From: Joan Rieu Date: Sun, 29 Oct 2017 14:58:57 +0100 Subject: [PATCH 1/2] docs(chart): add note about `.helmignore` for `.Files` --- docs/charts.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/charts.md b/docs/charts.md index 5098e0041..ea747db3d 100644 --- a/docs/charts.md +++ b/docs/charts.md @@ -589,9 +589,10 @@ sensitive_. `Chart.Maintainers`. - `Files`: A map-like object containing all non-special files in the chart. This will not give you access to templates, but will give you access to additional - files that are present. Files can be accessed using `{{index .Files "file.name"}}` - or using the `{{.Files.Get name}}` or `{{.Files.GetString name}}` functions. You can - also access the contents of the file as `[]byte` using `{{.Files.GetBytes}}` + files that are present (unless they are excluded using `.helmignore`). Files can be + accessed using `{{index .Files "file.name"}}` or using the `{{.Files.Get name}}` or + `{{.Files.GetString name}}` functions. You can also access the contents of the file + as `[]byte` using `{{.Files.GetBytes}}` - `Capabilities`: A map-like object that contains information about the versions of Kubernetes (`{{.Capabilities.KubeVersion}}`, Tiller (`{{.Capabilities.TillerVersion}}`, and the supported Kubernetes API versions From 171fa2ac46d63602a560d4e32b246e87f8dc1173 Mon Sep 17 00:00:00 2001 From: Joan Rieu Date: Sun, 29 Oct 2017 15:05:43 +0100 Subject: [PATCH 2/2] docs(chart-files): add note about `.helmignore` --- docs/chart_template_guide/accessing_files.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/chart_template_guide/accessing_files.md b/docs/chart_template_guide/accessing_files.md index 3911af830..c547babdd 100644 --- a/docs/chart_template_guide/accessing_files.md +++ b/docs/chart_template_guide/accessing_files.md @@ -7,6 +7,7 @@ Helm provides access to files through the `.Files` object. Before we get going w - It is okay to add extra files to your Helm chart. These files will be bundled and sent to Tiller. Be careful, though. Charts must be smaller than 1M because of the storage limitations of Kubernetes objects. - Some files cannot be accessed through the `.Files` object, usually for security reasons. - Files in `templates/` cannot be accessed. + - Files excluded using `.helmignore` cannot be accessed. - Charts do not preserve UNIX mode information, so file-level permissions will have no impact on the availability of a file when it comes to the `.Files` object.