Skip to content

Commit b8b91c6

Browse files
committed
bundle: Transition from Markdown to AsciiDoc
This gets a title [1] with an anchor [2], and the old *...* becomes _..._ [3]. I've also dropped the separate "Container Format" header because it didn't seem to be adding any useful information. [1]: http://asciidoc.org/userguide.html#X17 Titles [2]: http://asciidoc.org/userguide.html#X30 anchor [3]: http://asciidoc.org/userguide.html#X51 10.1. Quoted Text Signed-off-by: W. Trevor King <[email protected]>
1 parent 6a186c5 commit b8b91c6

File tree

3 files changed

+14
-10
lines changed

3 files changed

+14
-10
lines changed
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
1-
# Filesystem Bundle
1+
[[bundle,bundle]]
2+
Filesystem Bundle
3+
-----------------
24

3-
## Container Format
5+
:os-x-bundle: http://en.wikipedia.org/wiki/Bundle_%28OS_X%29
46

5-
This section defines a format for encoding a container as a *filesystem bundle* - a set of files organized in a certain way, and containing all the necessary data and metadata for any compliant runtime to perform all standard operations against it.
6-
See also [OS X application bundles](http://en.wikipedia.org/wiki/Bundle_%28OS_X%29) for a similar use of the term *bundle*.
7+
This section defines a format for encoding a container as a _filesystem bundle_ - a set of files organized in a certain way, and containing all the necessary data and metadata for any compliant runtime to perform all standard operations against it.
8+
See also {os-x-bundle}[OS X application bundles] for a similar use of the term _bundle_.
79

810
The definition of a bundle is only concerned with how a container, and its configuration data, are stored on a local filesystem so that it can be consumed by a compliant runtime.
911

1012
A Standard Container bundle contains all the information needed to load and run a container.
1113
This MUST include the following artifacts:
1214

1315
1. `config.json`: contains configuration data.
14-
This REQUIRED file MUST reside in the root of the bundle directory and MUST be named `config.json`.
15-
See [`config.json`](config.md) for more details.
16+
This REQUIRED file MUST reside in the root of the bundle directory and MUST be named `config.json`.
17+
See `<<config>>` for more details.
1618
1719
2. A directory representing the root filesystem of the container.
18-
While the name of this REQUIRED directory may be arbitrary, users should consider using a conventional name, such as `rootfs`.
19-
This directory MUST be referenced from within the `config.json` file.
20+
While the name of this REQUIRED directory may be arbitrary, users should consider using a conventional name, such as `rootfs`.
21+
This directory MUST be referenced from within the `config.json` file.
2022
2123
While these artifacts MUST all be present in a single directory on the local filesystem, that directory itself is not part of the bundle.
22-
In other words, a tar archive of a *bundle* will have these artifacts at the root of the archive, not nested within a top-level directory.
24+
In other words, a tar archive of a _bundle_ will have these artifacts at the root of the archive, not nested within a top-level directory.

oci-runtime-spec.asc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,5 @@ include::use-cases.asc[]
1717
include::definitions.asc[]
1818

1919
include::protocols.asc[]
20+
21+
include::bundle.asc[]

use-cases.asc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To provide context for users the following section gives example use cases for e
66
Application Bundle Builders
77
~~~~~~~~~~~~~~~~~~~~~~~~~~~
88

9-
Application bundle builders can create a `<<bundle>>` directory that includes all of the files required for launching an application as a container.
9+
Application bundle builders can create a <<bundle>> directory that includes all of the files required for launching an application as a container.
1010
The bundle contains an OCI `<<config>>` where the builder can specify host-independent details such as `<<process.args,which executable to launch>>` and host-specific settings such as `<<mounts>>`, `<<hooks>>`, `<<linux-namespaces>>` and `<<cgroups>>`.
1111
Because the configuration includes host-specific settings, application bundle directories copied between two hosts may require configuration adjustments.
1212

0 commit comments

Comments
 (0)