Skip to content

Commit 717db46

Browse files
committed
Docs for Custom Scheduler Name on Build and BuildRun objects
Signed-off-by: Dylan Orzel <[email protected]>
1 parent 0801005 commit 717db46

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

Diff for: docs/build.md

+3
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ A `Build` resource allows the user to define:
4141
- volumes
4242
- nodeSelector
4343
- tolerations
44+
- schedulerName
4445

4546
A `Build` is available within a namespace.
4647

@@ -97,6 +98,7 @@ To prevent users from triggering `BuildRun`s (_execution of a Build_) that will
9798
| OutputTimestampNotValid | The output timestamp value is not valid. |
9899
| NodeSelectorNotValid | The specified nodeSelector is not valid. |
99100
| TolerationNotValid | The specified tolerations are not valid. |
101+
| SchedulerNameNotValid | The specified schedulerName is not valid. |
100102

101103
## Configuring a Build
102104

@@ -130,6 +132,7 @@ The `Build` definition supports the following fields:
130132
- `spec.retention.succeededLimit` - Specifies the number of successful buildrun can exist.
131133
- `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.
132134
- `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.
135+
- `spec.schedulerName` - Specifies the scheduler name for the build pod. If schedulerName is specified in both a `Build` and `BuildRun`, `BuildRun` values take precedence.
133136

134137
### Defining the Source
135138

Diff for: docs/buildrun.md

+1
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ The `BuildRun` definition supports the following fields:
7777
- `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.
7878
- `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.
7979
- `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.
80+
- `spec.schedulerName` - Specifies the scheduler name for the build pod. If schedulerName is specified in both a `Build` and `BuildRun`, `BuildRun` values take precedence.
8081

8182
**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`.
8283

0 commit comments

Comments
 (0)