Merge pull request kubernetes#49674 from crimsonfaith91/rollout

Kubernetes Submit Queue · web-flow · commit c19785cfeafe · 2017-08-25T11:07:15.000-07:00
Automatic merge from submit-queue (batch tested with PRs 50033, 49988, 51132, 49674, 51207) StatefulSet kubectl rollout command **What this PR does / why we need it**: This PR implements StatefulSet kubectl rollout command, covering `history`, `status`, and `undo`. **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes kubernetes#49890 **Special notes for your reviewer**: **Release note**: ```release-note kubectl rollout `history`, `status`, and `undo` subcommands now support StatefulSets. ```
diff --git a/hack/make-rules/test-cmd-util.sh b/hack/make-rules/test-cmd-util.sh
diff --git a/hack/testdata/rollingupdate-statefulset-rv2.yaml b/hack/testdata/rollingupdate-statefulset-rv2.yaml
@@ -0,0 +1,33 @@
+apiVersion: apps/v1beta2
+kind: StatefulSet
+metadata:
+  name: nginx
+spec:
+  selector:
+    matchLabels:
+      app: nginx-statefulset
+  updateStrategy:
+    type: RollingUpdate
+  serviceName: "nginx"
+  replicas: 0
+  template:
+    metadata:
+      labels:
+        app: nginx-statefulset
+    spec:
+      terminationGracePeriodSeconds: 5
+      containers:
+      - name: nginx
+        image: gcr.io/google_containers/nginx-slim:0.8
+        ports:
+        - containerPort: 80
+          name: web
+        command:
+        - sh
+        - -c
+        - 'while true; do sleep 1; done'
+      - name: pause
+        image: gcr.io/google-containers/pause:2.0
+        ports:
+        - containerPort: 81
+          name: web-2
diff --git a/hack/testdata/rollingupdate-statefulset.yaml b/hack/testdata/rollingupdate-statefulset.yaml
@@ -1,34 +1,21 @@
-# A headless service to create DNS records
-apiVersion: v1
-kind: Service
-metadata:
-  annotations:
-    service.alpha.kubernetes.io/tolerate-unready-endpoints: "true"
-  name: nginx
-  labels:
-    app: nginx-statefulset
-spec:
-  ports:
-  - port: 80
-    name: web
-  # *.nginx.default.svc.cluster.local
-  clusterIP: None
-  selector:
-    app: nginx-statefulset
----
-apiVersion: apps/v1beta1
+apiVersion: apps/v1beta2
 kind: StatefulSet
 metadata:
   name: nginx
 spec:
+  selector:
+    matchLabels:
+      app: nginx-statefulset
+  updateStrategy:
+    type: RollingUpdate
   serviceName: "nginx"
   replicas: 0
   template:
     metadata:
       labels:
         app: nginx-statefulset
     spec:
-      terminationGracePeriodSeconds: 0
+      terminationGracePeriodSeconds: 5
       containers:
       - name: nginx
         image: gcr.io/google_containers/nginx-slim:0.7
diff --git a/pkg/controller/statefulset/stateful_set_control.go b/pkg/controller/statefulset/stateful_set_control.go
@@ -256,11 +256,11 @@ func (ssc *defaultStatefulSetControl) updateStatefulSet(
 	collisionCount int32,
 	pods []*v1.Pod) (*apps.StatefulSetStatus, error) {
 	// get the current and update revisions of the set.
-	currentSet, err := applyRevision(set, currentRevision)
+	currentSet, err := ApplyRevision(set, currentRevision)
 	if err != nil {
 		return nil, err
 	}
-	updateSet, err := applyRevision(set, updateRevision)
+	updateSet, err := ApplyRevision(set, updateRevision)
 	if err != nil {
 		return nil, err
 	}
diff --git a/pkg/controller/statefulset/stateful_set_control_test.go b/pkg/controller/statefulset/stateful_set_control_test.go
@@ -1281,7 +1281,7 @@ func TestStatefulSetControlRollback(t *testing.T) {
 			t.Fatalf("%s: %s", test.name, err)
 		}
 		history.SortControllerRevisions(revisions)
-		set, err = applyRevision(set, revisions[0])
+		set, err = ApplyRevision(set, revisions[0])
 		if err != nil {
 			t.Fatalf("%s: %s", test.name, err)
 		}
diff --git a/pkg/controller/statefulset/stateful_set_utils.go b/pkg/controller/statefulset/stateful_set_utils.go
@@ -17,6 +17,7 @@ limitations under the License.
 package statefulset
 
 import (
+	"bytes"
 	"encoding/json"
 	"fmt"
 	"regexp"
@@ -266,6 +267,15 @@ func newVersionedStatefulSetPod(currentSet, updateSet *apps.StatefulSet, current
 	return pod
 }
 
+// Match check if the given StatefulSet's template matches the template stored in the given history.
+func Match(ss *apps.StatefulSet, history *apps.ControllerRevision) (bool, error) {
+	patch, err := getPatch(ss)
+	if err != nil {
+		return false, err
+	}
+	return bytes.Equal(patch, history.Data.Raw), nil
+}
+
 // getPatch returns a strategic merge patch that can be applied to restore a StatefulSet to a
 // previous version. If the returned error is nil the patch is valid. The current state that we save is just the
 // PodSpecTemplate. We can modify this later to encompass more state (or less) and remain compatible with previously
@@ -319,9 +329,9 @@ func newRevision(set *apps.StatefulSet, revision int64, collisionCount *int32) (
 	return cr, nil
 }
 
-// applyRevision returns a new StatefulSet constructed by restoring the state in revision to set. If the returned error
+// ApplyRevision returns a new StatefulSet constructed by restoring the state in revision to set. If the returned error
 // is nil, the returned StatefulSet is valid.
-func applyRevision(set *apps.StatefulSet, revision *apps.ControllerRevision) (*apps.StatefulSet, error) {
+func ApplyRevision(set *apps.StatefulSet, revision *apps.ControllerRevision) (*apps.StatefulSet, error) {
 	obj, err := scheme.Scheme.DeepCopy(set)
 	if err != nil {
 		return nil, err
diff --git a/pkg/controller/statefulset/stateful_set_utils_test.go b/pkg/controller/statefulset/stateful_set_utils_test.go
@@ -258,7 +258,7 @@ func TestCreateApplyRevision(t *testing.T) {
 	key := "foo"
 	expectedValue := "bar"
 	set.Annotations[key] = expectedValue
-	restoredSet, err := applyRevision(set, revision)
+	restoredSet, err := ApplyRevision(set, revision)
 	if err != nil {
 		t.Fatal(err)
 	}
diff --git a/pkg/kubectl/BUILD b/pkg/kubectl/BUILD
@@ -129,6 +129,7 @@ go_library(
         "//pkg/client/unversioned:go_default_library",
         "//pkg/controller/daemon:go_default_library",
         "//pkg/controller/deployment/util:go_default_library",
+        "//pkg/controller/statefulset:go_default_library",
         "//pkg/credentialprovider:go_default_library",
         "//pkg/kubectl/resource:go_default_library",
         "//pkg/kubectl/util:go_default_library",
diff --git a/pkg/kubectl/cmd/rollout/rollout.go b/pkg/kubectl/cmd/rollout/rollout.go
@@ -42,6 +42,7 @@ var (
 
 		   * deployments
 		   * daemonsets
+		   * statefulsets
 		`)
 )
 
diff --git a/pkg/kubectl/cmd/rollout/rollout_history.go b/pkg/kubectl/cmd/rollout/rollout_history.go
@@ -44,7 +44,7 @@ var (
 func NewCmdRolloutHistory(f cmdutil.Factory, out io.Writer) *cobra.Command {
 	options := &resource.FilenameOptions{}
 
-	validArgs := []string{"deployment", "daemonset"}
+	validArgs := []string{"deployment", "daemonset", "statefulset"}
 	argAliases := kubectl.ResourceAliases(validArgs)
 
 	cmd := &cobra.Command{
diff --git a/pkg/kubectl/cmd/rollout/rollout_status.go b/pkg/kubectl/cmd/rollout/rollout_status.go
@@ -50,7 +50,7 @@ var (
 func NewCmdRolloutStatus(f cmdutil.Factory, out io.Writer) *cobra.Command {
 	options := &resource.FilenameOptions{}
 
-	validArgs := []string{"deployment", "daemonset"}
+	validArgs := []string{"deployment", "daemonset", "statefulset"}
 	argAliases := kubectl.ResourceAliases(validArgs)
 
 	cmd := &cobra.Command{
diff --git a/pkg/kubectl/cmd/rollout/rollout_undo.go b/pkg/kubectl/cmd/rollout/rollout_undo.go
@@ -64,7 +64,7 @@ var (
 func NewCmdRolloutUndo(f cmdutil.Factory, out io.Writer) *cobra.Command {
 	options := &UndoOptions{}
 
-	validArgs := []string{"deployment", "daemonset"}
+	validArgs := []string{"deployment", "daemonset", "statefulset"}
 	argAliases := kubectl.ResourceAliases(validArgs)
 
 	cmd := &cobra.Command{
diff --git a/pkg/kubectl/history.go b/pkg/kubectl/history.go
@@ -153,9 +153,9 @@ type DaemonSetHistoryViewer struct {
 // ViewHistory returns a revision-to-history map as the revision history of a deployment
 // TODO: this should be a describer
 func (h *DaemonSetHistoryViewer) ViewHistory(namespace, name string, revision int64) (string, error) {
-	versionedExtensionsClient := versionedExtensionsClientV1beta1(h.c)
 	versionedAppsClient := versionedAppsClientV1beta1(h.c)
-	ds, allHistory, err := controlledHistories(versionedExtensionsClient, versionedAppsClient, namespace, name)
+	versionedExtensionsClient := versionedExtensionsClientV1beta1(h.c)
+	versionedObj, allHistory, err := controlledHistories(versionedAppsClient, versionedExtensionsClient, namespace, name, "DaemonSet")
 	if err != nil {
 		return "", fmt.Errorf("unable to find history controlled by DaemonSet %s: %v", name, err)
 	}
@@ -175,7 +175,13 @@ func (h *DaemonSetHistoryViewer) ViewHistory(namespace, name string, revision in
 		if !ok {
 			return "", fmt.Errorf("unable to find the specified revision")
 		}
-		dsOfHistory, err := applyHistory(ds, history)
+
+		versionedDS, ok := versionedObj.(*extensionsv1beta1.DaemonSet)
+		if !ok {
+			return "", fmt.Errorf("unexpected non-DaemonSet object returned: %v", versionedDS)
+		}
+
+		dsOfHistory, err := applyHistory(versionedDS, history)
 		if err != nil {
 			return "", fmt.Errorf("unable to parse history %s", history.Name)
 		}
@@ -256,29 +262,51 @@ func (h *StatefulSetHistoryViewer) ViewHistory(namespace, name string, revision
 	})
 }
 
-// controlledHistories returns all ControllerRevisions controlled by the given DaemonSet
-func controlledHistories(extensions clientextensionsv1beta1.ExtensionsV1beta1Interface, apps clientappsv1beta1.AppsV1beta1Interface, namespace, name string) (*extensionsv1beta1.DaemonSet, []*appsv1beta1.ControllerRevision, error) {
-	ds, err := extensions.DaemonSets(namespace).Get(name, metav1.GetOptions{})
-	if err != nil {
-		return nil, nil, fmt.Errorf("failed to retrieve DaemonSet %s: %v", name, err)
+// controlledHistories returns all ControllerRevisions controlled by the given API object
+func controlledHistories(apps clientappsv1beta1.AppsV1beta1Interface, extensions clientextensionsv1beta1.ExtensionsV1beta1Interface, namespace, name, kind string) (runtime.Object, []*appsv1beta1.ControllerRevision, error) {
+	var obj runtime.Object
+	var labelSelector *metav1.LabelSelector
+
+	switch kind {
+	case "DaemonSet":
+		ds, err := extensions.DaemonSets(namespace).Get(name, metav1.GetOptions{})
+		if err != nil {
+			return nil, nil, fmt.Errorf("failed to retrieve DaemonSet %s: %v", name, err)
+		}
+		labelSelector = ds.Spec.Selector
+		obj = ds
+	case "StatefulSet":
+		ss, err := apps.StatefulSets(namespace).Get(name, metav1.GetOptions{})
+		if err != nil {
+			return nil, nil, fmt.Errorf("failed to retrieve StatefulSet %s: %v", name, err)
+		}
+		labelSelector = ss.Spec.Selector
+		obj = ss
+	default:
+		return nil, nil, fmt.Errorf("unsupported API object kind: %s", kind)
 	}
+
 	var result []*appsv1beta1.ControllerRevision
-	selector, err := metav1.LabelSelectorAsSelector(ds.Spec.Selector)
+	selector, err := metav1.LabelSelectorAsSelector(labelSelector)
 	if err != nil {
 		return nil, nil, err
 	}
-	historyList, err := apps.ControllerRevisions(ds.Namespace).List(metav1.ListOptions{LabelSelector: selector.String()})
+	historyList, err := apps.ControllerRevisions(namespace).List(metav1.ListOptions{LabelSelector: selector.String()})
 	if err != nil {
 		return nil, nil, err
 	}
+	accessor, err := meta.Accessor(obj)
+	if err != nil {
+		return nil, nil, fmt.Errorf("failed to obtain accessor for %s named %s: %v", kind, name, err)
+	}
 	for i := range historyList.Items {
 		history := historyList.Items[i]
-		// Only add history that belongs to the DaemonSet
-		if metav1.IsControlledBy(&history, ds) {
+		// Only add history that belongs to the API object
+		if metav1.IsControlledBy(&history, accessor) {
 			result = append(result, &history)
 		}
 	}
-	return ds, result, nil
+	return obj, result, nil
 }
 
 // applyHistory returns a specific revision of DaemonSet by applying the given history to a copy of the given DaemonSet
diff --git a/pkg/kubectl/rollback.go b/pkg/kubectl/rollback.go

Original file line number	Diff line number	Diff line change
`@@ -256,11 +256,11 @@ func (ssc *defaultStatefulSetControl) updateStatefulSet(`
`256`	`256`	`collisionCount int32,`
`257`	`257`	`pods []v1.Pod) (apps.StatefulSetStatus, error) {`
`258`	`258`	`// get the current and update revisions of the set.`
`259`		`- currentSet, err := applyRevision(set, currentRevision)`
	`259`	`+ currentSet, err := ApplyRevision(set, currentRevision)`
`260`	`260`	`if err != nil {`
`261`	`261`	`return nil, err`
`262`	`262`	`}`
`263`		`- updateSet, err := applyRevision(set, updateRevision)`
	`263`	`+ updateSet, err := ApplyRevision(set, updateRevision)`
`264`	`264`	`if err != nil {`
`265`	`265`	`return nil, err`
`266`	`266`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1281,7 +1281,7 @@ func TestStatefulSetControlRollback(t *testing.T) {`
`1281`	`1281`	`t.Fatalf("%s: %s", test.name, err)`
`1282`	`1282`	`}`
`1283`	`1283`	`history.SortControllerRevisions(revisions)`
`1284`		`- set, err = applyRevision(set, revisions[0])`
	`1284`	`+ set, err = ApplyRevision(set, revisions[0])`
`1285`	`1285`	`if err != nil {`
`1286`	`1286`	`t.Fatalf("%s: %s", test.name, err)`
`1287`	`1287`	`}`
Original file line number	Diff line number	Diff line change
`@@ -258,7 +258,7 @@ func TestCreateApplyRevision(t *testing.T) {`
`258`	`258`	`key := "foo"`
`259`	`259`	`expectedValue := "bar"`
`260`	`260`	`set.Annotations[key] = expectedValue`
`261`		`- restoredSet, err := applyRevision(set, revision)`
	`261`	`+ restoredSet, err := ApplyRevision(set, revision)`
`262`	`262`	`if err != nil {`
`263`	`263`	`t.Fatal(err)`
`264`	`264`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@ var (`
`42`	`42`
`43`	`43`	`* deployments`
`44`	`44`	`* daemonsets`
	`45`	`+ * statefulsets`
`45`	`46`	`)
`46`	`47`	`)`
`47`	`48`