Add the imageID for each step to the TaskRun.Spec.Status object.

[dlorenc]

Changes

This allows users to trace the exact steps (including digest) used in each TaskRun.
This information is already available on a Pod, but we need to assume completed Pods
will be GC'ed and not available long after the run is complete.

Fixes #1025

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)
• Commit messages follow commit message best practices

Release Notes

Adds a field called `ImageID` to `TaskRun.Spec.Status.Steps`, which contains the full image ID and digest used to run each step.

[imjasonh]

This is great. Would it be useful to have an integration test that checks that imageID is populated as expected?

I'm imagining a test that uses ggcr to resolve some public image's digest then runs that image by tag as a step and checks that the step state reports the image at the same digest.

[afrittoli]

This is great. Would it be useful to have an integration test that checks that imageID is populated as expected?

I'm imagining a test that uses ggcr to resolve some public image's digest then runs that image by tag as a step and checks that the step state reports the image at the same digest.

I think such E2E test could be interesting to have, but what it would verify additionally is that the image specified in the Step is passed properly into the container spec, and that k8s pulls the image correctly. I think that the fact that the image + digest from the pod is passed to the step status is already verified by the unit test.
If we setup such a test I would use a registry that the test has control on, as opposed to a public one.

[afrittoli]

/test pull-tekton-pipeline-integration-tests

[afrittoli]

LGTM, thank you, this looks useful to have.

[tekton-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: afrittoli, dlorenc

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 [afrittoli,dlorenc]

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

[dlorenc]

/test pull-tekton-pipeline-integration-tests

[bobcatfish]

I think this makes sense!

Couple quick requests 😇 :

• I think @afrittoli was asking for this as well but can this PR include an update to an end to end test to verify this field? if we update an example Task to use a specific image at a specific sha then we dont have to worry about the value changing or anything. (i.e. at least one test where we don't cmpopts.IgnoreFields(v1alpha1.StepState{}, "ImageID") for all imageID fields)
• can we add docs on this to https://github.com/tektoncd/pipeline/blob/master/docs/taskruns.md ? (there isnt yet a section for status but we can add one - we've got https://github.com/tektoncd/pipeline/blob/master/docs/taskruns.md#steps which should really be in a separate status section)

[dlorenc]

• I think @afrittoli was asking for this as well but can this PR include an update to an end to end test to verify this field? if we update an example Task to use a specific image at a specific sha then we dont have to worry about the value changing or anything. (i.e. at least one test where we don't cmpopts.IgnoreFields(v1alpha1.StepState{}, "ImageID") for all imageID fields)

Whoops, added!

• can we add docs on this to https://github.com/tektoncd/pipeline/blob/master/docs/taskruns.md ? (there isnt yet a section for status but we can add one - we've got https://github.com/tektoncd/pipeline/blob/master/docs/taskruns.md#steps which should really be in a separate status section)

Done!

[bobcatfish]

One super minor println away!

[bobcatfish]

/lgtm
/meow space

[bobcatfish]

❤️

[tekton-robot]

@bobcatfish:

In response to this:

/lgtm
/meow space

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]

interesting definition of "space"