Skip to content

Commit cc8438b

Browse files
committed
glossary: Provide a quick overview of important terms
And link them to the more detailed specification. This borrows from appc, which calls the launched process tree "the app" [1]. I don't see a point to abbreviating it, so I've gone with "application". Subsection titles for the entries will be obnoxiously spacious, but the other alternatives seem worse: a. An HTML definition list (<dl>) would have nice default styling, but it's annoying to write raw HTML. And we would have needed something like: <dt name="bundle">Bundle</dt> <dd> A [directory structure](bundle.md) that is... </dd> to get Markdown-style links in the defintion itself. b. A Markdown list (* ...) would have reasonable default styling, but there's no Markdown syntax for adding anchors to the entries. And a glossary is much less useful if you can't link to a specific entry. [1]: opencontainers#88 (comment) Signed-off-by: W. Trevor King <wking@tremily.us>
1 parent 03bf64f commit cc8438b

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-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
# Use Cases
2021

glossary.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Glossary
2+
3+
## Application
4+
5+
A process tree launched inside a [container](#container).
6+
7+
## Bundle
8+
9+
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 an [application](#application).
10+
11+
## Configuration
12+
13+
The [`config.json`](config.md) and [`runtime.json`](runtime-config.md) files in a [bundle](#bundle) which define the intended [container](#container) and [application](#application).
14+
15+
## Container
16+
17+
An environment setup for the [application](#application) (namespaces, resource limits, mounts, …).
18+
19+
## Runtime
20+
21+
An implementation of this specification.
22+
It reads the [configuration files](#configuration) from a [bundle](#bundle), uses that information to create a [container](#container), launches an [application](#application) inside the container, and performs other [lifecycle actions](runtime.md).

0 commit comments

Comments
 (0)