spec and README: reduce to just image-manifest #383
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
This change corresponds with opencontainers/image-spec#999 as we reconcile changes needed to allow referrers API (`subject` field and `artifactType` field responses) to function smoothly on image-manifest. Personal take on this: After ~~excesive~~ extensive deliberation, that while it would be nice to have a clean-break to work with a generic manifest, we would be setting ourselves and the whole ecosystem up for the compatibility challenges similer to Docker schema 1 -> schema 2 -> OCI v1. The biggest value for the community and ecosystem is to provide guidance on how to use the available data structures and APIs to already accomplish the same use-cases in the most broadly compatible way. Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
vbatts
requested review from
dmcgowan,
jzelinskie,
jonjohnsonjr,
jdolitsky,
mikebrow,
stevvooe and
sudo-bmitch
as code owners
vbatts
force-pushed
the
artifact-adjustments
branch
from
4f9e7a4
to
ab32a6f
Compare
jdolitsky
approved these changes
Feb 10, 2023
|
Thanks @vbatts |
sajayantony
reviewed
Feb 10, 2023
| @@ -66,10 +64,9 @@ Several terms are used frequently in this document and warrant basic definitions | |||
| - **Push**: the act of uploading blobs and manifests to a registry | |||
| - **Pull**: the act of downloading blobs and manifests from a registry | |||
| - **Blob**: the binary form of content that is stored by a registry, addressable by a digest | |||
| - **Manifest**: a JSON document uploaded via the manifests endpoint. A manifest may reference other manifests and blobs in a repository via descriptors. Examples of manifests are defined under the OCI Image Spec <sup>[apdx-2](#appendix)</sup>, such as the image manifest, image index, and artifact manifest.</sup> | |||
| - **Manifest**: a JSON document uploaded via the manifests endpoint. A manifest may reference other manifests and blobs in a repository via descriptors. Examples of manifests are defined under the OCI Image Spec <sup>[apdx-2](#appendix)</sup>, such as the image manifest and image index (and legacy manifests).</sup> | |||
| - **Image Index**: a manifest containing a list of manifests, defined under the OCI Image Spec <sup>[apdx-6](#appendix)</sup>. | |||
| - **Image Manifest**: a manifest containing a config descriptor and an indexed list of layers, commonly used for container images, defined under the OCI Image Spec <sup>[apdx-2](#appendix)</sup>. | |||
There was a problem hiding this comment.
Include non container types?
Suggested change
| - **Image Manifest**: a manifest containing a config descriptor and an indexed list of layers, commonly used for container images, defined under the OCI Image Spec <sup>[apdx-2](#appendix)</sup>. | |
| - **Image Manifest**: a manifest containing a config descriptor and an indexed list of layers, commonly used for artifacts and container images defined under the OCI Image Spec <sup>[apdx-2](#appendix)</sup>. |
dmcgowan
approved these changes
Feb 13, 2023
1 task
Closed
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 change corresponds with
opencontainers/image-spec#999 as we reconcile changes needed to allow referrers API (
subjectfield andartifactTypefield responses) to function smoothly on image-manifest.Personal take on this:
After
excesiveextensive deliberation, that while it would be nice to have a clean-break to work with a generic manifest, we would be setting ourselves and the whole ecosystem up for the compatibility challenges similer to Docker schema 1 -> schema 2 -> OCI v1.The biggest value for the community and ecosystem is to provide guidance on how to use the available data structures and APIs to already accomplish the same use-cases in the most broadly compatible way.
Signed-off-by: Vincent Batts vbatts@hashbangbash.com