Skip to content

Commit 9289afe

Browse files
author
Brandon Philips
committed
README: add runtime, bundle, and hook author user
Lets call out some users directly and give them titles. Then define what they is trying to do. Signed-off-by: Brandon Philips <[email protected]>
1 parent bcb459c commit 9289afe

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,20 @@ In the specifications in the above table of contents, the keywords "MUST", "MUST
2222

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

25-
#### Filesystem Bundle & Configuration
25+
#### Application Bundle Builders
2626

27-
- 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.
27+
Application bundle builders can create a [bundle](bundle.md) directory that includes all of the files required for launching an application as a container.
28+
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).
29+
Because the configuration includes host-specific settings, application bundle directories copied between two hosts may require configuration adjustments.
2830

31+
#### Hook Developers
32+
33+
[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.
34+
Example use cases include sophisticated network configuration, volume garbage collection, etc.
35+
36+
#### Runtime Developers
37+
38+
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.
2939

3040
# Releases
3141

0 commit comments

Comments
 (0)