Skip to content

Commit

Permalink
Update Docs for SchedulerName in PodTemplate
Browse files Browse the repository at this point in the history
  • Loading branch information
waveywaves committed Feb 13, 2020
1 parent 95d9cb4 commit c7f12a6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/podtemplates.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ The current fields supported are:
[priority class](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/)
to use when running the pod. Use this, for example, to selectively enable
preemption on lower priority workloads.
- `schedulerName` the name of the [scheduler](https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/)
to use when dispatching the Pod. This can be used when workloads of specific types need specific schedulers,
eg: If you are using volcano.sh for Machine Learning Workloads, you can pass the schedulerName and have Tasks be
dispatched by the volcano.sh scheduler.


A pod template can be specified for `TaskRun` or `PipelineRun` resources.
Expand Down
4 changes: 3 additions & 1 deletion docs/taskruns.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,8 @@ allows to customize some Pod specific field per `Task` execution, aka `TaskRun`.

In the following example, the Task is defined with a `volumeMount`
(`my-cache`), that is provided by the TaskRun, using a
PersistenceVolumeClaim. The Pod will also run as a non-root user.
PersistenceVolumeClaim. The SchedulerName has also been provided to define which scheduler should be used to
dispatch the Pod. The Pod will also run as a non-root user.

```yaml
apiVersion: tekton.dev/v1alpha1
Expand All @@ -219,6 +220,7 @@ spec:
taskRef:
name: mytask
podTemplate:
schedulerName: volcano
securityContext:
runAsNonRoot: true
volumes:
Expand Down

0 comments on commit c7f12a6

Please sign in to comment.