1# <a name="filesystemBundle" />Filesystem Bundle
2
3## <a name="containerFormat" />Container Format
4
5This 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.
6See also [MacOS application bundles][macos_bundle] for a similar use of the term *bundle*.
7
8The 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
10A Standard Container bundle contains all the information needed to load and run a container.
11This includes the following artifacts:
12
131. <a name="containerFormat01" />`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
172. <a name="containerFormat02" />container's root filesystem: the directory referenced by [`root.path`](config.md#root), if that property is set in `config.json`.
18
19When supplied, while these artifacts MUST all be present in a single directory on the local filesystem, that directory itself is not part of the bundle.
20In 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.
21
22[macos_bundle]: https://en.wikipedia.org/wiki/Bundle_%28macOS%29
View as plain text