Merge pull request #2157 from jchauncey/hook-weights

feat(hooks): Adds weighted hooks

docs/charts_hooks.md

@@ -58,16 +58,18 @@ hooks, the lifecycle is altered like this:
 1. User runs `helm install foo`
 2. Chart is loaded into Tiller
 3. After some verification, Tiller renders the `foo` templates
-4. Tiller executes the `pre-install` hook (loading hook resources into
+4. Tiller prepares to execute the `pre-install` hooks (loading hook resources into
    Kubernetes)
-5. Tiller waits until the hook is "Ready"
-6. Tiller loads the resulting resources into Kubernetes. Note that if the `--wait` 
+5. Tiller sorts hooks by weight (assigning a weight of 0 by default) and by name for those hooks with the same weight in ascending order.
+6. Tiller then loads the hook with the lowest weight first (negative to positive)
+7. Tiller waits until the hook is "Ready"
+8. 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
-10. The client exits
+9. Tiller executes the `post-install` hook (loading hook resources)
+10. Tiller waits until the hook is "Ready"
+11. Tiller returns the release name (and other data) to the client
+12. The client exits
 
 What does it mean to wait until a hook is ready? This depends on the
 resource declared in the hook. If the resources is a `Job` kind, Tiller
@@ -114,6 +116,7 @@ metadata:
     # This is what defines this resource as a hook. Without this line, the
     # job is considered part of the release.
     "helm.sh/hook": post-install
+    "helm.sh/hook-weight": "-5"
 spec:
   template:
     metadata:
@@ -154,3 +157,12 @@ When subcharts declare hooks, those are also evaluated. There is no way
 for a top-level chart to disable the hooks declared by subcharts. And
 again, there is no guaranteed ordering.
 
+It is also possible to define a weight for a hook which will help build a deterministic executing order. Weights are defined using the following annotation:
+
+```
+  annotations:
+    "helm.sh/hook-weight": "5"
+```
+
+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. 
+

pkg/hooks/hooks.go

@@ -23,6 +23,9 @@ import (
 // HookAnno is the label name for a hook
 const HookAnno = "helm.sh/hook"
 
+// HookWeightAnno is the label name for a hook weight
+const HookWeightAnno = "helm.sh/hook-weight"
+
 // Types of hooks
 const (
 	PreInstall         = "pre-install"

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

@@ -100,6 +100,8 @@ type Hook struct {
 	Events []Hook_Event `protobuf:"varint,5,rep,packed,name=events,enum=hapi.release.Hook_Event" json:"events,omitempty"`
 	// LastRun indicates the date/time this was last run.
 	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 types
+	Weight int `protobuf:"bytes,7,opt,name=weight" json:"weight,omitempty"`
 }
 
 func (m *Hook) Reset()                    { *m = Hook{} }

pkg/tiller/hook_sorter.go

+/*
+Copyright 2016 The Kubernetes Authors All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package tiller
+
+import (
+	"sort"
+
+	"k8s.io/helm/pkg/proto/hapi/release"
+)
+
+// sortByHookWeight does an in-place sort of hooks by their supplied weight.
+func sortByHookWeight(hooks []*release.Hook) []*release.Hook {
+	hs := newHookWeightSorter(hooks)
+	sort.Sort(hs)
+	return hs.hooks
+}
+
+type hookWeightSorter struct {
+	hooks []*release.Hook
+}
+
+func newHookWeightSorter(h []*release.Hook) *hookWeightSorter {
+	return &hookWeightSorter{
+		hooks: h,
+	}
+}
+
+func (hs *hookWeightSorter) Len() int { return len(hs.hooks) }
+
+func (hs *hookWeightSorter) Swap(i, j int) {
+	hs.hooks[i], hs.hooks[j] = hs.hooks[j], hs.hooks[i]
+}
+
+func (hs *hookWeightSorter) Less(i, j int) bool {
+	if hs.hooks[i].Weight == hs.hooks[j].Weight {
+		return hs.hooks[i].Name < hs.hooks[j].Name
+	}
+	return hs.hooks[i].Weight < hs.hooks[j].Weight
+}

pkg/tiller/hook_sorter_test.go

+/*
+Copyright 2017 The Kubernetes Authors All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package tiller
+
+import (
+	"testing"
+
+	"k8s.io/helm/pkg/proto/hapi/release"
+)
+
+func TestHookSorter(t *testing.T) {
+	hooks := []*release.Hook{
+		{
+			Name:   "g",
+			Kind:   "pre-install",
+			Weight: 99,
+		},
+		{
+			Name:   "f",
+			Kind:   "pre-install",
+			Weight: 3,
+		},
+		{
+			Name:   "b",
+			Kind:   "pre-install",
+			Weight: -3,
+		},
+		{
+			Name:   "e",
+			Kind:   "pre-install",
+			Weight: 3,
+		},
+		{
+			Name:   "a",
+			Kind:   "pre-install",
+			Weight: -10,
+		},
+		{
+			Name:   "c",
+			Kind:   "pre-install",
+			Weight: 0,
+		},
+		{
+			Name:   "d",
+			Kind:   "pre-install",
+			Weight: 3,
+		},
+	}
+
+	res := sortByHookWeight(hooks)
+	got := ""
+	expect := "abcdefg"
+	for _, r := range res {
+		got += r.Name
+	}
+	if got != expect {
+		t.Errorf("Expected %q, got %q", expect, got)
+	}
+}

pkg/tiller/hooks.go

@@ -20,6 +20,7 @@ import (
 	"fmt"
 	"log"
 	"path"
+	"strconv"
 	"strings"
 
 	"github.com/ghodss/yaml"
@@ -109,12 +110,20 @@ func sortManifests(files map[string]string, apis chartutil.VersionSet, sort Sort
 			generic = append(generic, manifest{name: n, content: c, head: &sh})
 			continue
 		}
+
+		hws, _ := sh.Metadata.Annotations[hooks.HookWeightAnno]
+		hw, err := strconv.Atoi(hws)
+		if err != nil {
+			hw = 0
+		}
+
 		h := &release.Hook{
 			Name:     sh.Metadata.Name,
 			Kind:     sh.Kind,
 			Path:     n,
 			Manifest: c,
 			Events:   []release.Hook_Event{},
+			Weight:   hw,
 		}
 
 		isHook := false

pkg/tiller/release_server.go

@@ -934,18 +934,19 @@ func (s *ReleaseServer) execHook(hs []*release.Hook, name, namespace, hook strin
 	}
 
 	log.Printf("Executing %s hooks for %s", hook, name)
+	executingHooks := []*release.Hook{}
 	for _, h := range hs {
-		found := false
 		for _, e := range h.Events {
 			if e == code {
-				found = true
+				executingHooks = append(executingHooks, h)
 			}
 		}
-		// If this doesn't implement the hook, skip it.
-		if !found {
-			continue
 	}
 
+	executingHooks = sortByHookWeight(executingHooks)
+
+	for _, h := range executingHooks {
+
 		b := bytes.NewBufferString(h.Manifest)
 		if err := kubeCli.Create(namespace, b, timeout, false); err != nil {
 			log.Printf("warning: Release %q %s %s failed: %s", name, hook, h.Path, err)
@@ -960,6 +961,7 @@ func (s *ReleaseServer) execHook(hs []*release.Hook, name, namespace, hook strin
 		}
 		h.LastRun = timeconv.Now()
 	}
+
 	log.Printf("Hooks complete for %s %s", hook, name)
 	return nil
 }