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.

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

Consider QoL improvements to tar artifacts generated by kit #489

Open
amisevsk opened this issue Sep 26, 2024 · 2 comments
Open

Consider QoL improvements to tar artifacts generated by kit #489

amisevsk opened this issue Sep 26, 2024 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@amisevsk
Copy link
Contributor

Describe the problem you're trying to solve
When packing a modelkit, each layer consists of a tar of the files in that layer's directory. For example, packing a model layer

model:
  path: model-files/

will result in a plain tar containing the contents of model-files (but not the directory itself). During unpacking, this context is reconstructed from the Kitfile so that digests are unchanged.

In addition, creating reproducible modelkits (unpacking and repacking results in the same digest) requires some additional changes, such as setting owner/group, timestamps, etc. to a known value.

This means that the tar files generated by Kit lose some information from the packing environment -- tooling using modelkits depends on kit-specific logic for extracting the contents of a modelkit.

Describe the solution you'd like
To make layer tars more useful outside of a kit context, it would be useful to find a way to include more of the context from the packing environment (e.g. directory names).

Additional context
Considering this change, it's likely something we want to decide sooner rather than later; any change to the pack process will break reproducibility of repacking unpacked modelkits. We also need to consider compatibility, so that previously-packed modelkits can still be unpacked with whatever new format we choose.

@amisevsk amisevsk added the enhancement New feature or request label Sep 26, 2024
@bmicklea
Copy link
Contributor

If implemented these will be breaking changes so better to do sooner than later. We'll take it in the sprint to discuss how to handle and (maybe) to implement.

@bmicklea
Copy link
Contributor

Sprint 17 goal: make the decision on what we are going to do for this.

Implement the change can follow in a future sprint if needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants