-
Notifications
You must be signed in to change notification settings - Fork 3.2k
/
controller.go
289 lines (245 loc) · 8.75 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
package cron
import (
"context"
"fmt"
"reflect"
"time"
"github.com/argoproj/argo-workflows/v3/util/env"
"github.com/argoproj/pkg/sync"
log "github.com/sirupsen/logrus"
apiv1 "k8s.io/api/core/v1"
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/runtime/schema"
"k8s.io/apimachinery/pkg/types"
runtimeutil "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/dynamic"
"k8s.io/client-go/dynamic/dynamicinformer"
"k8s.io/client-go/informers"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/util/workqueue"
"github.com/argoproj/argo-workflows/v3/pkg/apis/workflow"
"github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1"
"github.com/argoproj/argo-workflows/v3/pkg/client/clientset/versioned"
"github.com/argoproj/argo-workflows/v3/workflow/events"
"github.com/argoproj/argo-workflows/v3/workflow/metrics"
"github.com/argoproj/argo-workflows/v3/workflow/util"
)
// Controller is a controller for cron workflows
type Controller struct {
namespace string
managedNamespace string
instanceId string
cron *cronFacade
keyLock sync.KeyLock
wfClientset versioned.Interface
wfLister util.WorkflowLister
wfInformer cache.SharedIndexInformer
cronWfInformer informers.GenericInformer
cronWfQueue workqueue.RateLimitingInterface
dynamicInterface dynamic.Interface
metrics *metrics.Metrics
eventRecorderManager events.EventRecorderManager
}
const (
cronWorkflowResyncPeriod = 20 * time.Minute
cronWorkflowWorkers = 8
)
var (
cronSyncPeriod = env.LookupEnvDurationOr("CRON_SYNC_PERIOD", 10*time.Second)
)
func init() {
// this make sure we support timezones
_, err := time.Parse(time.RFC822, "17 Oct 07 14:03 PST")
if err != nil {
log.Fatal(err)
}
log.WithField("cronSyncPeriod", cronSyncPeriod).Info("cron config")
}
func NewCronController(wfclientset versioned.Interface, dynamicInterface dynamic.Interface, wfInformer cache.SharedIndexInformer, namespace string, managedNamespace string, instanceId string, metrics *metrics.Metrics, eventRecorderManager events.EventRecorderManager) *Controller {
return &Controller{
wfClientset: wfclientset,
wfInformer: wfInformer,
namespace: namespace,
managedNamespace: managedNamespace,
instanceId: instanceId,
cron: newCronFacade(),
keyLock: sync.NewKeyLock(),
dynamicInterface: dynamicInterface,
cronWfQueue: metrics.RateLimiterWithBusyWorkers(workqueue.DefaultControllerRateLimiter(), "cron_wf_queue"),
metrics: metrics,
eventRecorderManager: eventRecorderManager,
}
}
func (cc *Controller) Run(ctx context.Context) {
defer runtimeutil.HandleCrash(runtimeutil.PanicHandlers...)
defer cc.cronWfQueue.ShutDown()
log.Infof("Starting CronWorkflow controller")
if cc.instanceId != "" {
log.Infof("...with InstanceID: %s", cc.instanceId)
}
cc.cronWfInformer = dynamicinformer.NewFilteredDynamicSharedInformerFactory(cc.dynamicInterface, cronWorkflowResyncPeriod, cc.managedNamespace, func(options *v1.ListOptions) {
cronWfInformerListOptionsFunc(options, cc.instanceId)
}).ForResource(schema.GroupVersionResource{Group: workflow.Group, Version: workflow.Version, Resource: workflow.CronWorkflowPlural})
cc.addCronWorkflowInformerHandler()
cc.wfLister = util.NewWorkflowLister(cc.wfInformer)
cc.cron.Start()
defer cc.cron.Stop()
go cc.cronWfInformer.Informer().Run(ctx.Done())
go wait.UntilWithContext(ctx, cc.syncAll, cronSyncPeriod)
for i := 0; i < cronWorkflowWorkers; i++ {
go wait.Until(cc.runCronWorker, time.Second, ctx.Done())
}
<-ctx.Done()
}
func (cc *Controller) runCronWorker() {
ctx := context.TODO()
for cc.processNextCronItem(ctx) {
}
}
func (cc *Controller) processNextCronItem(ctx context.Context) bool {
defer runtimeutil.HandleCrash(runtimeutil.PanicHandlers...)
key, quit := cc.cronWfQueue.Get()
if quit {
return false
}
defer cc.cronWfQueue.Done(key)
cc.keyLock.Lock(key.(string))
defer cc.keyLock.Unlock(key.(string))
logCtx := log.WithField("cronWorkflow", key)
logCtx.Infof("Processing %s", key)
obj, exists, err := cc.cronWfInformer.Informer().GetIndexer().GetByKey(key.(string))
if err != nil {
logCtx.WithError(err).Error(fmt.Sprintf("Failed to get CronWorkflow '%s' from informer index", key))
return true
}
if !exists {
logCtx.Infof("Deleting '%s'", key)
cc.cron.Delete(key.(string))
return true
}
un, ok := obj.(*unstructured.Unstructured)
if !ok {
logCtx.Errorf("malformed cluster workflow template: expected *unstructured.Unstructured, got %s", reflect.TypeOf(obj).Name())
return true
}
cronWf := &v1alpha1.CronWorkflow{}
err = util.FromUnstructuredObj(un, cronWf)
if err != nil {
cc.eventRecorderManager.Get(un.GetNamespace()).Event(un, apiv1.EventTypeWarning, "Malformed", err.Error())
logCtx.WithError(err).Error("malformed cron workflow: could not convert from unstructured")
return true
}
cronWorkflowOperationCtx := newCronWfOperationCtx(cronWf, cc.wfClientset, cc.metrics)
err = cronWorkflowOperationCtx.validateCronWorkflow()
if err != nil {
logCtx.WithError(err).Error("invalid cron workflow")
return true
}
wfWasRun, err := cronWorkflowOperationCtx.runOutstandingWorkflows(ctx)
if err != nil {
logCtx.WithError(err).Error("could not run outstanding Workflow")
return true
} else if wfWasRun {
// A workflow was run, so the cron workflow will be requeued. Return here to avoid duplicating work
return true
}
// The job is currently scheduled, remove it and re add it.
cc.cron.Delete(key.(string))
cronSchedule := cronWf.Spec.Schedule
if cronWf.Spec.Timezone != "" {
cronSchedule = "CRON_TZ=" + cronWf.Spec.Timezone + " " + cronSchedule
}
lastScheduledTimeFunc, err := cc.cron.AddJob(key.(string), cronSchedule, cronWorkflowOperationCtx)
if err != nil {
logCtx.WithError(err).Error("could not schedule CronWorkflow")
return true
}
cronWorkflowOperationCtx.scheduledTimeFunc = lastScheduledTimeFunc
logCtx.Infof("CronWorkflow %s added", key.(string))
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) syncAll(ctx context.Context) {
defer runtimeutil.HandleCrash(runtimeutil.PanicHandlers...)
log.Debug("Syncing all CronWorkflows")
workflows, err := cc.wfLister.List()
if err != nil {
return
}
groupedWorkflows := groupWorkflows(workflows)
cronWorkflows := cc.cronWfInformer.Informer().GetStore().List()
for _, obj := range cronWorkflows {
un, ok := obj.(*unstructured.Unstructured)
if !ok {
log.Error("Unable to convert object to unstructured when syncing CronWorkflows")
continue
}
cronWf := &v1alpha1.CronWorkflow{}
err := util.FromUnstructuredObj(un, cronWf)
if err != nil {
log.WithError(err).Error("Unable to convert unstructured to CronWorkflow when syncing CronWorkflows")
continue
}
err = cc.syncCronWorkflow(ctx, cronWf, groupedWorkflows[cronWf.UID])
if err != nil {
log.WithError(err).Error("Unable to sync CronWorkflow")
continue
}
}
}
func (cc *Controller) syncCronWorkflow(ctx context.Context, cronWf *v1alpha1.CronWorkflow, workflows []v1alpha1.Workflow) error {
key := cronWf.Namespace + "/" + cronWf.Name
cc.keyLock.Lock(key)
defer cc.keyLock.Unlock(key)
cwoc := newCronWfOperationCtx(cronWf, cc.wfClientset, cc.metrics)
err := cwoc.enforceHistoryLimit(ctx, workflows)
if err != nil {
return err
}
err = cwoc.reconcileActiveWfs(ctx, workflows)
if err != nil {
return err
}
return nil
}
func groupWorkflows(wfs []*v1alpha1.Workflow) map[types.UID][]v1alpha1.Workflow {
cwfChildren := make(map[types.UID][]v1alpha1.Workflow)
for _, wf := range wfs {
owner := v1.GetControllerOf(wf)
if owner == nil || owner.Kind != workflow.CronWorkflowKind {
continue
}
cwfChildren[owner.UID] = append(cwfChildren[owner.UID], *wf)
}
return cwfChildren
}
func cronWfInformerListOptionsFunc(options *v1.ListOptions, instanceId string) {
options.FieldSelector = fields.Everything().String()
labelSelector := labels.NewSelector().Add(util.InstanceIDRequirement(instanceId))
options.LabelSelector = labelSelector.String()
}