Skip to content

Clarify User and MemorySwap are platform specific #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 4, 2016
Merged

Clarify User and MemorySwap are platform specific #375

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
006a4a7
config.md: clarify user is platform-specific
coolljt0725 Nov 2, 2016
acbc797
Specify memorySwap is platform-specific
coolljt0725 Nov 2, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down