Skip to content

Commit 2fd5ad6

Browse files
committed
Merge pull request #107 from wking/glossary
glossary: Provide a quick overview of important terms
2 parents d09cc0a + 0f9ec22 commit 2fd5ad6

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Table of Contents
1515
- [Runtime and Lifecycle](runtime.md)
1616
- [Linux Specific Runtime](runtime-linux.md)
1717
- [Implementations](implementations.md)
18+
- [Glossary](glossary.md)
1819

1920
In the specifications in the above table of contents, 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).
2021

glossary.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Glossary
2+
3+
## Bundle
4+
5+
A [directory structure](bundle.md) that is written ahead of time, distributed, and used to seed the runtime for creating a [container](#container) and launching a process within it.
6+
7+
## Configuration
8+
9+
The [`config.json`](config.md) and [`runtime.json`](runtime-config.md) files in a [bundle](#bundle) which define the intended [container](#container) and container process.
10+
11+
## Container
12+
13+
An environment for executing processes with configurable isolation and resource limitations.
14+
For example, namespaces, resource limits, and mounts are all part of the container environment.
15+
16+
## JSON
17+
18+
All configuration [JSON][] MUST be encoded in [UTF-8][].
19+
20+
## Runtime
21+
22+
An implementation of this specification.
23+
It reads the [configuration files](#configuration) from a [bundle](#bundle), uses that information to create a [container](#container), launches a process inside the container, and performs other [lifecycle actions](runtime.md).
24+
25+
[JSON]: http://json.org/
26+
[UTF-8]: http://www.unicode.org/versions/Unicode8.0.0/ch03.pdf

0 commit comments

Comments
 (0)