-
Notifications
You must be signed in to change notification settings - Fork 52
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
Add OCI digest project proposal #22
Conversation
Signed-off-by: Chris Aniszczyk <[email protected]>
## Abstract | ||
opencontainers/image-spec#486 introduces a dependency on a stable upstream implementation of https://github.com/docker/go-digest, which was recently broken out of the https://github.com/docker/distribution project. | ||
|
||
This package has been instrumental in providing a strong hash-identity implementation in Go and I hope to extend this to OCI. |
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.
Probably remove the first-person here.
# OCI go-digest project proposal | ||
|
||
## Abstract | ||
opencontainers/image-spec#486 introduces a dependency on a stable upstream implementation of https://github.com/docker/go-digest, which was recently broken out of the https://github.com/docker/distribution project. |
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.
GitHub doesn't render references like opencontainers/image-spec#486
in its filesystem browser. You probably want:
[image-spec#486][image-spec-486] introduces…
[image-spec-486]: https://github.com/opencontainerrs/image-spec/pull/486
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.
thanks!
## Abstract | ||
opencontainers/image-spec#486 introduces a dependency on a stable upstream implementation of https://github.com/docker/go-digest, which was recently broken out of the https://github.com/docker/distribution project. | ||
|
||
This package has been instrumental in providing a strong hash-identity implementation in Go and I hope to extend this to OCI. |
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.
Clarify that “I” is @stevvooe?
* Jason Bouzane <[email protected]> (@jbouzane) | ||
* John Starks <[email protected]> (@jstarks) | ||
* Jonathan Boulle <[email protected]> (@jonboulle) | ||
* Stephen Day <[email protected]> (@stevvooe) [lead maintainer] |
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.
Chief-Maintainer-ness is fuzzy. See @vishh pushing back on it here and my proposed removal from the project-template here. Since the OCI charter says nothing about Chief Maintainer, I suggest leaving it out of this proposal. If they want, the go-digest maintainers can adopt Chief-Maintainer-based rules without TOB intervention.
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.
sure, we can just list the set of maintainers. It's simpler for us to just carry over the list of image-spec maintainers to start
* The #OpenContainers IRC channel | ||
|
||
### Versioning / Roadmap | ||
Released version numbers of the go-digest project should roughly align with released versions of the associated specs projects. |
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'd rather have the versioning be completely independent. go-digest should be able to cut a 1.0 soon-ish and then sit on it forever, with the only updates being “a new version of Go was released, and we've decided to drop some backwards compat”.
|
||
## Frequenty Asked Questions (FAQ) | ||
Q: Does this change the OCI Charter or Scope Table? | ||
A: No. Nothing in this proposal is intended to amend the OCI Charter (https://www.opencontainers.org/about/governance) or OCI Scope Table (https://www.opencontainers.org/governance/oci-scope-table). |
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.
The scope-table URL (which matches what the charter links to) is currently 404-ing for me.
* The #OpenContainers IRC channel | ||
|
||
### Versioning / Roadmap | ||
Released version numbers of the go-digest project should roughly align with released versions of the associated specs projects. |
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.
We will probably minimize the releases of this project. It will provide digesting functionality for all present and future versions of the specification.
@caniszczyk Thanks! |
Rename (transfer) https://github.com/docker/go-digest would become https://github.com/opencontainers/go-digest. | ||
|
||
### Initial Maintainers | ||
Initial maintainers of the go-digest project would be seeded from the image-spec project: |
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.
To reduce the chance of absentee maintainers (who make it more difficult to pass quorum), I think the current set of image-spec maintainers should be invited (in this PR?) to become go-digest maintainers, but only image-spec maintainers who reply (“sure, I'd like to be a go-digest maintainer”) by the end of the year (or whatever) would actually become go-digest maintainers via this proposal. Anyone who misses the initial PR can always apply via the usual new-maintainer mechanism.
Signed-off-by: Chris Aniszczyk <[email protected]>
Signed-off-by: W. Trevor King <[email protected]>
# OCI go-digest project proposal | ||
|
||
## Abstract | ||
[image-spec-486]: https://github.com/opencontainerrs/image-spec/pull/486 introduces a dependency on a stable upstream implementation of https://github.com/docker/go-digest, which was recently broken out of the https://github.com/docker/distribution project. |
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.
The link is still busted. I've filed #23 against this PR with what I had in mind.
fixup! Respond to comments from OCI TDC
|
||
## Frequenty Asked Questions (FAQ) | ||
Q: Does this change the OCI Charter or Scope Table? | ||
A: No. Nothing in this proposal is intended to amend the OCI Charter (https://www.opencontainers.org/about/governance) or OCI Scope Table (https://www.opencontainers.org/about/oci-scope-table). |
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.
The scope table currently has an entry for “Hashing for Content Integrity” (distinct from “Use of Hash as Content Addressable name for immutable containers”). The hashing entry is “Work not yet started”. I'm not clear on the scope of the hashing entry (is it just the hashing? Which entry covers Merkle links?), but I expect we do want to update that entry in the scope table as part of landing this digest project.
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.
thanks for the reminder @wking, we'll do this post vote
The migration has happened: https://github.com/opencontainers/go-digest We still need to clean up the repo to be more OCI-like, but other than that, we're in business! Thanks @stevvooe |
For record keeping, add project proposal for go-digest:
#21
Signed-off-by: Chris Aniszczyk [email protected]