-
Notifications
You must be signed in to change notification settings - Fork 0
/
controller.go
306 lines (266 loc) · 8.87 KB
/
controller.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
package cron
import (
"context"
"time"
cron "github.com/robfig/cron/v3"
log "github.com/sirupsen/logrus"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/fields"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/selection"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/util/workqueue"
"git.code.oa.com/henrylwang/argo/pkg/apis/workflow/v1alpha1"
"git.code.oa.com/henrylwang/argo/pkg/client/clientset/versioned"
"git.code.oa.com/henrylwang/argo/pkg/client/informers/externalversions"
extv1alpha1 "git.code.oa.com/henrylwang/argo/pkg/client/informers/externalversions/workflow/v1alpha1"
"git.code.oa.com/henrylwang/argo/workflow/common"
"git.code.oa.com/henrylwang/argo/workflow/util"
)
// Controller is a controller for cron workflows
type Controller struct {
namespace string
managedNamespace string
instanceId string
cron *cron.Cron
nameEntryIDMap map[string]cron.EntryID
wfClientset versioned.Interface
wfInformer cache.SharedIndexInformer
wfLister util.WorkflowLister
wfQueue workqueue.RateLimitingInterface
cronWfInformer extv1alpha1.CronWorkflowInformer
cronWfQueue workqueue.RateLimitingInterface
restConfig *rest.Config
}
const (
cronWorkflowResyncPeriod = 20 * time.Minute
cronWorkflowWorkers = 2
cronWorkflowWorkflowWorkers = 2
)
func NewCronController(
wfclientset versioned.Interface,
restConfig *rest.Config,
namespace string,
managedNamespace string,
instanceId string,
) *Controller {
return &Controller{
wfClientset: wfclientset,
namespace: namespace,
managedNamespace: managedNamespace,
instanceId: instanceId,
cron: cron.New(),
restConfig: restConfig,
nameEntryIDMap: make(map[string]cron.EntryID),
wfQueue: workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter()),
cronWfQueue: workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter()),
}
}
func (cc *Controller) Run(ctx context.Context) {
defer cc.cronWfQueue.ShutDown()
defer cc.wfQueue.ShutDown()
log.Infof("Starting CronWorkflow controller")
if cc.instanceId != "" {
log.Infof("...with InstanceID: %s", cc.instanceId)
}
cc.cronWfInformer = externalversions.NewSharedInformerFactoryWithOptions(cc.wfClientset, cronWorkflowResyncPeriod, externalversions.WithNamespace(cc.managedNamespace),
externalversions.WithTweakListOptions(func(options *v1.ListOptions) {
cronWfInformerListOptionsFunc(options, cc.instanceId)
})).Argoproj().V1alpha1().CronWorkflows()
cc.addCronWorkflowInformerHandler()
cc.wfInformer = util.NewWorkflowInformer(cc.restConfig, cc.managedNamespace, cronWorkflowResyncPeriod, func(options *v1.ListOptions) {
wfInformerListOptionsFunc(options, cc.instanceId)
})
cc.addWorkflowInformerHandler()
cc.wfLister = util.NewWorkflowLister(cc.wfInformer)
cc.cron.Start()
defer cc.cron.Stop()
go cc.cronWfInformer.Informer().Run(ctx.Done())
go cc.wfInformer.Run(ctx.Done())
for i := 0; i < cronWorkflowWorkers; i++ {
go wait.Until(cc.runCronWorker, time.Second, ctx.Done())
}
for i := 0; i < cronWorkflowWorkflowWorkers; i++ {
go wait.Until(cc.runWorkflowWorker, time.Second, ctx.Done())
}
<-ctx.Done()
}
func (cc *Controller) runCronWorker() {
for cc.processNextCronItem() {
}
}
func (cc *Controller) processNextCronItem() bool {
key, quit := cc.cronWfQueue.Get()
if quit {
return false
}
defer cc.cronWfQueue.Done(key)
log.Infof("Processing %s", key)
obj, exists, err := cc.cronWfInformer.Informer().GetIndexer().GetByKey(key.(string))
if err != nil {
log.Errorf("Failed to get CronWorkflow '%s' from informer index: %+v", key, err)
return true
}
if !exists {
if entryId, ok := cc.nameEntryIDMap[key.(string)]; ok {
log.Infof("Deleting '%s'", key)
cc.cron.Remove(entryId)
delete(cc.nameEntryIDMap, key.(string))
}
return true
}
cronWf, ok := obj.(*v1alpha1.CronWorkflow)
if !ok {
log.Warnf("Key '%s' in index is not a CronWorkflow", key)
return true
}
cronWorkflowOperationCtx, err := newCronWfOperationCtx(cronWf, cc.wfClientset, cc.wfLister)
if err != nil {
log.Error(err)
return true
}
err = cronWorkflowOperationCtx.runOutstandingWorkflows()
if err != nil {
log.Errorf("could not run outstanding Workflow: %s", err)
return true
}
// The job is currently scheduled, remove it and re add it.
if entryId, ok := cc.nameEntryIDMap[key.(string)]; ok {
cc.cron.Remove(entryId)
delete(cc.nameEntryIDMap, key.(string))
}
cronSchedule := cronWf.Spec.Schedule
if cronWf.Spec.Timezone != "" {
cronSchedule = "CRON_TZ=" + cronWf.Spec.Timezone + " " + cronSchedule
}
entryId, err := cc.cron.AddJob(cronSchedule, cronWorkflowOperationCtx)
if err != nil {
log.Errorf("could not schedule CronWorkflow: %s", err)
return true
}
cc.nameEntryIDMap[key.(string)] = entryId
log.Infof("CronWorkflow %s added", key.(string))
return true
}
func (cc *Controller) runWorkflowWorker() {
for cc.processNextWorkflowItem() {
}
}
func (cc *Controller) processNextWorkflowItem() bool {
key, quit := cc.wfQueue.Get()
if quit {
return false
}
defer cc.wfQueue.Done(key)
obj, wfExists, err := cc.wfInformer.GetIndexer().GetByKey(key.(string))
if err != nil {
log.Errorf("Failed to get Workflow '%s' from informer index: %+v", key, err)
return true
}
// Check if the workflow no longer exists. If the workflow was deleted while it was an active workflow of a cron
// workflow, the cron workflow will reconcile this fact on its own next time it is processed.
if !wfExists {
log.Warnf("Workflow '%s' no longer exists", key)
return true
}
// The workflow informer receives unstructured objects to deal with the possibility of invalid
// workflow manifests that are unable to unmarshal to workflow objects
un, ok := obj.(*unstructured.Unstructured)
if !ok {
log.Warnf("Key '%s' in index is not an unstructured", key)
return true
}
wf, err := util.FromUnstructured(un)
if err != nil {
log.Warnf("Failed to unmarshal key '%s' to workflow object: %v", key, err)
return true
}
if wf.OwnerReferences == nil || len(wf.OwnerReferences) != 1 {
log.Warnf("Workflow '%s' stemming from CronWorkflow is malformed", wf.Name)
return true
}
// Workflows are run in the same namespace as CronWorkflow
nameEntryIdMapKey := wf.Namespace + "/" + wf.OwnerReferences[0].Name
var woc *cronWfOperationCtx
if entryId, ok := cc.nameEntryIDMap[nameEntryIdMapKey]; ok {
woc, ok = cc.cron.Entry(entryId).Job.(*cronWfOperationCtx)
if !ok {
log.Errorf("Parent CronWorkflow '%s' is malformed", nameEntryIdMapKey)
return true
}
} else {
log.Errorf("Parent CronWorkflow '%s' no longer exists", nameEntryIdMapKey)
return true
}
// If the workflow is completed or was deleted, remove it from Active Workflows
if wf.Status.Completed() || !wfExists {
log.Warnf("Workflow '%s' from CronWorkflow '%s' completed", wf.Name, woc.cronWf.Name)
woc.removeActiveWf(wf)
}
woc.enforceHistoryLimit()
return true
}
func (cc *Controller) addCronWorkflowInformerHandler() {
cc.cronWfInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
AddFunc: func(obj interface{}) {
key, err := cache.MetaNamespaceKeyFunc(obj)
if err == nil {
cc.cronWfQueue.Add(key)
}
},
UpdateFunc: func(old, new interface{}) {
key, err := cache.MetaNamespaceKeyFunc(new)
if err == nil {
cc.cronWfQueue.Add(key)
}
},
DeleteFunc: func(obj interface{}) {
key, err := cache.DeletionHandlingMetaNamespaceKeyFunc(obj)
if err == nil {
cc.cronWfQueue.Add(key)
}
},
})
}
func (cc *Controller) addWorkflowInformerHandler() {
cc.wfInformer.AddEventHandler(
cache.ResourceEventHandlerFuncs{
AddFunc: func(obj interface{}) {
key, err := cache.MetaNamespaceKeyFunc(obj)
if err == nil {
cc.wfQueue.Add(key)
}
},
UpdateFunc: func(old, new interface{}) {
key, err := cache.MetaNamespaceKeyFunc(new)
if err == nil {
cc.wfQueue.Add(key)
}
},
DeleteFunc: func(obj interface{}) {
key, err := cache.MetaNamespaceKeyFunc(obj)
if err == nil {
cc.wfQueue.Add(key)
}
},
},
)
}
func cronWfInformerListOptionsFunc(options *v1.ListOptions, instanceId string) {
options.FieldSelector = fields.Everything().String()
labelSelector := labels.NewSelector().Add(util.InstanceIDRequirement(instanceId))
options.LabelSelector = labelSelector.String()
}
func wfInformerListOptionsFunc(options *v1.ListOptions, instanceId string) {
options.FieldSelector = fields.Everything().String()
isCronWorkflowChildReq, err := labels.NewRequirement(common.LabelKeyCronWorkflow, selection.Exists, []string{})
if err != nil {
panic(err)
}
labelSelector := labels.NewSelector().Add(*isCronWorkflowChildReq)
labelSelector = labelSelector.Add(util.InstanceIDRequirement(instanceId))
options.LabelSelector = labelSelector.String()
}