spec.md
1
# <a name="openContainerInitiativeRuntimeSpecification" />Open Container Initiative Runtime Specification
3
The [Open Container Initiative][oci] develops specifications for standards on Operating System process and application containers.
5
# <a name="ociRuntimeSpecAbstract" />Abstract
7
The Open Container Initiative Runtime Specification aims to specify the configuration, execution environment, and lifecycle of a container.
8
9
A container's configuration is specified as the `config.json` for the supported platforms and details the fields that enable the creation of a container.
10
The execution environment is specified to ensure that applications running inside a container have a consistent environment between runtimes along with common actions defined for the container's lifecycle.
11
12
# <a name="ociRuntimeSpecPlatforms" />Platforms
13
14
Platforms defined by this specification are:
15
16
* `linux`: [runtime.md](runtime.md), [config.md](config.md), [config-linux.md](config-linux.md), and [runtime-linux.md](runtime-linux.md).
17
* `solaris`: [runtime.md](runtime.md), [config.md](config.md), and [config-solaris.md](config-solaris.md).
18
* `windows`: [runtime.md](runtime.md), [config.md](config.md), and [config-windows.md](config-windows.md).
20
# <a name="ociRuntimeSpecTOC" />Table of Contents
21
22
- [Introduction](spec.md)
23
- [Notational Conventions](#notational-conventions)
24
- [Container Principles](principles.md)
25
- [Filesystem Bundle](bundle.md)
26
- [Runtime and Lifecycle](runtime.md)
27
- [Linux-specific Runtime and Lifecycle](runtime-linux.md)
28
- [Configuration](config.md)
29
- [Linux-specific Configuration](config-linux.md)
30
- [Solaris-specific Configuration](config-solaris.md)
31
- [Windows-specific Configuration](config-windows.md)
32
- [Glossary](glossary.md)
33
34
# <a name="ociRuntimeSpecNotationalConventions" />Notational Conventions
36
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119][rfc2119].
37
38
The key words "unspecified", "undefined", and "implementation-defined" are to be interpreted as described in the [rationale for the C99 standard][c99-unspecified].
39
40
An implementation is not compliant for a given CPU architecture if it fails to satisfy one or more of the MUST, REQUIRED, or SHALL requirements for the [platforms](#platforms) it implements.
41
An implementation is compliant for a given CPU architecture if it satisfies all the MUST, REQUIRED, and SHALL requirements for the [platforms](#platforms) it implements.
44
[c99-unspecified]: http://www.open-std.org/jtc1/sc22/wg14/www/C99RationaleV5.10.pdf#page=18
45
[oci]: http://www.opencontainers.org
46
[rfc2119]: http://tools.ietf.org/html/rfc2119