集成kruise rollout对象的undo功能 (#78)

Signed-off-by: yunbo <yunbo10124scut@gmail.com> [temporary] temporary commit for sync Signed-off-by: yunbo <yunbo10124scut@gmail.com> [temporary] temporary commit for sync from local to work Signed-off-by: yunbo <yunbo10124scut@gmail.com> [temporary] temporary commit for sync from local to work Signed-off-by: yunbo <yunbo10124scut@gmail.com> rollout undo integration version2 Signed-off-by: yunbo <yunbo10124scut@gmail.com> update README.md Signed-off-by: yunbo <yunbo10124scut@gmail.com> remove the comment code Signed-off-by: yunbo <yunbo10124scut@gmail.com> hide the same-workload-error Signed-off-by: yunbo <yunbo10124scut@gmail.com> update README Co-authored-by: yunbo <yun@bo.com>
2023-12-18 15:49:59 +08:00 · 2023-12-18 15:49:59 +08:00 · d4bbc24ecf
parent ac41c04df6
commit d4bbc24ecf
5 changed files with 107 additions and 14 deletions
--- a/README.md
+++ b/README.md
@ -78,7 +78,10 @@ $ kubectl kruise rollout status statefulsets/sts1
 $ kubectl kruise rollout status statefulsets.apps.kruise.io/sts2

 # approve a kruise rollout resource named "rollout-demo" in "ns-demo" namespace
-$ kubectl-kruise rollout approve rollout-demo -n ns-demo`
+$ kubectl kruise rollout approve rollout-demo -n ns-demo`
+
+# undo a kruise rollout resource
+$ kubectl kruise rollout undo rollout/rollout-demo
 ```

 ### set
@ -138,7 +141,7 @@ kubectl kruise exec clone/myclone -S sidecar-container -it -- bash
 ```bash
 kubectl kruise migrate CloneSet --from Deployment --src-name deployment-demo --dst-name cloneset-demo --create --copy
 ```
-   
+
 #### kubectl kruise rollout for CloneSet workload
   * [x] undo
   * [x] history
@ -146,7 +149,7 @@ kubectl kruise migrate CloneSet --from Deployment --src-name deployment-demo --d
   * [x] pause
   * [x] resume
   * [x] restart
-   
+
 #### kubectl kruise rollout for Advanced StatefulSet
   * [x]  undo
   * [x] history
@ -155,22 +158,22 @@ kubectl kruise migrate CloneSet --from Deployment --src-name deployment-demo --d

 #### kubectl kruise expose for CloneSet workload
   * [x] kubectl kruise expose cloneset demo-clone  --port=80 --target-port=8000
-   
+
 #### kubectl kruise set SUBCOMMAND [options] for CloneSet
   * [x] kubectl kruise set image cloneset/abc
   * [x] kubectl kruise set env cloneset/abc
   * [x] kubectl kruise set serviceaccount cloneset/abc
   * [x] kubectl kruise set resources cloneset/abc
-   
+
 #### kubectl kruise set SUBCOMMAND [options] for Advanced StatefulSet
   * [x] kubectl kruise set image asts/abc
   * [x] kubectl kruise set env asts/abc
   * [x] kubectl kruise set serviceaccount asts/abc
   * [x] kubectl kruise set resources asts/abc
-   
+
 #### kubectl kruise autoscale SUBCOMMAND [options]
   * [ ] kubectl kruise autoscale 
- 
+

 ### Contributing
 We encourage you to help out by reporting issues, improving documentation, fixing bugs, or adding new features. 
--- a/pkg/cmd/rollout/rollout_undo.go
+++ b/pkg/cmd/rollout/rollout_undo.go
@ -22,8 +22,10 @@ import (

 	internalapi "github.com/openkruise/kruise-tools/pkg/api"
 	internalpolymorphichelpers "github.com/openkruise/kruise-tools/pkg/internal/polymorphichelpers"
-
+	kruiserolloutsv1apha1 "github.com/openkruise/rollouts/api/v1alpha1"
 	"github.com/spf13/cobra"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/apimachinery/pkg/util/errors"
 	"k8s.io/cli-runtime/pkg/genericclioptions"
 	"k8s.io/cli-runtime/pkg/printers"
 	"k8s.io/cli-runtime/pkg/resource"
@ -67,7 +69,10 @@ var (
 		kubectl-kruise rollout undo daemonset/abc --to-revision=3

 		# Rollback to the previous deployment with dry-run
-		kubectl-kruise rollout undo --dry-run=server deployment/abc`)
+		kubectl-kruise rollout undo --dry-run=server deployment/abc
+		
+		# Rollback to workload via rollout api object
+		kubectl-kruise rollout undo rollout/abc`)
 )

 // NewRolloutUndoOptions returns an initialized UndoOptions instance
@ -83,7 +88,7 @@ func NewRolloutUndoOptions(streams genericclioptions.IOStreams) *UndoOptions {
 func NewCmdRolloutUndo(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command {
 	o := NewRolloutUndoOptions(streams)

-	validArgs := []string{"deployment", "daemonset", "statefulset", "cloneset", "advanced statefulset"}
+	validArgs := []string{"deployment", "daemonset", "statefulset", "cloneset", "advanced statefulset", "rollout"}

 	cmd := &cobra.Command{
 		Use:                   "undo (TYPE NAME | TYPE/NAME) [flags]",
@ -157,13 +162,13 @@ func (o *UndoOptions) RunUndo() error {
 		ResourceTypeOrNameArgs(true, o.Resources...).
 		ContinueOnError().
 		Latest().
-		Flatten().
-		Do()
+		Flatten().Do()
 	if err := r.Err(); err != nil {
 		return err
 	}

-	err := r.Visit(func(info *resource.Info, err error) error {
+	// perform undo logic here
+	undoFunc := func(info *resource.Info, err error) error {
 		if err != nil {
 			return err
 		}
@ -188,7 +193,71 @@ func (o *UndoOptions) RunUndo() error {
 		}

 		return printer.PrintObj(info.Object, o.Out)
+	}
+
+	var refResources []string
+	// deduplication: If a rollout arg references a workload which is also specified as an arg in the same command,
+	// performing multiple undo operations on the workload within a single command is not smart. Such an action could
+	// lead to confusion and yield unintended consequences. Therefore, undo operations in this context are disallowed.
+	// Should such a scenario occur, only the first argument that points to the workload will be executed.
+	deDuplica := make(map[string]struct{})
+
+	err := r.Visit(func(info *resource.Info, err error) error {
+		if err != nil {
+			return err
+		}
+
+		if info.Mapping.GroupVersionKind.Group == "rollouts.kruise.io" && info.Mapping.GroupVersionKind.Kind == "Rollout" {
+			obj := info.Object
+			if obj == nil {
+				return fmt.Errorf("Rollout object not found")
+			}
+			ro, ok := obj.(*kruiserolloutsv1apha1.Rollout)
+			if !ok {
+				return fmt.Errorf("unsupported version of Rollout")
+			}
+			workloadRef := ro.Spec.ObjectRef.WorkloadRef
+			gv, err := schema.ParseGroupVersion(workloadRef.APIVersion)
+			if err != nil {
+				return err
+			}
+			deDuplicaKey := workloadRef.Kind + "." + gv.Version + "." + gv.Group + "/" + workloadRef.Name
+			if _, ok := deDuplica[deDuplicaKey]; ok {
+				return nil
+			}
+			deDuplica[deDuplicaKey] = struct{}{}
+			refResources = append(refResources, deDuplicaKey)
+			return nil
+		}
+		gvk := info.Mapping.GroupVersionKind
+		deDuplicaKey := gvk.Kind + "." + gvk.Version + "." + gvk.Group + "/" + info.Name
+		if _, ok := deDuplica[deDuplicaKey]; ok {
+			return nil
+		}
+		deDuplica[deDuplicaKey] = struct{}{}
+		return undoFunc(info, nil)
 	})

-	return err
+	if len(refResources) < 1 {
+		return err
+	}
+
+	var aggErrs []error
+	aggErrs = append(aggErrs, err)
+	r2 := o.Builder().
+		WithScheme(internalapi.GetScheme(), scheme.Scheme.PrioritizedVersionsAllGroups()...).
+		NamespaceParam(o.Namespace).DefaultNamespace().
+		FilenameParam(o.EnforceNamespace, &o.FilenameOptions).
+		ResourceTypeOrNameArgs(true, refResources...).
+		ContinueOnError().
+		Latest().
+		Flatten().Do()
+
+	if err = r2.Err(); err != nil {
+		aggErrs = append(aggErrs, err)
+		return errors.NewAggregate(aggErrs)
+	}
+	err = r2.Visit(undoFunc)
+	aggErrs = append(aggErrs, err)
+	return errors.NewAggregate(aggErrs)
 }
--- a/pkg/internal/apps/kind_visitor.go
+++ b/pkg/internal/apps/kind_visitor.go
@ -37,6 +37,7 @@ type KindVisitor interface {
 	VisitCloneSet(kind GroupKindElement)
 	VisitAdvancedStatefulSet(kind GroupKindElement)
 	VisitAdvancedDaemonSet(kind GroupKindElement)
+	VisitRollout(kind GroupKindElement)
 }

 // GroupKindElement defines a Kubernetes API group elem
@ -67,6 +68,8 @@ func (elem GroupKindElement) Accept(visitor KindVisitor) error {
 		visitor.VisitAdvancedStatefulSet(elem)
 	case elem.GroupMatch("apps.kruise.io") && elem.Kind == "DaemonSet":
 		visitor.VisitAdvancedDaemonSet(elem)
+	case elem.GroupMatch("rollouts.kruise.io") && elem.Kind == "Rollout":
+		visitor.VisitRollout(elem)
 	default:
 		return fmt.Errorf("no visitor method exists for %v", elem)
 	}
--- a/pkg/internal/polymorphichelpers/history.go
+++ b/pkg/internal/polymorphichelpers/history.go
@ -79,6 +79,7 @@ func (v *HistoryVisitor) VisitPod(kind internalapps.GroupKindElement)
 func (v *HistoryVisitor) VisitReplicaSet(kind internalapps.GroupKindElement)            {}
 func (v *HistoryVisitor) VisitReplicationController(kind internalapps.GroupKindElement) {}
 func (v *HistoryVisitor) VisitCronJob(kind internalapps.GroupKindElement)               {}
+func (v *HistoryVisitor) VisitRollout(kind internalapps.GroupKindElement)               {}

 // HistoryViewerFor returns an implementation of HistoryViewer interface for the given schema kind
 func HistoryViewerFor(kind schema.GroupKind, c kubernetes.Interface, kc kruiseclientsets.Interface) (HistoryViewer, error) {
--- a/pkg/internal/polymorphichelpers/rollback.go
+++ b/pkg/internal/polymorphichelpers/rollback.go
@ -87,6 +87,9 @@ func (v *RollbackVisitor) VisitAdvancedStatefulSet(kind internalapps.GroupKindEl
 func (v *RollbackVisitor) VisitAdvancedDaemonSet(kind internalapps.GroupKindElement) {
 	v.result = &AdvancedDaemonSetRollbacker{k: v.clientset, kc: v.kruiseclientset}
 }
+func (v *RollbackVisitor) VisitRollout(kind internalapps.GroupKindElement) {
+	v.result = &RolloutRollbacker{k: v.clientset, kc: v.kruiseclientset}
+}

 // RollbackerFor returns an implementation of Rollbacker interface for the given schema kind
 func RollbackerFor(kind schema.GroupKind, c kubernetes.Interface, kc kruiseclientsets.Interface) (Rollbacker, error) {
@ -540,6 +543,20 @@ type AdvancedDaemonSetRollbacker struct {
 	kc kruiseclientsets.Interface
 }

+type RolloutRollbacker struct {
+	k  kubernetes.Interface
+	kc kruiseclientsets.Interface
+}
+
+// RolloutRollbacker.Rollback never be called
+func (r *RolloutRollbacker) Rollback(obj runtime.Object,
+	updatedAnnotations map[string]string,
+	toRevision int64,
+	dryRunStrategy cmdutil.DryRunStrategy) (string, error) {
+
+	return rollbackSuccess, nil
+}
+
 func (r *AdvancedDaemonSetRollbacker) Rollback(obj runtime.Object,
 	updatedAnnotations map[string]string,
 	toRevision int64,