625 user control over pod labels #1069

Pinolo · 2022-05-24T10:37:05Z

Changes

Allows passing labels from ClusterBuildStrategy, BuildStrategy, Build, BuildRun, on to TaskRun and its pod
Overlapping labels in "lower" levels override "upper" levels
Some labels prefixes are reserved, i.e. not propagated

Fixes #625

Submitter Checklist

Includes tests if functionality changed/was added
Includes docs if changes are user-facing
Set a kind label on this PR
Release notes block has been filled in, or marked NONE

Release Notes

Developers and admins are now able to set labels in ClusterBuildStrategy, BuildStrategy, Build, BuildRun, that will be propagated to the pods running Tekton pipelines
Overlapping labels in "lower" levels override "upper" levels, i.e. if you set the same label key in both BuildStrategy resource and Build resource, the one in Build resource will be used
Reserved label key prefixes:
- k8s.io
- kubernetes.io
- tekton.dev
- shipwright.io

Developers and admins are now able to set labels in ClusterBuildStrategy, BuildStrategy, Build, BuildRun, that will be propagated to the pods running Tekton pipelines. Some reserved label key prefixes will not propagate:
- k8s.io
- kubernetes.io
- tekton.dev
- shipwright.io

openshift-ci · 2022-05-24T10:37:13Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign otaviof after the PR has been reviewed.
You can assign the PR to them by writing /assign @otaviof in a comment when ready.

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

Needs approval from an approver in each of these files:

OWNERS

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

Pinolo · 2022-05-25T10:45:37Z

/kind feature

pkg/reconciler/buildrun/resources/taskrun.go

SaschaSchwarze0

Thanks. We should wait for the discussions in the ship to be completed. Beside that, implementation looks mostly good. Also the right set of documentation is included. I think you should add an integration test as well.

SaschaSchwarze0 · 2022-06-19T20:24:35Z

docs/buildstrategies.md

+  - The Kubernetes [Network Traffic Shaping](https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/#support-traffic-shaping) feature looks for the `kubernetes.io/ingress-bandwidth` and `kubernetes.io/egress-bandwidth` annotations to limit the network bandwidth the `Pod` is allowed to use.
+  - The [AppArmor profile of a container](https://kubernetes.io/docs/tutorials/clusters/apparmor/) is defined using the `container.apparmor.security.beta.kubernetes.io/<container_name>` annotation.
+
+Since you can define labels for all of BuildStrategy/ClusterBuildStrategy, Build and BuildRun resources, if you define the same label key for different resources in the same build "pipeline", only the value in the last definition stage will be used (e.g. if you define `someproj.io/label: value01` in a Build and `someproj.io/label: value02` in a BuildRun that references such Build, `value02` will be used).


Please mention here that annotations cannot be overriden.

SaschaSchwarze0 · 2022-06-19T20:25:11Z

pkg/apis/build/v1alpha1/build_types.go

+func (b Build) GetLabels() map[string]string {
+	return b.Labels
+}


I don't think this is needed because Kubernetes already provides that function on ObjectMeta.

SaschaSchwarze0 · 2022-06-19T20:25:51Z

pkg/apis/build/v1alpha1/buildrun_types.go

+// GetLabels returns the labels of the BuildRun
+func (br *BuildRun) GetLabels() map[string]string {
+	return br.Labels
+}


I don't think this is needed because Kubernetes already provides that function on ObjectMeta.

SaschaSchwarze0 · 2022-06-19T20:26:17Z

pkg/apis/build/v1alpha1/buildstrategy_types.go

+// GetLabels returns the labels the build strategy
+func (s BuildStrategy) GetLabels() map[string]string {
+	return s.Labels
+}


I don't think this is needed because Kubernetes already provides that function on ObjectMeta.

SaschaSchwarze0 · 2022-06-19T20:26:24Z

pkg/apis/build/v1alpha1/clusterbuildstrategy_types.go

+// GetLabels returns the labels of the build strategy
+func (s ClusterBuildStrategy) GetLabels() map[string]string {
+	return s.Labels
+}


I don't think this is needed because Kubernetes already provides that function on ObjectMeta.

SaschaSchwarze0 · 2022-06-19T20:27:18Z

pkg/reconciler/buildrun/resources/taskrun.go

@@ -322,6 +322,32 @@ func GenerateTaskRun(
 		expectedTaskRun.Labels[label] = value
 	}

+	reserved, err := regexp.Compile(reservedLabels)


The regular expression should be compiled only once.

Marcello Testi and others added 4 commits May 23, 2022 15:41

Stubbing the implementation, only for Build labels

2c4a54d

Extend implementation passing labels from buildrun and strategy

7bf1778

Added unit test for label set and override

2f5d613

Filter reserved labels and add unit tests

7104eb4

openshift-ci bot added the do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. label May 24, 2022

openshift-ci bot requested review from adambkaplan and shahulsonhal May 24, 2022 10:37

openshift-ci bot added release-note Label for when a PR has specified a release note and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels May 25, 2022

Adding documentation for labels propagation

46dd7c8

openshift-ci bot added the kind/feature Categorizes issue or PR as related to a new feature. label May 25, 2022

paolomainardi reviewed May 26, 2022

View reviewed changes

pkg/reconciler/buildrun/resources/taskrun.go Outdated Show resolved Hide resolved

Fixing typo in comment

89ed08d

SaschaSchwarze0 added this to the release-v0.11.0 milestone Jun 1, 2022

SaschaSchwarze0 requested changes Jun 19, 2022

View reviewed changes

SaschaSchwarze0 modified the milestones: release-v0.11.0, release-v0.12.0 Sep 8, 2022

binnn6 mentioned this pull request Nov 11, 2022

Add support to add labels and annotations to build pod #1150

Closed

4 tasks

SaschaSchwarze0 modified the milestones: release-v0.12.0, release-v0.13.0 Nov 11, 2023

SaschaSchwarze0 removed this from the release-v0.13.0 milestone Dec 27, 2023

qu1queee added the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Jun 20, 2024

qu1queee closed this Jun 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

625 user control over pod labels #1069

625 user control over pod labels #1069

Pinolo commented May 24, 2022 •

edited

Loading

openshift-ci bot commented May 24, 2022

Pinolo commented May 25, 2022

SaschaSchwarze0 left a comment

SaschaSchwarze0 Jun 19, 2022

SaschaSchwarze0 Jun 19, 2022

SaschaSchwarze0 Jun 19, 2022

SaschaSchwarze0 Jun 19, 2022

SaschaSchwarze0 Jun 19, 2022

SaschaSchwarze0 Jun 19, 2022

625 user control over pod labels #1069

625 user control over pod labels #1069

Conversation

Pinolo commented May 24, 2022 • edited Loading

Changes

Submitter Checklist

Release Notes

openshift-ci bot commented May 24, 2022

Pinolo commented May 25, 2022

SaschaSchwarze0 left a comment

Choose a reason for hiding this comment

SaschaSchwarze0 Jun 19, 2022

Choose a reason for hiding this comment

SaschaSchwarze0 Jun 19, 2022

Choose a reason for hiding this comment

SaschaSchwarze0 Jun 19, 2022

Choose a reason for hiding this comment

SaschaSchwarze0 Jun 19, 2022

Choose a reason for hiding this comment

SaschaSchwarze0 Jun 19, 2022

Choose a reason for hiding this comment

SaschaSchwarze0 Jun 19, 2022

Choose a reason for hiding this comment

Pinolo commented May 24, 2022 •

edited

Loading