Skip to content
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

Jump to bottom

config-linux: mark memory.kernel[TCP] as NOT RECOMMENDED #1093

Merged
merged 1 commit into from
Mar 8, 2021
Merged

config-linux: mark memory.kernel[TCP] as NOT RECOMMENDED #1093

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions config-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,8 +264,8 @@ Values for memory specify the limit in bytes, or `-1` for unlimited memory.
* **`limit`** *(int64, OPTIONAL)* - sets limit of memory usage
* **`reservation`** *(int64, OPTIONAL)* - sets soft limit of memory usage
* **`swap`** *(int64, OPTIONAL)* - sets limit of memory+Swap usage
* **`kernel`** *(int64, OPTIONAL)* - sets hard limit for kernel memory
* **`kernelTCP`** *(int64, OPTIONAL)* - sets hard limit for kernel TCP buffer memory
* **`kernel`** *(int64, OPTIONAL, NOT RECOMMENDED)* - sets hard limit for kernel memory
* **`kernelTCP`** *(int64, OPTIONAL, NOT RECOMMENDED)* - sets hard limit for kernel TCP buffer memory
Comment on lines +267 to +268
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering if it would be better to mark them as "deprecated" (as they're deprecated in the Kernel); kept for backward compatibility by runtimes are allowed to ignore them

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. We're using the terms (OPTIONAL, NOT RECOMMENDED) as per RFC2119, and there's no such term as "DEPRECATED" in its lexicon.
  2. This spec (if I understand it right) is for both runtimes and their users. Saying "OPTIONAL" means users can chose to not set these limits, and runtimes can ignore the set limits. Saying NOT RECOMMENDED means users and runtimes should not set those limits, unless there's a good understanding and some compelling reasons to do so.


The following properties do not specify memory limits, but are covered by the `memory` controller:

Expand Down