docs/reference: update dockerd docs for changes in 23.0 #4199

thaJeztah · 2023-04-12T16:53:04Z

docs/reference: remove mention of DOCKER_NOWARN_KERNEL_VERSION

Support for this environment variable was removed in docker 23.0 in

moby/moby@1240f8b (daemon: remove kernel version check and DOCKER_NOWARN_KERNEL_VERSION moby/moby#43253)

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.

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;

moby/moby@68e96f8 (Fix daemon.json and daemon --seccomp-profile not accepting "unconfined", and rename default profile to "builtin" moby/moby#42481)

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

moby/moby@427c7cc (Add http(s) proxy properties to daemon configuration (carry 42647) moby/moby#42835)

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

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>

thaJeztah · 2023-04-12T16:54:13Z

docs/reference/commandline/dockerd.md

-      --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")


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.

thaJeztah · 2023-04-12T16:54:31Z

@dvdksn ptal

codecov-commenter · 2023-04-12T16:59:03Z

Codecov Report

Merging #4199 (c846428) into master (b799ab9) will not change coverage.
The diff coverage is n/a.

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

dvdksn · 2023-04-13T10:56:52Z

docs/reference/commandline/cli.md

 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:


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.

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)

dvdksn · 2023-04-13T10:58:25Z

docs/reference/commandline/dockerd.md

  -p, --pidfile string                        Path to use for daemon PID file (default "/var/run/docker.pid")
      --raw-logs                              Full timestamps without ANSI coloring
      --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")


Suggested change

--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")

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 😅

Yeah I figured it might've come from the CLI, let's update in moby then :)

I opened a PR;

daemon: touch-up flag description for --seccomp-profile moby/moby#45321

dvdksn · 2023-04-13T11:13:15Z

docs/reference/commandline/dockerd.md

+  "http-proxy": "http://proxy.example.com:80",
+  "https-proxy": "https://proxy.example.com:443",


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.

thaJeztah · 2023-04-13T11:33:31Z

Note to self; after this we also need to document the --validate option;

Daemon config validation moby/moby#42393

thaJeztah · 2023-04-13T12:01:34Z

And prepared a backport for the 23.0 release branch;

[23.0 backport] docs/reference: update dockerd docs for changes in 23.0 #4202

thaJeztah added 7 commits April 12, 2023 18:12

docs/reference: reformat env-vars table, and simplify

879e080

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>

docs/reference: use table for proxy env-vars

3701748

Adding a description based on the Go documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

docs/reference: dockerd: use table for env-vars

32bc912

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

docs/reference: dockerd: update seccomp flag description

c209743

Update the description for the changes made in; moby/moby@68e96f8 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

docs/reference: dockerd: remove default oom-score-adjust

c730a8e

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>

docs: update dockerd usage output for new proxy-options

c846428

Adds documentation for the options that were added in moby/moby@427c7cc Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

thaJeztah added kind/docs status/3-docs-review process/cherry-pick labels Apr 12, 2023

thaJeztah added this to the 24.0.0 milestone Apr 12, 2023

thaJeztah commented Apr 12, 2023

View reviewed changes

thaJeztah requested review from dvdksn and laurazard April 12, 2023 21:42

dvdksn reviewed Apr 13, 2023

View reviewed changes

thaJeztah mentioned this pull request Apr 13, 2023

[23.0 backport] docs/reference: update dockerd docs for changes in 23.0 #4202

Merged

thaJeztah added process/cherry-picked and removed process/cherry-pick labels Apr 13, 2023

cpuguy83 approved these changes Apr 13, 2023

View reviewed changes

neersighted approved these changes Apr 13, 2023

View reviewed changes

thaJeztah merged commit 60d0659 into docker:master Apr 13, 2023
74 checks passed

thaJeztah deleted the docs_daemon_proxy_config branch April 13, 2023 19:55

This was referenced May 19, 2023

docs: fix example for proxies in daemon.json #4309

Merged

[24.0 backport] docs: fix example for proxies in daemon.json #4310

Merged

This was referenced May 19, 2023

[23.0 backport] docs: fix example for proxies in daemon.json #4311

Merged

config: fix example for proxies in daemon.json docker/docs#17374

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs/reference: update dockerd docs for changes in 23.0 #4199

docs/reference: update dockerd docs for changes in 23.0 #4199

thaJeztah commented Apr 12, 2023 •

edited

thaJeztah Apr 12, 2023

thaJeztah commented Apr 12, 2023

codecov-commenter commented Apr 12, 2023

dvdksn Apr 13, 2023

thaJeztah Apr 13, 2023

dvdksn Apr 13, 2023

thaJeztah Apr 13, 2023

dvdksn Apr 13, 2023

thaJeztah Apr 13, 2023

dvdksn Apr 13, 2023

thaJeztah commented Apr 13, 2023

thaJeztah commented Apr 13, 2023

		--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")

		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:

	--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")

		"http-proxy": "http://proxy.example.com:80",
		"https-proxy": "https://proxy.example.com:443",

docs/reference: update dockerd docs for changes in 23.0 #4199

docs/reference: update dockerd docs for changes in 23.0 #4199

Conversation

thaJeztah commented Apr 12, 2023 • edited

docs/reference: remove mention of DOCKER_NOWARN_KERNEL_VERSION

docs/reference: reformat env-vars table, and simplify

docs/reference: use table for proxy env-vars

docs/reference: dockerd: use table for env-vars

docs/reference: dockerd: update seccomp flag description

docs/reference: dockerd: remove default oom-score-adjust

docs: update dockerd usage output for new proxy-options

Choose a reason for hiding this comment

thaJeztah commented Apr 12, 2023

codecov-commenter commented Apr 12, 2023

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thaJeztah commented Apr 13, 2023

thaJeztah commented Apr 13, 2023

thaJeztah commented Apr 12, 2023 •

edited