Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document intended workflow with imgpkg #162

Open
pivotaljohn opened this issue Sep 17, 2021 · 4 comments
Open

Document intended workflow with imgpkg #162

pivotaljohn opened this issue Sep 17, 2021 · 4 comments
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed documentation This issue indicates a change to the docs should be considered enhancement This issue is a feature request priority/unprioritized-backlog Higher priority than priority/awaiting-more-evidence. Contributions are welcome.

Comments

@pivotaljohn
Copy link
Contributor

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.
@pivotaljohn pivotaljohn added enhancement This issue is a feature request carvel triage This issue has not yet been reviewed for validity labels Sep 17, 2021
@cppforlife
Copy link
Contributor

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
Copy link
Contributor

@pivotaljohn any thoughts on @cppforlife's comment?

@cari-lynn
Copy link
Contributor

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
Copy link
Contributor Author

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.

@cari-lynn cari-lynn added documentation This issue indicates a change to the docs should be considered carvel accepted This issue should be considered for future work and that the triage process has been completed priority/unprioritized-backlog Higher priority than priority/awaiting-more-evidence. Contributions are welcome. and removed carvel triage This issue has not yet been reviewed for validity labels Oct 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed documentation This issue indicates a change to the docs should be considered enhancement This issue is a feature request priority/unprioritized-backlog Higher priority than priority/awaiting-more-evidence. Contributions are welcome.
Projects
Carvel
Status: Unprioritized
Milestone
No milestone
Development

No branches or pull requests
4 participants
@cppforlife @aaronshurley @pivotaljohn @cari-lynn