Skip to content

Commit 7cab1f8

Browse files
authored
Merge pull request opencontainers#375 from coolljt0725/config_platform_specific
Clarify User and MemorySwap are platform specific
2 parents 28b83df + acbc797 commit 7cab1f8

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ Note: Any OPTIONAL field MAY also be set to null, which is equivalent to being a
7474

7575
- **User** *string*, OPTIONAL
7676

77-
The username or UID which the process in the container should run as.
77+
The username or UID which is a platform-specific structure that allows specific control over which user the process run as.
7878
This acts as a default value to use when the value is not specified when creating a container.
79-
All of the following are valid: `user`, `uid`, `user:group`, `uid:gid`, `uid:group`, `user:gid`.
79+
For Linux based systems, all of the following are valid: `user`, `uid`, `user:group`, `uid:gid`, `uid:group`, `user:gid`.
8080
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.
8181

8282
- **Memory** *integer*, OPTIONAL
@@ -86,7 +86,7 @@ Note: Any OPTIONAL field MAY also be set to null, which is equivalent to being a
8686

8787
- **MemorySwap** *integer*, OPTIONAL
8888

89-
Total memory usage (memory + swap); set to `-1` to disable swap.
89+
MemorySwap is a platform-specific field to set total memory usage (memory + swap) for Linux based systems; set to `-1` to disable swap.
9090
This acts as a default value to use when the value is not specified when creating a container.
9191

9292
- **CpuShares** *integer*, OPTIONAL

0 commit comments

Comments
 (0)