Skip to content

Commit

Permalink
Merge pull request #280 from philips/try-and-add-some-use-cases
Browse files Browse the repository at this point in the history
README: add some user stories
  • Loading branch information
vishh committed Jan 19, 2016
2 parents ec7ca91 + 9289afe commit 72e7cf9
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,20 @@ In the specifications in the above table of contents, the keywords "MUST", "MUST

To provide context for users the following section gives example use cases for each part of the spec.

## Filesystem Bundle & Configuration
#### Application Bundle Builders

- A user can create a root filesystem and configuration, with low-level OS and host specific details, and launch it as a container under an Open Container runtime.
Application bundle builders can create a [bundle](bundle.md) directory that includes all of the files required for launching an application as a container.
The bundle contains OCI [configuration files](config.md) where the builder can specify host-independent details such as [which executable to launch](config.md#process-configuration) and host-specific settings such as [mount](runtime-config.md#mount-configuration) locations, [hook](runtime-config.md#hooks) paths, Linux [namespaces](runtime-config-linux.md#namespaces) and [cgroups](runtime-config-linux.md#control-groups).
Because the configuration includes host-specific settings, application bundle directories copied between two hosts may require configuration adjustments.

#### Hook Developers

[Hook](runtime-config.md#hooks) developers can extend the functionality of an OCI-compliant runtime by hooking into a container's lifecycle with an external application.
Example use cases include sophisticated network configuration, volume garbage collection, etc.

#### Runtime Developers

Runtime developers can build runtime implementations that run OCI-compliant bundles and container configuration, containing low-level OS and host specific details, on a particular platform.

# Releases

Expand Down

0 comments on commit 72e7cf9

Please sign in to comment.