TEP-0127: Larger results using sidecar logs: Validation, documentation and examples

[chitrangpatel]

Prior to this, we were extracting results from tasks via the termination messages which had a limit of only 4 KB per pod. If users had many results then the results would need to become smaller to obey the upper limit of 4 KB.

We now run a dedicated sidecar that has access to the results of all the steps. This sidecar prints out the result and its content to stdout. The logs of the sidecar are parsed by the taskrun controller and the results updated instead of termination logs. We set an upper limit on the results to 4KB by default (configurable) and users can have as many such results as needed.

This PR is the last one on issue #5851 which deals with validation of sidecar name, documentation and examples.

We validate that the user does not accidentally provide the reserved sidecar name as the name of their sidecar while the results-from feature has been set to sidecar-logs.

Changes

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

Admission webhook validation to ensure that the reserved sidecar name is not used by the user, user documentation and larger results TaskRun and PipelineRun examples.

[chitrangpatel]

/kind feature

[chitrangpatel]

/assign @jerop

[tekton-robot]

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
pkg/pod/entrypoint.go	89.5%	89.8%	0.2
pkg/pod/pod.go	89.5%	91.0%	1.5
pkg/pod/status.go	90.9%	85.4%	-5.6
pkg/reconciler/taskrun/taskrun.go	81.3%	80.7%	-0.5

[chitrangpatel]

/retest

[tekton-robot]

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
pkg/pod/entrypoint.go	89.5%	89.8%	0.2
pkg/pod/pod.go	89.5%	91.0%	1.5
pkg/pod/status.go	90.9%	85.4%	-5.6
pkg/reconciler/taskrun/taskrun.go	81.3%	80.7%	-0.5

[tekton-robot]

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
pkg/pod/entrypoint.go	89.5%	89.8%	0.2
pkg/pod/pod.go	89.5%	91.0%	1.5
pkg/pod/status.go	90.9%	85.4%	-5.6
pkg/reconciler/taskrun/taskrun.go	81.3%	80.7%	-0.5

[tekton-robot]

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
pkg/pod/entrypoint.go	89.5%	89.8%	0.2
pkg/pod/pod.go	89.5%	91.0%	1.5
pkg/pod/status.go	90.9%	85.4%	-5.5
pkg/reconciler/taskrun/taskrun.go	81.3%	80.7%	-0.5

[tekton-robot]

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
pkg/pod/entrypoint.go	89.5%	89.8%	0.2
pkg/pod/pod.go	89.5%	91.0%	1.5
pkg/pod/status.go	90.9%	85.4%	-5.5
pkg/reconciler/taskrun/taskrun.go	81.3%	80.7%	-0.5

[tekton-robot]

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
pkg/pod/pod.go	89.5%	90.0%	0.5
pkg/pod/status.go	90.9%	82.1%	-8.8
pkg/reconciler/taskrun/taskrun.go	81.4%	80.9%	-0.5
pkg/sidecarlogresults/sidecarlogresults.go	Do not exist	95.0%

[tekton-robot]

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/v1/task_validation.go	97.0%	97.0%	0.1
pkg/apis/pipeline/v1beta1/task_validation.go	97.1%	97.2%	0.1

[tekton-robot]

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/v1/task_validation.go	97.0%	97.0%	0.1
pkg/apis/pipeline/v1beta1/task_validation.go	97.1%	97.2%	0.1

[chitrangpatel]

/hold cancel

All PRs prior to this have been merged. This is the last of one.

[tekton-robot]

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/v1/task_validation.go	97.0%	97.0%	0.1
pkg/apis/pipeline/v1beta1/task_validation.go	97.1%	97.2%	0.1

[jerop]

thank you @chitrangpatel!

[tekton-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bendory, jerop

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 [jerop]

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

[jerop]

@abayer @dibyom please take a look

[abayer]

/lgtm

[dibyom]

@chitrangpatel - Can we modify the release notes with a line that describes the feature from an end user standpoint? And also mention that sidecars cannot be named the reserved sidecar name?

[chitrangpatel]

@chitrangpatel - Can we modify the release notes with a line that describes the feature from an end user standpoint? And also mention that sidecars cannot be named the reserved sidecar name?

Sure!