Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Propagate additional annotations to pods #3379

Merged
merged 2 commits into from
Feb 7, 2024
Merged

Propagate additional annotations to pods #3379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c48390
Propagate additional annotations to pods (#57)
Feb 5, 2024
bef556f
Merge branch 'master' into add-additional-annotations
zuqq Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions internal/executor/util/kubernetes_objects_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,7 @@ func TestCreatePodFromExecutorApiJob(t *testing.T) {
Job: &armadaevents.SubmitJob{
ObjectMeta: &armadaevents.ObjectMeta{
Labels: map[string]string{},
Annotations: map[string]string{},
Annotations: map[string]string{"runtime_gang_cardinality": "3"},
Namespace: "test-namespace",
},
JobId: jobId,
Expand All @@ -520,8 +520,9 @@ func TestCreatePodFromExecutorApiJob(t *testing.T) {
domain.PodCount: "1",
},
Annotations: map[string]string{
domain.JobSetId: "job-set",
domain.Owner: "user",
domain.JobSetId: "job-set",
domain.Owner: "user",
"runtime_gang_cardinality": "3",
},
},
Spec: v1.PodSpec{
Expand Down
16 changes: 16 additions & 0 deletions internal/scheduler/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ func (srv *ExecutorApi) LeaseJobRuns(stream executorapi.ExecutorApi_LeaseJobRuns
return err
}
addTolerations(submitMsg, PodRequirementsOverlay.Tolerations)
addAnnotations(submitMsg, PodRequirementsOverlay.Annotations)
}

var groups []string
Expand Down Expand Up @@ -239,6 +240,21 @@ func addTolerations(job *armadaevents.SubmitJob, tolerations []v1.Toleration) {
}
}

func addAnnotations(job *armadaevents.SubmitJob, annotations map[string]string) {
if job == nil || len(annotations) == 0 {
return
}
if job.ObjectMeta == nil {
job.ObjectMeta = &armadaevents.ObjectMeta{}
}
if job.ObjectMeta.Annotations == nil {
job.ObjectMeta.Annotations = make(map[string]string, len(annotations))
}
for k, v := range annotations {
job.ObjectMeta.Annotations[k] = v
}
}

// ReportEvents publishes all eventSequences to Pulsar. The eventSequences are compacted for more efficient publishing.
func (srv *ExecutorApi) ReportEvents(grpcCtx context.Context, list *executorapi.EventList) (*types.Empty, error) {
ctx := armadacontext.FromGrpcCtx(grpcCtx)
Expand Down
30 changes: 18 additions & 12 deletions internal/scheduler/api_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ func TestExecutorApi_LeaseJobRuns(t *testing.T) {

submit, compressedSubmit := submitMsg(
t,
nil,
&v1.PodSpec{
NodeSelector: map[string]string{nodeIdName: "node-id"},
},
Expand All @@ -97,7 +98,7 @@ func TestExecutorApi_LeaseJobRuns(t *testing.T) {
SubmitMessage: compressedSubmit,
}

submitWithoutNodeSelector, compressedSubmitNoNodeSelector := submitMsg(t, &v1.PodSpec{})
submitWithoutNodeSelector, compressedSubmitNoNodeSelector := submitMsg(t, nil, nil)
leaseWithoutNode := &database.JobRunLease{
RunID: uuid.New(),
Queue: "test-queue",
Expand All @@ -114,7 +115,7 @@ func TestExecutorApi_LeaseJobRuns(t *testing.T) {
Effect: v1.TaintEffectNoSchedule,
},
}
leaseWithTolerations := &database.JobRunLease{
leaseWithOverlay := &database.JobRunLease{
RunID: uuid.New(),
Queue: "test-queue",
JobSet: "test-jobset",
Expand All @@ -127,18 +128,22 @@ func TestExecutorApi_LeaseJobRuns(t *testing.T) {
PodRequirementsOverlay: protoutil.MustMarshall(
&schedulerobjects.PodRequirements{
Tolerations: tolerations,
Annotations: map[string]string{"runtime_gang_cardinality": "3"},
Priority: 1000,
},
),
}
submitWithTolerations, _ := submitMsg(
submitWithOverlay, _ := submitMsg(
t,
&armadaevents.ObjectMeta{
Annotations: map[string]string{"runtime_gang_cardinality": "3"},
},
&v1.PodSpec{
NodeSelector: map[string]string{nodeIdName: "node-id"},
Tolerations: tolerations,
},
)
submitWithTolerations.JobId = submit.JobId
submitWithOverlay.JobId = submit.JobId

tests := map[string]struct {
request *executorapi.LeaseRequest
Expand Down Expand Up @@ -195,17 +200,17 @@ func TestExecutorApi_LeaseJobRuns(t *testing.T) {
},
"run with PodRequirementsOverlay": {
request: defaultRequest,
leases: []*database.JobRunLease{leaseWithTolerations},
leases: []*database.JobRunLease{leaseWithOverlay},
expectedExecutor: defaultExpectedExecutor,
expectedMsgs: []*executorapi.LeaseStreamMessage{
{
Event: &executorapi.LeaseStreamMessage_Lease{Lease: &executorapi.JobRunLease{
JobRunId: armadaevents.ProtoUuidFromUuid(leaseWithTolerations.RunID),
Queue: leaseWithTolerations.Queue,
Jobset: leaseWithTolerations.JobSet,
User: leaseWithTolerations.UserID,
JobRunId: armadaevents.ProtoUuidFromUuid(leaseWithOverlay.RunID),
Queue: leaseWithOverlay.Queue,
Jobset: leaseWithOverlay.JobSet,
User: leaseWithOverlay.UserID,
Groups: groups,
Job: submitWithTolerations,
Job: submitWithOverlay,
}},
},
{
Expand Down Expand Up @@ -406,9 +411,10 @@ func TestExecutorApi_Publish(t *testing.T) {
}
}

func submitMsg(t *testing.T, podSpec *v1.PodSpec) (*armadaevents.SubmitJob, []byte) {
func submitMsg(t *testing.T, objectMeta *armadaevents.ObjectMeta, podSpec *v1.PodSpec) (*armadaevents.SubmitJob, []byte) {
submitMsg := &armadaevents.SubmitJob{
JobId: armadaevents.ProtoUuidFromUuid(uuid.New()),
JobId: armadaevents.ProtoUuidFromUuid(uuid.New()),
ObjectMeta: objectMeta,
MainObject: &armadaevents.KubernetesMainObject{
Object: &armadaevents.KubernetesMainObject_PodSpec{
PodSpec: &armadaevents.PodSpecWithAvoidList{
Expand Down
6 changes: 1 addition & 5 deletions internal/scheduler/scheduler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,10 +542,6 @@ func AppendEventSequencesFromScheduledJobs(eventSequences []*armadaevents.EventS
if err != nil {
return nil, err
}
additionalAnnotations, found := additionalAnnotationsByJobId[job.Id()]
if !found {
additionalAnnotations = make(map[string]string)
}
Comment on lines -545 to -548
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's fine for additionalAnnotations to be nil (we only read from it here), so I've removed this check.

run := job.LatestRun()
if run == nil {
return nil, errors.Errorf("attempting to generate lease eventSequences for job %s with no associated runs", job.Id())
Expand All @@ -569,9 +565,9 @@ func AppendEventSequencesFromScheduledJobs(eventSequences []*armadaevents.EventS
UpdateSequenceNumber: job.QueuedVersion(),
HasScheduledAtPriority: hasScheduledAtPriority,
ScheduledAtPriority: scheduledAtPriority,
AdditionalAnnotations: additionalAnnotations,
PodRequirementsOverlay: &schedulerobjects.PodRequirements{
Tolerations: jctx.AdditionalTolerations,
Annotations: additionalAnnotationsByJobId[job.Id()],
Priority: scheduledAtPriority,
},
},
Expand Down
3 changes: 0 additions & 3 deletions internal/scheduler/scheduler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1843,7 +1843,6 @@ func TestCycleConsistency(t *testing.T) {
UpdateSequenceNumber: 1,
HasScheduledAtPriority: true,
ScheduledAtPriority: 10,
AdditionalAnnotations: make(map[string]string),
PodRequirementsOverlay: &schedulerobjects.PodRequirements{Priority: 10},
},
},
Expand Down Expand Up @@ -1928,7 +1927,6 @@ func TestCycleConsistency(t *testing.T) {
UpdateSequenceNumber: 1,
HasScheduledAtPriority: true,
ScheduledAtPriority: 10,
AdditionalAnnotations: make(map[string]string),
PodRequirementsOverlay: &schedulerobjects.PodRequirements{Priority: 10},
},
},
Expand Down Expand Up @@ -1992,7 +1990,6 @@ func TestCycleConsistency(t *testing.T) {
UpdateSequenceNumber: 1,
HasScheduledAtPriority: true,
ScheduledAtPriority: 10,
AdditionalAnnotations: make(map[string]string),
PodRequirementsOverlay: &schedulerobjects.PodRequirements{Priority: 10},
},
},
Expand Down
Loading
Loading