Skip to content

Commit f92fdb3

Browse files
authored
Merge pull request #46 from wking/image-repository-wording
distribution: Reword scope table to avoid repository/image distinction
2 parents 5dcd80a + 75ede78 commit f92fdb3

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

proposals/distribution.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -104,30 +104,30 @@ The following entries should be added to the [scope table][scope]:
104104
* “Specifying a distribution method”.
105105
This entry replaces part of the previous “Creating Reference spec for optional DNS based naming & distribution” and “Standardizing on a particular Distribution method” entries.
106106

107-
Retrieving images covers the current “tag listing” (e.g. “what named manifests are in `library/busybox`?”), because tags are entries in the image format's [`manifests` array][manifests].
107+
Retrieving image indexes covers the current “tag listing” (e.g. “what named manifests are in `library/busybox`?”), because tags are entries in the image format's [`manifests` array][manifests].
108108
Other tag-listing endpoints needed for backwards-compatibility are therefore in scope as well.
109109

110-
Repository actions and listing images within a repository are considered part of distribution policy or content management and are out of scope for this entry's per-image action.
110+
Grouping image indexes in repositories is considered part of distribution policy or content management, which are out of scope for this entry's per-image action.
111111
For example, “what images are under `library/`?” is out of scope for this project.
112112

113113
* What: Specifying a distribution method
114114
* In/Out/Future: In scope
115115
* Status: In progress (see opencontainers/distribution-spec)
116-
* Description: Define a protocol for image, manifest, config, and blob creation, retrieval, and deletion.
117-
Listing repositories is a multi-repository action, which is out of scope for this entry.
118-
Creating and deleting repositories are per-repository actions, which are out of scope for this entry.
119-
Listing images within repositories is a per-repository action, which is out of scope for this entry.
116+
* Description: Define a protocol for creating, retrieving, updating, and deleting objects defined in the [image specification][image-spec].
117+
Listing repositories (like [`/v2/_catalog`][catalog]) is a multi-[image-index][] action, which is out of scope for this entry.
118+
Managing groups of image indexes requires multi-[image-index][] actions, which are out of scope for this entry.
119+
Listing image indexes within a group is a multi-[image-index][] action, which is out of scope for this entry.
120120
* Why: This specification will provide one (of possibly many) distribution specifications.
121121
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.
122122

123-
* “Retrieving images by their content-addressable hash”.
124-
Docker's registery API already provides endpoints for fetching manifest objects by digest][get-manifest].
125-
Docker's registery API does not currently provide endpoints for fetching image objects by digest, but this is the project where that will happen.
123+
* “Retrieving image content by its content-addressable hash”.
124+
Docker's registry API already provides [endpoints for fetching manifest objects by digest][get-manifest].
125+
Docker's registry API does not currently provide endpoints for fetching [image-index][] objects by digest, but this is the project where that will happen.
126126

127-
* What: Retrieving images by their content-addressable hash
127+
* What: Retrieving image content by its content-addressable hash
128128
* In/Out/Future: In scope
129129
* Status: In progress (see opencontainers/distribution-spec)
130-
* Description: Specify a protocol for retrieving an image from a distribution engine by the image's content-addressable hash.
130+
* Description: Specify a protocol for retrieving an [image index][image-index], [manifest][], or other [image specification][image-spec] object from a distribution engine by its content-addressable hash.
131131
* Why: Using a hash as a name is a way to ensure a unique image name without relying on a particular naming authority or system.
132132
Using hashing for name is an acceptable addition as it does not encode any centralized namespace.
133133

@@ -142,8 +142,12 @@ The following entries should remain in the [scope table][scope] but not be addre
142142
* Allows listing of manifests: docker/distribution#2199
143143

144144
[api.md]: https://github.com/docker/distribution/blob/5cb406d511b7b9163bff9b6439072e4892e5ae3b/docs/spec/api.md
145+
[catalog]: https://github.com/docker/distribution/blob/5cb406d511b7b9163bff9b6439072e4892e5ae3b/docs/spec/api.md#catalog
145146
[get-manifest]: https://github.com/docker/distribution/blob/5cb406d511b7b9163bff9b6439072e4892e5ae3b/docs/spec/api.md#pulling-an-image-manifest
146147
[iana-auth]: http://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml
148+
[image-spec]: https://github.com/opencontainers/image-spec/
149+
[image-index]: https://github.com/opencontainers/image-spec/blame/v1.0.1/image-index.md
150+
[manifest]: https://github.com/opencontainers/image-spec/blob/v1.0.1/manifest.md
147151
[manifests]: https://github.com/opencontainers/image-spec/blame/v1.0.1/image-index.md#L23
148152
[rfc6750]: https://tools.ietf.org/html/rfc6750
149153
[rfc7230]: https://tools.ietf.org/html/rfc7230

0 commit comments

Comments
 (0)