docs(chart_tips_and_tricks): explain resource-policy.

This adds a short explanation of the resource policy annotation.

Closes #1880
pull/1888/head
Matt Butcher 8 years ago
parent d41f093331
commit c5d0dc49c4
No known key found for this signature in database
GPG Key ID: DCD5F5E5EF32C345

@ -74,16 +74,38 @@ The `sha256sum` function can be used together with the `include`
function to ensure a deployments template section is updated if another function to ensure a deployments template section is updated if another
spec changes: spec changes:
``` ```yaml
kind: Deployment kind: Deployment
spec: spec:
template: template:
metadata: metadata:
annotations: annotations:
checksum/config: {{ include (print $.Chart.Name "/templates/secret.yaml") . | sha256sum }} checksum/config: {{ include (print $.Chart.Name "/templates/secret.yaml") . | sha256sum }}
[...] [...]
``` ```
## Tell Tiller Not To Delete a Resource
Sometimes there are resources that should not be deleted when Helm runs a
`helm delete`. Chart developers can add an annotation to a resource to prevent
it from being deleted.
```yaml
kind: Secret
metadata:
annotations:
"helm.sh/resource-policy": keep
[...]
```
(Quotation marks are required)
The annotation `"helm.sh/resource-policy": keep` instructs Tiller to skip this
resource during a `helm delete` operation. _However_, this resource becomes
orphaned. Helm will no longer manage it in any way. This can lead to problems
if using `helm install --replace` on a release that has already been deleted, but
has kept resources.
## Using "Partials" and Template Includes ## Using "Partials" and Template Includes
Sometimes you want to create some reusable parts in your chart, whether Sometimes you want to create some reusable parts in your chart, whether

Loading…
Cancel
Save