Feature flag for provenance field in status #5670

chuangw6 · 2022-10-20T15:01:41Z

Changes

/kind feature

Introduced a dedicated feature flag of boolean type named "enable-provenance-in-status"
in feature-flags configmap to enable the provenance field in status. The provenance field
was introducted to *run status in #5580 to record authenticated metadata about how a
software artifact was built i.e. the source where remote resource came from.

By default, this feature flag is false.

Signed-off-by: Chuang Wang chuangw@google.com

Related PRs:

Submitter Checklist

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

Has Docs included if any changes are user facing
Has Tests included if any functionality added or changed
Follows the commit message standard
Meets the Tekton contributor standards (including
functionality, content, code)
Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Added a new boolean feature flag named "enable-provenance-in-status" in feature-flags configmap to enable the provenance field in status to be populated. This field in status aims to record authenticated metadata about how a software artifact was built i.e. the source where remote resource came from.

JeromeJu · 2022-10-20T15:06:01Z

Thanks Chuang!
Wondering if this would be better to be part of #5580?

tekton-robot · 2022-10-20T15:07:13Z

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/config/feature_flags.go	78.9%	78.0%	-1.0

chuangw6 · 2022-10-20T15:20:49Z

Thanks Chuang! Wondering if this would be better to be part of #5580?

Good point. I didn't include in that PR for 2 reasons: 1/ tried to make that PR as smaller as possible 2/ wanted to add the feature flag when the code is actually trying to populate the field with data. But it turns out #5397 doing that is also quite large already, so I just created this PR to add feature flag only to make review a bit easier for reviewers :D

JeromeJu · 2022-10-20T15:23:09Z

Sounds good. Also, LGTM.

Thanks Chuang! Wondering if this would be better to be part of #5580?

Good point. I didn't include in that PR for 2 reasons: 1/ tried to make that PR as smaller as possible 2/ wanted to add the feature flag when the code is actually trying to populate the field with data. But it turns out the PR doing that is quite large already as well, so I just created this PR to add feature flag only to make review a bit easier for reviewers :D

tekton-robot · 2022-10-20T15:30:28Z

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/config/feature_flags.go	78.9%	78.0%	-1.0

chuangw6 · 2022-10-20T20:45:53Z

Hey @jerop @afrittoli @dibyom,

I've added this dedicated feature flag to control the provenance field in status that was recently introduced in #5580. PTAL. Thank you!!!

tekton-robot · 2022-10-20T20:46:16Z

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/config/feature_flags.go	78.3%	77.4%	-0.9

jerop · 2022-10-20T20:52:40Z

docs/install.md

+- `enable-provenance-in-status`: set this flag to "true" to enable recording 
+  the `provenance` field in `TaskRun` and `PipelineRun` status. The `provenance` field contains 
+  the key authenticated metadata about how a software artifact was built i.e. the source
+  where remote resource came from.
+


we should also list this feature among the alpha features with its individual feature flag - https://github.com/tektoncd/pipeline/blob/main/docs/install.md#alpha-features

Thanks @jerop ! Good idea. I've added this to the table. PTAL!

I've also updated the paragraph above the alpha features table. PTAL. Thank you very much!

cc @dibyom

jerop · 2022-10-20T20:54:23Z

we shouldn't release v0.41 with #5580 without the feature flag which is added in this PR, so adding this PR to the mileston -- cc @tektoncd/core-maintainers

dibyom · 2022-10-20T21:31:17Z

#5580 just adds the field - I don't think its actually being used yet

jerop · 2022-10-20T21:34:58Z

#5580 just adds the field - I don't think its actually being used yet

ah that's good to know, the conversation above btwn @chuangw6 and @JeromeJu made me think it was, in that case we don't need to have it in the milestone

tekton-robot · 2022-11-02T22:31:40Z

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/config/feature_flags.go	81.2%	80.3%	-0.9

tekton-robot · 2022-11-02T22:40:50Z

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/config/feature_flags.go	81.2%	80.3%	-0.9

tekton-robot · 2022-11-03T15:59:23Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom, vdemeester

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~~ [dibyom,vdemeester]

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

tekton-robot · 2022-11-03T21:26:35Z

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/config/feature_flags.go	81.2%	80.3%	-0.9

Introduced a dedicated feature flag of boolean type named "enable-provenance-in-status" in feature-flags configmap to enable the provenance field in status. The `provenance` field was introducted to *run status in tektoncd#5580 status to record authenticated metadata about how a software artifact was built i.e. the source where remote resource came from. By default, this feature flag is false. Signed-off-by: Chuang Wang <chuangw@google.com>

tekton-robot · 2022-11-03T21:53:31Z

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/config/feature_flags.go	81.2%	80.3%	-0.9

Prior, remote `ResolutionRequest` CRD supports **recording** the source information in its Status that identifies where the remote resource came from. Similarly, `TaskRun/PipelineRun` CRD supports **receiving** the source information via a field in its status from remote ResolutionRequest. Specifically, this field named `ConfigSource` is a subfield of the `Provenance` field in status. In this PR, we are trying to pass the data from `ResolutionRequest` to pipeline reconciler so that the data can be captured in TaskRun/PipelineRun's `Status.Provenance.ConfigSource`. The implication of this change is that many functions' interface has been changed because we are passing this extra source data alongside the remote resoure. Note: - The `provenance` field in Run.status is behind a feature flag named `enable-provenance-in-status` , which was introduced in tektoncd#5670. The field will be populated iff the flag is set to `true`. - If a pipeline yaml is from remote place A, and the individual tasks are from other remote places, pipelinerun status will only record the source for the pipeline, and the individual taskrun status will record the source for the corresponding task. Related PRs/Issues: - tektoncd#5580 - tektoncd#5551 - tektoncd#5670 - tektoncd#5522 Signed-off-by: Chuang Wang <chuangw@google.com>

dibyom · 2022-11-07T16:28:33Z

/lgtm

Prior, remote `ResolutionRequest` CRD supports **recording** the source information in its Status that identifies where the remote resource came from. Similarly, `TaskRun/PipelineRun` CRD supports **receiving** the source information via a field in its status from remote ResolutionRequest. Specifically, this field named `ConfigSource` is a subfield of the `Provenance` field in status. In this PR, we are trying to pass the data from `ResolutionRequest` to pipeline reconciler so that the data can be captured in TaskRun/PipelineRun's `Status.Provenance.ConfigSource`. The implication of this change is that many functions' interface has been changed because we are passing this extra source data alongside the remote resoure. Note: - The `provenance` field in Run.status is behind a feature flag named `enable-provenance-in-status` , which was introduced in tektoncd#5670. The field will be populated iff the flag is set to `true`. - If a pipeline yaml is from remote place A, and the individual tasks are from other remote places, pipelinerun status will only record the source for the pipeline, and the individual taskrun status will record the source for the corresponding task. Related PRs/Issues: - tektoncd#5580 - tektoncd#5551 - tektoncd#5670 - tektoncd#5522 Signed-off-by: Chuang Wang <chuangw@google.com>

Prior, remote `ResolutionRequest` CRD supports **recording** the source information in its Status that identifies where the remote resource came from. Similarly, `TaskRun/PipelineRun` CRD supports **receiving** the source information via a field in its status from remote ResolutionRequest. Specifically, this field named `ConfigSource` is a subfield of the `Provenance` field in status. In this PR, we are trying to pass the data from `ResolutionRequest` to pipeline reconciler so that the data can be captured in TaskRun/PipelineRun's `Status.Provenance.ConfigSource`. The implication of this change is that many functions' interface has been changed because we are passing this extra source data alongside the remote resoure. Note: - The `provenance` field in Run.status is behind a feature flag named `enable-provenance-in-status` , which was introduced in #5670. The field will be populated iff the flag is set to `true`. - If a pipeline yaml is from remote place A, and the individual tasks are from other remote places, pipelinerun status will only record the source for the pipeline, and the individual taskrun status will record the source for the corresponding task. Related PRs/Issues: - #5580 - #5551 - #5670 - #5522 Signed-off-by: Chuang Wang <chuangw@google.com>

tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/feature Categorizes issue or PR as related to a new feature. labels Oct 20, 2022

tekton-robot requested review from imjasonh and pritidesai October 20, 2022 15:01

tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 20, 2022

chuangw6 force-pushed the add-feature-flag branch from adaded7 to ed0f2eb Compare October 20, 2022 15:25

tekton-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 20, 2022

chuangw6 force-pushed the add-feature-flag branch from ed0f2eb to 36fdba6 Compare October 20, 2022 20:37

tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 20, 2022

chuangw6 force-pushed the add-feature-flag branch from 36fdba6 to ed0f2eb Compare October 20, 2022 20:39

tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 20, 2022

chuangw6 force-pushed the add-feature-flag branch from ed0f2eb to 267f1a4 Compare October 20, 2022 20:41

tekton-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 20, 2022

chuangw6 mentioned this pull request Oct 20, 2022

Per Feature Feature Flags #5632

Closed

jerop reviewed Oct 20, 2022

View reviewed changes

jerop added this to the Pipelines v0.41 milestone Oct 20, 2022

jerop removed this from the Pipelines v0.41 milestone Oct 20, 2022

chuangw6 mentioned this pull request Oct 20, 2022

Add Provenance field in TaskRun&PipelineRun status #5580

Merged

7 tasks

chuangw6 force-pushed the add-feature-flag branch from eb31779 to feca8f2 Compare November 2, 2022 22:35

vdemeester approved these changes Nov 3, 2022

View reviewed changes

chuangw6 requested review from dibyom and jerop and removed request for jerop and dibyom November 3, 2022 19:59

chuangw6 force-pushed the add-feature-flag branch from feca8f2 to b39efbc Compare November 3, 2022 21:20

chuangw6 force-pushed the add-feature-flag branch from b39efbc to 7b870d1 Compare November 3, 2022 21:47

chuangw6 requested review from dibyom and removed request for jerop November 7, 2022 15:42

tekton-robot assigned dibyom Nov 7, 2022

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

tekton-robot merged commit c2d0283 into tektoncd:main Nov 7, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature flag for provenance field in status #5670

Feature flag for provenance field in status #5670

chuangw6 commented Oct 20, 2022 •

edited by dibyom

Loading

JeromeJu commented Oct 20, 2022 •

edited

Loading

tekton-robot commented Oct 20, 2022

chuangw6 commented Oct 20, 2022 •

edited

Loading

JeromeJu commented Oct 20, 2022

tekton-robot commented Oct 20, 2022

chuangw6 commented Oct 20, 2022 •

edited

Loading

tekton-robot commented Oct 20, 2022

jerop Oct 20, 2022

chuangw6 Oct 21, 2022

chuangw6 Oct 21, 2022

jerop commented Oct 20, 2022

dibyom commented Oct 20, 2022

jerop commented Oct 20, 2022

tekton-robot commented Nov 2, 2022

tekton-robot commented Nov 2, 2022

tekton-robot commented Nov 3, 2022

tekton-robot commented Nov 3, 2022

tekton-robot commented Nov 3, 2022

dibyom commented Nov 7, 2022

Feature flag for provenance field in status #5670

Feature flag for provenance field in status #5670

Conversation

chuangw6 commented Oct 20, 2022 • edited by dibyom Loading

Changes

Submitter Checklist

Release Notes

JeromeJu commented Oct 20, 2022 • edited Loading

tekton-robot commented Oct 20, 2022

chuangw6 commented Oct 20, 2022 • edited Loading

JeromeJu commented Oct 20, 2022

tekton-robot commented Oct 20, 2022

chuangw6 commented Oct 20, 2022 • edited Loading

tekton-robot commented Oct 20, 2022

jerop Oct 20, 2022

Choose a reason for hiding this comment

chuangw6 Oct 21, 2022

Choose a reason for hiding this comment

chuangw6 Oct 21, 2022

Choose a reason for hiding this comment

jerop commented Oct 20, 2022

dibyom commented Oct 20, 2022

jerop commented Oct 20, 2022

tekton-robot commented Nov 2, 2022

tekton-robot commented Nov 2, 2022

tekton-robot commented Nov 3, 2022

tekton-robot commented Nov 3, 2022

tekton-robot commented Nov 3, 2022

dibyom commented Nov 7, 2022

chuangw6 commented Oct 20, 2022 •

edited by dibyom

Loading

JeromeJu commented Oct 20, 2022 •

edited

Loading

chuangw6 commented Oct 20, 2022 •

edited

Loading

chuangw6 commented Oct 20, 2022 •

edited

Loading