Fix docs to focus more on eStargz #189
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AkihiroSuda
reviewed
Dec 7, 2020
docs/stargz-estargz.md
Outdated
| However current OCI Image Spec uses tar and tar.gz archive formats for archiving layers, which don't suit to this use-case because of the following reasons, | ||
| When lazily pulling an image from the registry, necessary chunks of its layers are fetched *on-demand* during running the container, instead of downloading the entire contents of that image at once. | ||
| For achieving this, runtimes need to *selectively* fetch and extract files contents in the layer. | ||
| However current OCI/Docker Image Spec uses tar (optionally with compression) for archiving layers, which doesn't suit to this use-case because of the following reasons, |
docs/stargz-estargz.md
Outdated
| Corresponding to the chunks after 2nd, TOCEntries typed `chunk` MUST be contained. | ||
| `chunk`-typed TOCEntry must set offset, chunkOffset and chunkSize properties. | ||
|
|
||
| - **`size`** *int64* |
Member
Author
There was a problem hiding this comment.
Fixed this. The implementation will be following-up PRs.
docs/stargz-estargz.md
Outdated
|
|
||
| This OPTIONAL property contains the permission and mode bits. | ||
|
|
||
| - **`uid`** *int* |
Member
Author
There was a problem hiding this comment.
Fixed this. The implementation will be following-up PRs.
docs/stargz-estargz.md
Outdated
| 22 bytes Extra field (fmt.Sprintf("%016xSTARGZ", offsetOfTOC)) | ||
| 5 bytes flate header | ||
| 8 bytes gzip footer | ||
| (End of the eStargz blob) |
Member
There was a problem hiding this comment.
Is this section about plain stargz or eStargz?
Member
Author
There was a problem hiding this comment.
Fixed the footer section to make it compliant to Extra field in RFC 1952 (thus eStargz's footer).
The implementation will be the following-up PR.
ktock
force-pushed
the
docs-esgz
branch
2 times, most recently
from
3518c81 to
9aa303c
Compare
AkihiroSuda
requested changes
Dec 7, 2020
docs/stargz-estargz.md
Outdated
| (End of eStargz) | ||
| ``` | ||
|
|
||
| *NOTE that though eStarz is compatible to tar.gz, it's not compatible to stargz by Google CRFS.* |
Member
There was a problem hiding this comment.
Needs full explanation. The footer differs (for RFC compliance) but TOC is compatible, right?
Member
Author
There was a problem hiding this comment.
Yes. Added Notes on compatibility with stargz subsection for explaining this.
This includes the following changes - fixing the docs to focus on eStargz - updating the benchmark result to the recent one - fixing README to make each sentence start from the new line Signed-off-by: Kohei Tokunaga <[email protected]>
AkihiroSuda
approved these changes
Dec 7, 2020
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#184
This includes the following changes