Commit Graph

509 Commits

Author SHA1 Message Date
Vincent Batts 111e69668b config: corresponding change for required field
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2016-01-13 17:18:39 -05:00
Vincent Batts 353631ab5e Merge pull request #253 from hqhq/hq_version_compat
Clarify backwards compatibility for major version 0
2016-01-13 16:46:02 -05:00
Mrunal Patel d2617a1203 Merge pull request #307 from vbatts/carry-cwd
Clarify cwd
2016-01-13 13:42:46 -08:00
Vincent Batts 1f519091e2 Merge pull request #304 from mrunalp/clarify_rootfs
Remove clarify rootfs item from the ROADMAP
2016-01-13 16:42:23 -05:00
Mrunal Patel b28481ae37 Merge pull request #301 from vbatts/roadmap-distribution.md
ROADMAP: adding distribution format line item
2016-01-13 13:41:30 -08:00
Mrunal Patel 18edc801d2 Merge pull request #306 from vbatts/roadmap-protobuf
ROADMAP: remove the protobuf line item
2016-01-13 13:38:33 -08:00
Vincent Batts 25e6674a4c config: cwd is a required default
After thorough discussion, even though a reasonable default is "/", for
platform independence, leave this up to the bundle author.

Also, by this variable being present it makes things explicit for the
runtime.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2016-01-13 16:32:23 -05:00
Vincent Batts 2d6ef2325d ROADMAP: remove the protobuf line item
As using protobuf has been decided against, this removes it from the
Roadmap items.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2016-01-13 15:04:40 -05:00
Mrunal Patel c6d40b514e Remove clarify rootfs item from the ROADMAP
We discussed this in the face to face meeting and agreed
that it makes sense to keep the rootfs as is for flexibility.

Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2016-01-13 11:55:00 -08:00
Michael Crosby ad6092e1b2 Merge pull request #296 from wking/integer-classID
runtime-config-linux: Convert classID from hex to uint32
2016-01-13 11:54:45 -08:00
Vincent Batts 4715448f7d ROADMAP: adding distribution format line item
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2016-01-13 14:41:50 -05:00
Vincent Batts 588d54b350 Merge pull request #300 from duglin/patch-1
Update ROADMAP.md
2016-01-13 14:30:03 -05:00
Doug Davis 0fe5798279 Update ROADMAP.md
Signed-off-by: Doug Davis <dug@us.ibm.com>
2016-01-13 11:20:41 -08:00
Mrunal Patel 837f67d46b Merge pull request #294 from vbatts/bumpversion_v0.3.0
Bumpversion v0.3.0
2016-01-12 15:58:48 -08:00
W. Trevor King 5a960a478d runtime-config-linux: Convert classID from hex to uint32
The just-landed style conventions prefer integers to hex strings [1],
and I said I'd post an update for this setting if/when those landed
[2].  The kernel uses uint32s for this setting [3].

[1]: https://github.com/opencontainers/specs/pull/287
[2]: https://github.com/opencontainers/specs/pull/287#discussion_r48899312
[3]: https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/include/net/cls_cgroup.h?id=refs/tags/v4.3#n24

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-01-08 10:56:14 -08:00
Mrunal Patel 6aa53edc9b Merge pull request #287 from wking/policy
style: Collect established conventions in a discoverable location
2016-01-08 10:12:27 -08:00
Vincent Batts bd8131216e version: bump v0.3.0-dev
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2016-01-07 10:24:10 -05:00
Vincent Batts 467fd17d4f version: introduce a string for dev indication
Include a changelog of commit subjects

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2016-01-07 10:23:36 -05:00
Vish Kannan 6a6ba67755 Merge pull request #292 from vbatts/tiesheng_oomscoreadj
runtime-config-linux: Add info to clarify oom_score_adj (carrying #236)
2016-01-06 06:20:32 -08:00
W. Trevor King 408412ba80 style: Collect established styles in a discoverable location
So we have something to cite to avoid rehashing established decisions.
Provide some motivation and links to the backing discussion so folks
can re-open these if they have new information that wasn't covered in
the original decision.

Like the glossary (18734986, glossary: Provide a quick overview of
important terms, 2015-08-11, #107), I've used subsection titles for
each entry to get link anchors.

Signed-off-by: W. Trevor King <wking@tremily.us>
2016-01-05 13:31:29 -08:00
Vincent Batts 011acdfc73 runtime-config: defer description to linux docs
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2016-01-05 15:49:11 -05:00
Qiang Huang dd17705087 Merge pull request #291 from Ephemera/patch-1
Fix typo in Filesystem Bundle
2016-01-05 16:18:11 +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 4916d73709 Merge pull request #171 from gao-feng/update-runtime-config-linux-md
move the description of user ns mapping and default files to proper file
2016-01-05 14:53:50 +08:00
Gao feng 053f05933b move the description of user ns mapping to proper file
They should stay in runtime not config.

Signed-off-by: Gao feng <omarapazanadi@gmail.com>
2016-01-05 14:19:45 +08:00
Gao feng 0c9a97890d runtime-config: add example label before json exmaple
Signed-off-by: Gao feng <omarapazanadi@gmail.com>
2016-01-05 14:13:38 +08:00
Mrunal Patel 4060e6c1cc Merge pull request #288 from wking/glossary-doc-files
Makefile: Add glossary to DOC_FILES
2016-01-04 10:28:07 -08:00
Michael Crosby 99ef7393a3 Merge pull request #289 from vbatts/fixup_vishh
MAINTAINERS: correct Vish's github account
2016-01-04 10:05:08 -08:00
Vincent Batts 3c294d5752 Merge pull request #283 from jonboulle/master
Appropriately mark optional fields as omitempty
2016-01-04 12:48:23 -05:00
Vincent Batts 433abe0b98 Merge pull request #279 from hqhq/hq_fix_swappiness_value
Fix value of swappiness
2016-01-04 10:55:36 -05:00
Vincent Batts 575ad87ef4 MAINTAINERS: correct Vish's github account
Reported-by: W. Trevor King <wking@tremily.us>
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2016-01-04 10:12:25 -05:00
Jonathan Boulle 986fc9831e Mark RootfsPropagation as omitempty
Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
2015-12-31 12:16:27 +01:00
W. Trevor King d7acd86e0e Makefile: Add glossary to DOC_FILES
At the end of the list, to match its position in the README.  This
catches #107 up with #263, which I'd missed during one of the #107
rebases.

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-12-29 20:45:53 -08:00
Lai Jiangshan df3f12deab define the default value for the `cwd`
Signed-off-by: Lai Jiangshan <jiangshanlai@gmail.com>
2015-12-29 11:48:07 +08:00
arcnmx 0879a94844 Appropriately mark optional fields as omitempty
Signed-off-by: Jonathan Boulle <jonathanboulle@gmail.com>
2015-12-24 18:05:55 +01:00
Qiang Huang 2fd5ad660e Merge pull request #107 from wking/glossary
glossary: Provide a quick overview of important terms
2015-12-24 17:04:35 +08:00
Brandon Philips bcb459c1c7 README: make use cases less loud
I am going to add some additional use cases so lets move to h4 instead
of an h2.

Signed-off-by: Brandon Philips <brandon.philips@coreos.com>
2015-12-23 17:05:37 -08:00
W. Trevor King 0f9ec22bd4 glossary: Specify UTF-8 for all our JSON
I wish there was a cleaner reference for what UTF-8 was.  But [1]
seems too glib, and I can't find a more targetted link than just
dropping folks into a Unicode chapter (which is what [1] does):

  The Unicode Standard, Version 6.0, §3.9 D92, §3.10 D95 (2011)

With the current v8.0 (2015-06-17), it's still §3.9 D92 and §3.10 D95.

I'd rather put this normative requirement in the configuration-spec
files, but maintainer consensus was to put it in the glossary [2,3].

[1]: https://en.wikipedia.org/wiki/UTF-8
[2]: https://github.com/opencontainers/specs/pull/146#issuecomment-138970417
[3]: https://github.com/opencontainers/specs/pull/146#issuecomment-143348788

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-12-23 09:27:30 -08:00
W. Trevor King 18734986bc glossary: Provide a quick overview of important terms
And link them to the more detailed specification.

Subsection titles for the entries will be obnoxiously spacious, but
the other alternatives seem worse:

a. An HTML definition list (<dl>) would have nice default styling, but
   it's annoying to write raw HTML.  And we would have needed
   something like:

     <dt name="bundle">Bundle</dt>
     <dd>

     A [directory structure](bundle.md) that is...

     </dd>

   to get Markdown-style links in the defintion itself.

b. A Markdown list (* ...) would have reasonable default styling, but
   there's no Markdown syntax for adding anchors to the entries.  And
   a glossary is much less useful if you can't link to a specific
   entry.

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-12-23 09:27:30 -08:00
Mrunal Patel d09cc0a1d0 Merge pull request #278 from vbatts/project-doc
Project: document release process
2015-12-22 20:10:27 -08:00
Qiang Huang e4b4ba2c4c Fix value of swappiness
It's officially pointer of uint64 now, no point it can be
-1, change it to 0 as other fields in example.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-12-22 13:59:00 +08:00
Vincent Batts a008456e7f Project: document release process
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2015-12-21 16:07:39 -05:00
Vincent Batts d7df1b4f82 Merge pull request #263 from vbatts/printable
*: printable documents
2015-12-21 15:54:14 -05:00
Qiang Huang 9ffb3ef4ee Merge pull request #277 from runcom/missing-pointer
runtime_config_linux.go: add missing pointer
2015-12-21 21:04:28 +08:00
Antonio Murdaca 592f7547bf runtime_config_linux.go: add missing pointer
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
2015-12-19 12:39:16 +01:00
Mrunal Patel e298027a52 Merge pull request #233 from vishh/uint64
Fix cgroups value types in the spec.
2015-12-18 17:50:36 -08:00
Vishnu kannan 488f174af9 Make optional Cgroup related config params pointers along with `omitempty` json tag.
Signed-off-by: Vishnu kannan <vishnuk@google.com>
2015-12-18 17:43:27 -08:00
Michael Crosby e79365a749 Merge pull request #268 from wking/lifecycle-runtime.json
lifecycle: Mention runtime.json
2015-12-17 10:58:22 -08:00
Mrunal Patel 72ba8bf82e Merge pull request #272 from vbatts/roadmap-link
roadmap: update links and add wiki reference
2015-12-17 09:40:21 -08:00
Vincent Batts b7a4db3146 roadmap: update links and add wiki reference
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2015-12-16 16:37:50 -05:00