From 9c333aa6db3103bf10b959cbafb3416e2ffe1dc4 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 92d96c5c4..daba81f72 100644 --- a/image-layout.md +++ b/image-layout.md @@ -18,9 +18,12 @@ The image layout MUST contain two top level directories: Both `blobs` and `refs` MAY be empty. -The image layout MUST also contain a file that is used to identify the layout version: +The image layout MUST also contain an `oci-layout` file: -- `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 an `imageLayoutVersion` field + - The `imageLayoutVersion` value will align with the OCI Image Specification 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: