Skip to content

Document option for daemon config validation#3108

Merged
thaJeztah merged 1 commit intodocker:masterfrom
aiordache:validate_dockerd_config
Jun 24, 2021
Merged

Document option for daemon config validation#3108
thaJeztah merged 1 commit intodocker:masterfrom
aiordache:validate_dockerd_config

Conversation

@aiordache
Copy link
Copy Markdown
Contributor

We are adding a --validate option to dockerd to check if the config file is valid without starting the daemon.

Related to moby/moby#42393

- What I did
Added --validate option to the docker daemon options documentation.

- Description for the changelog
Update documentation and shell completion for the daemon validation option.

Comment thread docs/reference/commandline/dockerd.md
@thaJeztah
Copy link
Copy Markdown
Member

I moved this temporarily to "draft", pending moby/moby#42393 to be merged

@thaJeztah thaJeztah added this to the 21.xx milestone May 25, 2021
@aiordache aiordache force-pushed the validate_dockerd_config branch from 99b8ec3 to cf1442d Compare May 26, 2021 17:25
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 26, 2021

Codecov Report

Merging #3108 (cf1442d) into master (6b4d2e8) will not change coverage.
The diff coverage is n/a.

❗ Current head cf1442d differs from pull request most recent head 0f17575. Consider uploading reports for the commit 0f17575 to get more accurate results

@@           Coverage Diff           @@
##           master    #3108   +/-   ##
=======================================
  Coverage   56.96%   56.96%           
=======================================
  Files         299      299           
  Lines       18733    18733           
=======================================
  Hits        10672    10672           
  Misses       7193     7193           
  Partials      868      868           

Copy link
Copy Markdown
Collaborator

@albers albers left a comment

Choose a reason for hiding this comment

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

completion LGTM, thanks

Copy link
Copy Markdown
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

@thaJeztah thaJeztah marked this pull request as ready for review June 23, 2021 18:23
@thaJeztah
Copy link
Copy Markdown
Member

moved out of draft as moby PR was merged, but it needs a minor update (I'll leave a comment)

1 similar comment
@thaJeztah
Copy link
Copy Markdown
Member

moved out of draft as moby PR was merged, but it needs a minor update (I'll leave a comment)

Copy link
Copy Markdown
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.

left a comment 🤗

Comment thread docs/reference/commandline/dockerd.md Outdated

```console
$ dockerd --validate --config-file=/tmp/valid-config.json
Config OK
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This changed to

Suggested change
Config OK
configuration OK

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Should we also mention that the exit status will be 0 (success) and non-zero (failure)? as that's the "actual" check (message that's printed is informational)?

@aiordache aiordache force-pushed the validate_dockerd_config branch 3 times, most recently from c09cb25 to 64b2e95 Compare June 24, 2021 13:58
Copy link
Copy Markdown
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!

@thaJeztah thaJeztah merged commit 8e08b72 into docker:master Jun 24, 2021
Signed-off-by: Anca Iordache <[email protected]>
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.

4 participants