Skip to content

Commit a2fa9b2

Browse files
committed
clarification about nested index
Signed-off-by: Akihiro Suda <[email protected]>
1 parent 89b51c7 commit a2fa9b2

File tree

4 files changed

+10
-1
lines changed

4 files changed

+10
-1
lines changed

image-index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ For the media type(s) that this document is compatible with, see the [matrix][ma
3434

3535
- [`application/vnd.oci.image.manifest.v1+json`](manifest.md)
3636

37+
Also, implementations SHOULD support the following media types:
38+
39+
- `application/vnd.oci.image.index.v1+json` (nested index)
40+
3741
Image indexes concerned with portability SHOULD use one of the above media types.
3842
Future versions of the spec MAY use a different mediatype (i.e. a new versioned format).
3943
An encountered `mediaType` that is unknown SHOULD be safely ignored.

image-layout.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,11 @@ Those tags will often be represented in an image-layout repository with matching
199199
}
200200
```
201201

202-
This illustrates an index that provides two named manifest references and an auxiliary mediatype for this image layout.
202+
This illustrates an index that provides two named references and an auxiliary mediatype for this image layout.
203203

204+
The first named reference (`stable-release`) points to another index that might contain multiple references with distinct platforms and annotations.
205+
Note that the [`org.opencontainers.image.ref.name` annotation](annotations.md) SHOULD only be considered valid when on descriptors on `index.json`.
206+
207+
The second named reference (`v1.0`) points to a manifest that is specific to the linux/ppc64le platform.
204208

205209
[descriptors]: ./descriptor.md

img/media-types.dot

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ digraph G {
66
layer [shape=note, label="Layer tar archive\napplication/vnd.oci.image.layer.v1.tar\napplication/vnd.oci.image.layer.v1.tar+gzip\napplication/vnd.oci.image.layer.nondistributable.v1.tar\napplication/vnd.oci.image.layer.nondistributable.v1.tar+gzip"]
77
}
88

9+
imageIndex -> imageIndex [label="1..*"]
910
imageIndex -> manifest [label="1..*"]
1011
manifest -> config [label="1..1"]
1112
manifest -> layer [label="1..*"]

img/media-types.png

1.79 KB
Loading

0 commit comments

Comments
 (0)