Merge pull request #5092 from jlegrone/feature/delete-policy

feat(resource-policy): delete manifests when policy value is delete

docs/charts_tips_and_tricks.md

@@ -235,6 +235,9 @@ 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.
 
+To explicitly opt in to resource deletion, for example when overriding a chart's
+default annotations, set the resource policy annotation value to `delete`.
+
 ## Using "Partials" and Template Includes
 
 Sometimes you want to create some reusable parts in your chart, whether

pkg/kube/client.go

@@ -23,12 +23,13 @@ import (
 	goerrors "errors"
 	"fmt"
 	"io"
-	"k8s.io/apimachinery/pkg/api/meta"
 	"log"
 	"sort"
 	"strings"
 	"time"
 
+	"k8s.io/apimachinery/pkg/api/meta"
+
 	"github.com/evanphx/json-patch"
 	appsv1 "k8s.io/api/apps/v1"
 	appsv1beta1 "k8s.io/api/apps/v1beta1"
@@ -362,8 +363,9 @@ func (c *Client) Update(namespace string, originalReader, targetReader io.Reader
 		if err != nil {
 			c.Log("Unable to get annotations on %q, err: %s", info.Name, err)
 		}
-		if annotations != nil && annotations[ResourcePolicyAnno] == KeepPolicy {
+		if ResourcePolicyIsKeep(annotations) {
-			c.Log("Skipping delete of %q due to annotation [%s=%s]", info.Name, ResourcePolicyAnno, KeepPolicy)
+			policy := annotations[ResourcePolicyAnno]
+			c.Log("Skipping delete of %q due to annotation [%s=%s]", info.Name, ResourcePolicyAnno, policy)
 			continue
 		}
 

pkg/kube/client_test.go

@@ -213,7 +213,7 @@ func TestUpdate(t *testing.T) {
 
 	// Test resource policy is respected
 	actions = nil
-	listA.Items[2].ObjectMeta.Annotations = map[string]string{ResourcePolicyAnno: KeepPolicy}
+	listA.Items[2].ObjectMeta.Annotations = map[string]string{ResourcePolicyAnno: "keep"}
 	if err := c.Update(v1.NamespaceDefault, objBody(&listA), objBody(&listB), false, false, 0, false); err != nil {
 		t.Fatal(err)
 	}

pkg/kube/resource_policy.go

@@ -19,8 +19,23 @@ package kube
 // ResourcePolicyAnno is the annotation name for a resource policy
 const ResourcePolicyAnno = "helm.sh/resource-policy"
 
-// KeepPolicy is the resource policy type for keep
+// deletePolicy is the resource policy type for delete
 //
-// This resource policy type allows resources to skip being deleted
+// This resource policy type allows explicitly opting in to the default
-//   during an uninstallRelease action.
+//   resource deletion behavior, for example when overriding a chart's
-const KeepPolicy = "keep"
+//   default annotations. Any other value allows resources to skip being
+//   deleted during an uninstallRelease action.
+const deletePolicy = "delete"
+
+// ResourcePolicyIsKeep accepts a map of Kubernetes resource annotations and
+//   returns true if the resource should be kept, otherwise false if it is safe
+//   for Helm to delete.
+func ResourcePolicyIsKeep(annotations map[string]string) bool {
+	if annotations != nil {
+		resourcePolicyType, ok := annotations[ResourcePolicyAnno]
+		if ok && resourcePolicyType != deletePolicy {
+			return true
+		}
+	}
+	return false
+}

pkg/kube/resource_policy_test.go

@@ -0,0 +1,72 @@
+/*
+Copyright The Helm Authors.
+
+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 kube
+
+import "testing"
+
+func TestResourcePolicyIsKeep(t *testing.T) {
+	type annotations map[string]string
+	type testcase struct {
+		annotations
+		keep bool
+	}
+	cases := []testcase{
+		{nil, false},
+		{
+			annotations{
+				"foo": "bar",
+			},
+			false,
+		},
+		{
+			annotations{
+				ResourcePolicyAnno: "keep",
+			},
+			true,
+		},
+		{
+			annotations{
+				ResourcePolicyAnno: "KEEP   ",
+			},
+			true,
+		},
+		{
+			annotations{
+				ResourcePolicyAnno: "",
+			},
+			true,
+		},
+		{
+			annotations{
+				ResourcePolicyAnno: "delete",
+			},
+			false,
+		},
+		{
+			annotations{
+				ResourcePolicyAnno: "DELETE",
+			},
+			true,
+		},
+	}
+
+	for _, tc := range cases {
+		if tc.keep != ResourcePolicyIsKeep(tc.annotations) {
+			t.Errorf("Expected function to return %t for annotations %v", tc.keep, tc.annotations)
+		}
+	}
+}

pkg/tiller/release_server_test.go

@@ -89,13 +89,22 @@ spec:
 
 var manifestWithKeep = `kind: ConfigMap
 metadata:
-  name: test-cm-keep
+  name: test-cm-keep-a
   annotations:
     "helm.sh/resource-policy": keep
 data:
   name: value
 `
 
+var manifestWithKeepEmpty = `kind: ConfigMap
+metadata:
+  name: test-cm-keep-b
+  annotations:
+    "helm.sh/resource-policy": ""
+data:
+  name: value
+`
+
 var manifestWithUpgradeHooks = `kind: ConfigMap
 metadata:
   name: test-cm
@@ -449,23 +458,27 @@ func releaseWithKeepStub(rlsName string) *release.Release {
 			Name: "bunnychart",
 		},
 		Templates: []*chart.Template{
-			{Name: "templates/configmap", Data: []byte(manifestWithKeep)},
+			{Name: "templates/configmap-keep-a", Data: []byte(manifestWithKeep)},
+			{Name: "templates/configmap-keep-b", Data: []byte(manifestWithKeepEmpty)},
 		},
 	}
 
 	date := timestamp.Timestamp{Seconds: 242085845, Nanos: 0}
-	return &release.Release{
+	rl := &release.Release{
 		Name: rlsName,
 		Info: &release.Info{
 			FirstDeployed: &date,
 			LastDeployed:  &date,
 			Status:        &release.Status{Code: release.Status_DEPLOYED},
 		},
-		Chart:    ch,
+		Chart:   ch,
-		Config:   &chart.Config{Raw: `name: value`},
+		Config:  &chart.Config{Raw: `name: value`},
-		Version:  1,
+		Version: 1,
-		Manifest: manifestWithKeep,
 	}
+
+	helm.RenderReleaseMock(rl, false)
+
+	return rl
 }
 
 func MockEnvironment() *environment.Environment {

pkg/tiller/release_uninstall_test.go

@@ -150,7 +150,10 @@ func TestUninstallReleaseWithKeepPolicy(t *testing.T) {
 	if res.Info == "" {
 		t.Errorf("Expected response info to not be empty")
 	} else {
-		if !strings.Contains(res.Info, "[ConfigMap] test-cm-keep") {
+		if !strings.Contains(res.Info, "[ConfigMap] test-cm-keep-a") {
+			t.Errorf("unexpected output: %s", res.Info)
+		}
+		if !strings.Contains(res.Info, "[ConfigMap] test-cm-keep-b") {
 			t.Errorf("unexpected output: %s", res.Info)
 		}
 	}

pkg/tiller/resource_policy.go

@@ -34,17 +34,11 @@ func filterManifestsToKeep(manifests []Manifest) ([]Manifest, []Manifest) {
 			continue
 		}
 
-		resourcePolicyType, ok := m.Head.Metadata.Annotations[kube.ResourcePolicyAnno]
+		if kube.ResourcePolicyIsKeep(m.Head.Metadata.Annotations) {
-		if !ok {
-			remaining = append(remaining, m)
-			continue
-		}
-
-		resourcePolicyType = strings.ToLower(strings.TrimSpace(resourcePolicyType))
-		if resourcePolicyType == kube.KeepPolicy {
 			keep = append(keep, m)
+		} else {
+			remaining = append(remaining, m)
 		}
-
 	}
 	return keep, remaining
 }