Document Tekton Pipeline support with pod integration #3898
Conversation
k8s-ci-robot
added
release-note-none
k8s-ci-robot
added
cncf-cla: yes
✅ Deploy Preview for kubernetes-sigs-kueue ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
kannon92
changed the title
| The pod integration for TektonCD Pipelines could look like: | ||
|
|
||
| ```yaml | ||
| apiVersion: config.kueue.x-k8s.io/v1beta1 | ||
| kind: Configuration | ||
| integrations: | ||
| frameworks: | ||
| - "pod" | ||
| podOptions: | ||
| # You can change namespaceSelector to define in which | ||
| # namespaces kueue will manage the tektoncd pods. | ||
| namespaceSelector: | ||
| matchExpressions: | ||
| - key: kubernetes.io/metadata.name | ||
| operator: NotIn | ||
| values: [ kube-system, kueue-system ] | ||
| # Tekton pipelines uses the app.kubernetes.io/managed-by label to | ||
| # keep track of pods it manages. We will use that as a hint for Kueue | ||
| # to find Tekton pods. | ||
| podSelector: | ||
| matchExpressions: | ||
| - key: app.kubernetes.io/managed-by | ||
| operator: In | ||
| values: [ "tekton-pipelines" ] | ||
| ``` | ||
| 2. Pods that belong to other API resources managed by Kueue are excluded from being queued by `pod` integration. | ||
| For example, pods managed by `batch/v1.Job` won't be managed by `pod` integration. | ||
|
|
||
| 3. Check [Administer cluster quotas](/docs/tasks/administer_cluster_quotas) for details on the initial Kueue setup. |
There was a problem hiding this comment.
Once we describe the basic Kueue setting the above, we can get rid of these configurations.
| # to find Tekton pods. | ||
| podSelector: | ||
| matchExpressions: | ||
| - key: app.kubernetes.io/managed-by | ||
| operator: In | ||
| values: [ "tekton-pipelines" ] |
There was a problem hiding this comment.
I do not think that we should configure this Pod selector since this selector prevents the management of Pod except for the Tekton Pipeline Pods.
| As a simple example, we will define two tasks named sleep and hello: | ||
|
|
||
| Tasks: | ||
|
|
There was a problem hiding this comment.
Could you move Tekton specific manifests to https://github.com/kubernetes-sigs/kueue/tree/main/site/static/examples?
|
|
||
| This will inject the kueue label on every pod of the pipeline. Kueue will gate the pods once you are over the quota limits. | ||
|
|
||
| ## c. How it works |
There was a problem hiding this comment.
I think that we should remove this section since this page does not indicate the concept and mechanism. We just describe the user's documentation step by step.
I am not a tekton user but at a glance of their docs I think tekton translates to a single pod for a task. I don't see the option to support multiple pods as part a single task. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: kannon92 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Example integration with TektonCD
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?