docs: add description and examples for docker -H #4260
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #4260 +/- ##
==========================================
- Coverage 58.88% 58.87% -0.01%
==========================================
Files 570 570
Lines 49566 49558 -8
==========================================
- Hits 29186 29178 -8
Misses 18616 18616
Partials 1764 1764 |
thaJeztah
left a comment
thaJeztah
left a comment
There was a problem hiding this comment.
Thanks! Left some suggestions / comments
docs/reference/commandline/cli.md
Outdated
| daemon with IP address `174.17.0.1`, listening on port `3131`: | ||
|
|
||
| ```console | ||
| $ docker -H tcp://174.17.0.1:3131 ps |
There was a problem hiding this comment.
perhaps use :2376 here to encourage using the secure connection.
We have 3 ports registered; https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=docker
2375: tcp, non-TLS (insecure)2376: tcp (TLS)2377: used for swarm (secure)
So only the first 2 are relevant for this one, but perhaps we need to mention them somewhere
There was a problem hiding this comment.
I added a small note about it here, but we might want to add a similar description for this somewhere else too. Let's take it in a followup. LMK if the note I added seems OK to you.
|
Signed-off-by: David Karlsson <david.karlsson@docker.com>
| // opts.ValidateHost is not used here, so as to allow connection helpers | ||
| hostOpt := opts.NewNamedListOptsRef("hosts", &o.Hosts, nil) | ||
| flags.VarP(hostOpt, "host", "H", "Daemon socket(s) to connect to") | ||
| flags.VarP(hostOpt, "host", "H", "Daemon socket to connect to") |
There was a problem hiding this comment.
For a follow up we need to look at better wording for this, as this is not only for "sockets".
Okay for now, because we use this terminology in other places, so something to look at in a wider scope
3 participants
Signed-off-by: David Karlsson david.karlsson@docker.com
- What I did
Added a description for the
docker -Hflag. Since we don't really have a better place to put this atm, I used thecli.mdfile.- How I did it
- How to verify it
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)