From 6a319bd8f5c5bee3c81b0ec036ff5afa9057566a Mon Sep 17 00:00:00 2001 From: Taylor Thomas Date: Thu, 9 Mar 2017 12:58:46 -0800 Subject: [PATCH] fix(docs): Updates hook documentation for `--wait` flag The behavior of how the `--wait` flag interacts with the hook lifecycle was not documented. This adds clarification on the lifecycle behavior with the `--wait` flag. --- docs/charts_hooks.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/charts_hooks.md b/docs/charts_hooks.md index 1d6201a7e..56cecd788 100644 --- a/docs/charts_hooks.md +++ b/docs/charts_hooks.md @@ -61,7 +61,9 @@ hooks, the lifecycle is altered like this: 4. Tiller executes the `pre-install` hook (loading hook resources into Kubernetes) 5. Tiller waits until the hook is "Ready" -6. Tiller loads the resulting resources into Kubernetes +6. Tiller loads the resulting resources into Kubernetes. Note that if the `--wait` +flag is set, Tiller will wait until all resources are in a ready state +and will not run the `post-install` hook until they are ready. 7. Tiller executes the `post-install` hook (loading hook resources) 8. Tiller waits until the hook is "Ready" 9. Tiller returns the release name (and other data) to the client