Browse code

Merge pull request #8839 from irachex/dns-search-doc

Add docs for --dns-search=.

Michael Crosby authored on 2014/11/01 03:25:57
Showing 5 changed files
... ...
@@ -64,7 +64,7 @@ docker-create - Create a new container
64 64
    Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
65 65
 
66 66
 **--dns-search**=[]
67
-   Set custom DNS search domains
67
+   Set custom DNS search domains (Use --dns-search=. if you don't wish to set the search domain)
68 68
 
69 69
 **--dns**=[]
70 70
    Set custom DNS servers
... ...
@@ -103,7 +103,7 @@ stopping the process by pressing the keys CTRL-P CTRL-Q.
103 103
    Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
104 104
 
105 105
 **--dns-search**=[]
106
-   Set custom DNS search domains
106
+   Set custom DNS search domains (Use --dns-search=. if you don't wish to set the search domain)
107 107
 
108 108
 **--dns**=*IP-address*
109 109
    Set custom DNS servers. This option can be used to override the DNS
... ...
@@ -195,8 +195,8 @@ and foreground Docker containers.
195 195
    When set to true publish all exposed ports to the host interfaces. The
196 196
 default is false. If the operator uses -P (or -p) then Docker will make the
197 197
 exposed port accessible on the host and the ports will be available to any
198
-client that can reach the host. When using -P, Docker will bind the exposed 
199
-ports to a random port on the host between 49153 and 65535. To find the 
198
+client that can reach the host. When using -P, Docker will bind the exposed
199
+ports to a random port on the host between 49153 and 65535. To find the
200 200
 mapping between the host ports and the exposed ports, use **docker port**.
201 201
 
202 202
 **-p**, **--publish**=[]
... ...
@@ -232,11 +232,11 @@ interactive shell. The default is value is false.
232 232
 
233 233
 
234 234
 **-v**, **--volume**=*volume*[:ro|:rw]
235
-   Bind mount a volume to the container. 
235
+   Bind mount a volume to the container.
236 236
 
237 237
 The **-v** option can be used one or
238 238
 more times to add one or more mounts to a container. These mounts can then be
239
-used in other containers using the **--volumes-from** option. 
239
+used in other containers using the **--volumes-from** option.
240 240
 
241 241
 The volume may be optionally suffixed with :ro or :rw to mount the volumes in
242 242
 read-only or read-write mode, respectively. By default, the volumes are mounted
... ...
@@ -247,11 +247,11 @@ read-write. See examples.
247 247
 Once a volume is mounted in a one container it can be shared with other
248 248
 containers using the **--volumes-from** option when running those other
249 249
 containers. The volumes can be shared even if the original container with the
250
-mount is not running. 
250
+mount is not running.
251 251
 
252
-The container ID may be optionally suffixed with :ro or 
253
-:rw to mount the volumes in read-only or read-write mode, respectively. By 
254
-default, the volumes are mounted in the same mode (read write or read only) as 
252
+The container ID may be optionally suffixed with :ro or
253
+:rw to mount the volumes in read-only or read-write mode, respectively. By
254
+default, the volumes are mounted in the same mode (read write or read only) as
255 255
 the reference container.
256 256
 
257 257
 
... ...
@@ -14,7 +14,7 @@ Docker made the choice `172.17.42.1/16` when I started it a few minutes
14 14
 ago, for example — a 16-bit netmask providing 65,534 addresses for the
15 15
 host machine and its containers.
16 16
 
17
-> **Note:** 
17
+> **Note:**
18 18
 > This document discusses advanced networking configuration
19 19
 > and options for Docker. In most cases you won't need this information.
20 20
 > If you're looking to get started with a simpler explanation of Docker
... ...
@@ -170,6 +170,7 @@ Four different options affect container domain name services.
170 170
     When a container process attempts to access `host` and the search
171 171
     domain `example.com` is set, for instance, the DNS logic will not
172 172
     only look up `host` but also `host.example.com`.
173
+    Use `--dns-search=.` if you don't wish to set the search domain.
173 174
 
174 175
 Note that Docker, in the absence of either of the last two options
175 176
 above, will make `/etc/resolv.conf` inside of each container look like
... ...
@@ -119,7 +119,7 @@ for un-encrypted, and port `2376` for encrypted communication with the daemon.
119 119
 > and greater are supported. Protocols SSLv3 and under are not supported anymore
120 120
 > for security reasons.
121 121
 
122
-On Systemd based systems, you can communicate with the daemon via 
122
+On Systemd based systems, you can communicate with the daemon via
123 123
 [systemd socket activation](http://0pointer.de/blog/projects/socket-activation.html), use
124 124
 `docker -d -H fd://`. Using `fd://` will work perfectly for most setups but
125 125
 you can also specify individual sockets: `docker -d -H fd://3`. If the
... ...
@@ -505,7 +505,7 @@ Creates a new container.
505 505
       --cpuset=""                CPUs in which to allow execution (0-3, 0,1)
506 506
       --device=[]                Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
507 507
       --dns=[]                   Set custom DNS servers
508
-      --dns-search=[]            Set custom DNS search domains
508
+      --dns-search=[]            Set custom DNS search domains (Use --dns-search=. if you don't wish to set the search domain)
509 509
       -e, --env=[]               Set environment variables
510 510
       --entrypoint=""            Overwrite the default ENTRYPOINT of the image
511 511
       --env-file=[]              Read in a line delimited file of environment variables
... ...
@@ -1015,7 +1015,7 @@ used, which is observable by the process being suspended. With the cgroups freez
1015 1015
 the process is unaware, and unable to capture, that it is being suspended,
1016 1016
 and subsequently resumed.
1017 1017
 
1018
-See the 
1018
+See the
1019 1019
 [cgroups freezer documentation](https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt)
1020 1020
 for further details.
1021 1021
 
... ...
@@ -1207,7 +1207,7 @@ removed before the image is removed.
1207 1207
       -d, --detach=false         Detached mode: run the container in the background and print the new container ID
1208 1208
       --device=[]                Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
1209 1209
       --dns=[]                   Set custom DNS servers
1210
-      --dns-search=[]            Set custom DNS search domains
1210
+      --dns-search=[]            Set custom DNS search domains (Use --dns-search=. if you don't wish to set the search domain)
1211 1211
       -e, --env=[]               Set environment variables
1212 1212
       --entrypoint=""            Overwrite the default ENTRYPOINT of the image
1213 1213
       --env-file=[]              Read in a line delimited file of environment variables
... ...
@@ -1595,7 +1595,7 @@ them to [*Share Images via Repositories*](
1595 1595
 The `docker unpause` command uses the cgroups freezer to un-suspend all
1596 1596
 processes in a container.
1597 1597
 
1598
-See the 
1598
+See the
1599 1599
 [cgroups freezer documentation](https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt)
1600 1600
 for further details.
1601 1601
 
... ...
@@ -73,7 +73,7 @@ func Parse(cmd *flag.FlagSet, args []string, sysInfo *sysinfo.SysInfo) (*Config,
73 73
 	cmd.Var(&flPublish, []string{"p", "-publish"}, fmt.Sprintf("Publish a container's port to the host\nformat: %s\n(use 'docker port' to see the actual mapping)", nat.PortSpecTemplateFormat))
74 74
 	cmd.Var(&flExpose, []string{"#expose", "-expose"}, "Expose a port from the container without publishing it to your host")
75 75
 	cmd.Var(&flDns, []string{"#dns", "-dns"}, "Set custom DNS servers")
76
-	cmd.Var(&flDnsSearch, []string{"-dns-search"}, "Set custom DNS search domains")
76
+	cmd.Var(&flDnsSearch, []string{"-dns-search"}, "Set custom DNS search domains (Use --dns-search=. if you don't wish to set the search domain)")
77 77
 	cmd.Var(&flExtraHosts, []string{"-add-host"}, "Add a custom host-to-IP mapping (host:ip)")
78 78
 	cmd.Var(&flVolumesFrom, []string{"#volumes-from", "-volumes-from"}, "Mount volumes from the specified container(s)")
79 79
 	cmd.Var(&flLxcOpts, []string{"#lxc-conf", "-lxc-conf"}, "(lxc exec-driver only) Add custom lxc options --lxc-conf=\"lxc.cgroup.cpuset.cpus = 0,1\"")