feat(tiller): record a message for each lifecycle step

This adds a simple description for each lifecycle step on a release
object.

Closes #1661

_proto/hapi/release/info.proto

@@ -31,4 +31,7 @@ message Info {
 
 	// Deleted tracks when this object was deleted.
 	google.protobuf.Timestamp deleted = 4;
+
+	// Description is human-friendly "log entry" about this release.
+	string Description = 5;
 }

cmd/helm/helm_test.go

@@ -95,6 +95,7 @@ func releaseMock(opts *releaseOptions) *release.Release {
 			FirstDeployed: &date,
 			LastDeployed:  &date,
 			Status:        &release.Status{Code: scode},
+			Description:   "Release mock",
 		},
 		Chart:   ch,
 		Config:  &chart.Config{Raw: `name: "value"`},

cmd/helm/history.go

@@ -38,11 +38,11 @@ configures the maximum length of the revision list returned.
 The historical release set is printed as a formatted table, e.g:
 
     $ helm history angry-bird --max=4
-    REVISION   UPDATED                      STATUS           CHART
+    REVISION   UPDATED                      STATUS           CHART        DESCRIPTION
-    1           Mon Oct 3 10:15:13 2016     SUPERSEDED      alpine-0.1.0
+    1           Mon Oct 3 10:15:13 2016     SUPERSEDED      alpine-0.1.0  Initial install
-    2           Mon Oct 3 10:15:13 2016     SUPERSEDED      alpine-0.1.0
+    2           Mon Oct 3 10:15:13 2016     SUPERSEDED      alpine-0.1.0  Upgraded successfully
-    3           Mon Oct 3 10:15:13 2016     SUPERSEDED      alpine-0.1.0
+    3           Mon Oct 3 10:15:13 2016     SUPERSEDED      alpine-0.1.0  Rolled back to 2
-    4           Mon Oct 3 10:15:13 2016     DEPLOYED        alpine-0.1.0
+    4           Mon Oct 3 10:15:13 2016     DEPLOYED        alpine-0.1.0  Upgraded successfully
 `
 
 type historyCmd struct {
@@ -98,14 +98,15 @@ func (cmd *historyCmd) run() error {
 func formatHistory(rls []*release.Release) string {
 	tbl := uitable.New()
 	tbl.MaxColWidth = 30
-	tbl.AddRow("REVISION", "UPDATED", "STATUS", "CHART")
+	tbl.AddRow("REVISION", "UPDATED", "STATUS", "CHART", "DESCRIPTION")
 	for i := len(rls) - 1; i >= 0; i-- {
 		r := rls[i]
 		c := formatChartname(r.Chart)
 		t := timeconv.String(r.Info.LastDeployed)
 		s := r.Info.Status.Code.String()
 		v := r.Version
-		tbl.AddRow(v, t, s, c)
+		d := r.Info.Description
+		tbl.AddRow(v, t, s, c, d)
 	}
 	return tbl.String()
 }

cmd/helm/history_test.go

@@ -50,7 +50,7 @@ func TestHistoryCmd(t *testing.T) {
 				mk("angry-bird", 2, rpb.Status_SUPERSEDED),
 				mk("angry-bird", 1, rpb.Status_SUPERSEDED),
 			},
-			xout: "REVISION\tUPDATED                 \tSTATUS    \tCHART           \n1       \t(.*)\tSUPERSEDED\tfoo-0.1.0-beta.1\n2       \t(.*)\tSUPERSEDED\tfoo-0.1.0-beta.1\n3       \t(.*)\tSUPERSEDED\tfoo-0.1.0-beta.1\n4       \t(.*)\tDEPLOYED  \tfoo-0.1.0-beta.1\n",
+			xout: "REVISION\tUPDATED                 \tSTATUS    \tCHART           \tDESCRIPTION \n1       \t(.*)\tSUPERSEDED\tfoo-0.1.0-beta.1\tRelease mock\n2       \t(.*)\tSUPERSEDED\tfoo-0.1.0-beta.1\tRelease mock\n3       \t(.*)\tSUPERSEDED\tfoo-0.1.0-beta.1\tRelease mock\n4       \t(.*)\tDEPLOYED  \tfoo-0.1.0-beta.1\tRelease mock\n",
 		},
 		{
 			cmds: "helm history --max=MAX RELEASE_NAME",
@@ -60,7 +60,7 @@ func TestHistoryCmd(t *testing.T) {
 				mk("angry-bird", 4, rpb.Status_DEPLOYED),
 				mk("angry-bird", 3, rpb.Status_SUPERSEDED),
 			},
-			xout: "REVISION\tUPDATED                 \tSTATUS    \tCHART           \n3       \t(.*)\tSUPERSEDED\tfoo-0.1.0-beta.1\n4       \t(.*)\tDEPLOYED  \tfoo-0.1.0-beta.1\n",
+			xout: "REVISION\tUPDATED                 \tSTATUS    \tCHART           \tDESCRIPTION \n3       \t(.*)\tSUPERSEDED\tfoo-0.1.0-beta.1\tRelease mock\n4       \t(.*)\tDEPLOYED  \tfoo-0.1.0-beta.1\tRelease mock\n",
 		},
 	}
 

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

@@ -21,6 +21,8 @@ type Info struct {
 	LastDeployed  *google_protobuf.Timestamp `protobuf:"bytes,3,opt,name=last_deployed,json=lastDeployed" json:"last_deployed,omitempty"`
 	// Deleted tracks when this object was deleted.
 	Deleted *google_protobuf.Timestamp `protobuf:"bytes,4,opt,name=deleted" json:"deleted,omitempty"`
+	// Description is human-friendly "log entry" about this release.
+	Description string `protobuf:"bytes,5,opt,name=Description" json:"Description,omitempty"`
 }
 
 func (m *Info) Reset()                    { *m = Info{} }
@@ -63,19 +65,20 @@ func init() {
 func init() { proto.RegisterFile("hapi/release/info.proto", fileDescriptor1) }
 
 var fileDescriptor1 = []byte{
-	// 212 bytes of a gzipped FileDescriptorProto
+	// 235 bytes of a gzipped FileDescriptorProto
-	0x1f, 0x8b, 0x08, 0x00, 0x00, 0x09, 0x6e, 0x88, 0x02, 0xff, 0xe2, 0x12, 0xcf, 0x48, 0x2c, 0xc8,
+	0x1f, 0x8b, 0x08, 0x00, 0x00, 0x09, 0x6e, 0x88, 0x02, 0xff, 0x84, 0x8f, 0x31, 0x4f, 0xc3, 0x30,
-	0xd4, 0x2f, 0x4a, 0xcd, 0x49, 0x4d, 0x2c, 0x4e, 0xd5, 0xcf, 0xcc, 0x4b, 0xcb, 0xd7, 0x2b, 0x28,
+	0x10, 0x85, 0x95, 0x52, 0x5a, 0xd5, 0x6d, 0x19, 0x2c, 0x24, 0x42, 0x16, 0x22, 0xa6, 0x0e, 0xc8,
-	0xca, 0x2f, 0xc9, 0x17, 0xe2, 0x01, 0x49, 0xe8, 0x41, 0x25, 0xa4, 0xe4, 0xd3, 0xf3, 0xf3, 0xd3,
+	0x91, 0x80, 0x1d, 0x81, 0xba, 0xb0, 0x06, 0x26, 0x16, 0xe4, 0xe2, 0x73, 0xb1, 0xe4, 0xe6, 0x2c,
-	0x73, 0x52, 0xf5, 0xc1, 0x72, 0x49, 0xa5, 0x69, 0xfa, 0x25, 0x99, 0xb9, 0xa9, 0xc5, 0x25, 0x89,
+	0xfb, 0x3a, 0xf0, 0x2f, 0xf8, 0xc9, 0xa8, 0xb6, 0x83, 0xd2, 0xa9, 0xab, 0xbf, 0xf7, 0x3e, 0xbf,
-	0xb9, 0x05, 0x10, 0xe5, 0x52, 0x92, 0x28, 0xe6, 0x14, 0x97, 0x24, 0x96, 0x94, 0x16, 0x43, 0xa4,
+	0x63, 0x57, 0xdf, 0xd2, 0x99, 0xc6, 0x83, 0x05, 0x19, 0xa0, 0x31, 0x9d, 0x46, 0xe1, 0x3c, 0x12,
-	0x94, 0xde, 0x31, 0x72, 0xb1, 0x78, 0xe6, 0xa5, 0xe5, 0x0b, 0xe9, 0x70, 0xb1, 0x41, 0x24, 0x24,
+	0xf2, 0xc5, 0x01, 0x88, 0x0c, 0xaa, 0x9b, 0x2d, 0xe2, 0xd6, 0x42, 0x13, 0xd9, 0x66, 0xaf, 0x1b,
-	0x18, 0x15, 0x18, 0x35, 0xb8, 0x8d, 0x44, 0xf4, 0x90, 0xed, 0xd0, 0x0b, 0x06, 0xcb, 0x05, 0x41,
+	0x32, 0x3b, 0x08, 0x24, 0x77, 0x2e, 0xc5, 0xab, 0xeb, 0x23, 0x4f, 0x20, 0x49, 0xfb, 0x90, 0xd0,
-	0xd5, 0x08, 0x39, 0x72, 0xf1, 0xa5, 0x65, 0x16, 0x15, 0x97, 0xc4, 0xa7, 0xa4, 0x16, 0xe4, 0xe4,
+	0xed, 0xef, 0x88, 0x8d, 0x5f, 0x3b, 0x8d, 0xfc, 0x8e, 0x4d, 0x12, 0x28, 0x8b, 0xba, 0x58, 0xcd,
-	0x57, 0xa6, 0xa6, 0x48, 0x30, 0x81, 0x75, 0x49, 0xe9, 0x41, 0xdc, 0xa2, 0x07, 0x73, 0x8b, 0x5e,
+	0xef, 0x2f, 0xc5, 0xf0, 0x0f, 0xf1, 0x16, 0x59, 0x9b, 0x33, 0xfc, 0x99, 0x5d, 0x68, 0xe3, 0x03,
-	0x08, 0xcc, 0x2d, 0x41, 0xbc, 0x60, 0x1d, 0x2e, 0x50, 0x0d, 0x42, 0xf6, 0x5c, 0xbc, 0x39, 0x89,
+	0x7d, 0x2a, 0x70, 0x16, 0x7f, 0x40, 0x95, 0xa3, 0xd8, 0xaa, 0x44, 0xda, 0x22, 0xfa, 0x2d, 0xe2,
-	0xc8, 0x26, 0x30, 0x13, 0x34, 0x81, 0x07, 0xa4, 0x01, 0x6e, 0x80, 0x09, 0x17, 0x7b, 0x4a, 0x6a,
+	0xbd, 0xdf, 0xd2, 0x2e, 0x63, 0x63, 0x9d, 0x0b, 0xfc, 0x89, 0x2d, 0xad, 0x1c, 0x1a, 0xce, 0x4e,
-	0x4e, 0x6a, 0x49, 0x6a, 0x8a, 0x04, 0x0b, 0x41, 0xad, 0x30, 0xa5, 0x4e, 0x9c, 0x51, 0xec, 0x50,
+	0x1a, 0x16, 0x87, 0xc2, 0xbf, 0xe0, 0x91, 0x4d, 0x15, 0x58, 0x20, 0x50, 0xe5, 0xf8, 0x64, 0xb5,
-	0x3f, 0x25, 0xb1, 0x81, 0xd5, 0x19, 0x03, 0x02, 0x00, 0x00, 0xff, 0xff, 0xeb, 0x9d, 0xa1, 0xf8,
+	0x8f, 0xf2, 0x9a, 0xcd, 0xd7, 0x10, 0xbe, 0xbc, 0x71, 0x64, 0xb0, 0x2b, 0xcf, 0xeb, 0x62, 0x35,
-	0x67, 0x01, 0x00, 0x00,
+	0x6b, 0x87, 0x4f, 0x2f, 0xb3, 0x8f, 0x69, 0xbe, 0x7a, 0x33, 0x89, 0xa6, 0x87, 0xbf, 0x00, 0x00,
+	0x00, 0xff, 0xff, 0x1a, 0x52, 0x8f, 0x9c, 0x89, 0x01, 0x00, 0x00,
 }

pkg/tiller/release_server.go

@@ -289,6 +289,7 @@ func (s *ReleaseServer) performUpdate(originalRelease, updatedRelease *release.R
 
 	if req.DryRun {
 		log.Printf("Dry run for %s", updatedRelease.Name)
+		res.Release.Info.Description = "Dry run complete"
 		return res, nil
 	}
 
@@ -300,9 +301,11 @@ func (s *ReleaseServer) performUpdate(originalRelease, updatedRelease *release.R
 	}
 
 	if err := s.performKubeUpdate(originalRelease, updatedRelease, req.Recreate, req.Timeout, req.Wait); err != nil {
-		log.Printf("warning: Release Upgrade %q failed: %s", updatedRelease.Name, err)
+		msg := fmt.Sprintf("Upgrade %q failed: %s", updatedRelease.Name, err)
+		log.Printf("warning: %s", msg)
 		originalRelease.Info.Status.Code = release.Status_SUPERSEDED
 		updatedRelease.Info.Status.Code = release.Status_FAILED
+		updatedRelease.Info.Description = msg
 		s.recordRelease(originalRelease, true)
 		s.recordRelease(updatedRelease, false)
 		return res, err
@@ -319,6 +322,7 @@ func (s *ReleaseServer) performUpdate(originalRelease, updatedRelease *release.R
 	s.recordRelease(originalRelease, true)
 
 	updatedRelease.Info.Status.Code = release.Status_DEPLOYED
+	updatedRelease.Info.Description = "Upgrade complete"
 
 	return res, nil
 }
@@ -404,6 +408,7 @@ func (s *ReleaseServer) prepareUpdate(req *services.UpdateReleaseRequest) (*rele
 			FirstDeployed: currentRelease.Info.FirstDeployed,
 			LastDeployed:  ts,
 			Status:        &release.Status{Code: release.Status_UNKNOWN},
+			Description:   "Preparing upgrade", // This should be overwritten later.
 		},
 		Version:  revision,
 		Manifest: manifestDoc.String(),
@@ -454,9 +459,11 @@ func (s *ReleaseServer) performRollback(currentRelease, targetRelease *release.R
 	}
 
 	if err := s.performKubeUpdate(currentRelease, targetRelease, req.Recreate, req.Timeout, req.Wait); err != nil {
-		log.Printf("warning: Release Rollback %q failed: %s", targetRelease.Name, err)
+		msg := fmt.Sprintf("Rollback %q failed: %s", targetRelease.Name, err)
+		log.Printf("warning: %s", msg)
 		currentRelease.Info.Status.Code = release.Status_SUPERSEDED
 		targetRelease.Info.Status.Code = release.Status_FAILED
+		targetRelease.Info.Description = msg
 		s.recordRelease(currentRelease, true)
 		s.recordRelease(targetRelease, false)
 		return res, err
@@ -524,6 +531,9 @@ func (s *ReleaseServer) prepareRollback(req *services.RollbackReleaseRequest) (*
 				Code:  release.Status_UNKNOWN,
 				Notes: prls.Info.Status.Notes,
 			},
+			// Because we lose the reference to rbv elsewhere, we set the
+			// message here, and only override it later if we experience failure.
+			Description: fmt.Sprintf("Rollback to %d", rbv),
 		},
 		Version:  crls.Version + 1,
 		Manifest: prls.Manifest,
@@ -672,6 +682,7 @@ func (s *ReleaseServer) prepareRelease(req *services.InstallReleaseRequest) (*re
 				FirstDeployed: ts,
 				LastDeployed:  ts,
 				Status:        &release.Status{Code: release.Status_UNKNOWN},
+				Description:   fmt.Sprintf("Install failed: %s", err),
 			},
 			Version: 0,
 		}
@@ -691,6 +702,7 @@ func (s *ReleaseServer) prepareRelease(req *services.InstallReleaseRequest) (*re
 			FirstDeployed: ts,
 			LastDeployed:  ts,
 			Status:        &release.Status{Code: release.Status_UNKNOWN},
+			Description:   "Initial install underway", // Will be overwritten.
 		},
 		Manifest: manifestDoc.String(),
 		Hooks:    hooks,
@@ -793,6 +805,7 @@ func (s *ReleaseServer) performRelease(r *release.Release, req *services.Install
 
 	if req.DryRun {
 		log.Printf("Dry run for %s", r.Name)
+		res.Release.Info.Description = "Dry run complete"
 		return res, nil
 	}
 
@@ -821,9 +834,11 @@ func (s *ReleaseServer) performRelease(r *release.Release, req *services.Install
 		r.Version = old.Version + 1
 
 		if err := s.performKubeUpdate(old, r, false, req.Timeout, req.Wait); err != nil {
-			log.Printf("warning: Release replace %q failed: %s", r.Name, err)
+			msg := fmt.Sprintf("Release replace %q failed: %s", r.Name, err)
+			log.Printf("warning: %s", msg)
 			old.Info.Status.Code = release.Status_SUPERSEDED
 			r.Info.Status.Code = release.Status_FAILED
+			r.Info.Description = msg
 			s.recordRelease(old, true)
 			s.recordRelease(r, false)
 			return res, err
@@ -834,8 +849,10 @@ func (s *ReleaseServer) performRelease(r *release.Release, req *services.Install
 		// regular manifests
 		b := bytes.NewBufferString(r.Manifest)
 		if err := s.env.KubeClient.Create(r.Namespace, b, req.Timeout, req.Wait); err != nil {
-			log.Printf("warning: Release %q failed: %s", r.Name, err)
+			msg := fmt.Sprintf("Release %q failed: %s", r.Name, err)
+			log.Printf("warning: %s", msg)
 			r.Info.Status.Code = release.Status_FAILED
+			r.Info.Description = msg
 			s.recordRelease(r, false)
 			return res, fmt.Errorf("release %s failed: %s", r.Name, err)
 		}
@@ -844,13 +861,17 @@ func (s *ReleaseServer) performRelease(r *release.Release, req *services.Install
 	// post-install hooks
 	if !req.DisableHooks {
 		if err := s.execHook(r.Hooks, r.Name, r.Namespace, postInstall, req.Timeout); err != nil {
-			log.Printf("warning: Release %q failed post-install: %s", r.Name, err)
+			msg := fmt.Sprintf("Release %q failed post-install: %s", r.Name, err)
+			log.Printf("warning: %s", msg)
 			r.Info.Status.Code = release.Status_FAILED
+			r.Info.Description = msg
 			s.recordRelease(r, false)
 			return res, err
 		}
 	}
 
+	r.Info.Status.Code = release.Status_DEPLOYED
+	r.Info.Description = "Install complete"
 	// This is a tricky case. The release has been created, but the result
 	// cannot be recorded. The truest thing to tell the user is that the
 	// release was created. However, the user will not be able to do anything
@@ -858,7 +879,6 @@ func (s *ReleaseServer) performRelease(r *release.Release, req *services.Install
 	//
 	// One possible strategy would be to do a timed retry to see if we can get
 	// this stored in the future.
-	r.Info.Status.Code = release.Status_DEPLOYED
 	s.recordRelease(r, false)
 
 	return res, nil
@@ -946,6 +966,7 @@ func (s *ReleaseServer) UninstallRelease(c ctx.Context, req *services.UninstallR
 	log.Printf("uninstall: Deleting %s", req.Name)
 	rel.Info.Status.Code = release.Status_DELETING
 	rel.Info.Deleted = timeconv.Now()
+	rel.Info.Description = "Deletion in progress (or silently failed)"
 	res := &services.UninstallReleaseResponse{Release: rel}
 
 	if !req.DisableHooks {
@@ -1001,6 +1022,7 @@ func (s *ReleaseServer) UninstallRelease(c ctx.Context, req *services.UninstallR
 	}
 
 	rel.Info.Status.Code = release.Status_DELETED
+	rel.Info.Description = "Deletion complete"
 
 	if req.Purge {
 		err := s.purgeReleases(rels...)

pkg/tiller/release_server_test.go

@@ -120,6 +120,7 @@ func namedReleaseStub(name string, status release.Status_Code) *release.Release
 			FirstDeployed: &date,
 			LastDeployed:  &date,
 			Status:        &release.Status{Code: status},
+			Description:   "Named Release Stub",
 		},
 		Chart:   chartStub(),
 		Config:  &chart.Config{Raw: `name: value`},
@@ -294,6 +295,10 @@ func TestInstallRelease(t *testing.T) {
 	if !strings.Contains(rel.Manifest, "---\n# Source: hello/templates/hello\nhello: world") {
 		t.Errorf("unexpected output: %s", rel.Manifest)
 	}
+
+	if rel.Info.Description != "Install complete" {
+		t.Errorf("unexpected description: %s", rel.Info.Description)
+	}
 }
 
 func TestInstallReleaseWithNotes(t *testing.T) {
@@ -359,6 +364,10 @@ func TestInstallReleaseWithNotes(t *testing.T) {
 	if !strings.Contains(rel.Manifest, "---\n# Source: hello/templates/hello\nhello: world") {
 		t.Errorf("unexpected output: %s", rel.Manifest)
 	}
+
+	if rel.Info.Description != "Install complete" {
+		t.Errorf("unexpected description: %s", rel.Info.Description)
+	}
 }
 
 func TestInstallReleaseWithNotesRendered(t *testing.T) {
@@ -425,6 +434,10 @@ func TestInstallReleaseWithNotesRendered(t *testing.T) {
 	if !strings.Contains(rel.Manifest, "---\n# Source: hello/templates/hello\nhello: world") {
 		t.Errorf("unexpected output: %s", rel.Manifest)
 	}
+
+	if rel.Info.Description != "Install complete" {
+		t.Errorf("unexpected description: %s", rel.Info.Description)
+	}
 }
 
 func TestInstallReleaseWithChartAndDependencyNotes(t *testing.T) {
@@ -472,6 +485,10 @@ func TestInstallReleaseWithChartAndDependencyNotes(t *testing.T) {
 	if rel.Info.Status.Notes != notesText {
 		t.Fatalf("Expected '%s', got '%s'", notesText, rel.Info.Status.Notes)
 	}
+
+	if rel.Info.Description != "Install complete" {
+		t.Errorf("unexpected description: %s", rel.Info.Description)
+	}
 }
 
 func TestInstallReleaseDryRun(t *testing.T) {
@@ -521,6 +538,10 @@ func TestInstallReleaseDryRun(t *testing.T) {
 	if res.Release.Hooks[0].LastRun != nil {
 		t.Error("Expected hook to not be marked as run.")
 	}
+
+	if res.Release.Info.Description != "Dry run complete" {
+		t.Errorf("unexpected description: %s", res.Release.Info.Description)
+	}
 }
 
 func TestInstallReleaseNoHooks(t *testing.T) {
@@ -666,6 +687,11 @@ func TestUpdateRelease(t *testing.T) {
 	if res.Release.Version != 2 {
 		t.Errorf("Expected release version to be %v, got %v", 2, res.Release.Version)
 	}
+
+	edesc := "Upgrade complete"
+	if got := res.Release.Info.Description; got != edesc {
+		t.Errorf("Expected description %q, got %q", edesc, got)
+	}
 }
 func TestUpdateReleaseResetValues(t *testing.T) {
 	c := helm.NewContext()
@@ -721,6 +747,11 @@ func TestUpdateReleaseFailure(t *testing.T) {
 		t.Errorf("Expected FAILED release. Got %d", updatedStatus)
 	}
 
+	edesc := "Upgrade \"angry-panda\" failed: Failed update in kube client"
+	if got := res.Release.Info.Description; got != edesc {
+		t.Errorf("Expected description %q, got %q", edesc, got)
+	}
+
 	oldRelease, err := rs.env.Releases.Get(rel.Name, rel.Version)
 	if err != nil {
 		t.Errorf("Expected to be able to get previous release")
@@ -973,6 +1004,10 @@ func TestRollbackRelease(t *testing.T) {
 		t.Errorf("unexpected output: %s", rel.Manifest)
 	}
 
+	if res.Release.Info.Description != "Rollback to 2" {
+		t.Errorf("Expected rollback to 2, got %q", res.Release.Info.Description)
+	}
+
 }
 
 func TestUninstallRelease(t *testing.T) {
@@ -1004,6 +1039,10 @@ func TestUninstallRelease(t *testing.T) {
 	if res.Release.Info.Deleted.Seconds <= 0 {
 		t.Errorf("Expected valid UNIX date, got %d", res.Release.Info.Deleted.Seconds)
 	}
+
+	if res.Release.Info.Description != "Deletion complete" {
+		t.Errorf("Expected Deletion complete, got %q", res.Release.Info.Description)
+	}
 }
 
 func TestUninstallPurgeRelease(t *testing.T) {