carvel-dev / carvel-dev/kbld

Document intended workflow with imgpkg

Open
#162 4 comments 0 reactions 0 assignees View on GitHub
carvel accepted documentation enhancement priority/unprioritized-backlog
Dominant language
Go
Stars
329
Forks
52
PR merge metrics
No merged PRs in 30d

Description

**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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.