From 641c704d11509b6080451762761514a818727172 Mon Sep 17 00:00:00 2001 From: Ma Shimiao Date: Fri, 12 May 2017 11:22:32 +0800 Subject: [PATCH] config.md: minor changes for process Signed-off-by: Ma Shimiao --- config.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/config.md b/config.md index f1996d084..37db66a15 100644 --- a/config.md +++ b/config.md @@ -119,11 +119,11 @@ For Windows, see [mountvol][mountvol] and [SetVolumeMountPoint][set-volume-mount ## Process -**`process`** (object, OPTIONAL) specifies the container process. +**`process`** (object, OPTIONAL) specifies a process to run inside the container. This property is REQUIRED when [`start`](runtime.md#start) is called. -* **`terminal`** (bool, OPTIONAL) specifies whether a terminal is attached to that process, defaults to false. - As an example, if set to true on Linux a pseudoterminal pair is allocated for the container process and the pseudoterminal slave is duplicated on the container process's [standard streams][stdin.3]. +* **`terminal`** (bool, OPTIONAL) specifies whether a terminal is attached to the process, defaults to false. + As an example, if set to true on Linux a pseudoterminal pair is allocated for the process and the pseudoterminal slave is duplicated on the process's [standard streams][stdin.3]. * **`consoleSize`** (object, OPTIONAL) specifies the console size in characters of the terminal if attached, containing the following properties: * **`height`** (uint, REQUIRED) * **`width`** (uint, REQUIRED) @@ -132,14 +132,14 @@ For Windows, see [mountvol][mountvol] and [SetVolumeMountPoint][set-volume-mount * **`env`** (array of strings, OPTIONAL) with the same semantics as [IEEE Std 1003.1-2001's `environ`][ieee-1003.1-2001-xbd-c8.1]. * **`args`** (array of strings, REQUIRED) with similar semantics to [IEEE Std 1003.1-2001 `execvp`'s *argv*][ieee-1003.1-2001-xsh-exec]. This specification extends the IEEE standard in that at least one entry is REQUIRED, and that entry is used with the same semantics as `execvp`'s *file*. -* **`capabilities`** (object, OPTIONAL) is an object containing arrays that specifies the sets of capabilities for the process(es) inside the container. Valid values are platform-specific. For example, valid values for Linux are defined in the [capabilities(7)][capabilities.7] man page, such as `CAP_CHOWN`. Any value which cannot be mapped to a relevant kernel interface MUST cause an error. +* **`capabilities`** (object, OPTIONAL) is an object containing arrays that specifies the sets of capabilities for the process in the container. Valid values are platform-specific. For example, valid values for Linux are defined in the [capabilities(7)][capabilities.7] man page, such as `CAP_CHOWN`. Any value which cannot be mapped to a relevant kernel interface MUST cause an error. capabilities contains the following properties: * **`effective`** (array of strings, OPTIONAL) - the `effective` field is an array of effective capabilities that are kept for the process. * **`bounding`** (array of strings, OPTIONAL) - the `bounding` field is an array of bounding capabilities that are kept for the process. * **`inheritable`** (array of strings, OPTIONAL) - the `inheritable` field is an array of inheritable capabilities that are kept for the process. * **`permitted`** (array of strings, OPTIONAL) - the `permitted` field is an array of permitted capabilities that are kept for the process. * **`ambient`** (array of strings, OPTIONAL) - the `ambient` field is an array of ambient capabilities that are kept for the process. -* **`rlimits`** (array of objects, OPTIONAL) allows setting resource limits for a process inside the container. +* **`rlimits`** (array of objects, OPTIONAL) allows setting resource limits for the process in the container. Each entry has the following structure: * **`type`** (string, REQUIRED) - the platform resource being limited, for example on Linux as defined in the [setrlimit(2)][setrlimit.2] man page.