Skip to content

Commit

Permalink
glossary: Provide a quick overview of important terms
Browse files Browse the repository at this point in the history
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]: #88 (comment)

Signed-off-by: W. Trevor King <wking@tremily.us>
  • Loading branch information
wking committed Aug 11, 2015
1 parent da9240a commit 5fc03cf
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Table of Contents
- [Linux Specific Configuration](config-linux.md)
- [Runtime and Lifecycle](runtime.md)
- [Implementations](implementations.md)
- [Glossary](glossary.md)

## Use Cases

Expand Down
22 changes: 22 additions & 0 deletions glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Glossary

## Application

A process tree launched inside a [container](#container).

## Bundle

A [directory structure](bundle.md) that is written ahead of time, distributed, and used to seed the runtime for creating [containers](#container) and launching [applications](#application).

## Configuration

A [file](config.md) in a [bundle](#bundle) which defines the intended [container](#container) and [application](#application).

## Container

An environment setup for the [application](#application) (namespaces, resource limits, mounts, …).

## Runtime

An implementation of this specification.
It reads a [configuration file](#configuration) from a [bundle](#bundle), uses that information to create a [container](#container), and launches an [application](#application) inside the container.

0 comments on commit 5fc03cf

Please sign in to comment.