Merge pull request #2692 from DoctorZK/feat/hook-delete-policy

feat(*) add key helm.sh/hook-delete-policy to hook annotation

_proto/hapi/release/hook.proto

@@ -35,6 +35,10 @@ message Hook {
         RELEASE_TEST_SUCCESS = 9;
         RELEASE_TEST_FAILURE = 10;
 	}
+	enum DeletePolicy {
+	    SUCCEEDED = 0;
+	    FAILED = 1;
+	}
 	string name = 1;
 	// Kind is the Kubernetes kind.
 	string kind = 2;
@@ -48,4 +52,6 @@ message Hook {
 	google.protobuf.Timestamp last_run = 6;
 	// Weight indicates the sort order for execution among similar Hook type
 	int32 weight = 7;
+	// DeletePolicies are the policies that indicate when to delete the hook
+	repeated DeletePolicy delete_policies = 8;
 }

docs/charts_hooks.md

@@ -87,7 +87,7 @@ in the future.) It is considered good practice to add a hook weight, and set it
 to `0` if weight is not important.
 
 
-### Hook resources are unmanaged
+### Hook resources are not managed with correponding releases
 
 The resources that a hook creates are not tracked or managed as part of the
 release. Once Tiller verifies that the hook has reached its ready state, it
@@ -95,8 +95,8 @@ will leave the hook resource alone.
 
 Practically speaking, this means that if you create resources in a hook, you
 cannot rely upon `helm delete` to remove the resources. To destroy such
-resources, you need to write code to perform this operation in a `pre-delete`
-or `post-delete` hook.
+resources, you need to either write code to perform this operation in a `pre-delete`
+or `post-delete` hook or add `"helm.sh/hook-delete-policy"` annotation to the hook template file.
 
 ## Writing a Hook
 
@@ -122,6 +122,7 @@ metadata:
     # job is considered part of the release.
     "helm.sh/hook": post-install
     "helm.sh/hook-weight": "-5"
+    "helm/hook-delete-policy": hook-succeeded
 spec:
   template:
     metadata:
@@ -160,7 +161,7 @@ and a config map as a pre-install hook.
 When subcharts declare hooks, those are also evaluated. There is no way
 for a top-level chart to disable the hooks declared by subcharts.
 
-It is also possible to define a weight for a hook which will help build a
+It is possible to define a weight for a hook which will help build a
 deterministic executing order. Weights are defined using the following annotation:
 
 ```
@@ -172,3 +173,12 @@ Hook weights can be positive or negative numbers but must be represented as
 strings. When Tiller starts the execution cycle of hooks of a particular Kind it
 will sort those hooks in ascending order. 
 
+It is also possible to define policies that determine when to delete corresponding hook resources. Hook deletion policies are defined using the following annotation:
+
+```
+  annotations:
+    "helm.sh/hook-delete-policy": hook-succeeded
+```
+
+When using `"helm.sh/hook-delete-policy"` annoation, you can choose its value from `"hook-succeeded"` and `"hook-failed"`. The value `"hook-succeeded"` specifies Tiller should delete the hook after the hook is successfully excuted, while the value `"hook-failed"`specifies Tiller should delete the hook if the hook is failed during execuation.
+

pkg/hooks/hooks.go

@@ -26,6 +26,9 @@ const HookAnno = "helm.sh/hook"
 // HookWeightAnno is the label name for a hook weight
 const HookWeightAnno = "helm.sh/hook-weight"
 
+// HookDeleteAnno is the label name for the delete policy for a hook
+const HookDeleteAnno = "helm.sh/hook-delete-policy"
+
 // Types of hooks
 const (
 	PreInstall         = "pre-install"
@@ -40,6 +43,12 @@ const (
 	ReleaseTestFailure = "test-failure"
 )
 
+// Type of policy for deleting the hook
+const (
+	HookSucceeded = "hook-succeeded"
+	HookFailed    = "hook-failed"
+)
+
 // FilterTestHooks filters the list of hooks are returns only testing hooks.
 func FilterTestHooks(hooks []*release.Hook) []*release.Hook {
 	testHooks := []*release.Hook{}

pkg/proto/hapi/release/hook.pb.go

@@ -6,19 +6,9 @@ Package release is a generated protocol buffer package.
 
 It is generated from these files:
 	hapi/release/hook.proto
-	hapi/release/info.proto
-	hapi/release/release.proto
-	hapi/release/status.proto
-	hapi/release/test_run.proto
-	hapi/release/test_suite.proto
 
 It has these top-level messages:
 	Hook
-	Info
-	Release
-	Status
-	TestRun
-	TestSuite
 */
 package release
 
@@ -86,6 +76,27 @@ func (x Hook_Event) String() string {
 }
 func (Hook_Event) EnumDescriptor() ([]byte, []int) { return fileDescriptor0, []int{0, 0} }
 
+type Hook_DeletePolicy int32
+
+const (
+	Hook_SUCCEEDED Hook_DeletePolicy = 0
+	Hook_FAILED    Hook_DeletePolicy = 1
+)
+
+var Hook_DeletePolicy_name = map[int32]string{
+	0: "SUCCEEDED",
+	1: "FAILED",
+}
+var Hook_DeletePolicy_value = map[string]int32{
+	"SUCCEEDED": 0,
+	"FAILED":    1,
+}
+
+func (x Hook_DeletePolicy) String() string {
+	return proto.EnumName(Hook_DeletePolicy_name, int32(x))
+}
+func (Hook_DeletePolicy) EnumDescriptor() ([]byte, []int) { return fileDescriptor0, []int{0, 1} }
+
 // Hook defines a hook object.
 type Hook struct {
 	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
@@ -101,6 +112,8 @@ type Hook struct {
 	LastRun *google_protobuf.Timestamp `protobuf:"bytes,6,opt,name=last_run,json=lastRun" json:"last_run,omitempty"`
 	// Weight indicates the sort order for execution among similar Hook type
 	Weight int32 `protobuf:"varint,7,opt,name=weight" json:"weight,omitempty"`
+	// DeletePolicies are the policies that indicate when to delete the hook
+	DeletePolicies []Hook_DeletePolicy `protobuf:"varint,8,rep,packed,name=delete_policies,json=deletePolicies,enum=hapi.release.Hook_DeletePolicy" json:"delete_policies,omitempty"`
 }
 
 func (m *Hook) Reset()                    { *m = Hook{} }
@@ -157,37 +170,48 @@ func (m *Hook) GetWeight() int32 {
 	return 0
 }
 
+func (m *Hook) GetDeletePolicies() []Hook_DeletePolicy {
+	if m != nil {
+		return m.DeletePolicies
+	}
+	return nil
+}
+
 func init() {
 	proto.RegisterType((*Hook)(nil), "hapi.release.Hook")
 	proto.RegisterEnum("hapi.release.Hook_Event", Hook_Event_name, Hook_Event_value)
+	proto.RegisterEnum("hapi.release.Hook_DeletePolicy", Hook_DeletePolicy_name, Hook_DeletePolicy_value)
 }
 
 func init() { proto.RegisterFile("hapi/release/hook.proto", fileDescriptor0) }
 
 var fileDescriptor0 = []byte{
-	// 371 bytes of a gzipped FileDescriptorProto
-	0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x64, 0x90, 0xdf, 0x8e, 0x93, 0x40,
-	0x14, 0x87, 0x65, 0x5b, 0xa0, 0x3d, 0x5d, 0xd7, 0x71, 0x62, 0x74, 0xd2, 0x1b, 0xc9, 0x5e, 0x71,
-	0x35, 0x98, 0x35, 0x3e, 0x00, 0xdb, 0x1d, 0x75, 0xb3, 0x84, 0x36, 0x03, 0xc4, 0xc4, 0x1b, 0xc2,
-	0xc6, 0x69, 0x21, 0x2d, 0x0c, 0x29, 0x53, 0x7d, 0x33, 0x9f, 0xc4, 0x07, 0x32, 0x33, 0xfc, 0x89,
-	0x89, 0x77, 0x67, 0xbe, 0xdf, 0xc7, 0x39, 0x9c, 0x03, 0xef, 0xca, 0xa2, 0xad, 0x82, 0xb3, 0x38,
-	0x89, 0xa2, 0x13, 0x41, 0x29, 0xe5, 0x91, 0xb6, 0x67, 0xa9, 0x24, 0xbe, 0xd6, 0x01, 0x1d, 0x82,
-	0xf5, 0xfb, 0x83, 0x94, 0x87, 0x93, 0x08, 0x4c, 0xf6, 0x7c, 0xd9, 0x07, 0xaa, 0xaa, 0x45, 0xa7,
-	0x8a, 0xba, 0xed, 0xf5, 0xdb, 0xdf, 0x33, 0x98, 0x7f, 0x95, 0xf2, 0x88, 0x31, 0xcc, 0x9b, 0xa2,
-	0x16, 0xc4, 0xf2, 0x2c, 0x7f, 0xc9, 0x4d, 0xad, 0xd9, 0xb1, 0x6a, 0x7e, 0x90, 0xab, 0x9e, 0xe9,
-	0x5a, 0xb3, 0xb6, 0x50, 0x25, 0x99, 0xf5, 0x4c, 0xd7, 0x78, 0x0d, 0x8b, 0xba, 0x68, 0xaa, 0xbd,
-	0xe8, 0x14, 0x99, 0x1b, 0x3e, 0xbd, 0xf1, 0x07, 0x70, 0xc4, 0x4f, 0xd1, 0xa8, 0x8e, 0xd8, 0xde,
-	0xcc, 0xbf, 0xb9, 0x23, 0xf4, 0xdf, 0x1f, 0xa4, 0x7a, 0x36, 0x65, 0x5a, 0xe0, 0x83, 0x87, 0x3f,
-	0xc1, 0xe2, 0x54, 0x74, 0x2a, 0x3f, 0x5f, 0x1a, 0xe2, 0x78, 0x96, 0xbf, 0xba, 0x5b, 0xd3, 0x7e,
-	0x0d, 0x3a, 0xae, 0x41, 0xd3, 0x71, 0x0d, 0xee, 0x6a, 0x97, 0x5f, 0x1a, 0xfc, 0x16, 0x9c, 0x5f,
-	0xa2, 0x3a, 0x94, 0x8a, 0xb8, 0x9e, 0xe5, 0xdb, 0x7c, 0x78, 0xdd, 0xfe, 0xb1, 0xc0, 0x36, 0x03,
-	0xf0, 0x0a, 0xdc, 0x2c, 0x7e, 0x8a, 0xb7, 0xdf, 0x62, 0xf4, 0x02, 0xbf, 0x82, 0xd5, 0x8e, 0xb3,
-	0xfc, 0x31, 0x4e, 0xd2, 0x30, 0x8a, 0x90, 0x85, 0x11, 0x5c, 0xef, 0xb6, 0x49, 0x3a, 0x91, 0x2b,
-	0x7c, 0x03, 0xa0, 0x95, 0x07, 0x16, 0xb1, 0x94, 0xa1, 0x99, 0xf9, 0x44, 0x1b, 0x03, 0x98, 0x8f,
-	0x3d, 0xb2, 0xdd, 0x17, 0x1e, 0x3e, 0x30, 0x64, 0x4f, 0x3d, 0x46, 0xe2, 0x18, 0xc2, 0x59, 0xce,
-	0xb7, 0x51, 0x74, 0x1f, 0x6e, 0x9e, 0x90, 0x8b, 0x5f, 0xc3, 0x4b, 0xe3, 0x4c, 0x68, 0x81, 0x09,
-	0xbc, 0xe1, 0x2c, 0x62, 0x61, 0xc2, 0xf2, 0x94, 0x25, 0x69, 0x9e, 0x64, 0x9b, 0x0d, 0x4b, 0x12,
-	0xb4, 0xfc, 0x2f, 0xf9, 0x1c, 0x3e, 0x46, 0x19, 0x67, 0x08, 0xee, 0x97, 0xdf, 0xdd, 0xe1, 0x86,
-	0xcf, 0x8e, 0x39, 0xcb, 0xc7, 0xbf, 0x01, 0x00, 0x00, 0xff, 0xff, 0x82, 0x3c, 0x7a, 0x0e, 0x14,
-	0x02, 0x00, 0x00,
+	// 428 bytes of a gzipped FileDescriptorProto
+	0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x6c, 0x91, 0xd1, 0x6e, 0xda, 0x30,
+	0x14, 0x86, 0x9b, 0x12, 0x12, 0x38, 0x50, 0xea, 0x59, 0xd3, 0x66, 0x71, 0x53, 0xc4, 0x15, 0xbb,
+	0x09, 0x53, 0xa7, 0x3d, 0x40, 0x4a, 0xce, 0xd6, 0xaa, 0x11, 0x20, 0x27, 0x68, 0xd2, 0x6e, 0xa2,
+	0x74, 0xb8, 0x10, 0x11, 0xe2, 0x88, 0x98, 0x4d, 0x7b, 0xa6, 0xbd, 0xce, 0x1e, 0x68, 0xb2, 0x09,
+	0x59, 0xa5, 0xed, 0xee, 0x9c, 0xef, 0x7c, 0x76, 0xce, 0x1f, 0xc3, 0xdb, 0x6d, 0x5a, 0x66, 0xd3,
+	0x83, 0xc8, 0x45, 0x5a, 0x89, 0xe9, 0x56, 0xca, 0x9d, 0x57, 0x1e, 0xa4, 0x92, 0xb4, 0xaf, 0x07,
+	0x5e, 0x3d, 0x18, 0xde, 0x6c, 0xa4, 0xdc, 0xe4, 0x62, 0x6a, 0x66, 0x4f, 0xc7, 0xe7, 0xa9, 0xca,
+	0xf6, 0xa2, 0x52, 0xe9, 0xbe, 0x3c, 0xe9, 0xe3, 0x5f, 0x36, 0xd8, 0xf7, 0x52, 0xee, 0x28, 0x05,
+	0xbb, 0x48, 0xf7, 0x82, 0x59, 0x23, 0x6b, 0xd2, 0xe5, 0xa6, 0xd6, 0x6c, 0x97, 0x15, 0x6b, 0x76,
+	0x79, 0x62, 0xba, 0xd6, 0xac, 0x4c, 0xd5, 0x96, 0xb5, 0x4e, 0x4c, 0xd7, 0x74, 0x08, 0x9d, 0x7d,
+	0x5a, 0x64, 0xcf, 0xa2, 0x52, 0xcc, 0x36, 0xbc, 0xe9, 0xe9, 0x7b, 0x70, 0xc4, 0x77, 0x51, 0xa8,
+	0x8a, 0xb5, 0x47, 0xad, 0xc9, 0xe0, 0x96, 0x79, 0x2f, 0x17, 0xf4, 0xf4, 0xb7, 0x3d, 0xd4, 0x02,
+	0xaf, 0x3d, 0xfa, 0x11, 0x3a, 0x79, 0x5a, 0xa9, 0xe4, 0x70, 0x2c, 0x98, 0x33, 0xb2, 0x26, 0xbd,
+	0xdb, 0xa1, 0x77, 0x8a, 0xe1, 0x9d, 0x63, 0x78, 0xf1, 0x39, 0x06, 0x77, 0xb5, 0xcb, 0x8f, 0x05,
+	0x7d, 0x03, 0xce, 0x0f, 0x91, 0x6d, 0xb6, 0x8a, 0xb9, 0x23, 0x6b, 0xd2, 0xe6, 0x75, 0x47, 0xef,
+	0xe1, 0x7a, 0x2d, 0x72, 0xa1, 0x44, 0x52, 0xca, 0x3c, 0xfb, 0x96, 0x89, 0x8a, 0x75, 0xcc, 0x26,
+	0x37, 0xff, 0xd9, 0x24, 0x30, 0xe6, 0x52, 0x8b, 0x3f, 0xf9, 0x60, 0xfd, 0xb7, 0xcb, 0x44, 0x35,
+	0xfe, 0x6d, 0x41, 0xdb, 0xac, 0x4a, 0x7b, 0xe0, 0xae, 0xe6, 0x8f, 0xf3, 0xc5, 0x97, 0x39, 0xb9,
+	0xa0, 0xd7, 0xd0, 0x5b, 0x72, 0x4c, 0x1e, 0xe6, 0x51, 0xec, 0x87, 0x21, 0xb1, 0x28, 0x81, 0xfe,
+	0x72, 0x11, 0xc5, 0x0d, 0xb9, 0xa4, 0x03, 0x00, 0xad, 0x04, 0x18, 0x62, 0x8c, 0xa4, 0x65, 0x8e,
+	0x68, 0xa3, 0x06, 0xf6, 0xf9, 0x8e, 0xd5, 0xf2, 0x33, 0xf7, 0x03, 0x24, 0xed, 0xe6, 0x8e, 0x33,
+	0x71, 0x0c, 0xe1, 0x98, 0xf0, 0x45, 0x18, 0xde, 0xf9, 0xb3, 0x47, 0xe2, 0xd2, 0x57, 0x70, 0x65,
+	0x9c, 0x06, 0x75, 0x28, 0x83, 0xd7, 0x1c, 0x43, 0xf4, 0x23, 0x4c, 0x62, 0x8c, 0xe2, 0x24, 0x5a,
+	0xcd, 0x66, 0x18, 0x45, 0xa4, 0xfb, 0xcf, 0xe4, 0x93, 0xff, 0x10, 0xae, 0x38, 0x12, 0x18, 0xbf,
+	0x83, 0xfe, 0xcb, 0xd8, 0xf4, 0x0a, 0xba, 0xe6, 0x18, 0x06, 0x18, 0x90, 0x0b, 0x0a, 0xe0, 0x68,
+	0x17, 0x03, 0x62, 0xdd, 0x75, 0xbf, 0xba, 0xf5, 0xef, 0x7a, 0x72, 0xcc, 0x5b, 0x7c, 0xf8, 0x13,
+	0x00, 0x00, 0xff, 0xff, 0xb9, 0x8a, 0xe1, 0xaf, 0x89, 0x02, 0x00, 0x00,
 }

pkg/tiller/hooks.go

@@ -44,6 +44,12 @@ var events = map[string]release.Hook_Event{
 	hooks.ReleaseTestFailure: release.Hook_RELEASE_TEST_FAILURE,
 }
 
+// deletePolices represents a mapping between the key in the annotation for label deleting policy and its real meaning
+var deletePolices = map[string]release.Hook_DeletePolicy{
+	hooks.HookSucceeded: release.Hook_SUCCEEDED,
+	hooks.HookFailed:    release.Hook_FAILED,
+}
+
 // manifest represents a manifest file, which has a name and some content.
 type manifest struct {
 	name    string
@@ -113,6 +119,13 @@ func sortManifests(files map[string]string, apis chartutil.VersionSet, sort Sort
 //		annotations:
 //			helm.sh/hook: pre-install
 //
+// To determine the policy to delete the hook, it looks for a YAML structure like this:
+//
+//  kind: SomeKind
+//  apiVersion: v1
+//  metadata:
+// 		annotations:
+// 			helm.sh/hook-delete-policy: hook-succeeded
 func (file *manifestFile) sort(result *result) error {
 	for _, m := range file.entries {
 		var entry util.SimpleHead
@@ -149,12 +162,13 @@ func (file *manifestFile) sort(result *result) error {
 		hw := calculateHookWeight(entry)
 
 		h := &release.Hook{
-			Name:     entry.Metadata.Name,
-			Kind:     entry.Kind,
-			Path:     file.path,
-			Manifest: m,
-			Events:   []release.Hook_Event{},
-			Weight:   hw,
+			Name:           entry.Metadata.Name,
+			Kind:           entry.Kind,
+			Path:           file.path,
+			Manifest:       m,
+			Events:         []release.Hook_Event{},
+			Weight:         hw,
+			DeletePolicies: []release.Hook_DeletePolicy{},
 		}
 
 		isKnownHook := false
@@ -173,6 +187,22 @@ func (file *manifestFile) sort(result *result) error {
 		}
 
 		result.hooks = append(result.hooks, h)
+
+		isKnownDeletePolices := false
+		dps, ok := entry.Metadata.Annotations[hooks.HookDeleteAnno]
+		if ok {
+			for _, dp := range strings.Split(dps, ",") {
+				dp = strings.ToLower(strings.TrimSpace(dp))
+				p, exist := deletePolices[dp]
+				if exist {
+					isKnownDeletePolices = true
+					h.DeletePolicies = append(h.DeletePolicies, p)
+				}
+			}
+			if !isKnownDeletePolices {
+				log.Printf("info: skipping unknown hook delete policy: %q", dps)
+			}
+		}
 	}
 
 	return nil

pkg/tiller/release_server.go

@@ -30,6 +30,7 @@ import (
 	"k8s.io/kubernetes/pkg/client/clientset_generated/internalclientset"
 
 	"k8s.io/helm/pkg/chartutil"
+	"k8s.io/helm/pkg/hooks"
 	"k8s.io/helm/pkg/proto/hapi/chart"
 	"k8s.io/helm/pkg/proto/hapi/release"
 	"k8s.io/helm/pkg/proto/hapi/services"
@@ -347,12 +348,36 @@ func (s *ReleaseServer) execHook(hs []*release.Hook, name, namespace, hook strin
 		b.WriteString(h.Manifest)
 		if err := kubeCli.WatchUntilReady(namespace, b, timeout, false); err != nil {
 			s.Log("warning: Release %s %s %s could not complete: %s", name, hook, h.Path, err)
+			// If a hook is failed, checkout the annotation of the hook to determine whether the hook should be deleted
+			// under failed condition. If so, then clear the corresponding resource object in the hook
+			if hookShouldBeDeleted(h, hooks.HookFailed) {
+				b.Reset()
+				b.WriteString(h.Manifest)
+				s.Log("deleting %s hook %s for release %s due to %q policy", hook, h.Name, name, hooks.HookFailed)
+				if errHookDelete := kubeCli.Delete(namespace, b); errHookDelete != nil {
+					s.Log("warning: Release %s %s %S could not be deleted: %s", name, hook, h.Path, errHookDelete)
+					return errHookDelete
+				}
+			}
 			return err
 		}
-		h.LastRun = timeconv.Now()
 	}
 
 	s.Log("hooks complete for %s %s", hook, name)
+	// If all hooks are succeeded, checkout the annotation of each hook to determine whether the hook should be deleted
+	// under succeeded condition. If so, then clear the corresponding resource object in each hook
+	for _, h := range executingHooks {
+		b := bytes.NewBufferString(h.Manifest)
+		if hookShouldBeDeleted(h, hooks.HookSucceeded) {
+			s.Log("deleting %s hook %s for release %s due to %q policy", hook, h.Name, name, hooks.HookSucceeded)
+			if errHookDelete := kubeCli.Delete(namespace, b); errHookDelete != nil {
+				s.Log("warning: Release %s %s %S could not be deleted: %s", name, hook, h.Path, errHookDelete)
+				return errHookDelete
+			}
+		}
+		h.LastRun = timeconv.Now()
+	}
+
 	return nil
 }
 
@@ -373,3 +398,16 @@ func validateReleaseName(releaseName string) error {
 
 	return nil
 }
+
+// hookShouldBeDeleted determines whether the defined hook deletion policy matches the hook deletion polices
+// supported by helm. If so, mark the hook as one should be deleted.
+func hookShouldBeDeleted(hook *release.Hook, policy string) bool {
+	if dp, ok := deletePolices[policy]; ok {
+		for _, v := range hook.DeletePolicies {
+			if dp == v {
+				return true
+			}
+		}
+	}
+	return false
+}