docs/reference: update dockerd docs for changes in 23.0#4199
Conversation
Support for this environment variable was removed in docker 23.0 in moby/moby@1240f8b From that patch: > All regular, non-EOL Linux distros now come with more recent kernels > out of the box. There may still be users trying to run on kernel 3.10 > or older (some embedded systems, e.g.), but those should be a rare > exception, which we don't have to take into account. > > This patch removes the kernel version check on Linux, and the corresponding > DOCKER_NOWARN_KERNEL_VERSION environment that was there to skip this > check. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
No need to mention that the env-var may be removed at that point to keep the description more to-the-point. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Adding a description based on the Go documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Update the description for the changes made in; moby/moby@68e96f8 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The daemon no longer adjusts its oom-score by default; see - moby/moby@2b8e68e - moby/moby@cf7a5be Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Adds documentation for the options that were added in moby/moby@427c7cc Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
| -D, --debug Enable debug mode | ||
| --default-address-pool pool-options Default address pools for node specific local networks | ||
| --default-cgroupns-mode string Default mode for containers cgroup namespace ("host" | "private") (default "host") | ||
| --default-cgroupns-mode string Default mode for containers cgroup namespace ("host" | "private") (default "private") |
There was a problem hiding this comment.
We still need to look at some of these, because the default depends on the host running either cgroups v2 or v1. Cgroups v2 should be the most common now, so updated the output for that.
|
@dvdksn ptal |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #4199 +/- ##
=======================================
Coverage 58.86% 58.86%
=======================================
Files 572 572
Lines 49576 49576
=======================================
Hits 29182 29182
Misses 18624 18624
Partials 1770 1770 |
| Because Docker is developed using Go, you can also use any environment | ||
| variables used by the Go runtime. In particular, you may find these useful: |
There was a problem hiding this comment.
nit: I wonder if it's really necessary to mention the support for HTTP proxy variables as something derived from Go. Maybe we can just remove this part of the statement (also on line 149-150). They're effectively universally agreed upon.
There was a problem hiding this comment.
Yeah, I was wondering about that a bit. I think the main reason it's still mentioned is that there is no standard for these variables; they're a common convention, but implementations differ (with sometimes the devil being in the details).
Some tools use http_socket (lowercase), some HTTP_SOCKET (uppercase), some both (but order of preference may differ), and formats accepted for NO_PROXY ... differ very much.
See https://about.gitlab.com/blog/2021/01/27/we-need-to-talk-no-proxy/
and docker/docs#13786 (I still need to finish up that one)
| --registry-mirror list Preferred registry mirror | ||
| --rootless Enable rootless mode; typically used with RootlessKit | ||
| --seccomp-profile string Path to seccomp profile | ||
| --seccomp-profile string Path to seccomp profile. Use "unconfined" to disable the default seccomp profile (default "builtin") |
There was a problem hiding this comment.
| --seccomp-profile string Path to seccomp profile. Use "unconfined" to disable the default seccomp profile (default "builtin") | |
| --seccomp-profile string Path to seccomp profile. Set to "unconfined" to disable the default seccomp profile (default "builtin") |
There was a problem hiding this comment.
Oh, yes, we can change; this was the actual output of the daemon, so I would need to make code-changes for that in moby/moby 😅
There was a problem hiding this comment.
Yeah I figured it might've come from the CLI, let's update in moby then :)
There was a problem hiding this comment.
| "http-proxy": "http://proxy.example.com:80", | ||
| "https-proxy": "https://proxy.example.com:443", |
There was a problem hiding this comment.
this seems to always be a contentious point: the type of HTTP request to use for the proxy, and whether to use use different protocols/ports for HTTP_PROXY and HTTPS_PROXY. We should probably update the proxy configuration page in a follow-up, to use the same example values, so we're consistent across the board.
|
Note to self; after this we also need to document the |
|
And prepared a backport for the 23.0 release branch; |
docs/reference: remove mention of DOCKER_NOWARN_KERNEL_VERSION
Support for this environment variable was removed in docker 23.0 in
From that patch:
docs/reference: reformat env-vars table, and simplify
No need to mention that the env-var may be removed at that point to keep
the description more to-the-point.
docs/reference: use table for proxy env-vars
Adding a description based on the Go documentation.
docs/reference: dockerd: use table for env-vars
docs/reference: dockerd: update seccomp flag description
Update the description for the changes made in;
docs/reference: dockerd: remove default oom-score-adjust
The daemon no longer adjusts its oom-score by default; see
docs: update dockerd usage output for new proxy-options
Adds documentation for the options that were added in
- A picture of a cute animal (not mandatory but encouraged)