Commit Graph

24 Commits

Author SHA1 Message Date
Mrunal Patel bf52e72391 Merge pull request #139 from cloudfoundry-incubator/master
Fix links to go files in config.md
2015-09-03 15:04:48 -07:00
Will Pragnell d67689f0e2 config: fix links to go files 2015-09-03 10:18:35 +01:00
Alexander Morozov c18c283a17 Change layout of mountpoints and mounts
Added info about MountPoints to config.md.

Signed-off-by: Alexander Morozov <lk4d4@docker.com>

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-09-02 21:04:44 -07:00
Mrunal Patel e9cb5644fa Merge pull request #124 from wking/example-additional-gids
config: Add example additionalGids
2015-08-29 13:14:52 -07:00
W. Trevor King 10aa5f20c5 config: Add example cwd
The field is optional, but it's nice to have at least one example of
it in use.

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-08-28 22:19:26 -07:00
W. Trevor King 3f4125c3de config: Add example additionalGids
The field is optional, but it's nice to have at least one example of
it in use.  The GIDs I've chosen are currently "tty" and "disk" on
Gentoo (1 is "bin"), which may be remotely reasonable choices, but the
values we're using don't really matter without an example filesystem
to provide context.

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-08-28 22:17:36 -07:00
Brandon Philips 7232e4b137 specs: introduce the concept of a runtime.json
Based on our discussion in-person yesterday it seems necessary to
separate the concept of runtime configuration from application
configuration. There are a few motivators:

- To support runtime updates of things like cgroups, rlimits, etc we
  should separate things that are inherently runtime specific from
  things that are static to the application running in the container.

- To support the goal of being able to move a bundle between hosts we
  should make it clear what parts of the spec are and are not portable
  between hosts so that upon landing on a new host the non-portable
  options may be rewritten or removed.

- In order to attach a cryptographic identity to a bundle we must not
  include details in the bundle that are host specific.
2015-08-26 09:44:09 -07:00
Jonathan Rudenberg 19cb6c7de9 Fix Windows path escaping in example mount JSON 2015-07-07 17:52:27 +00:00
Jonathan Boulle 625798536e config: minor cleanup
- link to official SemVer page
- link between config.md and config-linux.md and explain relationship
- fix typo (arch -> os)
- tweak formatting of some special characters
2015-07-06 17:37:01 -07:00
Jonathan Boulle 7f2ff75576 config.md: update links to spec schema code 2015-07-02 14:18:26 -07:00
Jonathan Boulle bd2fd1a8df config.md: various cleanup/consistency fixes
- standardise on "filesystem" instead of the previous mix of "file
  system" and "filesystem"
- change "Machine-specific" to the more accurate "Platform-specific"
- move towards zeroth article for all field specifications
- grammar tweaks
2015-07-01 11:43:43 -07:00
Jonathan Boulle 1937c009ea *: small spelling fixes 2015-07-01 10:20:43 -07:00
Jonathan Boulle 2f854b20dd config.md: minor clean up of process specification
- Standardise on singular rather than plural
- Small formatting fixes
2015-07-01 09:58:39 -07:00
Brandon Philips 7b43ad727c config.md: make the version field example a semver 2015-06-30 17:48:05 -07:00
Michael Crosby b3918a259f Add bind mount example
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-06-30 16:08:52 -07:00
Brandon Philips 9c90ccdb93 config.md: make the version a semver
As suggested in #15 make this a semver so we have some interpretation of
compatibility.
2015-06-30 16:02:52 -07:00
Michael Crosby 8af3eb64b2 Specific platform specific user struct for spec
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-06-30 15:58:47 -07:00
Brandon Philips 929123342e config.md: clarify destination for mounts
leave room for bind mounts by specifying how dest is interpretted.
2015-06-30 15:43:47 -07:00
Brandon Philips 7ac41c699c config.md: reformat into a standard style
Cleanup all of the properties into a consistent style for readability
and easier additions later.
2015-06-30 15:17:32 -07:00
Brandon Philips 106bc8ebb2 config: cleanup language on readonly parameter 2015-06-30 14:40:56 -07:00
Michael Crosby 8865d1cebc Fix root object keys
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-06-30 14:37:18 -07:00
Michael Crosby 9eb09f9593 Move linux specific options to linux spec
This moves some of the linux specific options like namespaces and
devices to the linux config document.  It also removes processes as an
array and replaces it with a single process.

It adds the "platform" struct for OS and Arch and updates many of the
examples to match the changes.  I also remove some of the redundant
windows examples on the portable spec document because they did not add
any extra value and many values were the same.

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2015-06-29 14:15:33 -07:00
lizf-os ecb7590cc0 Fix typos in config.md
- Fix some typos
- Move the example of hostname above "Resource Constraints"

Signed-off-by: Zefan Li <lizefan@huawei.com>
2015-06-29 10:41:24 +08:00
Brandon Philips 5d2eb180f6 *: re-org the spec
We had an in-person spec discussion, lets separate the spec into some
high-level sections to clarify future discussion.

Crosby agreed to let me merge to master :)
2015-06-24 17:15:48 -07:00