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.

Sign up for GitHub

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

Jump to bottom

Document option for daemon config validation #3108

Merged
merged 1 commit into from Jun 24, 2021
Merged

Document option for daemon config validation #3108

merged 1 commit into from Jun 24, 2021

Conversation

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

@thaJeztah thaJeztah marked this pull request as draft May 25, 2021 15:21
@thaJeztah
Copy link
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
@codecov-commenter
Copy link

codecov-commenter commented May 26, 2021 •
edited

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

albers
albers approved these changes May 27, 2021
View reviewed changes
Copy link
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

thaJeztah
thaJeztah approved these changes May 27, 2021
View reviewed changes
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

@thaJeztah thaJeztah marked this pull request as ready for review June 23, 2021 18:23
@thaJeztah
Copy link
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
Member

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

thaJeztah
thaJeztah requested changes Jun 23, 2021
View reviewed changes
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.

left a comment 🤗

docs/reference/commandline/dockerd.md Outdated

```console
$ dockerd --validate --config-file=/tmp/valid-config.json
Config OK
Copy link
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
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
thaJeztah
thaJeztah approved these changes Jun 24, 2021
View reviewed changes
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!

@thaJeztah thaJeztah merged commit 8e08b72 into docker:master Jun 24, 2021
@aiordache
Document --validate daemon option
64b2e95 
Signed-off-by: Anca Iordache <anca.iordache@docker.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thaJeztah thaJeztah thaJeztah approved these changes

@albers albers albers approved these changes

Assignees
No one assigned
Labels
kind/docs status/3-docs-review
Projects
None yet
Milestone
23.0.0
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@aiordache @thaJeztah @codecov-commenter @albers