Skip to content

Carry pr497 #559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stevvooe merged 2 commits into from
Feb 10, 2017
Merged

Carry pr497 #559

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8022da
[Spec.md] Split title onto two lines
RobDolinMS Dec 14, 2016
51d3d1a
spec: step down the headings
vbatts Feb 8, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Open Container Initiative Image Format Specification
# Open Container Initiative
## Image Format Specification

This specification defines an OCI Image, consisting of a [manifest](manifest.md), a [manifest list](manifest-list.md) (optional), a set of [filesystem layers](layer.md), and a [configuration](config.md).

The goal of this specification is to enable the creation of interoperable tools for building, transporting, and preparing a container image to run.

## Table of Contents
### Table of Contents

- [Introduction](spec.md)
- [Notational Conventions](#notational-conventions)
Expand All @@ -22,7 +23,7 @@ The goal of this specification is to enable the creation of interoperable tools
- [Extensibility](considerations.md#extensibility)
- [Canonicalization](considerations.md#canonicalization)

# Notational Conventions
## Notational Conventions

The key words "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).

Expand All @@ -31,7 +32,7 @@ The key words "unspecified", "undefined", and "implementation-defined" are to be
An implementation is not compliant if it fails to satisfy one or more of the MUST, REQUIRED, or SHALL requirements for the protocols it implements.
An implementation is compliant if it satisfies all the MUST, REQUIRED, and SHALL requirements for the protocols it implements.

# Overview
## Overview

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 layer changeset](layer.md) archives that will be unpacked to make up the final runnable filesystem.
The image configuration includes information such as application arguments, environments, etc.
Expand All @@ -44,7 +45,7 @@ Once built the OCI Image can then be discovered by name, downloaded, verified by

![](img/run-diagram.png)

## Understanding the Specification
### Understanding the Specification

The [OCI Image Media Types](media-types.md) document is a starting point to understanding the overall structure of the specification.

Expand Down