Add Custom Scheduler Name to Build and BuildRun objects

Signed-off-by: Dylan Orzel <dorzel@redhat.com>

deploy/crds/shipwright.io_buildruns.yaml

@@ -7439,6 +7439,10 @@ spec:
                             format: duration
                             type: string
                         type: object
+                      schedulerName:
+                        description: SchedulerName specifies the scheduler to be used
+                          to dispatch the Pod
+                        type: string
                       source:
                         description: |-
                           Source refers to the location where the source code is,
@@ -9753,6 +9757,10 @@ spec:
                     format: duration
                     type: string
                 type: object
+              schedulerName:
+                description: SchedulerName specifies the scheduler to be used to dispatch
+                  the Pod
+                type: string
               serviceAccount:
                 description: |-
                   ServiceAccount refers to the kubernetes serviceaccount
@@ -11941,6 +11949,10 @@ spec:
                         format: duration
                         type: string
                     type: object
+                  schedulerName:
+                    description: SchedulerName specifies the scheduler to be used
+                      to dispatch the Pod
+                    type: string
                   source:
                     description: |-
                       Source refers to the location where the source code is,

deploy/crds/shipwright.io_builds.yaml

@@ -2818,6 +2818,10 @@ spec:
                     format: duration
                     type: string
                 type: object
+              schedulerName:
+                description: SchedulerName specifies the scheduler to be used to dispatch
+                  the Pod
+                type: string
               source:
                 description: |-
                   Source refers to the location where the source code is,

pkg/apis/build/v1beta1/build_types.go

@@ -80,7 +80,8 @@ const (
 	NodeSelectorNotValid BuildReason = "NodeSelectorNotValid"
 	// TolerationNotValid indicates that the Toleration value is not valid
 	TolerationNotValid BuildReason = "TolerationNotValid"
-
+	// SchedulerNameNotValid indicates that the Scheduler name is not valid
+	SchedulerNameNotValid BuildReason = "SchedulerNameNotValid"
 	// AllValidationsSucceeded indicates a Build was successfully validated
 	AllValidationsSucceeded = "all validations succeeded"
 )
@@ -191,6 +192,10 @@ type BuildSpec struct {
 	// +patchMergeKey=Key
 	// +patchStrategy=merge
 	Tolerations []corev1.Toleration `json:"tolerations,omitempty" patchStrategy:"merge" patchMergeKey:"Key"`
+
+	// SchedulerName specifies the scheduler to be used to dispatch the Pod
+	// +optional
+	SchedulerName string `json:"schedulerName,omitempty"`
 }
 
 // BuildVolume is a volume that will be mounted in build pod during build step

pkg/apis/build/v1beta1/buildrun_types.go

@@ -121,6 +121,10 @@ type BuildRunSpec struct {
 	// +patchMergeKey=Key
 	// +patchStrategy=merge
 	Tolerations []corev1.Toleration `json:"tolerations,omitempty" patchStrategy:"merge" patchMergeKey:"Key"`
+
+	// SchedulerName specifies the scheduler to be used to dispatch the Pod
+	// +optional
+	SchedulerName string `json:"schedulerName,omitempty"`
 }
 
 // BuildRunRequestedState defines the buildrun state the user can provide to override whatever is the current state.

pkg/reconciler/build/build.go

@@ -35,6 +35,7 @@ var validationTypes = [...]string{
 	validate.Triggers,
 	validate.NodeSelector,
 	validate.Tolerations,
+	validate.SchedulerName,
 }
 
 // ReconcileBuild reconciles a Build object

pkg/reconciler/buildrun/buildrun.go

@@ -162,6 +162,7 @@ func (r *ReconcileBuildRun) Reconcile(ctx context.Context, request reconcile.Req
 						validate.NewEnv(build),
 						validate.NewNodeSelector(build),
 						validate.NewTolerations(build),
+						validate.NewSchedulerName(build),
 					)
 
 					// an internal/technical error during validation happened
@@ -310,6 +311,15 @@ func (r *ReconcileBuildRun) Reconcile(ctx context.Context, request reconcile.Req
 				return reconcile.Result{}, nil
 			}
 
+			// Validate the schedulerName
+			valid, reason, message = validate.BuildRunSchedulerName(buildRun.Spec.SchedulerName)
+			if !valid {
+				if err := resources.UpdateConditionWithFalseStatus(ctx, r.client, buildRun, message, reason); err != nil {
+					return reconcile.Result{}, err
+				}
+				return reconcile.Result{}, nil
+			}
+
 			// Create the TaskRun, this needs to be the last step in this block to be idempotent
 			generatedTaskRun, err := r.createTaskRun(ctx, svcAccount, strategy, build, buildRun)
 			if err != nil {

pkg/reconciler/buildrun/resources/taskrun.go

@@ -255,6 +255,15 @@ func GenerateTaskRun(
 		taskRunPodTemplate.Tolerations = taskRunTolerations
 	}
 
+	// Set custom scheduler name if specified, giving preference to BuildRun values
+	if buildRun.Spec.SchedulerName != "" {
+		taskRunPodTemplate.SchedulerName = buildRun.Spec.SchedulerName
+	} else {
+		if build.Spec.SchedulerName != "" {
+			taskRunPodTemplate.SchedulerName = build.Spec.SchedulerName
+		}
+	}
+
 	if !(taskRunPodTemplate.Equals(&pod.PodTemplate{})) {
 		expectedTaskRun.Spec.PodTemplate = taskRunPodTemplate
 	}

pkg/validate/nodeselector.go

@@ -28,17 +28,11 @@ func NewNodeSelector(build *build.Build) *NodeSelectorRef {
 // ValidatePath implements BuildPath interface and validates
 // that NodeSelector keys/values are valid labels
 func (b *NodeSelectorRef) ValidatePath(_ context.Context) error {
-	for key, value := range b.Build.Spec.NodeSelector {
-		if errs := validation.IsQualifiedName(key); len(errs) > 0 {
-			b.Build.Status.Reason = ptr.To(build.NodeSelectorNotValid)
-			b.Build.Status.Message = ptr.To(fmt.Sprintf("Node selector key not valid: %v", strings.Join(errs, ", ")))
-		}
-		if errs := validation.IsValidLabelValue(value); len(errs) > 0 {
-			b.Build.Status.Reason = ptr.To(build.NodeSelectorNotValid)
-			b.Build.Status.Message = ptr.To(fmt.Sprintf("Node selector value not valid: %v", strings.Join(errs, ", ")))
-		}
+	ok, reason, msg := BuildRunNodeSelector(b.Build.Spec.NodeSelector)
+	if !ok {
+		b.Build.Status.Reason = ptr.To(build.BuildReason(reason))
+		b.Build.Status.Message = ptr.To(msg)
 	}
-
 	return nil
 }
 

pkg/validate/scheduler_name.go

@@ -0,0 +1,47 @@
+// Copyright The Shipwright Contributors
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package validate
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"k8s.io/apimachinery/pkg/util/validation"
+	"k8s.io/utils/ptr"
+
+	build "github.com/shipwright-io/build/pkg/apis/build/v1beta1"
+)
+
+// SchedulerNameRef contains all required fields
+// to validate a Scheduler name
+type SchedulerNameRef struct {
+	Build *build.Build // build instance for analysis
+}
+
+func NewSchedulerName(build *build.Build) *SchedulerNameRef {
+	return &SchedulerNameRef{build}
+}
+
+// ValidatePath implements BuildPath interface and validates
+// that SchedulerName values are valid
+func (b *SchedulerNameRef) ValidatePath(_ context.Context) error {
+	ok, reason, msg := BuildRunSchedulerName(b.Build.Spec.SchedulerName)
+	if !ok {
+		b.Build.Status.Reason = ptr.To(build.BuildReason(reason))
+		b.Build.Status.Message = ptr.To(msg)
+	}
+	return nil
+}
+
+// BuildSchedulerName is used to validate the schedulerName in the BuildRun object
+func BuildRunSchedulerName(schedulerName string) (bool, string, string) {
+	if schedulerName != "" {
+		if errs := validation.IsQualifiedName(schedulerName); len(errs) > 0 {
+			return false, string(build.SchedulerNameNotValid), fmt.Sprintf("Scheduler name not valid: %v", strings.Join(errs, ", "))
+		}
+	}
+	return true, "", ""
+}

pkg/validate/tolerations.go

@@ -29,34 +29,11 @@ func NewTolerations(build *build.Build) *TolerationsRef {
 // ValidatePath implements BuildPath interface and validates
 // that tolerations key/operator/value are valid
 func (b *TolerationsRef) ValidatePath(_ context.Context) error {
-	for _, toleration := range b.Build.Spec.Tolerations {
-		// validate Key
-		if errs := validation.IsQualifiedName(toleration.Key); errs != nil {
-			b.Build.Status.Reason = ptr.To(build.TolerationNotValid)
-			b.Build.Status.Message = ptr.To(fmt.Sprintf("Toleration key not valid: %v", strings.Join(errs, ", ")))
-		}
-		// validate Operator
-		if !((toleration.Operator == v1.TolerationOpExists) || (toleration.Operator == v1.TolerationOpEqual)) {
-			b.Build.Status.Reason = ptr.To(build.TolerationNotValid)
-			b.Build.Status.Message = ptr.To(fmt.Sprintf("Toleration operator not valid. Must be one of: '%v', '%v'", v1.TolerationOpExists, v1.TolerationOpEqual))
-		}
-		// validate Value
-		if errs := validation.IsValidLabelValue(toleration.Value); errs != nil {
-			b.Build.Status.Reason = ptr.To(build.TolerationNotValid)
-			b.Build.Status.Message = ptr.To(fmt.Sprintf("Toleration value not valid: %v", strings.Join(errs, ", ")))
-		}
-		// validate Taint Effect, of which only "NoSchedule" is supported
-		if !((toleration.Effect) == "" || (toleration.Effect == v1.TaintEffectNoSchedule)) {
-			b.Build.Status.Reason = ptr.To(build.TolerationNotValid)
-			b.Build.Status.Message = ptr.To(fmt.Sprintf("Only the '%v' toleration effect is supported.", v1.TaintEffectNoSchedule))
-		}
-		// validate TolerationSeconds, which should not be specified
-		if toleration.TolerationSeconds != nil {
-			b.Build.Status.Reason = ptr.To(build.TolerationNotValid)
-			b.Build.Status.Message = ptr.To("Specifying TolerationSeconds is not supported.")
-		}
+	ok, reason, msg := BuildRunTolerations(b.Build.Spec.Tolerations)
+	if !ok {
+		b.Build.Status.Reason = ptr.To(build.BuildReason(reason))
+		b.Build.Status.Message = ptr.To(msg)
 	}
-
 	return nil
 }
 

pkg/validate/validate.go

@@ -39,6 +39,8 @@ const (
 	NodeSelector = "nodeselector"
 	// Tolerations for validating `spec.tolerations` entry
 	Tolerations = "tolerations"
+	// SchedulerName for validating `spec.schedulerName` entry
+	SchedulerName = "schedulername"
 )
 
 const (
@@ -83,6 +85,8 @@ func NewValidation(
 		return &NodeSelectorRef{Build: build}, nil
 	case Tolerations:
 		return &TolerationsRef{Build: build}, nil
+	case SchedulerName:
+		return &SchedulerNameRef{Build: build}, nil
 	default:
 		return nil, fmt.Errorf("unknown validation type")
 	}
@@ -147,6 +151,11 @@ func BuildRunFields(buildRun *build.BuildRun) (string, string) {
 			return resources.BuildRunBuildFieldOverrideForbidden,
 				"cannot use 'tolerations' override and 'buildSpec' simultaneously"
 		}
+
+		if len(buildRun.Spec.SchedulerName) > 0 {
+			return resources.BuildRunBuildFieldOverrideForbidden,
+				"cannot use 'schedulerName' override and 'buildSpec' simultaneously"
+		}
 	}
 
 	return "", ""