Skip to content

Commit d4bbc24

Browse files
myname4423yunbo
andauthored
集成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>
1 parent ac41c04 commit d4bbc24

File tree

5 files changed

+107
-14
lines changed

5 files changed

+107
-14
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,10 @@ $ kubectl kruise rollout status statefulsets/sts1
7878
$ kubectl kruise rollout status statefulsets.apps.kruise.io/sts2
7979

8080
# approve a kruise rollout resource named "rollout-demo" in "ns-demo" namespace
81-
$ kubectl-kruise rollout approve rollout-demo -n ns-demo`
81+
$ kubectl kruise rollout approve rollout-demo -n ns-demo`
82+
83+
# undo a kruise rollout resource
84+
$ kubectl kruise rollout undo rollout/rollout-demo
8285
```
8386

8487
### set
@@ -138,15 +141,15 @@ kubectl kruise exec clone/myclone -S sidecar-container -it -- bash
138141
```bash
139142
kubectl kruise migrate CloneSet --from Deployment --src-name deployment-demo --dst-name cloneset-demo --create --copy
140143
```
141-
144+
142145
#### kubectl kruise rollout for CloneSet workload
143146
* [x] undo
144147
* [x] history
145148
* [x] status
146149
* [x] pause
147150
* [x] resume
148151
* [x] restart
149-
152+
150153
#### kubectl kruise rollout for Advanced StatefulSet
151154
* [x] undo
152155
* [x] history
@@ -155,22 +158,22 @@ kubectl kruise migrate CloneSet --from Deployment --src-name deployment-demo --d
155158

156159
#### kubectl kruise expose for CloneSet workload
157160
* [x] kubectl kruise expose cloneset demo-clone --port=80 --target-port=8000
158-
161+
159162
#### kubectl kruise set SUBCOMMAND [options] for CloneSet
160163
* [x] kubectl kruise set image cloneset/abc
161164
* [x] kubectl kruise set env cloneset/abc
162165
* [x] kubectl kruise set serviceaccount cloneset/abc
163166
* [x] kubectl kruise set resources cloneset/abc
164-
167+
165168
#### kubectl kruise set SUBCOMMAND [options] for Advanced StatefulSet
166169
* [x] kubectl kruise set image asts/abc
167170
* [x] kubectl kruise set env asts/abc
168171
* [x] kubectl kruise set serviceaccount asts/abc
169172
* [x] kubectl kruise set resources asts/abc
170-
173+
171174
#### kubectl kruise autoscale SUBCOMMAND [options]
172175
* [ ] kubectl kruise autoscale
173-
176+
174177

175178
### Contributing
176179
We encourage you to help out by reporting issues, improving documentation, fixing bugs, or adding new features.

pkg/cmd/rollout/rollout_undo.go

Lines changed: 76 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ import (
2222

2323
internalapi "github.com/openkruise/kruise-tools/pkg/api"
2424
internalpolymorphichelpers "github.com/openkruise/kruise-tools/pkg/internal/polymorphichelpers"
25-
25+
kruiserolloutsv1apha1 "github.com/openkruise/rollouts/api/v1alpha1"
2626
"github.com/spf13/cobra"
27+
"k8s.io/apimachinery/pkg/runtime/schema"
28+
"k8s.io/apimachinery/pkg/util/errors"
2729
"k8s.io/cli-runtime/pkg/genericclioptions"
2830
"k8s.io/cli-runtime/pkg/printers"
2931
"k8s.io/cli-runtime/pkg/resource"
@@ -67,7 +69,10 @@ var (
6769
kubectl-kruise rollout undo daemonset/abc --to-revision=3
6870
6971
# Rollback to the previous deployment with dry-run
70-
kubectl-kruise rollout undo --dry-run=server deployment/abc`)
72+
kubectl-kruise rollout undo --dry-run=server deployment/abc
73+
74+
# Rollback to workload via rollout api object
75+
kubectl-kruise rollout undo rollout/abc`)
7176
)
7277

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

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

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

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

190195
return printer.PrintObj(info.Object, o.Out)
196+
}
197+
198+
var refResources []string
199+
// deduplication: If a rollout arg references a workload which is also specified as an arg in the same command,
200+
// performing multiple undo operations on the workload within a single command is not smart. Such an action could
201+
// lead to confusion and yield unintended consequences. Therefore, undo operations in this context are disallowed.
202+
// Should such a scenario occur, only the first argument that points to the workload will be executed.
203+
deDuplica := make(map[string]struct{})
204+
205+
err := r.Visit(func(info *resource.Info, err error) error {
206+
if err != nil {
207+
return err
208+
}
209+
210+
if info.Mapping.GroupVersionKind.Group == "rollouts.kruise.io" && info.Mapping.GroupVersionKind.Kind == "Rollout" {
211+
obj := info.Object
212+
if obj == nil {
213+
return fmt.Errorf("Rollout object not found")
214+
}
215+
ro, ok := obj.(*kruiserolloutsv1apha1.Rollout)
216+
if !ok {
217+
return fmt.Errorf("unsupported version of Rollout")
218+
}
219+
workloadRef := ro.Spec.ObjectRef.WorkloadRef
220+
gv, err := schema.ParseGroupVersion(workloadRef.APIVersion)
221+
if err != nil {
222+
return err
223+
}
224+
deDuplicaKey := workloadRef.Kind + "." + gv.Version + "." + gv.Group + "/" + workloadRef.Name
225+
if _, ok := deDuplica[deDuplicaKey]; ok {
226+
return nil
227+
}
228+
deDuplica[deDuplicaKey] = struct{}{}
229+
refResources = append(refResources, deDuplicaKey)
230+
return nil
231+
}
232+
gvk := info.Mapping.GroupVersionKind
233+
deDuplicaKey := gvk.Kind + "." + gvk.Version + "." + gvk.Group + "/" + info.Name
234+
if _, ok := deDuplica[deDuplicaKey]; ok {
235+
return nil
236+
}
237+
deDuplica[deDuplicaKey] = struct{}{}
238+
return undoFunc(info, nil)
191239
})
192240

193-
return err
241+
if len(refResources) < 1 {
242+
return err
243+
}
244+
245+
var aggErrs []error
246+
aggErrs = append(aggErrs, err)
247+
r2 := o.Builder().
248+
WithScheme(internalapi.GetScheme(), scheme.Scheme.PrioritizedVersionsAllGroups()...).
249+
NamespaceParam(o.Namespace).DefaultNamespace().
250+
FilenameParam(o.EnforceNamespace, &o.FilenameOptions).
251+
ResourceTypeOrNameArgs(true, refResources...).
252+
ContinueOnError().
253+
Latest().
254+
Flatten().Do()
255+
256+
if err = r2.Err(); err != nil {
257+
aggErrs = append(aggErrs, err)
258+
return errors.NewAggregate(aggErrs)
259+
}
260+
err = r2.Visit(undoFunc)
261+
aggErrs = append(aggErrs, err)
262+
return errors.NewAggregate(aggErrs)
194263
}

pkg/internal/apps/kind_visitor.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ type KindVisitor interface {
3737
VisitCloneSet(kind GroupKindElement)
3838
VisitAdvancedStatefulSet(kind GroupKindElement)
3939
VisitAdvancedDaemonSet(kind GroupKindElement)
40+
VisitRollout(kind GroupKindElement)
4041
}
4142

4243
// GroupKindElement defines a Kubernetes API group elem
@@ -67,6 +68,8 @@ func (elem GroupKindElement) Accept(visitor KindVisitor) error {
6768
visitor.VisitAdvancedStatefulSet(elem)
6869
case elem.GroupMatch("apps.kruise.io") && elem.Kind == "DaemonSet":
6970
visitor.VisitAdvancedDaemonSet(elem)
71+
case elem.GroupMatch("rollouts.kruise.io") && elem.Kind == "Rollout":
72+
visitor.VisitRollout(elem)
7073
default:
7174
return fmt.Errorf("no visitor method exists for %v", elem)
7275
}

pkg/internal/polymorphichelpers/history.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ func (v *HistoryVisitor) VisitPod(kind internalapps.GroupKindElement)
7979
func (v *HistoryVisitor) VisitReplicaSet(kind internalapps.GroupKindElement) {}
8080
func (v *HistoryVisitor) VisitReplicationController(kind internalapps.GroupKindElement) {}
8181
func (v *HistoryVisitor) VisitCronJob(kind internalapps.GroupKindElement) {}
82+
func (v *HistoryVisitor) VisitRollout(kind internalapps.GroupKindElement) {}
8283

8384
// HistoryViewerFor returns an implementation of HistoryViewer interface for the given schema kind
8485
func HistoryViewerFor(kind schema.GroupKind, c kubernetes.Interface, kc kruiseclientsets.Interface) (HistoryViewer, error) {

pkg/internal/polymorphichelpers/rollback.go

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,9 @@ func (v *RollbackVisitor) VisitAdvancedStatefulSet(kind internalapps.GroupKindEl
8787
func (v *RollbackVisitor) VisitAdvancedDaemonSet(kind internalapps.GroupKindElement) {
8888
v.result = &AdvancedDaemonSetRollbacker{k: v.clientset, kc: v.kruiseclientset}
8989
}
90+
func (v *RollbackVisitor) VisitRollout(kind internalapps.GroupKindElement) {
91+
v.result = &RolloutRollbacker{k: v.clientset, kc: v.kruiseclientset}
92+
}
9093

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

546+
type RolloutRollbacker struct {
547+
k kubernetes.Interface
548+
kc kruiseclientsets.Interface
549+
}
550+
551+
// RolloutRollbacker.Rollback never be called
552+
func (r *RolloutRollbacker) Rollback(obj runtime.Object,
553+
updatedAnnotations map[string]string,
554+
toRevision int64,
555+
dryRunStrategy cmdutil.DryRunStrategy) (string, error) {
556+
557+
return rollbackSuccess, nil
558+
}
559+
543560
func (r *AdvancedDaemonSetRollbacker) Rollback(obj runtime.Object,
544561
updatedAnnotations map[string]string,
545562
toRevision int64,

0 commit comments

Comments
 (0)