Switch to minimal embedded-status

This commit changes the default of embedded-status to minimal status. Prior to this PR, the `DefaultEmbeddedStatus` is `full`, the pipelineRun reconciler will populate both `taskruns` and `runs` for `pipelineRunStatus`. With the change to `minimal`, the reconciler populates `childReferences` instead.
tektoncd · Jan 20, 2023 · ecbec59 · ecbec59
1 parent 9814fdd
commit ecbec59
Show file tree

Hide file tree

Showing 8 changed files with 169 additions and 118 deletions.
diff --git a/config/config-feature-flags.yaml b/config/config-feature-flags.yaml
@@ -89,7 +89,7 @@ data:
   # `PipelineRun` status. Set it to "minimal" to populate the `ChildReferences` field in the
   # `PipelineRun` status with name, kind, and API version information for each `TaskRun` and
   # `Run` in the `PipelineRun` instead. Set it to "both" to do both.
-  embedded-status: "full"
+  embedded-status: "minimal"
   # Setting this flag will determine the version for custom tasks created by PipelineRuns.
   # Acceptable values are "v1beta1" and "v1alpha1".
   # The default is "v1beta1".

diff --git a/docs/deprecations.md b/docs/deprecations.md
@@ -20,7 +20,7 @@ being deprecated.
 | Feature Being Deprecated                                                                                                                                                                                                     | Deprecation Announcement                                             | [API Compatibility Policy](https://github.com/tektoncd/pipeline/tree/main/api_compatibility_policy.md) | Earliest Date or Release of Removal |
 |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|-------------------------------------|
 | [`PipelineResources` are deprecated.](https://github.com/tektoncd/community/blob/main/teps/0074-deprecate-pipelineresources.md)                                                                                              | [v0.30.0](https://github.com/tektoncd/pipeline/releases/tag/v0.30.0) | Alpha                                                                                                  | Dec 20 2021                         |
-| [The `PipelineRun.Status.TaskRuns` and `PipelineRun.Status.Runs` fields are deprecated and will be removed.](https://github.com/tektoncd/community/blob/main/teps/0100-embedded-taskruns-and-runs-status-in-pipelineruns.md) | v0.35.0                                                              | Beta                                                                                                   | Jan 25, 2023                        |
+| [The `PipelineRun.Status.TaskRuns` and `PipelineRun.Status.Runs` fields; the `full` and `both` `embedded-status` values along with their functionalities are deprecated and will be removed in v0.45.](https://github.com/tektoncd/community/blob/main/teps/0100-embedded-taskruns-and-runs-status-in-pipelineruns.md) | v0.35.0    | Beta                                                                   | Jan 25, 2023                        |
 | [PipelineRun.Timeout is deprecated and will be removed](https://github.com/tektoncd/community/blob/main/teps/0046-finallytask-execution-post-timeout.md)                                                                     | v0.36.0                                                              | Beta                                                                                                   | Feb 25, 2023                        |
 | [Several fields of Task.Step are deprecated](https://github.com/tektoncd/pipeline/issues/4737)                                                                                                                               | v0.36.0                                                              | Beta                                                                                                   | Feb 25, 2023                        |
 | [`v1alpha1.Run` is deprecated](https://github.com/tektoncd/community/blob/main/teps/0114-custom-tasks-beta.md)                                                                                                               | v0.43.0                                                              | Alpha                                                                                                  | April 10, 2023 or v0.47.0           |

diff --git a/docs/pipelineruns.md b/docs/pipelineruns.md
@@ -1392,18 +1392,19 @@ Your `PipelineRun`'s `status` field can contain the following fields:
 
 ### Configuring usage of `TaskRun` and `Run` embedded statuses
 
-Currently, the default behavior is for the statuses of `TaskRun`s and `Run`s within this `PipelineRun`
-to be embedded in the `status.taskRuns` and `status.runs` fields. This will change in the future to
-instead default to `status.childReferences` being populated with references to the `TaskRun`s and
+Currently, the default behavior is to pupulate `status.childReferences` with references to the `TaskRun`s and
 `Run`s, which can be used to look up their statuses.
 
 This behavior can be controlled by changing the `embedded-status` feature flag in the `feature-flags`
 config map. See [`install.md`](./install.md#customizing-the-pipelines-controller-behavior) for more
 information on feature flags. The possible values for `embedded-status` are:
-- `full` - The current default behavior of populating `status.taskRuns` and `status.runs`, without populating `status.childReferences`.
-- `minimal` - Just populate `status.childReferences`, not `status.taskRuns` or `status.runs`.
+- `minimal` - The current default behavior, populate `status.childReferences`, not `status.taskRuns` or `status.runs`.
+- `full` - Populating `status.taskRuns` and `status.runs`, without populating `status.childReferences`.
 - `both` - Populate `status.childReferences` as well as `status.taskRuns` and `status.runs`.
 
+*Note that after the `PipelineRunStatus` migration as planned in [TEP-100](https://github.com/tektoncd/community/blob/main/teps/0100-embedded-taskruns-and-runs-status-in-pipelineruns.md#2-deprecate-and-remove-full-embedded-status),
+[the `full` and `both` `embedded-status` options will be removed](https://github.com/tektoncd/pipeline/blob/main/docs/deprecations.md).
+
 ### Monitoring execution status
 
 As your `PipelineRun` executes, its `status` field accumulates information on the execution of each `TaskRun`

diff --git a/pkg/apis/config/feature_flags.go b/pkg/apis/config/feature_flags.go
@@ -77,7 +77,7 @@ const (
 	// DefaultSendCloudEventsForRuns is the default value for "send-cloudevents-for-runs".
 	DefaultSendCloudEventsForRuns = false
 	// DefaultEmbeddedStatus is the default value for "embedded-status".
-	DefaultEmbeddedStatus = FullEmbeddedStatus
+	DefaultEmbeddedStatus = MinimalEmbeddedStatus
 	// DefaultEnableSpire is the default value for "enable-spire".
 	DefaultEnableSpire = false
 	// DefaultResourceVerificationMode is the default value for "resource-verification-mode".

diff --git a/pkg/apis/config/feature_flags_test.go b/pkg/apis/config/feature_flags_test.go
@@ -138,7 +138,7 @@ func TestNewFeatureFlagsFromConfigMap(t *testing.T) {
 		{
 			expectedConfig: &config.FeatureFlags{
 				EnableAPIFields:                  "stable",
-				EmbeddedStatus:                   "full",
+				EmbeddedStatus:                   config.DefaultEmbeddedStatus,
 				EnableSpire:                      true,
 				ResourceVerificationMode:         config.DefaultResourceVerificationMode,
 				RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
@@ -152,7 +152,7 @@ func TestNewFeatureFlagsFromConfigMap(t *testing.T) {
 		{
 			expectedConfig: &config.FeatureFlags{
 				EnableAPIFields:                  "stable",
-				EmbeddedStatus:                   "full",
+				EmbeddedStatus:                   config.DefaultEmbeddedStatus,
 				ResourceVerificationMode:         config.DefaultResourceVerificationMode,
 				RunningInEnvWithInjectedSidecars: config.DefaultRunningInEnvWithInjectedSidecars,
 				AwaitSidecarReadiness:            config.DefaultAwaitSidecarReadiness,

diff --git a/pkg/reconciler/pipelinerun/cancel_test.go b/pkg/reconciler/pipelinerun/cancel_test.go
@@ -46,17 +46,17 @@ func TestCancelPipelineRun(t *testing.T) {
 		customRuns     []*v1beta1.CustomRun
 		wantErr        bool
 	}{{
-		name:           "no-resolved-taskrun",
-		embeddedStatus: config.DefaultEmbeddedStatus,
+		name:           "no-resolved-taskrun-with-full",
+		embeddedStatus: config.FullEmbeddedStatus,
 		pipelineRun: &v1beta1.PipelineRun{
 			ObjectMeta: metav1.ObjectMeta{Name: "test-pipeline-run-cancelled"},
 			Spec: v1beta1.PipelineRunSpec{
 				Status: v1beta1.PipelineRunSpecStatusCancelled,
 			},
 		},
 	}, {
-		name:           "one-taskrun",
-		embeddedStatus: config.DefaultEmbeddedStatus,
+		name:           "one-taskrun-with-full",
+		embeddedStatus: config.FullEmbeddedStatus,
 		pipelineRun: &v1beta1.PipelineRun{
 			ObjectMeta: metav1.ObjectMeta{Name: "test-pipeline-run-cancelled"},
 			Spec: v1beta1.PipelineRunSpec{
@@ -72,8 +72,8 @@ func TestCancelPipelineRun(t *testing.T) {
 			{ObjectMeta: metav1.ObjectMeta{Name: "t1"}},
 		},
 	}, {
-		name:           "multiple-taskruns-one-missing",
-		embeddedStatus: config.DefaultEmbeddedStatus,
+		name:           "multiple-taskruns-one-missing-with-full",
+		embeddedStatus: config.FullEmbeddedStatus,
 		pipelineRun: &v1beta1.PipelineRun{
 			ObjectMeta: metav1.ObjectMeta{Name: "test-pipeline-run-cancelled"},
 			Spec: v1beta1.PipelineRunSpec{
@@ -90,8 +90,8 @@ func TestCancelPipelineRun(t *testing.T) {
 			{ObjectMeta: metav1.ObjectMeta{Name: "t2"}},
 		},
 	}, {
-		name:           "multiple-taskruns",
-		embeddedStatus: config.DefaultEmbeddedStatus,
+		name:           "multiple-taskruns-with-full",
+		embeddedStatus: config.FullEmbeddedStatus,
 		pipelineRun: &v1beta1.PipelineRun{
 			ObjectMeta: metav1.ObjectMeta{Name: "test-pipeline-run-cancelled"},
 			Spec: v1beta1.PipelineRunSpec{
@@ -109,8 +109,8 @@ func TestCancelPipelineRun(t *testing.T) {
 			{ObjectMeta: metav1.ObjectMeta{Name: "t2"}},
 		},
 	}, {
-		name:           "multiple-runs",
-		embeddedStatus: config.DefaultEmbeddedStatus,
+		name:           "multiple-runs-with-full",
+		embeddedStatus: config.FullEmbeddedStatus,
 		pipelineRun: &v1beta1.PipelineRun{
 			ObjectMeta: metav1.ObjectMeta{Name: "test-pipeline-run-cancelled"},
 			Spec: v1beta1.PipelineRunSpec{
@@ -128,8 +128,8 @@ func TestCancelPipelineRun(t *testing.T) {
 			{ObjectMeta: metav1.ObjectMeta{Name: "t2"}},
 		},
 	}, {
-		name:           "multiple-runs-one-missing",
-		embeddedStatus: config.DefaultEmbeddedStatus,
+		name:           "multiple-runs-one-missing-with-full",
+		embeddedStatus: config.FullEmbeddedStatus,
 		pipelineRun: &v1beta1.PipelineRun{
 			ObjectMeta: metav1.ObjectMeta{Name: "test-pipeline-run-cancelled"},
 			Spec: v1beta1.PipelineRunSpec{
@@ -227,7 +227,7 @@ func TestCancelPipelineRun(t *testing.T) {
 		},
 	}, {
 		name:           "child-references-with-minimal",
-		embeddedStatus: config.MinimalEmbeddedStatus,
+		embeddedStatus: config.DefaultEmbeddedStatus,
 		pipelineRun: &v1beta1.PipelineRun{
 			ObjectMeta: metav1.ObjectMeta{Name: "test-pipeline-run-cancelled"},
 			Spec: v1beta1.PipelineRunSpec{
@@ -268,7 +268,7 @@ func TestCancelPipelineRun(t *testing.T) {
 		},
 	}, {
 		name:           "child-references-with-minimal-some-missing",
-		embeddedStatus: config.MinimalEmbeddedStatus,
+		embeddedStatus: config.DefaultEmbeddedStatus,
 		pipelineRun: &v1beta1.PipelineRun{
 			ObjectMeta: metav1.ObjectMeta{Name: "test-pipeline-run-cancelled"},
 			Spec: v1beta1.PipelineRunSpec{
@@ -458,8 +458,8 @@ func TestGetChildObjectsFromPRStatusForTaskNames(t *testing.T) {
 		hasError               bool
 	}{
 		{
-			name:           "single taskrun, default embedded",
-			embeddedStatus: config.DefaultEmbeddedStatus,
+			name:           "single taskrun, full embedded",
+			embeddedStatus: config.FullEmbeddedStatus,
 			prStatus: v1beta1.PipelineRunStatus{PipelineRunStatusFields: v1beta1.PipelineRunStatusFields{
 				TaskRuns: map[string]*v1beta1.PipelineRunTaskRunStatus{
 					"t1": {PipelineTaskName: "task-1"},
@@ -470,8 +470,8 @@ func TestGetChildObjectsFromPRStatusForTaskNames(t *testing.T) {
 			expectedCustomRunNames: nil,
 			hasError:               false,
 		}, {
-			name:           "single run, default embedded",
-			embeddedStatus: config.DefaultEmbeddedStatus,
+			name:           "single run, full embedded",
+			embeddedStatus: config.FullEmbeddedStatus,
 			prStatus: v1beta1.PipelineRunStatus{PipelineRunStatusFields: v1beta1.PipelineRunStatusFields{
 				Runs: map[string]*v1beta1.PipelineRunRunStatus{
 					"r1": {PipelineTaskName: "run-1"},
@@ -481,8 +481,8 @@ func TestGetChildObjectsFromPRStatusForTaskNames(t *testing.T) {
 			expectedCustomRunNames: []string{"r1"},
 			hasError:               false,
 		}, {
-			name:           "taskrun and run, default embedded",
-			embeddedStatus: config.DefaultEmbeddedStatus,
+			name:           "taskrun and run, full embedded",
+			embeddedStatus: config.FullEmbeddedStatus,
 			prStatus: v1beta1.PipelineRunStatus{PipelineRunStatusFields: v1beta1.PipelineRunStatusFields{
 				TaskRuns: map[string]*v1beta1.PipelineRunTaskRunStatus{
 					"t1": {PipelineTaskName: "task-1"},
@@ -495,8 +495,8 @@ func TestGetChildObjectsFromPRStatusForTaskNames(t *testing.T) {
 			expectedCustomRunNames: []string{"r1"},
 			hasError:               false,
 		}, {
-			name:           "taskrun and run, default embedded, just want taskrun",
-			embeddedStatus: config.DefaultEmbeddedStatus,
+			name:           "taskrun and run, full embedded, just want taskrun",
+			embeddedStatus: config.FullEmbeddedStatus,
 			prStatus: v1beta1.PipelineRunStatus{PipelineRunStatusFields: v1beta1.PipelineRunStatusFields{
 				TaskRuns: map[string]*v1beta1.PipelineRunTaskRunStatus{
 					"t1": {PipelineTaskName: "task-1"},
@@ -548,7 +548,7 @@ func TestGetChildObjectsFromPRStatusForTaskNames(t *testing.T) {
 			expectedRunNames: []string{"r1"},
 			hasError:         false,
 		}, {
-			name:           "minimal embedded",
+			name:           "default minimal embedded",
 			embeddedStatus: config.MinimalEmbeddedStatus,
 			prStatus: v1beta1.PipelineRunStatus{PipelineRunStatusFields: v1beta1.PipelineRunStatusFields{
 				TaskRuns: map[string]*v1beta1.PipelineRunTaskRunStatus{