Skip to content

Commit 4b41db2

Browse files
authored
Merge pull request #225 from philips/add-tags-notes
image-layout: add explanation of the refs directory use case for tags
2 parents fe00fbf + 79d0c7f commit 4b41db2

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

image-layout.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ No semantic restriction is given for object names in the `refs` subdirectory.
4949
Each object in the `refs` subdirectory MUST be of type `application/vnd.oci.descriptor.v1+json`.
5050
In general the `mediatype` of this [descriptor][descriptors] object will be either `application/vnd.oci.image.manifest.list.v1+json` or `application/vnd.oci.image.manifest.v1+json` although future versions of the spec MAY use a different mediatype.
5151

52+
**Implementor's Note:**
53+
A common use case of refs is representing "tags" for a container image.
54+
For example, an image may have a tag for different versions or builds of the software.
55+
In the wild you often see "tags" like "v1.0.0-vendor.0", "2.0.0-debug", etc.
56+
5257
This illustrates the expected contents of a given ref, the manifest list it points to and the blobs the manifest references.
5358

5459
```

0 commit comments

Comments
 (0)