Add `StdoutConfig` and `StderrConfig` to steps. #3103

chhsia0 · 2020-08-15T20:55:56Z

Changes

This PR implements Option 1 of TEP-0011.

Closes #2925.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

Includes tests (if functionality changed/added)
Includes docs (if user facing)
Commit messages follow commit message best practices
Release notes block has been filled in or deleted (only if no user facing changes)

See the contribution guide for more details.

Double check this list of stuff that's easy to miss:

If you are adding a new binary/image to the cmd dir, please update
the release Task to build and release this image.

Reviewer Notes

If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.

Release Notes

EXPERIMENTAL: Users can specify the TEKTON_STDOUT_FILE and TEKTON_STDERR_FILE environment variables in steps to capture steps' stdout and stderr to local files. This feature can be used to capture stdout and stderr into task results.

linux-foundation-easycla · 2020-08-15T20:55:59Z

The committers are authorized under a signed CLA.

✅ Chun-Hung Hsiao (606639a)

tekton-robot · 2020-08-15T20:56:06Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign dlorenc
You can assign the PR to them by writing /assign @dlorenc 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

tekton-robot · 2020-08-15T20:56:11Z

Hi @chhsia0. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

chhsia0 · 2020-08-15T21:43:37Z

/kind feature

jlpettersson · 2020-08-15T21:56:11Z

/ok-to-test

tekton-robot · 2020-08-15T23:54: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
cmd/entrypoint/io.go	Do not exist	86.3%
cmd/entrypoint/runner.go	81.0%	84.1%	3.1

tekton-robot · 2020-08-16T20:31:03Z

@chhsia0: Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

vdemeester

@chhsia0 how do we envision being able to pass those flags from the "API" ?

cmd/entrypoint/runner.go

chhsia0 · 2020-08-17T17:20:56Z

@vdemeester I'll create a TEP for passing the params :) Right now in its current state user would use env vars as a channel transparent to the Tekton controller. Sounds scary huh? ;)

vdemeester · 2020-08-18T10:02:25Z

@vdemeester I'll create a TEP for passing the params :) Right now in its current state user would use env vars as a channel transparent to the Tekton controller. Sounds scary huh? ;)

😁 nothing is scary 😝 and as you said during the API WG, it allows you to more easily experiment with it without really commiting to it (aka see if it's useful and all).

tekton-robot · 2020-11-06T23:31: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/pod/entrypoint.go	84.8%	85.9%	1.1

chhsia0 · 2021-03-10T17:08:59Z

/remove-lifecycle stale

When `-stdout_path` and `-stderr_path` are set, the entrypoint binary will copy stdout and stderr to the specified paths. This can be used to capture the stdout or stderr of a step in task results. The default values of these flags are obtained from the `TEKTON_STDOUT_PATH` and `TEKTON_STDERR_PATH` environment variables, so users can specify these variables in the step's environment to enable stdout/stderr capturing.

tekton-robot · 2021-03-10T17:20: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
cmd/entrypoint/io.go	Do not exist	86.8%
cmd/entrypoint/runner.go	84.0%	82.1%	-1.9
pkg/pod/entrypoint.go	84.8%	85.9%	1.1

tekton-robot · 2021-03-11T15:37:42Z

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
cmd/entrypoint/io.go	Do not exist	86.8%
cmd/entrypoint/runner.go	80.0%	80.4%	0.4
pkg/pod/entrypoint.go	84.8%	85.9%	1.1

tekton-robot · 2021-03-11T16:04:09Z

@chhsia0: The following tests failed, say /retest to rerun them all:

Test name	Commit	Details	Rerun command
pull-tekton-pipeline-unit-tests	`a52c86f`	link	`/test tekton-pipeline-unit-tests`
pull-tekton-pipeline-build-tests	`a52c86f`	link	`/test pull-tekton-pipeline-build-tests`
pull-tekton-pipeline-integration-tests	`a52c86f`	link	`/test pull-tekton-pipeline-integration-tests`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

tekton-robot · 2021-03-11T16:04:09Z

@chhsia0: The following tests failed, say /retest to rerun them all:

Test name	Commit	Details	Rerun command
pull-tekton-pipeline-unit-tests	`a52c86f`	link	`/test tekton-pipeline-unit-tests`
pull-tekton-pipeline-build-tests	`a52c86f`	link	`/test pull-tekton-pipeline-build-tests`
pull-tekton-pipeline-integration-tests	`a52c86f`	link	`/test pull-tekton-pipeline-integration-tests`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

bobcatfish · 2021-04-29T18:24:20Z

highly relevant: kubernetes/kubernetes#94892

tekton-robot · 2021-05-06T18:19:01Z

@chhsia0: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

bobcatfish · 2021-06-30T17:46:21Z

@chhsia0 I'm thinking maybe it makes sense at this point to close this PR for now, unless you're planning to pick it up again in the near future. We can always re-open.

vdemeester · 2021-07-01T06:33:44Z

I think we can close, and I plan to carry this one soon 😇
/close

tekton-robot · 2021-07-01T06:33:46Z

@vdemeester: Closed this PR.

In response to this:

I think we can close, and I plan to carry this one soon 😇
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Implements Option 1 of [TEP-0011](https://github.com/tektoncd/community/blob/master/teps/0011-redirecting-step-output-streams.md) Resurrects [#3103](#3103) Closes [#2925](#2925) Signed-off-by: Brad Beck <bradley.beck@gmail.com>

tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Aug 15, 2020

tekton-robot requested review from bobcatfish and a user August 15, 2020 20:56

tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 15, 2020

tekton-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 15, 2020

tekton-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Aug 15, 2020

tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 15, 2020

tekton-robot added do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. and removed release-note Denotes a PR that will be considered when it comes time to generate release notes. labels Aug 16, 2020

chhsia0 changed the title ~~Added -stdout_path and -stderr_path flags to entrypoint.~~ Added -stdout_file and -stderr_file flags to entrypoint. Aug 16, 2020

vdemeester added kind/feature Categorizes issue or PR as related to a new feature. and removed kind/feature Categorizes issue or PR as related to a new feature. labels Aug 17, 2020

vdemeester reviewed Aug 17, 2020

View reviewed changes

cmd/entrypoint/runner.go Outdated Show resolved Hide resolved

chhsia0 mentioned this pull request Aug 17, 2020

TEP-0011: Redirecting Step Output Streams tektoncd/community#182

Merged

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

chhsia0 force-pushed the entrypoint-stdout branch from 8b70a13 to 8bd1736 Compare November 6, 2020 23:28

tekton-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Nov 6, 2020

tekton-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 10, 2021

chhsia0 added 10 commits March 10, 2021 09:14

Renamed tests.

2688e38

Made copyAsync copy stream until EOF if stopCh is nil.

988794b

Use File.Stat to get file size in test.

739d6d7

Removed asyncWriwer wrapper.

96e8e5b

Added README.

d342aef

Added StdoutConfig and StderrConfig fields in v1beta1.Step.

8ab5b33

Passed StepOutputConfig to entrypoint.

6e78d3b

Fixed race condition when asynchronously copying outputs.

a99a19a

Added an integration test for redirecting step outputs.

a52c86f

chhsia0 force-pushed the entrypoint-stdout branch from ea992c6 to a52c86f Compare March 10, 2021 17:17

tekton-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 10, 2021

Base automatically changed from master to main March 11, 2021 15:28

tekton-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 6, 2021

tekton-robot closed this Jul 1, 2021

jdurzi mentioned this pull request Sep 15, 2021

We either need an output to file option, or a Docker image that has a shell anchore/grype#418

Closed

wagoodman mentioned this pull request Oct 5, 2021

add an option to output the report into a file rather than redirecting the output anchore/grype#207

Closed

bradbeck mentioned this pull request May 17, 2022

TEP-0011: Add StdoutConfig and StderrConfig to steps. #4882

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `StdoutConfig` and `StderrConfig` to steps. #3103

Add `StdoutConfig` and `StderrConfig` to steps. #3103

chhsia0 commented Aug 15, 2020 •

edited

Loading

linux-foundation-easycla bot commented Aug 15, 2020 •

edited

Loading

tekton-robot commented Aug 15, 2020

tekton-robot commented Aug 15, 2020

chhsia0 commented Aug 15, 2020

jlpettersson commented Aug 15, 2020

tekton-robot commented Aug 15, 2020

tekton-robot commented Aug 16, 2020

vdemeester left a comment

chhsia0 commented Aug 17, 2020

vdemeester commented Aug 18, 2020

tekton-robot commented Nov 6, 2020

chhsia0 commented Mar 10, 2021

tekton-robot commented Mar 10, 2021

tekton-robot commented Mar 11, 2021

tekton-robot commented Mar 11, 2021

tekton-robot commented Mar 11, 2021

bobcatfish commented Apr 29, 2021

tekton-robot commented May 6, 2021

bobcatfish commented Jun 30, 2021

vdemeester commented Jul 1, 2021

tekton-robot commented Jul 1, 2021

Add StdoutConfig and StderrConfig to steps. #3103

Add StdoutConfig and StderrConfig to steps. #3103

Conversation

chhsia0 commented Aug 15, 2020 • edited Loading

Changes

Submitter Checklist

Reviewer Notes

Release Notes

linux-foundation-easycla bot commented Aug 15, 2020 • edited Loading

tekton-robot commented Aug 15, 2020

tekton-robot commented Aug 15, 2020

chhsia0 commented Aug 15, 2020

jlpettersson commented Aug 15, 2020

tekton-robot commented Aug 15, 2020

tekton-robot commented Aug 16, 2020

vdemeester left a comment

Choose a reason for hiding this comment

chhsia0 commented Aug 17, 2020

vdemeester commented Aug 18, 2020

tekton-robot commented Nov 6, 2020

chhsia0 commented Mar 10, 2021

tekton-robot commented Mar 10, 2021

tekton-robot commented Mar 11, 2021

tekton-robot commented Mar 11, 2021

tekton-robot commented Mar 11, 2021

bobcatfish commented Apr 29, 2021

tekton-robot commented May 6, 2021

bobcatfish commented Jun 30, 2021

vdemeester commented Jul 1, 2021

tekton-robot commented Jul 1, 2021

Add `StdoutConfig` and `StderrConfig` to steps. #3103

Add `StdoutConfig` and `StderrConfig` to steps. #3103

chhsia0 commented Aug 15, 2020 •

edited

Loading

linux-foundation-easycla bot commented Aug 15, 2020 •

edited

Loading