From 006a4a78278692606f9d7ea93790ff6cd8f2373c Mon Sep 17 00:00:00 2001 From: Lei Jitang Date: Tue, 1 Nov 2016 23:19:06 -0400 Subject: [PATCH 1/2] config.md: clarify user is platform-specific Signed-off-by: Lei Jitang --- config.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/config.md b/config.md index 396cc8120..26b38ee37 100644 --- a/config.md +++ b/config.md @@ -74,9 +74,9 @@ Note: Any OPTIONAL field MAY also be set to null, which is equivalent to being a - **User** *string*, OPTIONAL - The username or UID which the process in the container should run as. + The username or UID which is a platform-specific structure that allows specific control over which user the process run as. This acts as a default value to use when the value is not specified when creating a container. - All of the following are valid: `user`, `uid`, `user:group`, `uid:gid`, `uid:group`, `user:gid`. + For Linux based systems, all of the following are valid: `user`, `uid`, `user:group`, `uid:gid`, `uid:group`, `user:gid`. If `group`/`gid` is not specified, the default group and supplementary groups of the given `user`/`uid` in `/etc/passwd` from the container are applied. - **Memory** *integer*, OPTIONAL From acbc797ba0f88e31c42df662db8738a05ae3297a Mon Sep 17 00:00:00 2001 From: Lei Jitang Date: Tue, 1 Nov 2016 23:20:36 -0400 Subject: [PATCH 2/2] Specify memorySwap is platform-specific Signed-off-by: Lei Jitang --- config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config.md b/config.md index 26b38ee37..a5dccebd4 100644 --- a/config.md +++ b/config.md @@ -86,7 +86,7 @@ Note: Any OPTIONAL field MAY also be set to null, which is equivalent to being a - **MemorySwap** *integer*, OPTIONAL - Total memory usage (memory + swap); set to `-1` to disable swap. + MemorySwap is a platform-specific field to set total memory usage (memory + swap) for Linux based systems; set to `-1` to disable swap. This acts as a default value to use when the value is not specified when creating a container. - **CpuShares** *integer*, OPTIONAL