Docs for Custom Scheduler Name on Build and BuildRun objects

Signed-off-by: Dylan Orzel <[email protected]>
shipwright-io · Jan 8, 2025 · d876ab6 · d876ab6
1 parent dfdfcce
commit d876ab6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/build.md b/docs/build.md
@@ -41,6 +41,7 @@ A `Build` resource allows the user to define:
 - volumes
 - nodeSelector
 - tolerations
+- schedulerName
 
 A `Build` is available within a namespace.
 
@@ -97,6 +98,7 @@ To prevent users from triggering `BuildRun`s (_execution of a Build_) that will
 | OutputTimestampNotValid                         | The output timestamp value is not valid.                                                                                                                                                                     |
 | NodeSelectorNotValid                            | The specified nodeSelector is not valid. |
 | TolerationNotValid                              | The specified tolerations are not valid. |
+| SchedulerNameNotValid                              | The specified schedulerName is not valid. |
 
 ## Configuring a Build
 
@@ -130,6 +132,7 @@ The `Build` definition supports the following fields:
   - `spec.retention.succeededLimit` - Specifies the number of successful buildrun can exist.
   - `spec.nodeSelector` - Specifies a selector which must match a node's labels for the build pod to be scheduled on that node. If nodeSelectors are specified in both a `Build` and `BuildRun`, `BuildRun` values take precedence.
   - `spec.tolerations` - Specifies the tolerations for the build pod. Only `key`, `value`, and `operator` are supported. Only `NoSchedule` taint `effect` is supported. If tolerations are specified in both a `Build` and `BuildRun`, `BuildRun` values take precedence.
+  - `spec.schedulerName` - Specifies the scheduler name for the build pod. If schedulerName is specified in both a `Build` and `BuildRun`, `BuildRun` values take precedence.
 
 ### Defining the Source
 

diff --git a/docs/buildrun.md b/docs/buildrun.md
@@ -77,6 +77,7 @@ The `BuildRun` definition supports the following fields:
   - `spec.env` - Specifies additional environment variables that should be passed to the build container. Overrides any environment variables that are specified in the `Build` resource. The available variables depend on the tool used by the chosen build strategy.
   - `spec.nodeSelector` - Specifies a selector which must match a node's labels for the build pod to be scheduled on that node. If nodeSelectors are specified in both a `Build` and `BuildRun`, `BuildRun` values take precedence.
   - `spec.tolerations` - Specifies the tolerations for the build pod. Only `key`, `value`, and `operator` are supported. Only `NoSchedule` taint `effect` is supported. If tolerations are specified in both a `Build` and `BuildRun`, `BuildRun` values take precedence.
+  - `spec.schedulerName` - Specifies the scheduler name for the build pod. If schedulerName is specified in both a `Build` and `BuildRun`, `BuildRun` values take precedence.
 
 **Note**: The `spec.build.name` and `spec.build.spec` are mutually exclusive. Furthermore, the overrides for `timeout`, `paramValues`, `output`, and `env` can only be combined with `spec.build.name`, but **not** with `spec.build.spec`.