From 91f5ad7cfa85b606236aa2243565260f5f845881 Mon Sep 17 00:00:00 2001 From: Jonathan Boulle Date: Thu, 2 Jul 2015 17:36:09 -0700 Subject: [PATCH 1/2] bundle.md: various updates to latest spec - Move to single root filesystem, as the configuration specification now only supports a single process - Clarify that signatures are just another kind of content directory - Cross-reference configuration specification for config.json --- bundle.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/bundle.md b/bundle.md index 897ad4db..86c639c0 100644 --- a/bundle.md +++ b/bundle.md @@ -12,20 +12,19 @@ A standard container bundle is made of the following 3 parts: # Directory layout -A Standard Container bundle is a directory containing all the content needed to load and run a container. This includes its configuration file, content directories, and cryptographic signatures. The main property of this directory layout is that it can be moved as a unit to another machine and run the same container. +A Standard Container bundle is a directory containing all the content needed to load and run a container. This includes its configuration file (`config.json`) and content directories. The main property of this directory layout is that it can be moved as a unit to another machine and run the same container. -One or more *content directories* may be adjacent to the configuration file. This at least includes the root filesystem (referenced in the configuration by the *rootfs* field) and other related content (signatures, other configs, etc.). The interpretation of these resources is specified in the configuration. +The syntax and semantics for `config.json` are described in [this specification](config.md). + +One or more *content directories* may be adjacent to the configuration file. This must include at least the root filesystem (referenced in the configuration file by the *root* field) and may include other related content (signatures, other configs, etc.). The interpretation of these resources is specified in the configuration. ``` / ! -- config.json ! ---- rootfs1 +--- rootfs ! ---- rootfs2 +--- sigs ``` -The syntax and semantics for config.json are described in this specification. - -One or more content directories can be specified as root file systems for containers. They COULD be called rootfs..10^100 but SHALL be called whatever you want. From 112dcbb6a9c495163c7f26378bcae40a61be5ff5 Mon Sep 17 00:00:00 2001 From: Jonathan Boulle Date: Thu, 2 Jul 2015 17:50:49 -0700 Subject: [PATCH 2/2] bundle.md: clarify arbitrary/conventional dirnames Add a note describing that the names of directories in the bundle are arbitrary and referenced from the configuration, but conventional names (like "rootfs" and "signatures") should be used. --- bundle.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/bundle.md b/bundle.md index 86c639c0..1948e486 100644 --- a/bundle.md +++ b/bundle.md @@ -16,7 +16,7 @@ A Standard Container bundle is a directory containing all the content needed to The syntax and semantics for `config.json` are described in [this specification](config.md). -One or more *content directories* may be adjacent to the configuration file. This must include at least the root filesystem (referenced in the configuration file by the *root* field) and may include other related content (signatures, other configs, etc.). The interpretation of these resources is specified in the configuration. +One or more *content directories* may be adjacent to the configuration file. This must include at least the root filesystem (referenced in the configuration file by the *root* field) and may include other related content (signatures, other configs, etc.). The interpretation of these resources is specified in the configuration. The names of the directories may be arbitrary, but users should consider using conventional names as in the example below. ``` / @@ -25,6 +25,6 @@ One or more *content directories* may be adjacent to the configuration file. Thi ! --- rootfs ! ---- sigs +--- signatures ```