Add OCI digest project proposal #22
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # OCI go-digest project proposal | ||
|
|
||
| ## Abstract | ||
| [image-spec#486][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 we will extend this to OCI. This will be supported by moving https://github.com/opencontainers/go-digest to OCI. While this package does support opencontainers/image-spec, it is broadly useful in other image formats or outside image formats. | ||
|
|
||
| Having a solid, battle-proven, common digest implementation in OCI for use in and outside the image-spec will ensure long lasting security and interoperability throughout the container ecosystem. | ||
|
|
||
| ## Proposal | ||
| With repositories under the https://github.com/opencontainers organization: | ||
|
|
||
| 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: | ||
| * Brandon Philips <[email protected]> (@philips) | ||
| * Brendan Burns <[email protected]> (@brendandburns) | ||
| * Jason Bouzane <[email protected]> (@jbouzane) | ||
| * John Starks <[email protected]> (@jstarks) | ||
| * Jonathan Boulle <[email protected]> (@jonboulle) | ||
| * Stephen Day <[email protected]> (@stevvooe) | ||
| * Vincent Batts <[email protected]> (@vbatts) | ||
|
|
||
| ### Code of Conduct | ||
| This project would incorporate (by reference) the OCI Code of Conduct. | ||
|
|
||
| ### Governance and Releases | ||
| This project would incorporate the Governance and Releases processes from the OCI project template: https://github.com/opencontainers/project-template. | ||
|
|
||
| ### Project Communications | ||
| Both of the proposed projects would continue to use existing channels in use by the OCI developer community for communication including: | ||
| * GitHub for issues and pull requests | ||
| * The [email protected] email list | ||
| * The weekly OCI developer community conference call | ||
| * The #OpenContainers IRC channel | ||
|
|
||
| ### Versioning / Roadmap | ||
| We will probably minimize the releases of this project. | ||
|
|
||
| It will provide digesting functionality for all present and future versions of the specification. | ||
|
|
||
| ## 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). | ||
|
Contributor
There was a problem hiding this comment. 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.
Contributor
Author
There was a problem hiding this comment. thanks for the reminder @wking, we'll do this post vote |
||
|
|
||
| [image-spec-486]: https://github.com/opencontainers/image-spec/pull/486 | ||
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.
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.