Skip to content

docs: deprecation: OOM-score adjust for the daemon#4209

Merged
thaJeztah merged 1 commit into
docker:masterfrom
thaJeztah:deprecate_oom_score_adjust
Apr 18, 2023
Merged

docs: deprecation: OOM-score adjust for the daemon#4209
thaJeztah merged 1 commit into
docker:masterfrom
thaJeztah:deprecate_oom_score_adjust

Conversation

@thaJeztah

Copy link
Copy Markdown
Member

The oom-score-adjust option was added to prevent the daemon from being OOM-killed before other processes. This option was mostly added as a convenience, as running the daemon as a systemd unit was not yet common.

Having the daemon set its own limits is not best-practice, and something better handled by the process-manager starting the daemon.

Docker 20.10 and newer no longer adjust the daemon's OOM score by default, instead setting the OOM-score to the systemd unit (OOMScoreAdjust) that's shipped with the packages.

Users currently depending on this feature are recommended to adjust the daemon's OOM score using systemd or through other means, when starting the daemon.

- What I did

- How I did it

- How to verify it

- Description for the changelog

- A picture of a cute animal (not mandatory but encouraged)

The `oom-score-adjust` option was added to prevent the daemon from being
OOM-killed before other processes. This option was mostly added as a
convenience, as running the daemon as a systemd unit was not yet common.

Having the daemon set its own limits is not best-practice, and something
better handled by the process-manager starting the daemon.

Docker v20.10 and newer no longer adjust the daemon's OOM score by default,
instead setting the OOM-score to the systemd unit (OOMScoreAdjust) that's
shipped with the packages.

Users currently depending on this feature are recommended to adjust the
daemon's OOM score using systemd or through other means, when starting
the daemon.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah thaJeztah force-pushed the deprecate_oom_score_adjust branch from 11c7999 to c97c321 Compare April 15, 2023 12:45
@codecov-commenter

codecov-commenter commented Apr 15, 2023

Copy link
Copy Markdown

Codecov Report

Merging #4209 (c97c321) into master (67c4570) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4209   +/-   ##
=======================================
  Coverage   58.86%   58.86%           
=======================================
  Files         572      572           
  Lines       49544    49544           
=======================================
  Hits        29162    29162           
  Misses      18616    18616           
  Partials     1766     1766           

@thaJeztah thaJeztah requested a review from dvdksn April 18, 2023 09:18
Comment thread docs/deprecated.md
### OOM-score adjust for the daemon

**Deprecated in Release: v24.0.0**
**Target For Removal In Release: v25.0.0**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
**Target For Removal In Release: v25.0.0**
**Subject for Removal in Release: v25.0.0**

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I'll keep this one to be the same, but we should indeed touch up this page a bit

@dvdksn

dvdksn commented Apr 18, 2023

Copy link
Copy Markdown
Contributor

I just noticed that the formatting of these "Deprecated in Release" and "Removed in Release" phrases are a bit off. They use title case and bold, which isn't according to our style guide. And there's no blank line between these two lines, which renders them as one paragraph.

I will raise a follow-up to this to improve the formatting of these.

@thaJeztah

Copy link
Copy Markdown
Member Author

Yeah, it would use some tweaking; I used the existing approach, but definitely could use some touching up

@thaJeztah thaJeztah merged commit 3bc814e into docker:master Apr 18, 2023
@thaJeztah thaJeztah deleted the deprecate_oom_score_adjust branch April 18, 2023 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants