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

config: minor cleanup #608

Merged
merged 2 commits into from
Mar 14, 2017
Merged

config: minor cleanup #608

merged 2 commits into from
Mar 14, 2017

Conversation

jonboulle
Copy link
Contributor

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.

@wking
Copy link
Contributor

wking commented Mar 10, 2017

Missing signoffs?

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

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.

Copy link
Contributor Author

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.
Copy link
Member

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?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i guess so

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vbatts
Copy link
Member

vbatts commented Mar 13, 2017

LGTM

Approved with PullApprove

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

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.

Copy link
Contributor Author

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

@stevvooe
Copy link
Contributor

stevvooe commented Mar 14, 2017

LGTM

Need to address #608 (comment) separately. This should not be a must.

Approved with PullApprove

@stevvooe stevvooe merged commit f17fdaf into opencontainers:master Mar 14, 2017
jonboulle added a commit to jonboulle/image-spec that referenced this pull request Mar 14, 2017
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>
@vbatts vbatts mentioned this pull request May 19, 2017
dattgoswami9lk5g added a commit to dattgoswami9lk5g/bremlinr that referenced this pull request Jun 6, 2022
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>
7c00d pushed a commit to 7c00d/J1nHyeockKim that referenced this pull request Jun 6, 2022
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>
7c00d added a commit to 7c00d/J1nHyeockKim that referenced this pull request Jun 6, 2022
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>
laventuraw added a commit to laventuraw/Kihara-tony0 that referenced this pull request Jun 6, 2022
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>
tomalopbsr0tt added a commit to tomalopbsr0tt/fabiojosej that referenced this pull request Oct 6, 2022
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants