docker / docker/cli

There is no where to see all of the configurations options and possible values for dockerd

Open
#3,860 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/docs kind/feature status/0-triage
Dominant language
Go
Stars
6.1k
Forks
2.2k
Avg merge
1d 15h
Merged PRs (30d)
43

Description

Description

Both the command line help and the online documentation could be more helpful by displaying all of the configuration options for dockerd (using either the command line or a daemon.js file).

Command line help
This does not display the possible values for --log-opts.
Screenshot 2022-11-11 at 4 22 55 PM

Online Documentation
Daemon Configuration File
Displays all of the configuration options, but does not include an example of the possible values nor a description of each option. For instance, if you want to set the max-size to 1 GB would that be 1g or 1G.

Also, there is no description about what each option does. The descriptions from the command line help would be nice here also in addition to adding descriptions for nested options like the log-opts properties.

Screenshot 2022-11-11 at 4 25 31 PM

This JSON File logging driver is a good start, however, it should be easier to find when searching for daemon.json or Daemon Configuration File.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the dockerd command-line help and the linked Daemon Configuration File documentation, then compare their coverage with the JSON File logging driver page. Identify where configuration options, nested log-opts values, examples, and descriptions are documented; done means the command-line and online references clearly expose the requested options and possible values.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
cli, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.