Skip to content

Commit

Permalink
clarification about nested index
Browse files Browse the repository at this point in the history
Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
  • Loading branch information
AkihiroSuda committed Nov 25, 2017
1 parent 577479e commit c4c9dec
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 1 deletion.
4 changes: 4 additions & 0 deletions image-index.md
Expand Up @@ -34,6 +34,10 @@ For the media type(s) that this document is compatible with, see the [matrix][ma

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

Also, implementations SHOULD support the following media types:

- `application/vnd.oci.image.index.v1+json` (nested index)

Image indexes concerned with portability SHOULD use one of the above media types.
Future versions of the spec MAY use a different mediatype (i.e. a new versioned format).
An encountered `mediaType` that is unknown SHOULD be safely ignored.
Expand Down
6 changes: 5 additions & 1 deletion image-layout.md
Expand Up @@ -199,7 +199,11 @@ Those tags will often be represented in an image-layout repository with matching
}
```

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

The first named reference (`stable-release`) points to another index that might contain multiple references with distinct platforms and annotations.
Note that the [`org.opencontainers.image.ref.name` annotation](annotations.md) SHOULD only be considered valid when on descriptors on `index.json`.

The second named reference (`v1.0`) points to a manifest that is specific to the linux/ppc64le platform.

[descriptors]: ./descriptor.md
1 change: 1 addition & 0 deletions img/media-types.dot
Expand Up @@ -6,6 +6,7 @@ digraph G {
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"]
}

imageIndex -> imageIndex [label="1..*"]
imageIndex -> manifest [label="1..*"]
manifest -> config [label="1..1"]
manifest -> layer [label="1..*"]
Expand Down
Binary file modified img/media-types.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c4c9dec

Please sign in to comment.