Update dockerd command line ref#5865
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5865 +/- ##
=======================================
Coverage 59.27% 59.27%
=======================================
Files 353 353
Lines 29694 29694
=======================================
Hits 17601 17601
Misses 11113 11113
Partials 980 980 |
We moved the man page, but not yet the reference docs; ultimately we should move these as well (also for the daemon.json), and ideally generate yamldocs with the cli-docs-tool code (instead of the So we're "half-way there" 🙈 |
thaJeztah
left a comment
thaJeztah
left a comment
There was a problem hiding this comment.
Some minor nits to consider, but not a strict blocker (some bits we should consider updating in actual code probably)
docs/reference/dockerd.md
Outdated
| --default-shm-size bytes Default shm size for containers (default 64MiB) | ||
| --default-ulimit ulimit Default ulimits for containers (default []) | ||
| --dns list DNS server to use | ||
| --dns ipSlice DNS server to use (default []) |
There was a problem hiding this comment.
This one we may have manually kept as list and/or removed the "default" (as the default is determined dynamically; we should probably look at the --help output as well to consider if we want to show (default []). I recall I once started on a PR to show the actual DNS we'd be using as default to /info in moby/moby#35506, but that one may have been wrong in the systemd-resolvd case (to be checked)
docs/reference/dockerd.md
Outdated
| --feature map Enable feature in the daemon | ||
| --fixed-cidr string IPv4 subnet for fixed IPs | ||
| --fixed-cidr-v6 string IPv6 subnet for fixed IPs | ||
| --feature map Enable feature in the daemon (default map[]) |
There was a problem hiding this comment.
This may have been a case where we also removed the default for the docs (and possibly should consider doing so for the CLI, as (default map[]) may not say much for the user.
docs/reference/dockerd.md
Outdated
| -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 | ||
| --registry-mirror list Preferred Docker registry mirror |
There was a problem hiding this comment.
Perhaps one we should consider updating in code as well; I suspect we removed Docker to move away from "Docker registry", as it's an OCI registry, but we should update it to indicate that mirror is only for Docker Hub currently 🤔
Signed-off-by: Rob Murray <[email protected]>
Signed-off-by: Rob Murray <[email protected]>
robmry
force-pushed
the
doc_default_bridge
branch
from
88f9c63 to
4e7497e
Compare
Thank you - I've updated those ... only the change for |
5 participants
- What I did
Updated the dockerd command line option reference (for https://docs.docker.com/reference/cli/dockerd/).
- How I did it
Pasted in current
--helpoutput, fixed up some paths.- How to verify it
- Human readable description for the release notes