Document intended workflow with imgpkg

[pivotaljohn]

Describe the problem/challenge you have
While integration with imgpkg is mentioned (specifically that one can generate a kind: ImagesLock), the user is left to infer the intended workflow. There are details (e.g. how meta is handled, how references are relocated, explicitly that this lockfile is .imgpkg/images.yml) that are no documented anywhere.

Describe the solution you'd like
Document the end-to-end workflow:

kbld --imgpkg-lock-output=.imgpkg/images.yml ... ==> imgpkg copy ... ==> imgpkg pull ==> kbld -f .imgpkg/images.yml ...

Anything else you would like to add:

---

Vote on this request

This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible"
👎 "There are other more important things to focus on right now"

We are also happy to receive and review Pull Requests if you want to help working on this issue.

[cppforlife]

i believe such documentation already is under imgpkg. if you think it's appropriate to link to it from kbld docs, that's probably good, but i would be a bit on the fence to introduce similar content in kbld directly.

[aaronshurley]

@pivotaljohn any thoughts on @cppforlife's comment?

[cari-lynn]

The docs in imgpkg do detail the workflow @jtigger mentioned, and I agree that we shouldn't duplicate the docs. However reading through kbld's docs there are details on resolving images using --imgpkg-lock-output, but it was difficult to find and does not cover imgpkg at all.

An idea for improvement is to link to the imgpkg documentation on 'Generating resolution imgpkg lock output'. I would even go one step further and say it may deserve its own page to make it more discoverable.

[pivotaljohn]

An idea for improvement is to link to the imgpkg documentation on 'Generating resolution imgpkg lock output'. I would even go one step further and say it may deserve its own page to make it more discoverable.

Perfect.