Merge pull request #3073 from joanrieu/helmignore-docs

docs(chart): add notes regarding `.helmignore` and `.Files`
pull/2880/head
Taylor Thomas 7 years ago committed by GitHub
commit d6ba39e6f2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -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. - 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. - Some files cannot be accessed through the `.Files` object, usually for security reasons.
- Files in `templates/` cannot be accessed. - 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. - 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.
<!-- (see https://github.com/jonschlinkert/markdown-toc) --> <!-- (see https://github.com/jonschlinkert/markdown-toc) -->

@ -590,9 +590,10 @@ sensitive_.
`Chart.Maintainers`. `Chart.Maintainers`.
- `Files`: A map-like object containing all non-special files in the chart. This - `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 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"}}` files that are present (unless they are excluded using `.helmignore`). Files can be
or using the `{{.Files.Get name}}` or `{{.Files.GetString name}}` functions. You can accessed using `{{index .Files "file.name"}}` or using the `{{.Files.Get name}}` or
also access the contents of the file as `[]byte` using `{{.Files.GetBytes}}` `{{.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 - `Capabilities`: A map-like object that contains information about the versions
of Kubernetes (`{{.Capabilities.KubeVersion}}`, Tiller of Kubernetes (`{{.Capabilities.KubeVersion}}`, Tiller
(`{{.Capabilities.TillerVersion}}`, and the supported Kubernetes API versions (`{{.Capabilities.TillerVersion}}`, and the supported Kubernetes API versions

Loading…
Cancel
Save