-
Notifications
You must be signed in to change notification settings - Fork 134
/
submit.go
860 lines (749 loc) · 31.1 KB
/
submit.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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
package server
import (
"context"
"encoding/json"
"fmt"
"math"
"strings"
"time"
"github.com/gogo/protobuf/types"
pool "github.com/jolestar/go-commons-pool"
"github.com/pkg/errors"
log "github.com/sirupsen/logrus"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"k8s.io/utils/strings/slices"
"github.com/armadaproject/armada/internal/armada/configuration"
"github.com/armadaproject/armada/internal/armada/permissions"
"github.com/armadaproject/armada/internal/armada/repository"
servervalidation "github.com/armadaproject/armada/internal/armada/validation"
"github.com/armadaproject/armada/internal/common/armadaerrors"
"github.com/armadaproject/armada/internal/common/auth/authorization"
"github.com/armadaproject/armada/internal/common/compress"
"github.com/armadaproject/armada/internal/common/util"
"github.com/armadaproject/armada/internal/common/validation"
"github.com/armadaproject/armada/pkg/api"
"github.com/armadaproject/armada/pkg/client/queue"
)
type SubmitServer struct {
permissions authorization.PermissionChecker
jobRepository repository.JobRepository
queueRepository repository.QueueRepository
eventStore repository.EventStore
schedulingInfoRepository repository.SchedulingInfoRepository
cancelJobsBatchSize int
queueManagementConfig *configuration.QueueManagementConfig
schedulingConfig *configuration.SchedulingConfig
compressorPool *pool.ObjectPool
}
func NewSubmitServer(
permissions authorization.PermissionChecker,
jobRepository repository.JobRepository,
queueRepository repository.QueueRepository,
eventStore repository.EventStore,
schedulingInfoRepository repository.SchedulingInfoRepository,
cancelJobsBatchSize int,
queueManagementConfig *configuration.QueueManagementConfig,
schedulingConfig *configuration.SchedulingConfig,
) *SubmitServer {
poolConfig := pool.ObjectPoolConfig{
MaxTotal: 100,
MaxIdle: 50,
MinIdle: 10,
BlockWhenExhausted: true,
MinEvictableIdleTime: 30 * time.Minute,
SoftMinEvictableIdleTime: math.MaxInt64,
TimeBetweenEvictionRuns: 0,
NumTestsPerEvictionRun: 10,
}
compressorPool := pool.NewObjectPool(context.Background(), pool.NewPooledObjectFactorySimple(
func(context.Context) (interface{}, error) {
return compress.NewZlibCompressor(512)
}), &poolConfig)
return &SubmitServer{
permissions: permissions,
jobRepository: jobRepository,
queueRepository: queueRepository,
eventStore: eventStore,
schedulingInfoRepository: schedulingInfoRepository,
cancelJobsBatchSize: cancelJobsBatchSize,
queueManagementConfig: queueManagementConfig,
schedulingConfig: schedulingConfig,
compressorPool: compressorPool,
}
}
func (server *SubmitServer) Health(ctx context.Context, _ *types.Empty) (*api.HealthCheckResponse, error) {
// For now, lets make the health check really simple.
return &api.HealthCheckResponse{Status: api.HealthCheckResponse_SERVING}, nil
}
func (server *SubmitServer) GetQueueInfo(ctx context.Context, req *api.QueueInfoRequest) (*api.QueueInfo, error) {
q, err := server.queueRepository.GetQueue(req.Name)
var expected *repository.ErrQueueNotFound
if errors.Is(err, expected) {
return nil, status.Errorf(codes.NotFound, "[GetQueueInfo] Queue %s does not exist", req.Name)
}
if err != nil {
return nil, err
}
err = checkPermission(server.permissions, ctx, permissions.WatchAllEvents)
var globalPermErr *ErrUnauthorized
if errors.As(err, &globalPermErr) {
err = checkQueuePermission(server.permissions, ctx, q, permissions.WatchEvents, queue.PermissionVerbWatch)
var queuePermErr *ErrUnauthorized
if errors.As(err, &queuePermErr) {
return nil, status.Errorf(codes.PermissionDenied,
"[GetQueueInfo] error getting info for queue %s: %s", req.Name, MergePermissionErrors(globalPermErr, queuePermErr))
} else if err != nil {
return nil, status.Errorf(codes.Unavailable, "[GetQueueInfo] error checking permissions: %s", err)
}
} else if err != nil {
return nil, status.Errorf(codes.Unavailable, "[GetQueueInfo] error checking permissions: %s", err)
}
jobSets, e := server.jobRepository.GetQueueActiveJobSets(req.Name)
if e != nil {
return nil, status.Errorf(codes.Unavailable, "[GetQueueInfo] error getting job sets for queue %s: %s", req.Name, err)
}
return &api.QueueInfo{
Name: req.Name,
ActiveJobSets: jobSets,
}, nil
}
func (server *SubmitServer) GetQueue(ctx context.Context, req *api.QueueGetRequest) (*api.Queue, error) {
queue, err := server.queueRepository.GetQueue(req.Name)
var e *repository.ErrQueueNotFound
if errors.As(err, &e) {
return nil, status.Errorf(codes.NotFound, "[GetQueue] error: %s", err)
} else if err != nil {
return nil, status.Errorf(codes.Unavailable, "[GetQueue] error getting queue %q: %s", req.Name, err)
}
return queue.ToAPI(), nil
}
func (server *SubmitServer) CreateQueue(ctx context.Context, request *api.Queue) (*types.Empty, error) {
err := checkPermission(server.permissions, ctx, permissions.CreateQueue)
var ep *ErrUnauthorized
if errors.As(err, &ep) {
return nil, status.Errorf(codes.PermissionDenied, "[CreateQueue] error creating queue %s: %s", request.Name, ep)
} else if err != nil {
return nil, status.Errorf(codes.Unavailable, "[CreateQueue] error checking permissions: %s", err)
}
if len(request.UserOwners) == 0 {
principal := authorization.GetPrincipal(ctx)
request.UserOwners = []string{principal.GetName()}
}
queue, err := queue.NewQueue(request)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "[CreateQueue] error validating queue: %s", err)
}
err = server.queueRepository.CreateQueue(queue)
var eq *repository.ErrQueueAlreadyExists
if errors.As(err, &eq) {
return nil, status.Errorf(codes.AlreadyExists, "[CreateQueue] error creating queue: %s", err)
} else if err != nil {
return nil, status.Errorf(codes.Unavailable, "[CreateQueue] error creating queue: %s", err)
}
return &types.Empty{}, nil
}
func (server *SubmitServer) CreateQueues(ctx context.Context, request *api.QueueList) (*api.BatchQueueCreateResponse, error) {
var failedQueues []*api.QueueCreateResponse
// Create a queue for each element of the request body and return the failures.
for _, queue := range request.Queues {
_, err := server.CreateQueue(ctx, queue)
if err != nil {
failedQueues = append(failedQueues, &api.QueueCreateResponse{
Queue: queue,
Error: err.Error(),
})
}
}
return &api.BatchQueueCreateResponse{
FailedQueues: failedQueues,
}, nil
}
func (server *SubmitServer) UpdateQueue(ctx context.Context, request *api.Queue) (*types.Empty, error) {
err := checkPermission(server.permissions, ctx, permissions.CreateQueue)
var ep *ErrUnauthorized
if errors.As(err, &ep) {
return nil, status.Errorf(codes.PermissionDenied, "[UpdateQueue] error updating queue %s: %s", request.Name, ep)
} else if err != nil {
return nil, status.Errorf(codes.Unavailable, "[UpdateQueue] error checking permissions: %s", err)
}
queue, err := queue.NewQueue(request)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "[UpdateQueue] error: %s", err)
}
err = server.queueRepository.UpdateQueue(queue)
var e *repository.ErrQueueNotFound
if errors.As(err, &e) {
return nil, status.Errorf(codes.NotFound, "[UpdateQueue] error: %s", err)
} else if err != nil {
return nil, status.Errorf(codes.Unavailable, "[UpdateQueue] error getting queue %q: %s", queue.Name, err)
}
return &types.Empty{}, nil
}
func (server *SubmitServer) UpdateQueues(ctx context.Context, request *api.QueueList) (*api.BatchQueueUpdateResponse, error) {
var failedQueues []*api.QueueUpdateResponse
// Create a queue for each element of the request body and return the failures.
for _, queue := range request.Queues {
_, err := server.UpdateQueue(ctx, queue)
if err != nil {
failedQueues = append(failedQueues, &api.QueueUpdateResponse{
Queue: queue,
Error: err.Error(),
})
}
}
return &api.BatchQueueUpdateResponse{
FailedQueues: failedQueues,
}, nil
}
func (server *SubmitServer) DeleteQueue(ctx context.Context, request *api.QueueDeleteRequest) (*types.Empty, error) {
err := checkPermission(server.permissions, ctx, permissions.DeleteQueue)
var ep *ErrUnauthorized
if errors.As(err, &ep) {
return nil, status.Errorf(codes.PermissionDenied, "[DeleteQueue] error deleting queue %s: %s", request.Name, ep)
} else if err != nil {
return nil, status.Errorf(codes.Unavailable, "[DeleteQueue] error checking permissions: %s", err)
}
active, err := server.jobRepository.GetQueueActiveJobSets(request.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "[DeleteQueue] error getting active job sets for queue %s: %s", request.Name, err)
}
if len(active) > 0 {
return nil, status.Errorf(codes.FailedPrecondition, "[DeleteQueue] error deleting queue %s: queue is not empty", request.Name)
}
err = server.queueRepository.DeleteQueue(request.Name)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "[DeleteQueue] error deleting queue %s: %s", request.Name, err)
}
return &types.Empty{}, nil
}
func (server *SubmitServer) SubmitJobs(ctx context.Context, req *api.JobSubmitRequest) (*api.JobSubmitResponse, error) {
principal := authorization.GetPrincipal(ctx)
jobs, e := server.createJobs(req, principal.GetName(), principal.GetGroupNames())
if e != nil {
reqJson, _ := json.Marshal(req)
return nil, status.Errorf(codes.InvalidArgument, "[SubmitJobs] Error submitting job %s for user %s: %v", reqJson, principal.GetName(), e)
}
if err := validation.ValidateApiJobs(jobs, *server.schedulingConfig); err != nil {
return nil, err
}
q, err := server.getQueueOrCreate(ctx, req.Queue)
if err != nil {
return nil, status.Errorf(armadaerrors.CodeFromError(err), "couldn't get/make queue: %s", err)
}
err = server.submittingJobsWouldSurpassLimit(*q, req)
if err != nil {
return nil, status.Errorf(
codes.InvalidArgument,
"[SubmitJobs] error checking queue limit: %s", err)
}
err = checkPermission(server.permissions, ctx, permissions.SubmitAnyJobs)
var globalPermErr *ErrUnauthorized
if errors.As(err, &globalPermErr) {
err = checkQueuePermission(server.permissions, ctx, *q, permissions.SubmitJobs, queue.PermissionVerbSubmit)
var queuePermErr *ErrUnauthorized
if errors.As(err, &queuePermErr) {
return nil, status.Errorf(codes.PermissionDenied,
"[SubmitJobs] error submitting job in queue %s: %s", req.Queue, MergePermissionErrors(globalPermErr, queuePermErr))
} else if err != nil {
return nil, status.Errorf(codes.Unavailable, "[SubmitJobs] error checking permissions: %s", err)
}
} else if err != nil {
return nil, status.Errorf(codes.Unavailable, "[SubmitJobs] error checking permissions: %s", err)
}
// Check if the job would fit on any executor,
// to avoid having users wait for a job that may never be scheduled
allClusterSchedulingInfo, err := server.schedulingInfoRepository.GetClusterSchedulingInfo()
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error getting scheduling info: %s", err)
}
if ok, err := validateJobsCanBeScheduled(jobs, allClusterSchedulingInfo); !ok {
if err != nil {
return nil, errors.WithMessagef(err, "can't schedule job for user %s", principal.GetName())
}
return nil, errors.Errorf("can't schedule job for user %s", principal.GetName())
}
// Create events marking the jobs as submitted
err = reportSubmitted(server.eventStore, jobs)
if err != nil {
return nil, status.Errorf(codes.Aborted, "[SubmitJobs] error getting submitted report: %s", err)
}
// Submit the jobs by writing them to the database
submissionResults, err := server.jobRepository.AddJobs(jobs)
if err != nil {
jobFailures := createJobFailuresWithReason(jobs, fmt.Sprintf("Failed to save job in Armada: %s", e))
reportErr := reportFailed(server.eventStore, "", jobFailures)
if reportErr != nil {
return nil, status.Errorf(codes.Internal, "[SubmitJobs] error reporting failure event: %v", reportErr)
}
return nil, status.Errorf(codes.Aborted, "[SubmitJobs] error saving jobs in Armada: %s", err)
}
// Create the response to send to the client
result := &api.JobSubmitResponse{
JobResponseItems: make([]*api.JobSubmitResponseItem, 0, len(submissionResults)),
}
var createdJobs []*api.Job
var jobFailures []*jobFailure
var doubleSubmits []*repository.SubmitJobResult
for i, submissionResult := range submissionResults {
jobResponse := &api.JobSubmitResponseItem{JobId: submissionResult.JobId}
if submissionResult.Error != nil {
jobResponse.Error = submissionResult.Error.Error()
jobFailures = append(jobFailures, &jobFailure{
job: jobs[i],
reason: fmt.Sprintf("Failed to save job in Armada: %s", submissionResult.Error.Error()),
})
} else if submissionResult.DuplicateDetected {
doubleSubmits = append(doubleSubmits, submissionResult)
} else {
createdJobs = append(createdJobs, jobs[i])
}
result.JobResponseItems = append(result.JobResponseItems, jobResponse)
}
err = reportFailed(server.eventStore, "", jobFailures)
if err != nil {
return result, status.Errorf(codes.Internal, fmt.Sprintf("[SubmitJobs] error reporting failed jobs: %s", err))
}
err = reportDuplicateDetected(server.eventStore, doubleSubmits)
if err != nil {
return result, status.Errorf(codes.Internal, fmt.Sprintf("[SubmitJobs] error reporting duplicate jobs: %s", err))
}
err = reportQueued(server.eventStore, createdJobs)
if err != nil {
return result, status.Errorf(codes.Internal, fmt.Sprintf("[SubmitJobs] error reporting queued jobs: %s", err))
}
if len(jobFailures) > 0 {
return result, status.Errorf(codes.Internal, fmt.Sprintf("[SubmitJobs] error submitting some or all jobs: %s", err))
}
return result, nil
}
func (server *SubmitServer) submittingJobsWouldSurpassLimit(q queue.Queue, jobSubmitRequest *api.JobSubmitRequest) error {
limit := server.queueManagementConfig.DefaultQueuedJobsLimit
if limit <= 0 {
return nil
}
queued, err := server.countQueuedJobs(q)
if err != nil {
return err
}
queuedAfterSubmission := queued + int64(len(jobSubmitRequest.JobRequestItems))
if queuedAfterSubmission > int64(limit) {
return errors.Errorf(
"too many queued jobs: currently have %d, would have %d with new submission, limit is %d",
queued, queuedAfterSubmission, limit)
}
return nil
}
func (server *SubmitServer) countQueuedJobs(q queue.Queue) (int64, error) {
sizes, err := server.jobRepository.GetQueueSizes(queue.QueuesToAPI([]queue.Queue{q}))
if err != nil {
return 0, err
}
if len(sizes) == 0 {
return 0, errors.Errorf("no value for number of queued jobs returned from job repository")
}
return sizes[0], nil
}
// CancelJobs cancels jobs identified by the request.
// If the request contains a job ID, only the job with that ID is cancelled.
// If the request contains a queue name and a job set ID, all jobs matching those are cancelled.
func (server *SubmitServer) CancelJobs(ctx context.Context, request *api.JobCancelRequest) (*api.CancellationResult, error) {
if request.JobId != "" {
return server.cancelJobsById(ctx, request.JobId, request.Reason)
} else if request.JobSetId != "" && request.Queue != "" {
return server.cancelJobsByQueueAndSet(ctx, request.Queue, request.JobSetId, nil, request.Reason)
}
return nil, status.Errorf(codes.InvalidArgument, "[CancelJobs] specify either job ID or both queue name and job set ID")
}
func (server *SubmitServer) CancelJobSet(ctx context.Context, request *api.JobSetCancelRequest) (*types.Empty, error) {
err := servervalidation.ValidateJobSetFilter(request.Filter)
if err != nil {
return nil, err
}
_, err = server.cancelJobsByQueueAndSet(ctx, request.Queue, request.JobSetId, createJobSetFilter(request.Filter), request.Reason)
return &types.Empty{}, err
}
func createJobSetFilter(filter *api.JobSetFilter) *repository.JobSetFilter {
if filter == nil {
return nil
}
jobSetFilter := &repository.JobSetFilter{
IncludeQueued: false,
IncludeLeased: false,
}
for _, state := range filter.States {
if state == api.JobState_QUEUED {
jobSetFilter.IncludeQueued = true
}
if state == api.JobState_PENDING || state == api.JobState_RUNNING {
jobSetFilter.IncludeLeased = true
}
}
return jobSetFilter
}
// cancels a job with a given ID
func (server *SubmitServer) cancelJobsById(ctx context.Context, jobId string, reason string) (*api.CancellationResult, error) {
jobs, err := server.jobRepository.GetExistingJobsByIds([]string{jobId})
if err != nil {
return nil, status.Errorf(codes.Unavailable, "[cancelJobsById] error getting job with ID %s: %s", jobId, err)
}
if len(jobs) != 1 {
return nil, status.Errorf(codes.Internal, "[cancelJobsById] error getting job with ID %s: expected exactly one result, but got %v", jobId, jobs)
}
result, err := server.cancelJobs(ctx, jobs, reason)
var e *ErrUnauthorized
if errors.As(err, &e) {
return nil, status.Errorf(codes.PermissionDenied, "[cancelJobsById] error canceling job with ID %s: %s", jobId, e)
} else if err != nil {
return nil, status.Errorf(codes.Unavailable, "[cancelJobsById] error checking permissions: %s", err)
}
return result, nil
}
// cancels all jobs part of a particular job set and queue
func (server *SubmitServer) cancelJobsByQueueAndSet(
ctx context.Context,
queue string,
jobSetId string,
filter *repository.JobSetFilter,
reason string,
) (*api.CancellationResult, error) {
ids, err := server.jobRepository.GetJobSetJobIds(queue, jobSetId, filter)
if err != nil {
return nil, status.Errorf(codes.Unavailable, "[cancelJobsBySetAndQueue] error getting job IDs: %s", err)
}
// Split IDs into batches and process one batch at a time
// To reduce the number of jobs stored in memory
batches := util.Batch(ids, server.cancelJobsBatchSize)
var cancelledIds []string
for _, batch := range batches {
jobs, err := server.jobRepository.GetExistingJobsByIds(batch)
if err != nil {
result := &api.CancellationResult{CancelledIds: cancelledIds}
return result, status.Errorf(codes.Internal, "[cancelJobsBySetAndQueue] error getting jobs: %s", err)
}
result, err := server.cancelJobs(ctx, jobs, reason)
var e *ErrUnauthorized
if errors.As(err, &e) {
return nil, status.Errorf(codes.PermissionDenied, "[cancelJobsBySetAndQueue] error canceling jobs: %s", e)
} else if err != nil {
result := &api.CancellationResult{CancelledIds: cancelledIds}
return result, status.Errorf(codes.Unavailable, "[cancelJobsBySetAndQueue] error checking permissions: %s", err)
}
cancelledIds = append(cancelledIds, result.CancelledIds...)
// TODO I think the right way to do this is to include a timeout with the call to Redis
// Then, we can check for a deadline exceeded error here
if util.CloseToDeadline(ctx, time.Second*1) {
result := &api.CancellationResult{CancelledIds: cancelledIds}
return result, status.Errorf(codes.DeadlineExceeded, "[cancelJobsBySetAndQueue] deadline exceeded")
}
}
return &api.CancellationResult{CancelledIds: cancelledIds}, nil
}
func (server *SubmitServer) cancelJobs(ctx context.Context, jobs []*api.Job, reason string) (*api.CancellationResult, error) {
principal := authorization.GetPrincipal(ctx)
err := server.checkCancelPerms(ctx, jobs)
if err != nil {
return nil, err
}
err = reportJobsCancelling(server.eventStore, principal.GetName(), jobs, reason)
if err != nil {
return nil, errors.Errorf("[cancelJobs] error reporting jobs marked as cancelled: %v", err)
}
deletionResult, err := server.jobRepository.DeleteJobs(jobs)
if err != nil {
return nil, errors.Errorf("[cancelJobs] error deleting jobs: %v", err)
}
var cancelled []*api.Job
var cancelledIds []string
for job, err := range deletionResult {
if err != nil {
log.Errorf("[cancelJobs] error cancelling job with ID %s: %s", job.Id, err)
} else {
cancelled = append(cancelled, job)
cancelledIds = append(cancelledIds, job.Id)
}
}
cancelledJobPayloads := util.Map(cancelled, func(job *api.Job) *CancelledJobPayload {
return &CancelledJobPayload{
job: job,
reason: reason,
}
})
err = reportJobsCancelled(server.eventStore, principal.GetName(), cancelledJobPayloads)
if err != nil {
return nil, errors.Errorf("[cancelJobs] error reporting job cancellation: %v", err)
}
return &api.CancellationResult{CancelledIds: cancelledIds}, nil
}
func (server *SubmitServer) checkCancelPerms(ctx context.Context, jobs []*api.Job) error {
queueNames := make(map[string]struct{})
for _, job := range jobs {
queueNames[job.Queue] = struct{}{}
}
for queueName := range queueNames {
q, err := server.queueRepository.GetQueue(queueName)
if err != nil {
return err
}
err = checkPermission(server.permissions, ctx, permissions.CancelAnyJobs)
var globalPermErr *ErrUnauthorized
if errors.As(err, &globalPermErr) {
err = checkQueuePermission(server.permissions, ctx, q, permissions.CancelJobs, queue.PermissionVerbCancel)
var queuePermErr *ErrUnauthorized
if errors.As(err, &queuePermErr) {
return MergePermissionErrors(globalPermErr, queuePermErr)
} else if err != nil {
return err
}
} else if err != nil {
return err
}
}
return nil
}
// ReprioritizeJobs updates the priority of one of more jobs.
// Returns a map from job ID to any error (or nil if the call succeeded).
func (server *SubmitServer) ReprioritizeJobs(ctx context.Context, request *api.JobReprioritizeRequest) (*api.JobReprioritizeResponse, error) {
var jobs []*api.Job
if len(request.JobIds) > 0 {
existingJobs, err := server.jobRepository.GetExistingJobsByIds(request.JobIds)
if err != nil {
return nil, status.Errorf(codes.Unavailable, "[ReprioritizeJobs] error getting jobs by ID: %s", err)
}
jobs = existingJobs
} else if request.Queue != "" && request.JobSetId != "" {
ids, err := server.jobRepository.GetActiveJobIds(request.Queue, request.JobSetId)
if err != nil {
return nil, status.Errorf(codes.Unavailable,
"[ReprioritizeJobs] error getting job IDs for queue %s and job set %s: %s",
request.Queue, request.JobSetId, err)
}
existingJobs, err := server.jobRepository.GetExistingJobsByIds(ids)
if err != nil {
return nil, status.Errorf(codes.Unavailable, "[ReprioritizeJobs] error getting jobs for queue %s and job set %s: %s", request.Queue, request.JobSetId, err)
}
jobs = existingJobs
}
err := server.checkReprioritizePerms(ctx, jobs)
var e *ErrUnauthorized
if errors.As(err, &e) {
return nil, status.Errorf(codes.PermissionDenied, "[ReprioritizeJobs] error: %s", e)
} else if err != nil {
return nil, status.Errorf(codes.Unavailable, "[ReprioritizeJobs] error checking permissions: %s", err)
}
principalName := authorization.GetPrincipal(ctx).GetName()
err = reportJobsReprioritizing(server.eventStore, principalName, jobs, request.NewPriority)
if err != nil {
return nil, status.Errorf(codes.Unavailable, "[ReprioritizeJobs] error reporting job re-prioritisation: %s", err)
}
var jobIds []string
for _, job := range jobs {
jobIds = append(jobIds, job.Id)
}
results, err := server.reprioritizeJobs(jobIds, request.NewPriority, principalName)
if err != nil {
return nil, status.Errorf(codes.Unavailable, "[ReprioritizeJobs] error re-prioritising jobs: %s", err)
}
return &api.JobReprioritizeResponse{ReprioritizationResults: results}, nil
}
func (server *SubmitServer) reprioritizeJobs(jobIds []string, newPriority float64, principalName string) (map[string]string, error) {
// TODO There's a bug here.
// The function passed to UpdateJobs is called under an optimistic lock.
// If the jobs to be updated are mutated by another thread concurrently,
// the changes are not written to Redis. However, this function has side effects
// (creating reprioritized events) that would not be rolled back.
updateJobResults, err := server.jobRepository.UpdateJobs(jobIds, func(jobs []*api.Job) {
for _, job := range jobs {
job.Priority = newPriority
}
err := server.reportReprioritizedJobEvents(jobs, newPriority, principalName)
if err != nil {
log.Warnf("Failed to report events for reprioritize of jobs %s: %v", strings.Join(jobIds, ", "), err)
}
})
if err != nil {
return nil, errors.Errorf("[reprioritizeJobs] error updating jobs: %s", err)
}
results := map[string]string{}
for _, r := range updateJobResults {
if r.Error == nil {
results[r.JobId] = ""
} else {
results[r.JobId] = r.Error.Error()
}
}
return results, nil
}
func (server *SubmitServer) reportReprioritizedJobEvents(reprioritizedJobs []*api.Job, newPriority float64, principalName string) error {
err := reportJobsUpdated(server.eventStore, principalName, reprioritizedJobs)
if err != nil {
return errors.Errorf("[reportReprioritizedJobEvents] error reporting jobs updated: %v", err)
}
err = reportJobsReprioritized(server.eventStore, principalName, reprioritizedJobs, newPriority)
if err != nil {
return errors.Errorf("[reportReprioritizedJobEvents] error reporting jobs reprioritized: %v", err)
}
return nil
}
func (server *SubmitServer) checkReprioritizePerms(ctx context.Context, jobs []*api.Job) error {
queueNames := make(map[string]struct{})
for _, job := range jobs {
queueNames[job.Queue] = struct{}{}
}
for queueName := range queueNames {
q, err := server.queueRepository.GetQueue(queueName)
if err != nil {
return err
}
err = checkPermission(server.permissions, ctx, permissions.ReprioritizeAnyJobs)
var globalPermErr *ErrUnauthorized
if errors.As(err, &globalPermErr) {
err = checkQueuePermission(server.permissions, ctx, q, permissions.ReprioritizeJobs, queue.PermissionVerbReprioritize)
var queuePermErr *ErrUnauthorized
if errors.As(err, &queuePermErr) {
return MergePermissionErrors(globalPermErr, queuePermErr)
} else if err != nil {
return err
}
} else if err != nil {
return err
}
}
return nil
}
func (server *SubmitServer) getQueueOrCreate(ctx context.Context, queueName string) (*queue.Queue, error) {
q, e := server.queueRepository.GetQueue(queueName)
if e == nil {
return &q, nil
}
var expected *repository.ErrQueueNotFound
if errors.As(e, &expected) {
if !server.queueManagementConfig.AutoCreateQueues {
return nil, status.Errorf(
codes.Aborted,
"Queue %s not found; refusing to make it automatically (server setting autoCreateQueues is false)",
queueName,
)
}
if !server.permissions.UserHasPermission(ctx, permissions.SubmitAnyJobs) {
return nil, status.Errorf(codes.PermissionDenied, "Queue %s not found; won't create because user lacks SubmitAnyJobs permission", queueName)
}
principal := authorization.GetPrincipal(ctx)
groupNames := slices.Filter(nil, principal.GetGroupNames(),
func(s string) bool { return s != authorization.EveryoneGroup },
)
q = queue.Queue{
Name: queueName,
PriorityFactor: queue.PriorityFactor(server.queueManagementConfig.DefaultPriorityFactor),
Permissions: []queue.Permissions{
queue.NewPermissionsFromOwners([]string{principal.GetName()}, groupNames),
},
}
if err := server.queueRepository.CreateQueue(q); err != nil {
return nil, status.Errorf(codes.Aborted, "Couldn't find or create queue %s: %s", queueName, err.Error())
}
return &q, nil
}
return nil, status.Errorf(codes.Unavailable, "Couldn't load queue %s: %s", queueName, e.Error())
}
// createJobs returns a list of objects representing the jobs in a JobSubmitRequest.
// This function validates the jobs in the request and the pod specs. in each job.
// If any job or pod in invalid, an error is returned.
func (server *SubmitServer) createJobs(request *api.JobSubmitRequest, owner string, ownershipGroups []string) ([]*api.Job, error) {
return server.createJobsObjects(request, owner, ownershipGroups, time.Now, util.NewULID)
}
func (server *SubmitServer) createJobsObjects(request *api.JobSubmitRequest, owner string, ownershipGroups []string,
getTime func() time.Time, getUlid func() string,
) ([]*api.Job, error) {
compressor, err := server.compressorPool.BorrowObject(context.Background())
if err != nil {
return nil, err
}
defer func(compressorPool *pool.ObjectPool, ctx context.Context, object interface{}) {
err := compressorPool.ReturnObject(ctx, object)
if err != nil {
log.WithError(err).Errorf("Error returning compressor to pool")
}
}(server.compressorPool, context.Background(), compressor)
compressedOwnershipGroups, err := compress.CompressStringArray(ownershipGroups, compressor.(compress.Compressor))
if err != nil {
return nil, err
}
jobs := make([]*api.Job, 0, len(request.JobRequestItems))
if request.JobSetId == "" {
return nil, errors.Errorf("[createJobs] job set not specified")
}
if request.Queue == "" {
return nil, errors.Errorf("[createJobs] queue not specified")
}
for i, item := range request.JobRequestItems {
if item.PodSpec != nil && len(item.PodSpecs) > 0 {
return nil, errors.Errorf("[createJobs] job %d in job set %s contains both podSpec and podSpecs, but may only contain either", i, request.JobSetId)
}
podSpec := item.GetMainPodSpec()
if podSpec == nil {
return nil, errors.Errorf("[createJobs] job %d in job set %s contains no podSpec", i, request.JobSetId)
}
if err := validation.ValidateJobSubmitRequestItem(item); err != nil {
return nil, errors.Errorf("[createJobs] error validating the %d-th job of job set %s: %v", i, request.JobSetId, err)
}
namespace := item.Namespace
if namespace == "" {
namespace = "default"
}
fillContainerRequestsAndLimits(podSpec.Containers)
applyDefaultsToPodSpec(podSpec, *server.schedulingConfig)
if err := validation.ValidatePodSpec(podSpec, server.schedulingConfig); err != nil {
return nil, errors.Errorf("[createJobs] error validating the %d-th job of job set %s: %v", i, request.JobSetId, err)
}
// TODO: remove, RequiredNodeLabels is deprecated and will be removed in future versions
for k, v := range item.RequiredNodeLabels {
if podSpec.NodeSelector == nil {
podSpec.NodeSelector = map[string]string{}
}
podSpec.NodeSelector[k] = v
}
jobId := getUlid()
enrichText(item.Labels, jobId)
enrichText(item.Annotations, jobId)
j := &api.Job{
Id: jobId,
ClientId: item.ClientId,
Queue: request.Queue,
JobSetId: request.JobSetId,
Namespace: namespace,
Labels: item.Labels,
Annotations: item.Annotations,
RequiredNodeLabels: item.RequiredNodeLabels,
Ingress: item.Ingress,
Services: item.Services,
Priority: item.Priority,
Scheduler: item.Scheduler,
PodSpec: item.PodSpec,
PodSpecs: item.PodSpecs,
Created: getTime(), // Replaced with now for mocking unit test
Owner: owner,
QueueOwnershipUserGroups: nil,
CompressedQueueOwnershipUserGroups: compressedOwnershipGroups,
}
jobs = append(jobs, j)
}
return jobs, nil
}
func enrichText(labels map[string]string, jobId string) {
for key, value := range labels {
value := strings.ReplaceAll(value, "{{JobId}}", ` \z`) // \z cannot be entered manually, hence its use
value = strings.ReplaceAll(value, "{JobId}", jobId)
labels[key] = strings.ReplaceAll(value, ` \z`, "JobId")
}
}
func createJobFailuresWithReason(jobs []*api.Job, reason string) []*jobFailure {
jobFailures := make([]*jobFailure, len(jobs), len(jobs))
for i, job := range jobs {
jobFailures[i] = &jobFailure{
job: job,
reason: reason,
}
}
return jobFailures
}