Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 2.24 KB

bundle.md

File metadata and controls

30 lines (22 loc) · 2.24 KB
Raw

Filesystem Bundle

Container Format

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. See also OS X application bundles for a similar use of the term bundle.

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

A Standard Container bundle contains all the information needed to load and run a container. This includes the following three artifacts which MUST all reside in the same directory on the local filesystem:

  1. config.json : contains host-independent configuration data. This REQUIRED file, which MUST be named config.json, contains settings that are host-independent and application-specific such as security permissions, environment variables and arguments. When the bundle is packaged up for distribution, this file MUST be included. See config.json for more details.

  2. runtime.json : contains host-specific configuration data. This REQUIRED file, which MUST be named runtime.json, contains settings that are host-specific such as mount sources and hooks. The goal is that the bundle can be moved as a unit to another runtime and run the same application once a host-specific runtime.json is defined. When the bundle is packaged up for distribution, this file MUST NOT be included. See runtime.json for more details.

  3. A directory representing the root filesystem of the container. While the name of this REQUIRED directory may be arbitrary, users should consider using a conventional name, such as rootfs. When the bundle is packaged up for distribution, this directory MUST be included. This directory MUST be referenced from within the config.json file.

While these three artifacts MUST all be present in a single directory on the local filesystem, that directory itself is not part of the bundle. 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.