shipwright-io / cli

A CLI for building container images on Kubernetes!
https://shipwright.io
Apache License 2.0
16 stars 29 forks source link

[FEATURE] Debug utility command: `shp buildrun gather` #250

Open adambkaplan opened 6 months ago

adambkaplan commented 6 months ago

Is there an existing feature request for this?

Is your feature request related to a problem or use-case? Please describe.

Failed BuildRuns can be challenging to debug due to the multiple abstraction layers involved. We should provide a simple command to extract the details of the failed BuildRun so diagnostics/analysis can be run by a support or platform team.

Describe the solution that you would like.

Provide a sub-command for shp buildrun that downloads all pertinent information for the BuildRun and saves it in a single location (or tarball/zip):

  1. BuildRun object
  2. TaskRun generated by the BuildRun
  3. Pod generated by the TaskRun
  4. Logs

Describe alternatives you have considered.

Update/provide troubleshooting docs on the website.

Anything else?

No response

adambkaplan commented 6 months ago

This feature might be a bit too big for a brand new contributor, but if someone has submitted their first patch/PR then this is a "good second issue"/"good first feature"

qu1queee commented 6 months ago

From Refinement, this would be something to have but not committing it to a specific milestone.

Adarsh-jaiss commented 2 months ago

/assign