Merge *Run's PodTemplate with Default 🧙 #4057

vdemeester · 2021-06-23T16:56:09Z

Changes

Right, now when you specify a default pod template and also specify
pod template at pipelinerun/taskrun level. The default pod template is
getting overridden by the one at the pipelinerun/taskrun level.

This changes this behavior by only overriding the PodTemplate field
that are defined by the TaskRun and not the whole
PodTemplate. This means it is possible to define a NodeSelector
widely (through the default) without it being overriden when the user
sets a SecurityContext on his TaskRun.

This is also done on the PipelineRun PodTemplate.

Closes #3569

/cc @sbwsg @afrittoli @pritidesai @skaegi @bobcatfish

This probably need a bit more unit tests, but I think it's worth opening to discuss if the approach is correct (for each fields)

Signed-off-by: Vincent Demeester vdemeest@redhat.com

/kind feature

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

Docs included if any changes are user facing
Tests included if any functionality added or changed
Follows the commit message standard
Meets the Tekton contributor standards (including
functionality, content, code)
Release notes block below has been filled in or deleted (only if no user facing changes)

Release Notes

TaskRun and PipelineRun's PodTemplate are now merge with the default PodTemplate. This means any field that is not specified in a TaskRun or PipelineRun's PodTemplate will come from the configured default PodTemplate (if defined).

vdemeester · 2021-06-23T16:57:47Z

This also probably needs some docs 🙃
/hold

vdemeester · 2021-06-24T07:16:09Z

/retest

tekton-robot · 2021-06-24T07:35:23Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1beta1/pipelinerun_defaults.go	92.9%	92.3%	-0.5
pkg/apis/pipeline/v1beta1/taskrun_defaults.go	100.0%	98.0%	-2.0

vdemeester · 2021-06-24T08:10:16Z

/retest

vdemeester · 2021-06-24T08:10:46Z

/cc @piyush-garg

ghost · 2021-06-29T17:14:43Z

This looks good from my perspective. 👍 /approve

chmouel

/lgtm

bobcatfish · 2021-06-30T17:51:35Z

@vdemeester you mentioned adding some docs, is this something we can do before we merge? (maybe at https://github.com/tektoncd/pipeline/blob/main/docs/podtemplates.md)

Also looks like the coverage went down slightly - in both cases it looks like it's just one line per file not getting touched, maybe it's easy to add those to the test cases?

🙏

Right, now when you specify a default pod template and also specify pod template at pipelinerun/taskrun level. The default pod template is getting overridden by the one at the pipelinerun/taskrun level. This changes this behavior by only overriding the `PodTemplate` field that are defined by the `TaskRun` and not the whole `PodTemplate`. This means it is possible to define a `NodeSelector` widely (through the default) without it being overriden when the user sets a `SecurityContext` on his `TaskRun`. This is also done on the `PipelineRun` PodTemplate. Signed-off-by: Vincent Demeester <vdemeest@redhat.com>

vdemeester · 2021-07-05T14:47:07Z

/hold cancel

tekton-robot · 2021-07-05T14:49:25Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/apis/pipeline/v1beta1/pipelinerun_defaults.go	92.9%	92.3%	-0.5

ghost · 2021-07-07T18:10:01Z

Re-adding my approve.

/approve

tekton-robot · 2021-07-07T18:10:08Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbwsg

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [sbwsg]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

pritidesai · 2021-07-07T23:31:04Z

pkg/apis/pipeline/v1beta1/taskrun_defaults.go

+	switch {
+	case defaultTpl == nil:
+		// No configured default, just return the template
+		return tpl


Could tpl be nil here? or not possible to have both defaultTpl and tpl to be nil at this point?

or don't bother to merge, just return tpl here irrespective of it being nil

Yeah if there is no default, we just return the taskrun template, be it nil or not 😛

pritidesai · 2021-07-07T23:55:30Z

pkg/apis/pipeline/v1beta1/taskrun_defaults.go

+	default:
+		// Otherwise, merge fields
+		if tpl.NodeSelector == nil {
+			tpl.NodeSelector = defaultTpl.NodeSelector


do we need a check here if defaultTpl.NodeSelector is not nil and likewise for the rest of the fields?

or again just return default irrespective of it being nil

pritidesai · 2021-07-07T23:59:28Z

/lgtm

thanks @vdemeester

pritidesai · 2021-07-08T06:52:56Z

tests seems flaky

/test tekton-pipeline-unit-tests
/test tekton-pipeline-build-tests
/test tekton-pipeline-alpha-integration-tests

vdemeester · 2021-07-08T07:07:07Z

/retest

vdemeester · 2021-07-08T07:44:35Z

/retest

vdemeester · 2021-07-08T08:33:28Z

/retest

Letty5411 · 2022-02-24T08:39:46Z

pkg/apis/pipeline/v1beta1/taskrun_defaults.go

+		}
+		if tpl.HostNetwork == false && defaultTpl.HostNetwork == true {
+			tpl.HostNetwork = true
+		}


Maybe sometimes the taskrun don't want to use hostnetwork, and set it 'false' in task template explicitly. If the value of global template is 'true', it will be set to 'true'.

tekton-robot requested review from afrittoli, bobcatfish, pritidesai, a user and skaegi June 23, 2021 16:56

tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 23, 2021

tekton-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 23, 2021

vdemeester force-pushed the 3569-merge-taskrun-podtemplate branch from a3567a8 to b6352d2 Compare June 24, 2021 07:33

tekton-robot requested a review from piyush-garg June 24, 2021 08:10

ghost added this to the Pipelines v0.26 milestone Jun 29, 2021

chmouel reviewed Jun 30, 2021

View reviewed changes

tekton-robot assigned chmouel Jun 30, 2021

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 30, 2021

vdemeester force-pushed the 3569-merge-taskrun-podtemplate branch from b6352d2 to 131bab1 Compare July 5, 2021 14:47

tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 5, 2021

tekton-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 5, 2021

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 7, 2021

pritidesai reviewed Jul 7, 2021

View reviewed changes

tekton-robot assigned pritidesai Jul 7, 2021

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 7, 2021

tekton-robot merged commit ea36b8c into tektoncd:main Jul 8, 2021

vdemeester deleted the 3569-merge-taskrun-podtemplate branch July 8, 2021 09:05

Letty5411 reviewed Feb 24, 2022

View reviewed changes

vdemeester mentioned this pull request Jun 20, 2023

Is the podTemplate expected to be merged? #6846

Closed

l-qing mentioned this pull request Jan 9, 2024

The Default and Run's PodTemplate (env and volumes) have not merged well #7551

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge *Run's PodTemplate with Default 🧙 #4057

Merge *Run's PodTemplate with Default 🧙 #4057

vdemeester commented Jun 23, 2021 •

edited

vdemeester commented Jun 23, 2021

vdemeester commented Jun 24, 2021

tekton-robot commented Jun 24, 2021

vdemeester commented Jun 24, 2021

vdemeester commented Jun 24, 2021

ghost commented Jun 29, 2021

chmouel left a comment

bobcatfish commented Jun 30, 2021

vdemeester commented Jul 5, 2021

tekton-robot commented Jul 5, 2021

ghost commented Jul 7, 2021

tekton-robot commented Jul 7, 2021

pritidesai Jul 7, 2021

pritidesai Jul 7, 2021

vdemeester Jul 8, 2021

pritidesai Jul 7, 2021

pritidesai Jul 7, 2021

pritidesai commented Jul 7, 2021

pritidesai commented Jul 8, 2021

vdemeester commented Jul 8, 2021

vdemeester commented Jul 8, 2021

vdemeester commented Jul 8, 2021

Letty5411 Feb 24, 2022 •

edited

Merge *Run's PodTemplate with Default 🧙 #4057

Merge *Run's PodTemplate with Default 🧙 #4057

Conversation

vdemeester commented Jun 23, 2021 • edited

Changes

Submitter Checklist

Release Notes

vdemeester commented Jun 23, 2021

vdemeester commented Jun 24, 2021

tekton-robot commented Jun 24, 2021

vdemeester commented Jun 24, 2021

vdemeester commented Jun 24, 2021

ghost commented Jun 29, 2021

chmouel left a comment

Choose a reason for hiding this comment

bobcatfish commented Jun 30, 2021

vdemeester commented Jul 5, 2021

tekton-robot commented Jul 5, 2021

ghost commented Jul 7, 2021

tekton-robot commented Jul 7, 2021

pritidesai Jul 7, 2021

Choose a reason for hiding this comment

pritidesai Jul 7, 2021

Choose a reason for hiding this comment

vdemeester Jul 8, 2021

Choose a reason for hiding this comment

pritidesai Jul 7, 2021

Choose a reason for hiding this comment

pritidesai Jul 7, 2021

Choose a reason for hiding this comment

pritidesai commented Jul 7, 2021

pritidesai commented Jul 8, 2021

vdemeester commented Jul 8, 2021

vdemeester commented Jul 8, 2021

vdemeester commented Jul 8, 2021

Letty5411 Feb 24, 2022 • edited

Choose a reason for hiding this comment

vdemeester commented Jun 23, 2021 •

edited

Letty5411 Feb 24, 2022 •

edited