Story (Required)

<Describes high level purpose and goal for this story. Answers the questions: Who is impacted, what is it and why do we need it? How does it improve the customer’s experience?>

As a developer trying to build images on specific nodes I want to set the custom scheduler options on a BuildRun through the shp command line.

Background (Required)

<Describes the context or background related to this story>

With BUILD-986, Shipwright will expose options that let builds be scheduled using a custom scheduler. With increasing adoption of AI workloads on Kubernetes, custom schedulers optimized for batch workloads are becoming more commonplace (example: Volcano). The shp command line should provide a simple user experience that lets developers set these options on a `BuildRun`.

Out of scope

<Defines what is not included in this story>

• Hardening guideline.
• Node selector - this has been split to BUILD-1151

Approach (Required)

<Description of the general technical path on how to achieve the goal of the story. Include details like json schema, class definitions>

TBD

Dependencies

<Describes what this story depends on. Dependent Stories and EPICs should be linked to the story.>

• BUILD-986 - Build API needs to provide/expose these options.

Acceptance Criteria (Mandatory)

<Describe edge cases to consider when implementing the story and defining tests>

<Provides a required and minimum list of acceptance tests for this story. More is expected as the engineer implements this story>

• CLI provides option to use a custom scheduler. When added, the custom scheduler is ultimately used to schedule the build pod.
• CLI option is self documenting through `--help` option
• Release note describes the new CLI flag.
• Upstream documentation exists for the CLI option (maybe?)
• Downstream documentation updated describing the CLI's behavior (maybe?)

INVEST Checklist

Dependencies identified

Blockers noted and expected delivery timelines set

Design is implementable

Acceptance criteria agreed upon

Story estimated

Legend

Unknown

Verified

Unsatisfied

Done Checklist

• Code is completed, reviewed, documented and checked in
• Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
• Continuous Delivery pipeline(s) is able to proceed with new code included
• Customer facing documentation, API docs etc. are produced/updated, reviewed and published
• Acceptance criteria are met