From d876ab6c5b3214c980e03346efb960075225cdcd Mon Sep 17 00:00:00 2001 From: Dylan Orzel Date: Wed, 8 Jan 2025 10:56:28 -0700 Subject: [PATCH] Docs for Custom Scheduler Name on Build and BuildRun objects Signed-off-by: Dylan Orzel --- docs/build.md | 3 +++ docs/buildrun.md | 1 + 2 files changed, 4 insertions(+) diff --git a/docs/build.md b/docs/build.md index 3bab038d7..a4df9a3ff 100644 --- 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 index 35866480a..47f4898c8 100644 --- 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`.