Commit Graph

22 Commits

Author SHA1 Message Date
Ma Shimiao 5a9013321c bundle.md: specify root reference the directory
I think this make clear what reference the directory in config.json

Signed-off-by: Ma Shimiao <mashimiao.fnst@cn.fujitsu.com>
2017-05-11 09:25:03 +08:00
Jesse Butler f9dc90b05a make link usage consistent across the specification
Signed-off-by: Jesse Butler <jesse.butler@oracle.com>
2017-03-03 14:43:09 -05:00
Rob Dolin (MSFT) 9f5e394937 [Bundle] Adds anchor tags for headings and bullets
Signed-off-by: Rob Dolin <robdolin@microsoft.com>
2016-11-08 11:38:11 -08:00
W. Trevor King a2d07dcfda Replace " : " with ": "
There's an outside change that these are intentional, since I pointed
one of these out earlier [1] and it wasn't fixed.  But I haven't seen
" : " used intentionally outside of this project, and don't think we
want to break ground in that direction ;).

[1]: https://github.com/opencontainers/runtime-spec/pull/510#discussion_r77291554

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-09-06 22:21:33 -07:00
Lei Jitang d0b0ac224f Use filesystem instead of file system
Signed-off-by: Lei Jitang <leijitang@huawei.com>
2016-08-12 00:00:00 -04:00
W. Trevor King ecb7fa51ea bundle: Remove distribution references
These distribution requirements belong in image-spec or similar.  They
don't apply to runtimes or filesystem bundles (the latter are covered
by the earlier "This MUST include the following artifacts"), which are
the two entities tested for compliance with this spec.

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-06-04 13:51:07 -07:00
Kenfe-Mickael Laventure b2e9154a31 Remove requirement for rootfs path to be relative
Closes #389

Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2016-04-22 11:57:21 -07:00
W. Trevor King cb2da5430a config: Single, unified config file
Reverting 7232e4b1 (specs: introduce the concept of a runtime.json,
2015-07-30, #88) after discussion on the mailing list [1].  The main
reason is that it's hard to draw a clear line around "inherently
runtime-specific" or "non-portable", so we shouldn't try to do that in
the spec.  Folks who want to flag settings as non-portable for their
own system are welcome to do so (e.g. "we will clobber 'hooks' in
bundles we run") are welcome to do so, but we don't have to have
to split the config into multiple files to do that.

There have been a number of additional changes since #88, so this
isn't a pure Git reversion.  Besides copy-pasting and the associated
link-target updates, I've:

* Restored path -> destination, now that the mount type contains both
  source and target paths again.  I'd prefer 'target' to 'destination'
  to match mount(2), but the pre-7232e4b1 phrasing was 'destination'
  (possibly due to Windows using 'target' for the source?).

* Restored the Windows mount example to its pre-7232e4b1 content.

* Removed required mounts from the config example (requirements landed
  in 3848a238, config-linux: specify the default devices/filesystems
  available, 2015-09-09, #164), because specifying those mounts in the
  config is now redundant.

* Used headers (vs. bold paragraphs) to set off mount examples so we
  get link anchors in the rendered Markdown.

* Replaced references to runtime.json with references to config.json.

[1]: https://groups.google.com/a/opencontainers.org/forum/#!topic/dev/0QbyJDM9fWY
     Subject: Single, unified config file (i.e. rolling back specs#88)
     Date: Wed, 4 Nov 2015 09:53:20 -0800
     Message-ID: <20151104175320.GC24652@odin.tremily.us>

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-01-27 09:51:54 -08:00
Ephemera 7a94673f42 Fix typo in Filesystem Bundle
Signed-off-by: GyuYong Jung <obliviscence+git@gmail.com>
2016-01-05 16:02:30 +09:00
Qiang Huang f4f5c14a4e Add hyphen for host specific
We have `host-specific` and `host specific` in the same doc,
add hyphen to keep consistency.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-12-04 14:39:34 +08:00
Doug Davis e14e82648c Talk about host specific/independent instead of mutability
Cover my action item from this week's OCI call.

Also moved State json out of config.go since its not really part of
the config.json file/config.

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-10-30 07:34:53 -07:00
Doug Davis 106ec2daa0 Cleanup bundle.md
Mainly just moved stuff around, but also tried to add some clarity around
what is required w.r.t. naming and location of files/dirs.

Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-10-07 10:22:39 -07:00
Vincent Batts 70372d3880 *.md: update TOC and links
Some of the docs were not even linked to, and did not have a logic
outline for their grouping.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2015-09-25 11:47:16 -04:00
Vincent Batts 6cab2747d9 *.md: markdown formatting
Closes https://github.com/opencontainers/specs/issues/83

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2015-09-09 10:17:06 -04: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
Lai Jiangshan 94d93ec010 specs: align the ascii graph
The three files/directory are at the same level in the bundle directory,
they should be aligned.

Signed-off-by: Lai Jiangshan <jiangshanlai@gmail.com>
2015-07-26 16:38:17 +08:00
Jonathan Boulle 112dcbb6a9 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.
2015-07-02 17:50:49 -07:00
Jonathan Boulle 91f5ad7cfa 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
2015-07-02 17:36:09 -07:00
Jonathan Boulle d29a2e0465 bundle.md: fix off-by-one error 2015-07-01 09:53:15 -07:00
Jonathan Boulle 6a30a93f09 bundle.md: fix link formatting 2015-06-25 11:16:22 -07:00
W. Trevor King 4d53689006 bundle: Fix 'and any number of and other related' typo 2015-06-24 22:02:56 -07: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