-
Notifications
You must be signed in to change notification settings - Fork 687
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
config: minor cleanup #608
Conversation
config.md
Outdated
@@ -26,7 +26,7 @@ Changing it means creating a new derived image, instead of changing the existing | |||
### Layer DiffID | |||
|
|||
A layer DiffID is the digest over the layer's uncompressed tar archive and serialized in the descriptor digest format, e.g., `sha256:a9561eb1b190625c9adb5a9513e72c4dedafc1cb2d4c5236c9a6957ec7dfd5a9`. | |||
Layers must be packed and unpacked reproducibly to avoid changing the layer DiffID, for example by using tar-split to save the tar headers. | |||
Layers must be packed and unpacked reproducibly to avoid changing the layer DiffID, for example by using [tar-split][tar-split] to save the tar headers. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: You can just use [tar-split][]
to take advantage of the implicit link name shortcut. Removing the redundant link name makes this line slightly easier to read, but it's obviously not a big deal either way.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
@@ -26,7 +26,7 @@ Changing it means creating a new derived image, instead of changing the existing | |||
### Layer DiffID | |||
|
|||
A layer DiffID is the digest over the layer's uncompressed tar archive and serialized in the descriptor digest format, e.g., `sha256:a9561eb1b190625c9adb5a9513e72c4dedafc1cb2d4c5236c9a6957ec7dfd5a9`. | |||
Layers must be packed and unpacked reproducibly to avoid changing the layer DiffID, for example by using tar-split to save the tar headers. | |||
Layers must be packed and unpacked reproducibly to avoid changing the layer DiffID, for example by using [tar-split][] to save the tar headers. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does that empty bracket work?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i guess so
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -26,7 +26,7 @@ Changing it means creating a new derived image, instead of changing the existing | |||
### Layer DiffID | |||
|
|||
A layer DiffID is the digest over the layer's uncompressed tar archive and serialized in the descriptor digest format, e.g., `sha256:a9561eb1b190625c9adb5a9513e72c4dedafc1cb2d4c5236c9a6957ec7dfd5a9`. | |||
Layers must be packed and unpacked reproducibly to avoid changing the layer DiffID, for example by using tar-split to save the tar headers. | |||
Layers must be packed and unpacked reproducibly to avoid changing the layer DiffID, for example by using [tar-split][] to save the tar headers. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this actually a must? I don't think we need to require that implementation require tar-split or that layers be packed reproducibly. Neither are necessary for a working container runtime.
This is more of an implementation note, maybe.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suppose (?) as written it's not supposed to be an imperative must (i.e. "to avoid changing the headers, it is necessary for layers to be packed reproducibly" rather than "implementers must pack reproducibly") but I think we should probably standardise on RFC2119 language to be clearer. #611
LGTM Need to address #608 (comment) separately. This should not be a must. |
As noted in opencontainers#608 (comment) - we shouldn't be mandating that implementers use something like tar-split to facilitate reproducible DiffIDs, but rather recommend it. Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
As noted in opencontainers/image-spec#608 (comment) - we shouldn't be mandating that implementers use something like tar-split to facilitate reproducible DiffIDs, but rather recommend it. Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
As noted in opencontainers/image-spec#608 (comment) - we shouldn't be mandating that implementers use something like tar-split to facilitate reproducible DiffIDs, but rather recommend it. Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
As noted in opencontainers/image-spec#608 (comment) - we shouldn't be mandating that implementers use something like tar-split to facilitate reproducible DiffIDs, but rather recommend it. Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
As noted in opencontainers/image-spec#608 (comment) - we shouldn't be mandating that implementers use something like tar-split to facilitate reproducible DiffIDs, but rather recommend it. Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
As noted in opencontainers/image-spec#608 (comment) - we shouldn't be mandating that implementers use something like tar-split to facilitate reproducible DiffIDs, but rather recommend it. Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
The DiffID exploration doesn't parse as cleanly as it could to me and I'd like
to work on improving it. Starting with some hopefully uncontroversial tweaks.