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.

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

Update dockerd command line ref #5865

Merged
merged 2 commits into from
Feb 24, 2025
Merged

Conversation

robmry
Copy link
Contributor

@robmry robmry commented Feb 24, 2025

- 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 --help output, fixed up some paths.

- How to verify it

- Human readable description for the release notes

@robmry robmry added this to the 28.0.1 milestone Feb 24, 2025
@robmry robmry self-assigned this Feb 24, 2025
@robmry robmry requested review from thaJeztah and a team as code owners February 24, 2025 15:27
@codecov-commenter
Copy link

codecov-commenter commented Feb 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.27%. Comparing base (656523e) to head (4e7497e).
Report is 11 commits behind head on master.

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           

Copy link
Collaborator

@vvoland vvoland left a comment

Choose a reason for hiding this comment

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

Oh actually, didn't we move it back to moby/moby?

moby/moby#48298

EDIT: So this is actually different, but thinking if we could share the flags description between these 🤔

@thaJeztah
Copy link
Member

Oh actually, didn't we move it back to moby/moby?

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 copy/paste usage output).

So we're "half-way there" 🙈

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

Some minor nits to consider, but not a strict blocker (some bits we should consider updating in actual code probably)

--dns list DNS server to use
--dns ipSlice DNS server to use (default [])
Copy link
Member

Choose a reason for hiding this comment

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

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)

--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[])
Copy link
Member

Choose a reason for hiding this comment

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

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.

--registry-mirror list Preferred registry mirror
--registry-mirror list Preferred Docker registry mirror
Copy link
Member

Choose a reason for hiding this comment

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

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 🤔

Verified

This commit was signed with the committer’s verified signature.
thaJeztah Sebastiaan van Stijn
Signed-off-by: Rob Murray <rob.murray@docker.com>
Signed-off-by: Rob Murray <rob.murray@docker.com>
@robmry robmry force-pushed the doc_default_bridge branch from 88f9c63 to 4e7497e Compare February 24, 2025 18:07
@robmry
Copy link
Contributor Author

robmry commented Feb 24, 2025

Some minor nits to consider, but not a strict blocker (some bits we should consider updating in actual code probably)

Thank you - I've updated those ... only the change for --seccomp-profile is left in the first commit.

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

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.

None yet

5 participants