jasder
/
runc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
runc/spec.md

47 lines
2.7 KiB
Markdown
Raw Normal View History

Add anchors to misc. docs Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2017-03-03 03:01:18 +08:00
# <a name="openContainerInitiativeRuntimeSpecification" />Open Container Initiative Runtime Specification
Cleanup the spec a bit to remove WG/git text that's not really part of the spec renamed an href to "container-namespace2" to avoid a dup-warning msg from the PDF generator Signed-off-by: Doug Davis <dug@us.ibm.com>
2016-11-14 22:37:11 +08:00
make link usage consistent across the specification Signed-off-by: Jesse Butler <jesse.butler@oracle.com>
2017-02-10 04:32:39 +08:00
The [Open Container Initiative][oci] develops specifications for standards on Operating System process and application containers.
Cleanup the spec a bit to remove WG/git text that's not really part of the spec renamed an href to "container-namespace2" to avoid a dup-warning msg from the PDF generator Signed-off-by: Doug Davis <dug@us.ibm.com>
2016-11-14 22:37:11 +08:00
Add anchors to misc. docs Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2017-03-03 03:01:18 +08:00
# <a name="ociRuntimeSpecAbstract" />Abstract
Add OCI Runtime Abstract Closes #506 Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-02-16 08:13:55 +08:00
spec.md: small fix Signed-off-by: Ma Shimiao <mashimiao.fnst@cn.fujitsu.com>
2017-03-13 16:18:25 +08:00
The OCI Runtime Specification aims to specify the configuration, execution environment, and lifecycle of a container.
Add OCI Runtime Abstract Closes #506 Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-02-16 08:13:55 +08:00
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.
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.
Add anchors to misc. docs Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2017-03-03 03:01:18 +08:00
# <a name="ociRuntimeSpecPlatforms" />Platforms
config: Link platform:"..." JSON tags with platform slugs So that the semantics of the tags are clear. The platform/protocol disconnect is unfortunate. "Protocol" was chosen in de3f1af6 (Remove language around Solaris being optional as it is covered in compliance language, 2016-08-17, #527) because we may have compliance subsets that aren't linked to platforms [1]. I'd be open to renaming the JSON tag from platform:"..." -> protocol:"...", but that's probably more change than it's worth. The approach taken in this commit, on the other hand, renames "protocol" to "platform". I think that unnecessarily limits (or sets up confusing semantics for) the platform/protocol values you can use, but two maintainers both prefer "platform" [2,3]. [1]: https://github.com/opencontainers/runtime-spec/pull/527#issuecomment-238979250 [2]: https://github.com/opencontainers/runtime-spec/pull/570#discussion_r99227202 [3]: https://github.com/opencontainers/runtime-spec/pull/570#discussion_r100013014 Signed-off-by: W. Trevor King <wking@tremily.us>
2016-09-15 23:26:13 +08:00
Platforms defined by this specification are:
spec: Slug protocol names We'll be referring to these in code, and using a slug everywhere avoids having to define both a slug form (linux) and an English form (Linux containers). Signed-off-by: W. Trevor King <wking@tremily.us>
2016-09-15 23:55:00 +08:00
* `linux`: [runtime.md](runtime.md), [config.md](config.md), [config-linux.md](config-linux.md), and [runtime-linux.md](runtime-linux.md).
* `solaris`: [runtime.md](runtime.md), [config.md](config.md), and [config-solaris.md](config-solaris.md).
* `windows`: [runtime.md](runtime.md), [config.md](config.md), and [config-windows.md](config-windows.md).
Cleanup the spec a bit to remove WG/git text that's not really part of the spec renamed an href to "container-namespace2" to avoid a dup-warning msg from the PDF generator Signed-off-by: Doug Davis <dug@us.ibm.com>
2016-11-14 22:37:11 +08:00
Add anchors to misc. docs Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2017-03-03 03:01:18 +08:00
# <a name="ociRuntimeSpecTOC" />Table of Contents
Cleanup the spec a bit to remove WG/git text that's not really part of the spec renamed an href to "container-namespace2" to avoid a dup-warning msg from the PDF generator Signed-off-by: Doug Davis <dug@us.ibm.com>
2016-11-14 22:37:11 +08:00
- [Introduction](spec.md)
- [Notational Conventions](#notational-conventions)
- [Container Principles](principles.md)
- [Filesystem Bundle](bundle.md)
- [Runtime and Lifecycle](runtime.md)
- [Linux-specific Runtime and Lifecycle](runtime-linux.md)
- [Configuration](config.md)
- [Linux-specific Configuration](config-linux.md)
- [Solaris-specific Configuration](config-solaris.md)
- [Windows-specific Configuration](config-windows.md)
- [Glossary](glossary.md)
Add anchors to misc. docs Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2017-03-03 03:01:18 +08:00
# <a name="ociRuntimeSpecNotationalConventions" />Notational Conventions
Cleanup the spec a bit to remove WG/git text that's not really part of the spec renamed an href to "container-namespace2" to avoid a dup-warning msg from the PDF generator Signed-off-by: Doug Davis <dug@us.ibm.com>
2016-11-14 22:37:11 +08:00
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][rfc2119].
The key words "unspecified", "undefined", and "implementation-defined" are to be interpreted as described in the [rationale for the C99 standard][c99-unspecified].
config: Link platform:"..." JSON tags with platform slugs So that the semantics of the tags are clear. The platform/protocol disconnect is unfortunate. "Protocol" was chosen in de3f1af6 (Remove language around Solaris being optional as it is covered in compliance language, 2016-08-17, #527) because we may have compliance subsets that aren't linked to platforms [1]. I'd be open to renaming the JSON tag from platform:"..." -> protocol:"...", but that's probably more change than it's worth. The approach taken in this commit, on the other hand, renames "protocol" to "platform". I think that unnecessarily limits (or sets up confusing semantics for) the platform/protocol values you can use, but two maintainers both prefer "platform" [2,3]. [1]: https://github.com/opencontainers/runtime-spec/pull/527#issuecomment-238979250 [2]: https://github.com/opencontainers/runtime-spec/pull/570#discussion_r99227202 [3]: https://github.com/opencontainers/runtime-spec/pull/570#discussion_r100013014 Signed-off-by: W. Trevor King <wking@tremily.us>
2016-09-15 23:26:13 +08:00
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.
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.
Cleanup the spec a bit to remove WG/git text that's not really part of the spec renamed an href to "container-namespace2" to avoid a dup-warning msg from the PDF generator Signed-off-by: Doug Davis <dug@us.ibm.com>
2016-11-14 22:37:11 +08:00
make link usage consistent across the specification Signed-off-by: Jesse Butler <jesse.butler@oracle.com>
2017-02-10 04:32:39 +08:00
Cleanup the spec a bit to remove WG/git text that's not really part of the spec renamed an href to "container-namespace2" to avoid a dup-warning msg from the PDF generator Signed-off-by: Doug Davis <dug@us.ibm.com>
2016-11-14 22:37:11 +08:00
[c99-unspecified]: http://www.open-std.org/jtc1/sc22/wg14/www/C99RationaleV5.10.pdf#page=18
make link usage consistent across the specification Signed-off-by: Jesse Butler <jesse.butler@oracle.com>
2017-02-10 04:32:39 +08:00
[oci]: http://www.opencontainers.org
Cleanup the spec a bit to remove WG/git text that's not really part of the spec renamed an href to "container-namespace2" to avoid a dup-warning msg from the PDF generator Signed-off-by: Doug Davis <dug@us.ibm.com>
2016-11-14 22:37:11 +08:00
[rfc2119]: http://tools.ietf.org/html/rfc2119