From b76270ecf82bfe04b0ed16b27210e359672eeeac Mon Sep 17 00:00:00 2001 From: "Rob Dolin (MSFT)" Date: Wed, 24 Aug 2016 06:56:50 -0700 Subject: [PATCH] [ReadMe] Adds boilerplate MUST, MAY, etc. language Signed-off-by: Rob Dolin --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 39897e82f..1fa0eef84 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ The OCI Image Format project creates and maintains the software shipping contain This specification defines how to create an OCI Image, which will generally be done by a build system, and output an [image manifest](manifest.md), a [filesystem serialization](serialization.md), and an [image configuration](serialization.md#image-json-description). At a high level the image manifest contains metadata about the contents and dependencies of the image including the content-addressable identity of one or more filesystem serialization archives that will be unpacked to make up the final runnable filesystem. The image configuration includes information such as application arguments, environments, etc. The combination of the image manifest, image configuration, and one or more filesystem serializations is called the "OCI Image". +The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997). + ![](img/build-diagram.png) Once built the OCI Image can then discovered by name, downloaded, verified by hash, trusted through a signature, and unpacked into an [OCI Runtime Bundle](https://github.com/opencontainers/runtime-spec/blob/master/bundle.md).