Docs: host-gateway-ip daemon option IPv4+IPv6 #5607
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5607 +/- ##
=======================================
Coverage 59.53% 59.53%
=======================================
Files 346 346
Lines 29357 29357
=======================================
Hits 17477 17477
Misses 10910 10910
Partials 970 970 |
robmry
force-pushed
the
v6only/host_gateway_ip
branch
2 times, most recently
from
f92dc3f
to
1864129
Compare
docs/reference/dockerd.md
Outdated
| @@ -62,8 +62,7 @@ Options: | |||
| -G, --group string Group for the unix socket (default "docker") | |||
| --help Print usage | |||
| -H, --host list Daemon socket(s) to connect to | |||
| --host-gateway-ip ip IP address that the special 'host-gateway' string in --add-host resolves to. | |||
| Defaults to the IP address of the default bridge | |||
| --host-gateway-ip list IP addresses that the special 'host-gateway' string in --add-host resolves to. Defaults to the IP addresses of the default bridge | |||
There was a problem hiding this comment.
Oh! Can you manually wrap / format this one? This page is still manually maintained and this block rendered as a code-block, so wrapping reduces horizontal scrolling; see https://docs.docker.com/reference/cli/dockerd/
There was a problem hiding this comment.
Will do ... I did that at first, then thought maybe it was supposed to exactly match the --help output. Doh!
host-gateway-ip isn't a new option, but it's not in the manpage in this repo or moby ... I'll add it.
There was a problem hiding this comment.
Yeah we really need to;
- update our packaging to use the man-page from moby/moby instead (and remove the man page from this repo)
- look at moving the dockerd reference docs to moby/moby, and use the "docs-generator" to generate these flag-descriptions and the "YAML" docs so that we can use the same formatting as the other reference docs.
There was a problem hiding this comment.
I've fixed the dockerd.md formatting, and added --host-gateway to the manpage (also put --help in the right place).
I'll make the same changes to moby's copy of the manpage.
The host-gateway-ip daemon option now accepts two addresses, one IPv4 and one IPv6. Signed-off-by: Rob Murray <[email protected]>
Signed-off-by: Rob Murray <[email protected]>
Signed-off-by: Rob Murray <[email protected]>
robmry
force-pushed
the
v6only/host_gateway_ip
branch
from
1864129
to
c629eca
Compare
| @@ -63,8 +63,8 @@ Options: | |||
| -G, --group string Group for the unix socket (default "docker") | |||
| --help Print usage | |||
| -H, --host list Daemon socket(s) to connect to | |||
| --host-gateway-ip ip IP address that the special 'host-gateway' string in --add-host resolves to. | |||
| Defaults to the IP address of the default bridge | |||
| --host-gateway-ip list IP addresses that the special 'host-gateway' string in --add-host resolves to. | |||
There was a problem hiding this comment.
I hate Cobra for this; we should probably look if we can make it show a custom type. "list" is ... not very informative. The ugly bit is that Cobra doesn't allow you to set it per flag, but it's really tied to the type you're using 😞 (perhaps we can come with some trickery to initialise it for a specific flag 🤔)
- What I did
Depends on:
The host-gateway-ip daemon option now accepts two addresses, one IPv4 and one IPv6.
- How I did it
- How to verify it
- Description for the changelog