Skip to content

Commit 7151e1a

Browse files
committed
glossary: Merge into the definitions file
There is no reason to separate these from the definitions which are already there. But the existing definition paragraphs define multiple terms a piece, so I haven't converted them to the alphabetized labeled-list format I've been using for glossary entries. Signed-off-by: W. Trevor King <[email protected]>
1 parent 10237c8 commit 7151e1a

File tree

4 files changed

+38
-47
lines changed

4 files changed

+38
-47
lines changed

config-linux.asc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,10 @@ Entries have the following properties:
7777
`cgroup`::: the container will have an isolated view of the cgroup hierarchy.
7878

7979
`path`::
80-
(string, OPTIONAL) - path to namespace file in the `<<runtime-namespace,runtime mount namespace>>`.
80+
(string, OPTIONAL) - path to namespace file in the <<runtime-namespace,runtime mount namespace>>.
8181

8282
If a path is specified, that particular file is used to join that type of namespace.
83-
If a namespace type is not specified in the `namespaces` array, the container MUST inherit the `<<runtime-namespace>>` of that type.
83+
If a namespace type is not specified in the `namespaces` array, the container MUST inherit the <<runtime-namespace>> of that type.
8484
If a new namespace is not created (because the namespace type is not listed, or because it is listed with a `path`), runtimes MUST assume that the setup for that namespace has already been done and error out if the config specifies anything else related to that namespace.
8585
If a `namespaces` field contains duplicated namespaces with same `type`, the runtime MUST error out.
8686

@@ -808,7 +808,7 @@ Masked Paths
808808

809809
`maskedPaths`::
810810
(array of strings, OPTIONAL) will mask over the provided paths inside the container so that they cannot be read.
811-
The values MUST be absolute paths in the `<<container-namespace>>`.
811+
The values MUST be absolute paths in the <<container-namespace>>.
812812

813813
[[linux-maskedPaths-example]]
814814
.Example
@@ -827,7 +827,7 @@ Readonly Paths
827827

828828
`readonlyPaths`::
829829
(array of strings, OPTIONAL) will set the provided paths as readonly inside the container.
830-
The values MUST be absolute paths in the `<<container-namespace>>`.
830+
The values MUST be absolute paths in the <<container-namespace>>.
831831

832832
[[linux-readonlyPaths-example]]
833833
.Example

config.asc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -236,13 +236,13 @@ Linux and Solaris User
236236
For Linux and Solaris based systems the user structure has the following fields:
237237

238238
`uid`::
239-
(int, REQUIRED) specifies the user ID in the `<<container namespace>>`.
239+
(int, REQUIRED) specifies the user ID in the <<container-namespace>>.
240240

241241
`gid`::
242-
(int, REQUIRED) specifies the group ID in the `<<container namespace>>`.
242+
(int, REQUIRED) specifies the group ID in the <<container-namespace>>.
243243

244244
`additionalGids`::
245-
(array of ints, OPTIONAL) specifies additional group IDs (in the `<<container-namespace>>`) to be added to the process.
245+
(array of ints, OPTIONAL) specifies additional group IDs (in the <<container-namespace>>) to be added to the process.
246246

247247
[NOTE]
248248
Symbolic name for `uid` and `gid`, such as `uname` and `gname` respectively, are left to upper levels to derive (i.e. `/etc/passwd` parsing, NSS, etc.).
@@ -455,7 +455,7 @@ Hooks allow one to run code before/after various lifecycle events of the contain
455455
Hooks MUST be called in the listed order.
456456
The state of the container is passed to the hooks over {stdin-3}[stdin], so the hooks could get the information they need to do their work.
457457

458-
Hook paths are absolute and are executed from the host's filesystem in the `<<runtime-namespace>>`.
458+
Hook paths are absolute and are executed from the host's filesystem in the <<runtime-namespace>>.
459459

460460
[[prestart,prestart]]
461461
Prestart

definitions.asc

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,41 @@
11
Definitions
22
-----------
33

4-
:rfc2119: http://tools.ietf.org/html/rfc2119
54
:c99-unspecified: http://www.open-std.org/jtc1/sc22/wg14/www/C99RationaleV5.10.pdf#page=18
5+
:json: https://tools.ietf.org/html/rfc7159
6+
:namespaces-7: http://man7.org/linux/man-pages/man7/namespaces.7.html
7+
:rfc2119: http://tools.ietf.org/html/rfc2119
8+
:utf-8: http://www.unicode.org/versions/Unicode8.0.0/ch03.pdf
69

710
In the specifications in the above table of contents, the keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in {rfc2119}[RFC 2119] (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).
811

912
The keywords "unspecified", "undefined", and "implementation-defined" are to be interpreted as described in the {c99-unspecified}[rationale for the C99 standard].
1013

1114
An implementation is not compliant for a given CPU architecture if it fails to satisfy one or more of the MUST, REQUIRED, or SHALL requirements for the protocols it implements.
1215
An implementation is compliant for a given CPU architecture if it satisfies all the MUST, REQUIRED, and SHALL requirements for the protocols it implements.
16+
17+
[[bundle-definition,bundle]] bundle::
18+
A <<bundle,directory structure>> that is written ahead of time, distributed, and used to seed the runtime for creating a <<container>> and launching a process within it.
19+
20+
[[config-definition,configuration]] configuration::
21+
The <<config,`config.json`>> file in a <<bundle-definition>> which defines the intended <<container>> and container process.
22+
23+
[[container,container]] container::
24+
An environment for executing processes with configurable isolation and resource limitations.
25+
For example, namespaces, resource limits, and mounts are all part of the container environment.
26+
27+
[[container-namespace,container namespace]] container namespace::
28+
On Linux, a leaf in the {namespaces-7}[namespace] hierarchy in which the <<process,configured process>> executes.
29+
30+
[[json,JSON]] JSON::
31+
All configuration {json}[JSON] MUST be encoded in {utf-8}[UTF-8].
32+
JSON objects MUST NOT include duplicate names.
33+
The order of entries in JSON objects is not significant.
34+
35+
[[runtime-definition,runtime]] runtime::
36+
An implementation of this specification.
37+
It reads the <<config-definition>> from a <<bundle-definition>>, uses that information to create a <<container>>, launches a process inside the container, and performs other <<runtime,lifecycle actions>>.
38+
39+
[[runtime-namespace,runtime namespace]] runtime namespace::
40+
On Linux, a leaf in the {namespaces-7}[namespace] hierarchy from which the <<runtime-definition>> process is executed.
41+
New <<container-namespace,container namespaces>> will be created as children of the runtime namespaces.

glossary.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

0 commit comments

Comments
 (0)