forked from argoproj/argo-workflows
-
Notifications
You must be signed in to change notification settings - Fork 0
/
controller.go
395 lines (361 loc) · 12.7 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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
package controller
import (
"context"
"fmt"
"strings"
"time"
log "github.com/sirupsen/logrus"
apiv1 "k8s.io/api/core/v1"
apierr "k8s.io/apimachinery/pkg/api/errors"
metav1 "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"
"k8s.io/apimachinery/pkg/selection"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/apimachinery/pkg/watch"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/util/workqueue"
"github.com/argoproj/argo"
wfclientset "github.com/argoproj/argo/pkg/client/clientset/versioned"
"github.com/argoproj/argo/workflow/common"
"github.com/argoproj/argo/workflow/metrics"
"github.com/argoproj/argo/workflow/ttlcontroller"
"github.com/argoproj/argo/workflow/util"
)
// WorkflowController is the controller for workflow resources
type WorkflowController struct {
// namespace of the workflow controller
namespace string
// configMap is the name of the config map in which to derive configuration of the controller from
configMap string
// Config is the workflow controller's configuration
Config WorkflowControllerConfig
// cliExecutorImage is the executor image as specified from the command line
cliExecutorImage string
// cliExecutorImagePullPolicy is the executor imagePullPolicy as specified from the command line
cliExecutorImagePullPolicy string
// restConfig is used by controller to send a SIGUSR1 to the wait sidecar using remotecommand.NewSPDYExecutor().
restConfig *rest.Config
kubeclientset kubernetes.Interface
wfclientset wfclientset.Interface
// datastructures to support the processing of workflows and workflow pods
wfInformer cache.SharedIndexInformer
podInformer cache.SharedIndexInformer
wfQueue workqueue.RateLimitingInterface
podQueue workqueue.RateLimitingInterface
completedPods chan string
}
const (
workflowResyncPeriod = 20 * time.Minute
workflowMetricsResyncPeriod = 1 * time.Minute
podResyncPeriod = 30 * time.Minute
)
// NewWorkflowController instantiates a new WorkflowController
func NewWorkflowController(
restConfig *rest.Config,
kubeclientset kubernetes.Interface,
wfclientset wfclientset.Interface,
namespace,
executorImage,
executorImagePullPolicy,
configMap string,
) *WorkflowController {
wfc := WorkflowController{
restConfig: restConfig,
kubeclientset: kubeclientset,
wfclientset: wfclientset,
configMap: configMap,
namespace: namespace,
cliExecutorImage: executorImage,
cliExecutorImagePullPolicy: executorImagePullPolicy,
wfQueue: workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter()),
podQueue: workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter()),
completedPods: make(chan string, 512),
}
return &wfc
}
// MetricsServer starts a prometheus metrics server if enabled in the configmap
func (wfc *WorkflowController) MetricsServer(ctx context.Context) {
if wfc.Config.MetricsConfig.Enabled {
informer := util.NewWorkflowInformer(wfc.restConfig, wfc.Config.Namespace, workflowMetricsResyncPeriod, wfc.tweakWorkflowMetricslist)
go informer.Run(ctx.Done())
registry := metrics.NewWorkflowRegistry(informer)
metrics.RunServer(ctx, wfc.Config.MetricsConfig, registry)
}
}
// TelemetryServer starts a prometheus telemetry server if enabled in the configmap
func (wfc *WorkflowController) TelemetryServer(ctx context.Context) {
if wfc.Config.TelemetryConfig.Enabled {
registry := metrics.NewTelemetryRegistry()
metrics.RunServer(ctx, wfc.Config.TelemetryConfig, registry)
}
}
// RunTTLController runs the workflow TTL controller
func (wfc *WorkflowController) RunTTLController(ctx context.Context) {
ttlCtrl := ttlcontroller.NewController(
wfc.restConfig,
wfc.wfclientset,
wfc.Config.Namespace,
wfc.Config.InstanceID,
)
err := ttlCtrl.Run(ctx.Done())
if err != nil {
panic(err)
}
}
// Run starts an Workflow resource controller
func (wfc *WorkflowController) Run(ctx context.Context, wfWorkers, podWorkers int) {
defer wfc.wfQueue.ShutDown()
defer wfc.podQueue.ShutDown()
log.Infof("Workflow Controller (version: %s) starting", argo.GetVersion())
log.Infof("Workers: workflow: %d, pod: %d", wfWorkers, podWorkers)
log.Info("Watch Workflow controller config map updates")
_, err := wfc.watchControllerConfigMap(ctx)
if err != nil {
log.Errorf("Failed to register watch for controller config map: %v", err)
return
}
wfc.wfInformer = util.NewWorkflowInformer(wfc.restConfig, wfc.Config.Namespace, workflowResyncPeriod, wfc.tweakWorkflowlist)
wfc.addWorkflowInformerHandler()
wfc.podInformer = wfc.newPodInformer()
go wfc.wfInformer.Run(ctx.Done())
go wfc.podInformer.Run(ctx.Done())
go wfc.podLabeler(ctx.Done())
// Wait for all involved caches to be synced, before processing items from the queue is started
for _, informer := range []cache.SharedIndexInformer{wfc.wfInformer, wfc.podInformer} {
if !cache.WaitForCacheSync(ctx.Done(), informer.HasSynced) {
log.Error("Timed out waiting for caches to sync")
return
}
}
for i := 0; i < wfWorkers; i++ {
go wait.Until(wfc.runWorker, time.Second, ctx.Done())
}
for i := 0; i < podWorkers; i++ {
go wait.Until(wfc.podWorker, time.Second, ctx.Done())
}
<-ctx.Done()
}
// podLabeler will label all pods on the controllers completedPod channel as completed
func (wfc *WorkflowController) podLabeler(stopCh <-chan struct{}) {
for {
select {
case <-stopCh:
return
case pod := <-wfc.completedPods:
parts := strings.Split(pod, "/")
if len(parts) != 2 {
log.Warnf("Unexpected item on completed pod channel: %s", pod)
continue
}
namespace := parts[0]
podName := parts[1]
err := common.AddPodLabel(wfc.kubeclientset, podName, namespace, common.LabelKeyCompleted, "true")
if err != nil {
if !apierr.IsNotFound(err) {
log.Errorf("Failed to label pod %s/%s completed: %+v", namespace, podName, err)
}
} else {
log.Infof("Labeled pod %s/%s completed", namespace, podName)
}
}
}
}
func (wfc *WorkflowController) runWorker() {
for wfc.processNextItem() {
}
}
// processNextItem is the worker logic for handling workflow updates
func (wfc *WorkflowController) processNextItem() bool {
key, quit := wfc.wfQueue.Get()
if quit {
return false
}
defer wfc.wfQueue.Done(key)
obj, exists, err := wfc.wfInformer.GetIndexer().GetByKey(key.(string))
if err != nil {
log.Errorf("Failed to get workflow '%s' from informer index: %+v", key, err)
return true
}
if !exists {
// This happens after a workflow was labeled with completed=true
// or was deleted, but the work queue still had an entry for it.
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)
woc := newWorkflowOperationCtx(wf, wfc)
woc.markWorkflowFailed(fmt.Sprintf("invalid spec: %s", err.Error()))
woc.persistUpdates()
return true
}
if wf.ObjectMeta.Labels[common.LabelKeyCompleted] == "true" {
// can get here if we already added the completed=true label,
// but we are still draining the controller's workflow workqueue
return true
}
woc := newWorkflowOperationCtx(wf, wfc)
woc.operate()
// TODO: operate should return error if it was unable to operate properly
// so we can requeue the work for a later time
// See: https://github.com/kubernetes/client-go/blob/master/examples/workqueue/main.go
//c.handleErr(err, key)
return true
}
func (wfc *WorkflowController) podWorker() {
for wfc.processNextPodItem() {
}
}
// processNextPodItem is the worker logic for handling pod updates.
// For pods updates, this simply means to "wake up" the workflow by
// adding the corresponding workflow key into the workflow workqueue.
func (wfc *WorkflowController) processNextPodItem() bool {
key, quit := wfc.podQueue.Get()
if quit {
return false
}
defer wfc.podQueue.Done(key)
obj, exists, err := wfc.podInformer.GetIndexer().GetByKey(key.(string))
if err != nil {
log.Errorf("Failed to get pod '%s' from informer index: %+v", key, err)
return true
}
if !exists {
// we can get here if pod was queued into the pod workqueue,
// but it was either deleted or labeled completed by the time
// we dequeued it.
return true
}
pod, ok := obj.(*apiv1.Pod)
if !ok {
log.Warnf("Key '%s' in index is not a pod", key)
return true
}
if pod.Labels == nil {
log.Warnf("Pod '%s' did not have labels", key)
return true
}
workflowName, ok := pod.Labels[common.LabelKeyWorkflow]
if !ok {
// Ignore pods unrelated to workflow (this shouldn't happen unless the watch is setup incorrectly)
log.Warnf("watch returned pod unrelated to any workflow: %s", pod.ObjectMeta.Name)
return true
}
// TODO: currently we reawaken the workflow on *any* pod updates.
// But this could be be much improved to become smarter by only
// requeue the workflow when there are changes that we care about.
wfc.wfQueue.Add(pod.ObjectMeta.Namespace + "/" + workflowName)
return true
}
func (wfc *WorkflowController) tweakWorkflowlist(options *metav1.ListOptions) {
options.FieldSelector = fields.Everything().String()
// completed notin (true)
incompleteReq, err := labels.NewRequirement(common.LabelKeyCompleted, selection.NotIn, []string{"true"})
if err != nil {
panic(err)
}
labelSelector := labels.NewSelector().
Add(*incompleteReq).
Add(util.InstanceIDRequirement(wfc.Config.InstanceID))
options.LabelSelector = labelSelector.String()
}
func (wfc *WorkflowController) tweakWorkflowMetricslist(options *metav1.ListOptions) {
options.FieldSelector = fields.Everything().String()
labelSelector := labels.NewSelector().Add(util.InstanceIDRequirement(wfc.Config.InstanceID))
options.LabelSelector = labelSelector.String()
}
func (wfc *WorkflowController) addWorkflowInformerHandler() {
wfc.wfInformer.AddEventHandler(
cache.ResourceEventHandlerFuncs{
AddFunc: func(obj interface{}) {
key, err := cache.MetaNamespaceKeyFunc(obj)
if err == nil {
wfc.wfQueue.Add(key)
}
},
UpdateFunc: func(old, new interface{}) {
key, err := cache.MetaNamespaceKeyFunc(new)
if err == nil {
wfc.wfQueue.Add(key)
}
},
DeleteFunc: func(obj interface{}) {
// IndexerInformer uses a delta queue, therefore for deletes we have to use this
// key function.
key, err := cache.DeletionHandlingMetaNamespaceKeyFunc(obj)
if err == nil {
wfc.wfQueue.Add(key)
}
},
},
)
}
func (wfc *WorkflowController) newWorkflowPodWatch() *cache.ListWatch {
c := wfc.kubeclientset.CoreV1().RESTClient()
resource := "pods"
namespace := wfc.Config.Namespace
// completed=false
incompleteReq, _ := labels.NewRequirement(common.LabelKeyCompleted, selection.Equals, []string{"false"})
labelSelector := labels.NewSelector().
Add(*incompleteReq).
Add(util.InstanceIDRequirement(wfc.Config.InstanceID))
listFunc := func(options metav1.ListOptions) (runtime.Object, error) {
options.LabelSelector = labelSelector.String()
req := c.Get().
Namespace(namespace).
Resource(resource).
VersionedParams(&options, metav1.ParameterCodec)
return req.Do().Get()
}
watchFunc := func(options metav1.ListOptions) (watch.Interface, error) {
options.Watch = true
options.LabelSelector = labelSelector.String()
req := c.Get().
Namespace(namespace).
Resource(resource).
VersionedParams(&options, metav1.ParameterCodec)
return req.Watch()
}
return &cache.ListWatch{ListFunc: listFunc, WatchFunc: watchFunc}
}
func (wfc *WorkflowController) newPodInformer() cache.SharedIndexInformer {
source := wfc.newWorkflowPodWatch()
informer := cache.NewSharedIndexInformer(source, &apiv1.Pod{}, podResyncPeriod, cache.Indexers{})
informer.AddEventHandler(
cache.ResourceEventHandlerFuncs{
AddFunc: func(obj interface{}) {
key, err := cache.MetaNamespaceKeyFunc(obj)
if err == nil {
wfc.podQueue.Add(key)
}
},
UpdateFunc: func(old, new interface{}) {
key, err := cache.MetaNamespaceKeyFunc(new)
if err == nil {
wfc.podQueue.Add(key)
}
},
DeleteFunc: func(obj interface{}) {
// IndexerInformer uses a delta queue, therefore for deletes we have to use this
// key function.
key, err := cache.DeletionHandlingMetaNamespaceKeyFunc(obj)
if err == nil {
wfc.podQueue.Add(key)
}
},
},
)
return informer
}