Working Group Proposal for Reference Types #335
Merged
Conversation
This file contains 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
jdolitsky
force-pushed
the
pr
branch
5 times, most recently
from
ec033dc
to
3870c84
Compare
AkihiroSuda
reviewed
Aug 10, 2022
jdolitsky
requested review from
dmcgowan,
jzelinskie,
jonjohnsonjr,
jdolitsky,
mikebrow,
stevvooe,
sudo-bmitch and
vbatts
as code owners
jdolitsky
previously approved these changes
Aug 10, 2022
|
@opencontainers/distribution-spec-maintainers given the size of this, we are giving this 2 weeks for any objections before merging. It was presented on the OCI call today and hopefully a recording will be posted soon. After merging it still won't be a tagged release, so if there are any issues raised, we can always open another PR. |
This was referenced Aug 11, 2022
mikebrow
requested changes
Aug 11, 2022
mikebrow
reviewed
Aug 12, 2022
jzelinskie
reviewed
Aug 16, 2022
7 tasks
jdolitsky
previously approved these changes
Aug 18, 2022
nishakm
reviewed
Aug 18, 2022
vbatts
reviewed
Aug 25, 2022
vbatts
reviewed
Aug 25, 2022
| *Note: this feature was added in distibution-spec 1.1. | ||
| Registries should see [Enabling the Referrers API](#enabling-the-referrers-api) before enabling this.* | ||
|
|
||
| To fetch the list of referrers, perform a `GET` request to a path in the following format: `/v2/<name>/referrers/<reference>` <sup>[end-12a](#endpoints)</sup>. |
There was a problem hiding this comment.
Reading through this and the examples below, I'm not actually clear on what string <reference> actually is. Media Type? digest? arbitrary value?
vbatts
reviewed
Aug 25, 2022
vbatts
reviewed
Aug 25, 2022
| Example request with filtering: | ||
|
|
||
| ``` | ||
| GET /v2/<name>/referrers/<ref>?artifactType=application/vnd.example.sbom.v1 |
There was a problem hiding this comment.
it's <ref> here, but <reference> everywhere else
vbatts
reviewed
Aug 25, 2022
| ### Backwards Compatibility | ||
|
|
||
| Client implementations MUST support registries that implement partial or older versions of the OCI Distribution Spec. | ||
| This section describes client fallback procedures that MUST be implemented when a new/optional API is not available from a Registry. |
There was a problem hiding this comment.
right, so, if there is a backward-compat condition, then is it required that this feature bumps the version to 1.1?
vbatts
reviewed
Aug 25, 2022
| This tag should return an Image Index matching the expected response of the [Referrers API](#listing-referrers). | ||
| Maintaining the content of this tag is the responsibility of clients pushing and deleting Image and Artifact Manifests that contain a `refers` field. | ||
|
|
||
| Multiple clients could attempt to update the tag simultaneously resulting in race conditions and data loss. |
sudo-bmitch
previously approved these changes
Aug 25, 2022
This is a culmination of many people's work over the last few months to introduce reference types to OCI as part of the [OCI Reference Types WG](oci-ref-type-wg). This PR contains the changes from our chosen proposal, [Proposal E][proposal-e]. [oci-ref-type-wg]: https://github.com/opencontainers/tob/blob/main/proposals/wg-reference-types.md [proposal-e]: https://github.com/opencontainers/wg-reference-types/blob/main/docs/proposals/PROPOSAL_E.md Co-authored-by: Josh Dolitsky <josh@dolit.ski> Co-authored-by: Josh Dolitsky <393494+jdolitsky@users.noreply.github.com> Co-authored-by: Michael Brown <brownxmi@amazon.com> Signed-off-by: Brandon Mitchell <git@bmitch.net>
|
I said this on |
sudo-bmitch
approved these changes
Aug 25, 2022
7 tasks
sajayantony
approved these changes
Aug 25, 2022
mikebrow
approved these changes
Aug 25, 2022
This was referenced Sep 15, 2022
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a culmination of many people's work over the last few months to introduce reference types to OCI as part of the OCI Reference Types WG.
This PR contains the changes from our chosen proposal, Proposal E, relevant to the distribution-spec. We're looking forward to hearing feedback from distribution-spec maintainers on these changes!
We have also opened a similar PR for the
image-spec: opencontainers/image-spec#934