Skip to content

Commit

Permalink
image-layout: clarification of oci-layout
Browse files Browse the repository at this point in the history
The section for this file was too crammed together. Breaking it out into
individual items allows for more straightforward validation.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
  • Loading branch information
vbatts committed Nov 1, 2016
1 parent 5dbe4a3 commit daac7a3
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions image-layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,12 @@ The image layout has two top level directories:
- "refs" contains [descriptors][descriptors]. Commonly pointing to an [image manifest](manifest.md#image-manifest) or an [image manifest list](manifest-list.md#oci-image-manifest-list-specification).


It also contains a file that is used to identify the layout version:
The image layout MUST contain a file "oci-layout":

- "oci-layout" MUST contain a JSON object with a version field `{"imageLayoutVersion": "1.0.0"}` and MAY include additional fields.
- It MUST be a JSON object
- It MUST contain a `imageLayoutVersion` field for determing the version of the layout used
- The `imageLayoutVersion` value will align with the `specs.Version` at the time changes to the layout are made, and will pin a given version until changes to the layout are required
- It MAY include additional fields

This is an example image layout:

Expand Down

0 comments on commit daac7a3

Please sign in to comment.