|
1 | | -# Filesystem Bundle |
| 1 | +[[bundle,bundle]] |
| 2 | +Filesystem Bundle |
| 3 | +----------------- |
2 | 4 |
|
3 | | -## Container Format |
| 5 | +:os-x-bundle: http://en.wikipedia.org/wiki/Bundle_%28OS_X%29 |
4 | 6 |
|
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_. |
7 | 9 |
|
8 | 10 | 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. |
9 | 11 |
|
10 | 12 | A Standard Container bundle contains all the information needed to load and run a container. |
11 | 13 | This MUST include the following artifacts: |
12 | 14 |
|
13 | 15 | 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. |
16 | 18 |
|
17 | 19 | 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. |
20 | 22 |
|
21 | 23 | 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. |
0 commit comments