Skip to content

proposals/distribution: remove non-sense about image indexes #49

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.

Sign up for GitHub

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

Closed
stevvooe wants to merge 1 commit into from
Closed

proposals/distribution: remove non-sense about image indexes #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions proposals/distribution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,8 @@ The following entries should be added to the [scope table][scope]:
* What: Specifying a distribution method
* In/Out/Future: In scope
* Status: In progress (see opencontainers/distribution-spec)
* Description: Define a protocol for creating, retrieving, updating, and deleting objects defined in the [image specification][image-spec].
Listing repositories (like [`/v2/_catalog`][catalog]) is a multi-[image-index][] action, which is out of scope for this entry.
Managing groups of image indexes requires multi-[image-index][] actions, which are out of scope for this entry.
Listing image indexes within a group is a multi-[image-index][] action, which is out of scope for this entry.
* Description: Define a protocol for creating, retrieving, updating, and deleting content-addressable objects, such as those defined in the [image specification][image-spec].
Listing repositories is a registry-wide operation; the implementation of which is out of scope of this document.
Copy link
Member

@mikebrow mikebrow Mar 15, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Nit: this is a first introduction of term "document." Suggest using this "spec."
Also this listing restriction does not make sense here. Can we move it to the Grouping line above on 109 and change the word grouping to a broader term like "managing?" "Managing the grouping of images (image names) as repositories within a registry is considered part of distribution policy or content management, which are out of scope for this spec."

Copy link
Member

@dmcgowan dmcgowan Mar 15, 2018

Choose a reason for hiding this comment

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

The relationship between these two sentences is not straightforward. However I do think this is referring to slightly different functionality. While the "grouping" section is just saying that each repository name is considered independent from the perspective of the API, this is referring to an endpoint which lists all the repository names within a registry. While the group and name hierarchy could be of interest to an end API user, cataloging has normally just be considered an administrative endpoint not exposed to API users.

+1 on document -> specification

Copy link
Member

@mikebrow mikebrow Mar 15, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Cool..
Maybe.. "An endpoint for listing repository names within a registry, is considered out of scope for this spec and thus also out of scope for this protocol." Or distribution protocol...

Copy link
Member

@dmcgowan dmcgowan Mar 15, 2018

Choose a reason for hiding this comment

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

That language sounds clearer, let me update and move it next to tag listing. I don't think these statements belong here.

* Why: This specification will provide one (of possibly many) distribution specifications.
Alternative distribution specifications may be developed for uses cases not covered by this specification, but defining them is currently out of scope for the OCI.

Expand Down