forked from kubernetes-sigs/kueue
/
controller.go
793 lines (701 loc) · 26.9 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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
/*
Copyright 2023 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package provisioning
import (
"context"
"crypto/sha1"
"encoding/hex"
"errors"
"fmt"
"maps"
"regexp"
"strconv"
"time"
corev1 "k8s.io/api/core/v1"
apimeta "k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/sets"
autoscaling "k8s.io/autoscaler/cluster-autoscaler/apis/provisioningrequest/autoscaling.x-k8s.io/v1beta1"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/util/workqueue"
"k8s.io/klog/v2"
"k8s.io/utils/ptr"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
kueue "sigs.k8s.io/kueue/apis/kueue/v1beta1"
"sigs.k8s.io/kueue/pkg/podset"
"sigs.k8s.io/kueue/pkg/util/admissioncheck"
"sigs.k8s.io/kueue/pkg/util/api"
"sigs.k8s.io/kueue/pkg/util/slices"
"sigs.k8s.io/kueue/pkg/workload"
)
const (
objNameHashLength = 5
// 253 is the maximal length for a CRD name. We need to subtract one for '-', and the hash length.
objNameMaxPrefixLength = 252 - objNameHashLength
podTemplatesPrefix = "ppt"
)
var (
errInconsistentPodSetAssignments = errors.New("inconsistent podSet assignments")
)
var (
MaxRetries int32 = 3
MinBackoffSeconds int32 = 60
)
type provisioningConfigHelper = admissioncheck.ConfigHelper[*kueue.ProvisioningRequestConfig, kueue.ProvisioningRequestConfig]
func newProvisioningConfigHelper(c client.Client) (*provisioningConfigHelper, error) {
return admissioncheck.NewConfigHelper[*kueue.ProvisioningRequestConfig](c)
}
type Controller struct {
client client.Client
helper *provisioningConfigHelper
record record.EventRecorder
}
var _ reconcile.Reconciler = (*Controller)(nil)
// +kubebuilder:rbac:groups="",resources=events,verbs=create;watch;update
// +kubebuilder:rbac:groups="",resources=podtemplates,verbs=get;list;watch;create;delete;update
// +kubebuilder:rbac:groups=autoscaling.x-k8s.io,resources=provisioningrequests,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=autoscaling.x-k8s.io,resources=provisioningrequests/status,verbs=get
// +kubebuilder:rbac:groups=kueue.x-k8s.io,resources=workloads,verbs=get;list;watch;update;patch;delete
// +kubebuilder:rbac:groups=kueue.x-k8s.io,resources=workloads/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=kueue.x-k8s.io,resources=admissionchecks,verbs=get;list;watch
// +kubebuilder:rbac:groups=kueue.x-k8s.io,resources=provisioningrequestconfigs,verbs=get;list;watch
func NewController(client client.Client, record record.EventRecorder) (*Controller, error) {
helper, err := newProvisioningConfigHelper(client)
if err != nil {
return nil, err
}
return &Controller{
client: client,
record: record,
helper: helper,
}, nil
}
// Reconcile performs a full reconciliation for the object referred to by the Request.
// The Controller will requeue the Request to be processed again if an error is non-nil or
// Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
func (c *Controller) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error) {
wl := &kueue.Workload{}
log := ctrl.LoggerFrom(ctx)
log.V(2).Info("Reconcile workload")
err := c.client.Get(ctx, req.NamespacedName, wl)
if err != nil {
return reconcile.Result{}, client.IgnoreNotFound(err)
}
if !workload.HasQuotaReservation(wl) || apimeta.IsStatusConditionTrue(wl.Status.Conditions, kueue.WorkloadFinished) {
//1.2 workload has no reservation or is finished
log.V(5).Info("workload with no reservation, delete owned requests")
return reconcile.Result{}, c.deleteOwnedProvisionRequests(ctx, req.Namespace, req.Name)
}
// get the lists of relevant checks
relevantChecks, err := admissioncheck.FilterForController(ctx, c.client, wl.Status.AdmissionChecks, ControllerName)
if err != nil {
return reconcile.Result{}, err
}
list := &autoscaling.ProvisioningRequestList{}
if err := c.client.List(ctx, list, client.InNamespace(wl.Namespace), client.MatchingFields{RequestsOwnedByWorkloadKey: wl.Name}); client.IgnoreNotFound(err) != nil {
return reconcile.Result{}, err
}
ownedPrs := list.Items
activeOrLastPRForChecks := c.activeOrLastPRForChecks(ctx, wl, relevantChecks, ownedPrs)
if workload.IsAdmitted(wl) {
// check the state of the provision requests, eventually toggle the checks to false
// otherwise there is nothing to here
log.V(5).Info("workload admitted, sync checks")
return reconcile.Result{}, c.syncCheckStates(ctx, wl, relevantChecks, activeOrLastPRForChecks)
}
err = c.deleteUnusedProvisioningRequests(ctx, ownedPrs, activeOrLastPRForChecks)
if err != nil {
log.V(2).Error(err, "syncOwnedProvisionRequest failed to delete unused provisioning requests")
return reconcile.Result{}, err
}
requeAfter, err := c.syncOwnedProvisionRequest(ctx, wl, relevantChecks, activeOrLastPRForChecks)
if err != nil {
// this can also delete unneeded checks
log.V(2).Error(err, "syncOwnedProvisionRequest failed")
return reconcile.Result{}, err
}
err = c.syncCheckStates(ctx, wl, relevantChecks, activeOrLastPRForChecks)
if err != nil {
return reconcile.Result{}, err
}
if requeAfter != nil {
return reconcile.Result{RequeueAfter: *requeAfter}, nil
}
return reconcile.Result{}, nil
}
func (c *Controller) activeOrLastPRForChecks(ctx context.Context, wl *kueue.Workload, relevantChecks []string, ownedPrs []autoscaling.ProvisioningRequest) map[string]*autoscaling.ProvisioningRequest {
activeOrLastPRForChecks := make(map[string]*autoscaling.ProvisioningRequest)
for _, checkName := range relevantChecks {
for i := range ownedPrs {
req := &ownedPrs[i]
// PRs relevant for the admission check
if matches(req, wl.Name, checkName) {
prc, err := c.helper.ConfigForAdmissionCheck(ctx, checkName)
if err == nil && c.reqIsNeeded(ctx, wl, prc) && requestHasParameters(req, prc) {
if currPr, exists := activeOrLastPRForChecks[checkName]; !exists || getAttempt(ctx, currPr, wl.Name, checkName) < getAttempt(ctx, req, wl.Name, checkName) {
activeOrLastPRForChecks[checkName] = req
}
}
}
}
}
return activeOrLastPRForChecks
}
func (c *Controller) deleteUnusedProvisioningRequests(ctx context.Context, ownedPrs []autoscaling.ProvisioningRequest, activeOrLastPRForChecks map[string]*autoscaling.ProvisioningRequest) error {
log := ctrl.LoggerFrom(ctx)
prNames := sets.New[string]()
for _, pr := range activeOrLastPRForChecks {
prNames.Insert(pr.Name)
}
for _, pr := range ownedPrs {
req := &pr
if !prNames.Has(req.Name) {
if err := c.client.Delete(ctx, req); client.IgnoreNotFound(err) != nil {
log.V(5).Error(err, "deleting the request", "req", klog.KObj(req))
return err
}
}
}
return nil
}
func (c *Controller) deleteOwnedProvisionRequests(ctx context.Context, namespace string, name string) error {
list := &autoscaling.ProvisioningRequestList{}
if err := c.client.List(ctx, list, client.InNamespace(namespace), client.MatchingFields{RequestsOwnedByWorkloadKey: name}); err != nil {
return client.IgnoreNotFound(err)
}
for i := range list.Items {
if err := c.client.Delete(ctx, &list.Items[i]); client.IgnoreNotFound(err) != nil {
return fmt.Errorf("delete requests for %s/%s: %w", namespace, name, err)
}
}
return nil
}
func (c *Controller) syncOwnedProvisionRequest(ctx context.Context, wl *kueue.Workload, relevantChecks []string, activeOrLastPRForChecks map[string]*autoscaling.ProvisioningRequest) (*time.Duration, error) {
log := ctrl.LoggerFrom(ctx)
var requeAfter *time.Duration
for _, checkName := range relevantChecks {
//get the config
prc, err := c.helper.ConfigForAdmissionCheck(ctx, checkName)
if err != nil {
// the check is not active
continue
}
if !c.reqIsNeeded(ctx, wl, prc) {
continue
}
if ac := workload.FindAdmissionCheck(wl.Status.AdmissionChecks, checkName); ac != nil && ac.State == kueue.CheckStateReady {
log.V(2).Info("Skip syncing of the ProvReq for admission check which is Ready", "workload", klog.KObj(wl), "admissionCheck", checkName)
continue
}
oldPr, exists := activeOrLastPRForChecks[checkName]
attempt := int32(1)
shouldCreatePr := false
if exists {
attempt = getAttempt(ctx, oldPr, wl.Name, checkName)
if apimeta.IsStatusConditionTrue(oldPr.Status.Conditions, autoscaling.Failed) {
if attempt <= MaxRetries {
prFailed := apimeta.FindStatusCondition(oldPr.Status.Conditions, autoscaling.Failed)
remainingTime := remainingTime(prc, attempt, prFailed.LastTransitionTime.Time)
if remainingTime <= 0 {
shouldCreatePr = true
attempt += 1
} else if requeAfter == nil || remainingTime < *requeAfter {
requeAfter = &remainingTime
}
}
}
} else {
shouldCreatePr = true
}
requestName := GetProvisioningRequestName(wl.Name, checkName, attempt)
if shouldCreatePr {
log.V(3).Info("Creating ProvisioningRequest", "requestName", requestName, "attempt", attempt)
req := &autoscaling.ProvisioningRequest{
ObjectMeta: metav1.ObjectMeta{
Name: requestName,
Namespace: wl.Namespace,
},
Spec: autoscaling.ProvisioningRequestSpec{
ProvisioningClassName: prc.Spec.ProvisioningClassName,
Parameters: parametersKueueToProvisioning(prc.Spec.Parameters),
},
}
expectedPodSets := requiredPodSets(wl.Spec.PodSets, prc.Spec.ManagedResources)
psaMap := slices.ToRefMap(wl.Status.Admission.PodSetAssignments, func(p *kueue.PodSetAssignment) string { return p.Name })
podSetMap := slices.ToRefMap(wl.Spec.PodSets, func(ps *kueue.PodSet) string { return ps.Name })
for _, psName := range expectedPodSets {
ps, psFound := podSetMap[psName]
psa, psaFound := psaMap[psName]
if !psFound || !psaFound {
return nil, errInconsistentPodSetAssignments
}
req.Spec.PodSets = append(req.Spec.PodSets, autoscaling.PodSet{
PodTemplateRef: autoscaling.Reference{
Name: getProvisioningRequestPodTemplateName(requestName, psName),
},
Count: ptr.Deref(psa.Count, ps.Count),
})
}
if err := ctrl.SetControllerReference(wl, req, c.client.Scheme()); err != nil {
return nil, err
}
if err := c.client.Create(ctx, req); err != nil {
return nil, err
}
c.record.Eventf(wl, corev1.EventTypeNormal, "ProvisioningRequestCreated", "Created ProvisioningRequest: %q", req.Name)
activeOrLastPRForChecks[checkName] = req
}
if err := c.syncProvisionRequestsPodTemplates(ctx, wl, requestName, prc); err != nil {
return nil, err
}
}
return requeAfter, nil
}
func (c *Controller) syncProvisionRequestsPodTemplates(ctx context.Context, wl *kueue.Workload, prName string, prc *kueue.ProvisioningRequestConfig) error {
request := &autoscaling.ProvisioningRequest{}
requestKey := types.NamespacedName{
Name: prName,
Namespace: wl.Namespace,
}
err := c.client.Get(ctx, requestKey, request)
if err != nil {
return client.IgnoreNotFound(err)
}
expectedPodSets := requiredPodSets(wl.Spec.PodSets, prc.Spec.ManagedResources)
podsetRefsMap := slices.ToMap(expectedPodSets, func(i int) (string, string) {
return getProvisioningRequestPodTemplateName(prName, expectedPodSets[i]), expectedPodSets[i]
})
// the order of the podSets should be the same in the workload and prov. req.
// if the number is different, just delete the request
if len(request.Spec.PodSets) != len(expectedPodSets) {
return c.client.Delete(ctx, request)
}
psaMap := slices.ToRefMap(wl.Status.Admission.PodSetAssignments, func(p *kueue.PodSetAssignment) string { return p.Name })
podSetMap := slices.ToRefMap(wl.Spec.PodSets, func(ps *kueue.PodSet) string { return ps.Name })
for i := range request.Spec.PodSets {
reqPS := &request.Spec.PodSets[i]
psName, refFound := podsetRefsMap[reqPS.PodTemplateRef.Name]
ps, psFound := podSetMap[psName]
psa, psaFound := psaMap[psName]
if !refFound || !psFound || !psaFound || ptr.Deref(psa.Count, 0) != reqPS.Count {
return c.client.Delete(ctx, request)
}
pt := &corev1.PodTemplate{}
ptKey := types.NamespacedName{
Namespace: request.Namespace,
Name: reqPS.PodTemplateRef.Name,
}
err := c.client.Get(ctx, ptKey, pt)
if client.IgnoreNotFound(err) != nil {
return err
}
if err != nil {
// it's a not found, so create it
newPt := &corev1.PodTemplate{
ObjectMeta: metav1.ObjectMeta{
Name: ptKey.Name,
Namespace: ptKey.Namespace,
},
Template: ps.Template,
}
// apply the admission node selectors to the Template
psi, err := podset.FromAssignment(ctx, c.client, psaMap[psName], reqPS.Count)
if err != nil {
return err
}
err = podset.Merge(&newPt.Template.ObjectMeta, &newPt.Template.Spec, psi)
if err != nil {
return err
}
if err := ctrl.SetControllerReference(request, newPt, c.client.Scheme()); err != nil {
return err
}
if err = c.client.Create(ctx, newPt); err != nil {
return err
}
}
// maybe check the consistency deeper
}
return nil
}
func (c *Controller) reqIsNeeded(ctx context.Context, wl *kueue.Workload, prc *kueue.ProvisioningRequestConfig) bool {
return len(requiredPodSets(wl.Spec.PodSets, prc.Spec.ManagedResources)) > 0
}
func requiredPodSets(podSets []kueue.PodSet, resources []corev1.ResourceName) []string {
resourcesSet := sets.New(resources...)
users := make([]string, 0, len(podSets))
for i := range podSets {
ps := &podSets[i]
if len(resources) == 0 || podUses(&ps.Template.Spec, resourcesSet) {
users = append(users, ps.Name)
}
}
return users
}
func podUses(pod *corev1.PodSpec, resourceSet sets.Set[corev1.ResourceName]) bool {
for i := range pod.InitContainers {
if containerUses(&pod.InitContainers[i], resourceSet) {
return true
}
}
for i := range pod.Containers {
if containerUses(&pod.Containers[i], resourceSet) {
return true
}
}
return false
}
func containerUses(cont *corev1.Container, resourceSet sets.Set[corev1.ResourceName]) bool {
for r := range cont.Resources.Requests {
if resourceSet.Has(r) {
return true
}
}
return false
}
func parametersKueueToProvisioning(in map[string]kueue.Parameter) map[string]autoscaling.Parameter {
if in == nil {
return nil
}
out := make(map[string]autoscaling.Parameter, len(in))
for k, v := range in {
out[k] = autoscaling.Parameter(v)
}
return out
}
func requestHasParameters(req *autoscaling.ProvisioningRequest, prc *kueue.ProvisioningRequestConfig) bool {
if req.Spec.ProvisioningClassName != prc.Spec.ProvisioningClassName {
return false
}
if len(req.Spec.Parameters) != len(prc.Spec.Parameters) {
return false
}
for k, vReq := range req.Spec.Parameters {
if vCfg, found := prc.Spec.Parameters[k]; !found || vReq != autoscaling.Parameter(vCfg) {
return false
}
}
return true
}
func (c *Controller) syncCheckStates(ctx context.Context, wl *kueue.Workload, checks []string, activeOrLastPRForChecks map[string]*autoscaling.ProvisioningRequest) error {
log := ctrl.LoggerFrom(ctx)
checksMap := slices.ToRefMap(wl.Status.AdmissionChecks, func(c *kueue.AdmissionCheckState) string { return c.Name })
wlPatch := workload.BaseSSAWorkload(wl)
recorderMessages := make([]string, 0, len(checks))
updated := false
for _, check := range checks {
checkState := *checksMap[check]
if prc, err := c.helper.ConfigForAdmissionCheck(ctx, check); err != nil {
// the check is not active
if checkState.State != kueue.CheckStatePending || checkState.Message != CheckInactiveMessage {
updated = true
checkState.State = kueue.CheckStatePending
checkState.Message = CheckInactiveMessage
}
} else if !c.reqIsNeeded(ctx, wl, prc) {
if checkState.State != kueue.CheckStateReady {
updated = true
checkState.State = kueue.CheckStateReady
checkState.Message = NoRequestNeeded
checkState.PodSetUpdates = nil
}
} else {
pr := activeOrLastPRForChecks[check]
if pr == nil {
return nil
}
prFailed := apimeta.IsStatusConditionTrue(pr.Status.Conditions, autoscaling.Failed)
prProvisioned := apimeta.IsStatusConditionTrue(pr.Status.Conditions, autoscaling.Provisioned)
log.V(3).Info("Synchronizing admission check state based on provisioning request", "wl", klog.KObj(wl), "check", check, "prName", pr.Name, "failed", prFailed, "accepted", prProvisioned)
switch {
case prFailed:
if checkState.State != kueue.CheckStateRejected {
if attempt := getAttempt(ctx, pr, wl.Name, check); attempt <= MaxRetries {
// it is going to be retried
message := fmt.Sprintf("Retrying after failure: %s", apimeta.FindStatusCondition(pr.Status.Conditions, autoscaling.Failed).Message)
updated = updated || checkState.State != kueue.CheckStatePending || checkState.Message != message
checkState.State = kueue.CheckStatePending
checkState.Message = message
} else {
updated = true
checkState.State = kueue.CheckStateRejected
checkState.Message = apimeta.FindStatusCondition(pr.Status.Conditions, autoscaling.Failed).Message
}
}
case prProvisioned:
if checkState.State != kueue.CheckStateReady {
updated = true
checkState.State = kueue.CheckStateReady
// add the pod podSetUpdates
checkState.PodSetUpdates = podSetUpdates(wl, pr)
}
default:
if checkState.State != kueue.CheckStatePending {
updated = true
checkState.State = kueue.CheckStatePending
}
}
}
existingCondition := workload.FindAdmissionCheck(wlPatch.Status.AdmissionChecks, checkState.Name)
if existingCondition != nil && existingCondition.State != checkState.State {
message := fmt.Sprintf("Admission check %s updated state from %s to %s", checkState.Name, existingCondition.State, checkState.State)
if checkState.Message != "" {
message += fmt.Sprintf(" with message %s", checkState.Message)
}
recorderMessages = append(recorderMessages, message)
}
workload.SetAdmissionCheckState(&wlPatch.Status.AdmissionChecks, checkState)
}
if updated {
if err := c.client.Status().Patch(ctx, wlPatch, client.Apply, client.FieldOwner(ControllerName), client.ForceOwnership); err != nil {
return err
}
for i := range recorderMessages {
c.record.Event(wl, corev1.EventTypeNormal, "AdmissionCheckUpdated", api.TruncateEventMessage(recorderMessages[i]))
}
}
return nil
}
func podSetUpdates(wl *kueue.Workload, pr *autoscaling.ProvisioningRequest) []kueue.PodSetUpdate {
podSets := wl.Spec.PodSets
refMap := slices.ToMap(podSets, func(i int) (string, string) {
return getProvisioningRequestPodTemplateName(pr.Name, podSets[i].Name), podSets[i].Name
})
return slices.Map(pr.Spec.PodSets, func(ps *autoscaling.PodSet) kueue.PodSetUpdate {
return kueue.PodSetUpdate{
Name: refMap[ps.PodTemplateRef.Name],
Annotations: map[string]string{ConsumesAnnotationKey: pr.Name},
}
})
}
type acHandler struct {
client client.Client
}
var _ handler.EventHandler = (*acHandler)(nil)
func (a *acHandler) Create(ctx context.Context, event event.CreateEvent, q workqueue.RateLimitingInterface) {
ac, isAc := event.Object.(*kueue.AdmissionCheck)
if !isAc {
return
}
if ac.Spec.ControllerName == ControllerName {
err := a.reconcileWorkloadsUsing(ctx, ac.Name, q)
if err != nil {
ctrl.LoggerFrom(ctx).V(5).Error(err, "Failure on create event", "admissionCheck", klog.KObj(ac))
}
}
}
func (a *acHandler) Update(ctx context.Context, event event.UpdateEvent, q workqueue.RateLimitingInterface) {
oldAc, isOldAc := event.ObjectOld.(*kueue.AdmissionCheck)
newAc, isNewAc := event.ObjectNew.(*kueue.AdmissionCheck)
if !isNewAc || !isOldAc {
return
}
if oldAc.Spec.ControllerName == ControllerName || newAc.Spec.ControllerName == ControllerName {
err := a.reconcileWorkloadsUsing(ctx, oldAc.Name, q)
if err != nil {
ctrl.LoggerFrom(ctx).V(5).Error(err, "Failure on update event", "admissionCheck", klog.KObj(oldAc))
}
}
}
func (a *acHandler) Delete(ctx context.Context, event event.DeleteEvent, q workqueue.RateLimitingInterface) {
ac, isAc := event.Object.(*kueue.AdmissionCheck)
if !isAc {
return
}
if ac.Spec.ControllerName == ControllerName {
err := a.reconcileWorkloadsUsing(ctx, ac.Name, q)
if err != nil {
ctrl.LoggerFrom(ctx).V(5).Error(err, "Failure on delete event", "admissionCheck", klog.KObj(ac))
}
}
}
func (a *acHandler) Generic(_ context.Context, _ event.GenericEvent, _ workqueue.RateLimitingInterface) {
// nothing to do for now
}
func (a *acHandler) reconcileWorkloadsUsing(ctx context.Context, check string, q workqueue.RateLimitingInterface) error {
list := &kueue.WorkloadList{}
if err := a.client.List(ctx, list, client.MatchingFields{WorkloadsWithAdmissionCheckKey: check}); client.IgnoreNotFound(err) != nil {
return err
}
for i := range list.Items {
wl := &list.Items[i]
req := reconcile.Request{
NamespacedName: types.NamespacedName{
Name: wl.Name,
Namespace: wl.Namespace,
},
}
q.Add(req)
}
return nil
}
type prcHandler struct {
client client.Client
acHandlerOverride func(ctx context.Context, config string, q workqueue.RateLimitingInterface) error
}
var _ handler.EventHandler = (*prcHandler)(nil)
func (p *prcHandler) Create(ctx context.Context, event event.CreateEvent, q workqueue.RateLimitingInterface) {
prc, isPRC := event.Object.(*kueue.ProvisioningRequestConfig)
if !isPRC {
return
}
err := p.reconcileWorkloadsUsing(ctx, prc.Name, q)
if err != nil {
ctrl.LoggerFrom(ctx).V(5).Error(err, "Failure on create event", "provisioningRequestConfig", klog.KObj(prc))
}
}
func (p *prcHandler) Update(ctx context.Context, event event.UpdateEvent, q workqueue.RateLimitingInterface) {
oldPRC, isOldPRC := event.ObjectOld.(*kueue.ProvisioningRequestConfig)
newPRC, isNewPRC := event.ObjectNew.(*kueue.ProvisioningRequestConfig)
if !isNewPRC || !isOldPRC {
return
}
if oldPRC.Spec.ProvisioningClassName != newPRC.Spec.ProvisioningClassName || !maps.Equal(oldPRC.Spec.Parameters, newPRC.Spec.Parameters) || !slices.CmpNoOrder(oldPRC.Spec.ManagedResources, newPRC.Spec.ManagedResources) {
err := p.reconcileWorkloadsUsing(ctx, oldPRC.Name, q)
if err != nil {
ctrl.LoggerFrom(ctx).V(5).Error(err, "Failure on update event", "provisioningRequestConfig", klog.KObj(oldPRC))
}
}
}
func (p *prcHandler) Delete(ctx context.Context, event event.DeleteEvent, q workqueue.RateLimitingInterface) {
prc, isPRC := event.Object.(*kueue.ProvisioningRequestConfig)
if !isPRC {
return
}
err := p.reconcileWorkloadsUsing(ctx, prc.Name, q)
if err != nil {
ctrl.LoggerFrom(ctx).V(5).Error(err, "Failure on delete event", "provisioningRequestConfig", klog.KObj(prc))
}
}
func (p *prcHandler) Generic(_ context.Context, _ event.GenericEvent, _ workqueue.RateLimitingInterface) {
// nothing to do for now
}
func (p *prcHandler) reconcileWorkloadsUsing(ctx context.Context, config string, q workqueue.RateLimitingInterface) error {
list := &kueue.AdmissionCheckList{}
if err := p.client.List(ctx, list, client.MatchingFields{AdmissionCheckUsingConfigKey: config}); client.IgnoreNotFound(err) != nil {
return err
}
users := slices.Map(list.Items, func(ac *kueue.AdmissionCheck) string { return ac.Name })
for _, user := range users {
if p.acHandlerOverride != nil {
if err := p.acHandlerOverride(ctx, user, q); err != nil {
return err
}
} else {
req := reconcile.Request{
NamespacedName: types.NamespacedName{
Name: user,
},
}
q.Add(req)
}
}
return nil
}
func (c *Controller) SetupWithManager(mgr ctrl.Manager) error {
ach := &acHandler{
client: c.client,
}
prch := &prcHandler{
client: c.client,
acHandlerOverride: ach.reconcileWorkloadsUsing,
}
err := ctrl.NewControllerManagedBy(mgr).
For(&kueue.Workload{}).
Owns(&autoscaling.ProvisioningRequest{}).
Watches(&kueue.AdmissionCheck{}, ach).
Watches(&kueue.ProvisioningRequestConfig{}, prch).
Complete(c)
if err != nil {
return err
}
prcACh := &prcHandler{
client: c.client,
}
acReconciler := &acReconciler{
client: c.client,
helper: c.helper,
}
return ctrl.NewControllerManagedBy(mgr).
For(&kueue.AdmissionCheck{}).
Watches(&kueue.ProvisioningRequestConfig{}, prcACh).
Complete(acReconciler)
}
func GetProvisioningRequestName(workloadName, checkName string, attempt int32) string {
fullName := fmt.Sprintf("%s-%s-%d", workloadName, checkName, int(attempt))
return limitObjectName(fullName)
}
func getProvisioningRequestNamePrefix(workloadName, checkName string) string {
fullName := fmt.Sprintf("%s-%s-", workloadName, checkName)
return limitObjectName(fullName)
}
func getProvisioningRequestPodTemplateName(prName, podsetName string) string {
fullName := fmt.Sprintf("%s-%s-%s", podTemplatesPrefix, prName, podsetName)
return limitObjectName(fullName)
}
func limitObjectName(fullName string) string {
if len(fullName) <= objNameMaxPrefixLength {
return fullName
}
h := sha1.New()
h.Write([]byte(fullName))
hashBytes := hex.EncodeToString(h.Sum(nil))
return fmt.Sprintf("%s-%s", fullName[:objNameMaxPrefixLength], hashBytes[:objNameHashLength])
}
func matches(pr *autoscaling.ProvisioningRequest, workloadName, checkName string) bool {
attemptRegex := getAttemptRegex(workloadName, checkName)
matches := attemptRegex.FindStringSubmatch(pr.Name)
return len(matches) > 0
}
func getAttempt(ctx context.Context, pr *autoscaling.ProvisioningRequest, workloadName, checkName string) int32 {
logger := log.FromContext(ctx)
attemptRegex := getAttemptRegex(workloadName, checkName)
matches := attemptRegex.FindStringSubmatch(pr.Name)
if len(matches) > 0 {
number, err := strconv.Atoi(matches[1])
if err != nil {
logger.Error(err, "Parsing the attempt number from provisioning request", "requestName", pr.Name)
return 1
} else {
return int32(number)
}
} else {
logger.Info("No attempt suffix in provisioning request", "requestName", pr.Name)
return 1
}
}
func getAttemptRegex(workloadName, checkName string) *regexp.Regexp {
prefix := getProvisioningRequestNamePrefix(workloadName, checkName)
escapedPrefix := regexp.QuoteMeta(prefix)
return regexp.MustCompile("^" + escapedPrefix + "([0-9]+)$")
}
func remainingTime(prc *kueue.ProvisioningRequestConfig, failuresCount int32, lastFailureTime time.Time) time.Duration {
defaultBackoff := time.Duration(MinBackoffSeconds) * time.Second
maxBackoff := 30 * time.Minute
backoffDuration := defaultBackoff
for i := 1; i < int(failuresCount); i++ {
backoffDuration = backoffDuration * 2
if backoffDuration >= maxBackoff {
backoffDuration = maxBackoff
break
}
}
timeElapsedSinceLastFailure := time.Since(lastFailureTime)
return backoffDuration - timeElapsedSinceLastFailure
}