Skip to content

bundle.md: various updates to latest spec #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 6, 2015
Merged

bundle.md: various updates to latest spec #55

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91f5ad7
bundle.md: various updates to latest spec
jonboulle Jul 3, 2015
112dcbb
bundle.md: clarify arbitrary/conventional dirnames
jonboulle Jul 3, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions bundle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link

@stevvooe stevvooe Jul 3, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we name this rootfs by convention or is the the specified name for this directory? Do we need to clarify that above? Perhaps a note that explains these names are a convention is required.

Copy link
Contributor Author

@jonboulle jonboulle Jul 3, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stevvooe If my understanding is correct and bundles only support a single rootfs directory then it seems to me like the natural next step would just be standardising/mandating its location at a well-known path. /cc @philips @crosbymichael

Copy link
Contributor Author

@jonboulle jonboulle Jul 3, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(in the meantime I'll add a note on convention, that would clarify "sigs" as well ;-)

!
--- rootfs2
--- sigs
Copy link

@stevvooe stevvooe Jul 3, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

signatures. No need for brevity ;).

```

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.