From daac7a3201e3451b7f79607227b0e3cdde7d044b Mon Sep 17 00:00:00 2001 From: Vincent Batts Date: Tue, 1 Nov 2016 12:44:36 -0400 Subject: [PATCH] image-layout: clarification of oci-layout 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 --- image-layout.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/image-layout.md b/image-layout.md index 739a0c9a3..d4a09083f 100644 --- a/image-layout.md +++ b/image-layout.md @@ -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: