Commit Graph

334 Commits

Author SHA1 Message Date
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
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
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
W. Trevor King 0a55d5ca5a lifecycle: Mention runtime.json
As discussed earlier [1,2].  I'm in favor of rolling it back into
config.json [3], but we aren't there yet [4].

[1]: https://github.com/opencontainers/specs/pull/231#discussion_r43262848
[2]: https://github.com/opencontainers/specs/pull/231/files#r46735828
[3]: 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>
[4]: 4a63e81a80/bundle.md (container-format)

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-12-16 09:41:45 -08:00
Qiang Huang 7c17452142 Merge pull request #269 from wking/lifecycle-state-path
lifecycle: Don't require /run/opencontainer/<runtime>/containers
2015-12-15 16:41:06 +08:00
Vish Kannan 56b88759a6 Merge pull request #235 from yangdongsheng/kmem_tcp
cgroup: Add support for memory.kmem.tcp.limit_in_bytes
2015-12-14 21:39:53 -08:00
W. Trevor King f89cb852ae lifecycle: Don't require /run/opencontainer/<runtime>/containers
We already require it for Linux/Unix-based systems [1], so we don't
have to repeat it here.  And other systems will use different paths,
which we haven't specified yet.  When I asked why we didn't specify a
path for Windows [2], Vincent said we were waiting on help from PoC
implementations [3].  So this commit punts the location to the "State"
section, and lets the "Lifecycle" section just focus on when the
write-to-filesystem happens.

There's also discussion about removing the filesystem state registry
completely [4], in which case we'd want to remove the whole line from
the lifecycle.

[1]: 7713efc1be (diff-b84a8d65d8ed53f4794cd2db7e8ea731L7)
[2]: https://github.com/opencontainers/specs/pull/211#discussion_r41066673
[3]: https://github.com/opencontainers/specs/pull/211#discussion_r41067134
[4]: https://groups.google.com/a/opencontainers.org/forum/#!topic/dev/q6TYqVZOcX8
     Subject: removal of /run/opencontainer/containers
     Date: Wed, 25 Nov 2015 14:29:35 +0000
     Message-ID: <CAD2oYtNipt3i_C6=J4Bc-jwauo5YAvKXUqTROnPNP3vZ9+C5Vw@mail.gmail.com>

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-12-14 10:46:21 -08:00
Vincent Batts 772f073960 Merge pull request #255 from hqhq/hq_clarify_hooks
Clarify the meaning of hook elements
2015-12-09 13:32:59 -05:00
Vincent Batts 4ee036fcd2 *: printable documents
I do not like having this build step of printable documentation
depending on pulling a container, but the pandoc+latex combo is a big
bundle. This is the minimal and cleanest approach for using these tools,
for now.

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
2015-12-09 13:23:03 -05:00
Vincent Batts 82cfe56140 Merge pull request #231 from mrunalp/lifecycle
Add lifecycle for containers
2015-12-09 13:03:29 -05:00
Vincent Batts 58f6cab5ff Merge pull request #251 from hqhq/hq_change_cgroupsPath
Change the behavior when cgroupsPath is absent
2015-12-08 13:46:53 -05:00
Michael Crosby 458a76410d Merge pull request #260 from mikebrow/RFC2119
adds text describing the upper-case keywords used in the spec
2015-12-04 14:12:51 -08:00
Mrunal Patel 4a63e81a80 Merge pull request #144 from wking/state-version-example
runtime: Add 'version' to the state.json example
2015-12-04 13:12:12 -08:00
Mrunal Patel 8cbabfc616 Merge pull request #257 from nponeccop/patch-1
Example lists "root' but text mentions "bundlePath"
2015-12-04 12:54:58 -08:00
Mrunal Patel 6203f575db Merge pull request #261 from coolsvap/update-typo
Update Typo in ROADMAP.md
2015-12-04 12:54:10 -08:00
Mrunal Patel 7713efc1be Add lifecycle for containers
The lifecycle described is generic and should apply all platforms.
It provides leeway for the runtimes to be flexible in how they
implement it.

Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2015-12-04 15:52:39 -05:00
Vincent Batts 2b7ae6a3f9 Merge pull request #262 from hqhq/hq_host_specific
Add hyphen for host specific
2015-12-04 12:07:07 -06:00
Mike Brown 57a196a0a0 adds text describing the upper-case keywords used in the spec
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2015-12-04 09:32:23 -06:00
Swapnil Kulkarni (coolsvap) 34e7f47e17 Update Typo in ROADMAP.md
Signed-off-by: Swapnil Kulkarni <me@coolsvap.net>
2015-12-04 13:27:29 +05:30
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
nponeccop c19a920a9c Example lists "root' but text mentions "bundlePath"
Signed-off-by: Andrii Melnykov <andy.melnikov@gmail.com>
2015-12-02 11:33:41 +02:00
W. Trevor King 889f775dcf runtime: Add 'version' to the state.json example
The version field was added while 180df9d (Add runtime state
configuration and structs, 2015-07-29, #87) was in-flight [1], and it
missed getting documented in the example.

[1]: https://github.com/opencontainers/specs/pull/87#issuecomment-135117343

Signed-off-by: W. Trevor King <wking@tremily.us>
2015-12-01 14:54:45 -08:00
Qiang Huang 48049d2341 Clarify the semantics of hook elements
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-11-25 08:02:32 +08:00
Vincent Batts 8d66fdd863 Merge pull request #254 from hqhq/hq_fix_golint
Fix golint warnings
2015-11-19 19:29:20 +01:00
Qiang Huang d663a5b022 Change the behavior when cgroupsPath is absent
The former definition was join "/" when `cgroupsPath` is absent, it's
not clear whether to join the root cgroup or create a sub cgroup under "/".

Join root cgroup would be a bad idea cause that's not what a container
should do. And craete a sub cgroup would be missing definition about what
the cgroup name should that be.

So I think we should leave this to implementations what the default
cgroup path should be.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-11-19 08:52:49 +08:00
Qiang Huang f4db3f1b8e Fix golint warnings
Codes in specs should be decent, first of all should make
golint happy.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-11-18 19:31:57 +08:00