Browse code

Merge pull request #18301 from wenchma/doc_update_for_net

Add NETWORK_NAME_or_ID value for --net= option

Sebastiaan van Stijn authored on 2015/12/03 06:36:01
Showing 7 changed files
... ...
@@ -278,7 +278,7 @@ __docker_network_commands() {
278 278
         "disconnect:Disconnects a container from a network"
279 279
         "inspect:Displays detailed information on a network"
280 280
         "ls:Lists all the networks created by the user"
281
-        "rm:Deletes a network"
281
+        "rm:Deletes one or more networks"
282 282
     )
283 283
     _describe -t docker-network-commands "docker network command" _docker_network_subcommands
284 284
 }
... ...
@@ -56,7 +56,12 @@ Creates a new container.
56 56
       --memory-swap=""              Total memory (memory + swap), '-1' to disable swap
57 57
       --memory-swappiness=""        Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
58 58
       --name=""                     Assign a name to the container
59
-      --net="default"               Set the Network mode for the container
59
+      --net="bridge"                Connect a container to a network
60
+                                    'bridge': create a network stack on the default Docker bridge
61
+                                    'none': no networking
62
+                                    'container:<name|id>': reuse another container's network stack
63
+                                    'host': use the Docker host network stack
64
+                                    '<network-name>|<network-id>': connect to a user-defined network
60 65
       --oom-kill-disable=false      Whether to disable OOM Killer for the container or not
61 66
       --oom-score-adj=0             Tune the host's OOM preferences for containers (accepts -1000 to 1000)
62 67
       -P, --publish-all=false       Publish all exposed ports to random ports
... ...
@@ -55,12 +55,12 @@ parent = "smn_cli"
55 55
       --memory-swap=""              Total memory (memory + swap), '-1' to disable swap
56 56
       --memory-swappiness=""        Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
57 57
       --name=""                     Assign a name to the container
58
-      --net="bridge"                Connects a container to a network
59
-                                    'bridge': creates a new network stack for the container on the docker bridge
60
-                                    'none': no networking for this container
61
-                                    'container:<name|id>': reuses another container network stack
62
-                                    'host': use the host network stack inside the container
63
-                                    'NETWORK': connects the container to user-created network using `docker network create` command
58
+      --net="bridge"                Connect a container to a network
59
+                                    'bridge': create a network stack on the default Docker bridge
60
+                                    'none': no networking
61
+                                    'container:<name|id>': reuse another container's network stack
62
+                                    'host': use the Docker host network stack
63
+                                    '<network-name>|<network-id>': connect to a user-defined network
64 64
       --oom-kill-disable=false      Whether to disable OOM Killer for the container or not
65 65
       --oom-score-adj=0             Tune the host's OOM preferences for containers (accepts -1000 to 1000)
66 66
       -P, --publish-all=false       Publish all exposed ports to random ports
... ...
@@ -244,12 +244,12 @@ of the containers.
244 244
 ## Network settings
245 245
 
246 246
     --dns=[]         : Set custom dns servers for the container
247
-    --net="bridge"   : Connects a container to a network
248
-                        'bridge': creates a new network stack for the container on the docker bridge
249
-                        'none': no networking for this container
250
-                        'container:<name|id>': reuses another container network stack
251
-                        'host': use the host network stack inside the container
252
-                        'NETWORK': connects the container to user-created network using `docker network create` command
247
+    --net="bridge"   : Connect a container to a network
248
+                        'bridge': create a network stack on the default Docker bridge
249
+                        'none': no networking
250
+                        'container:<name|id>': reuse another container's network stack
251
+                        'host': use the Docker host network stack
252
+                        '<network-name>|<network-id>': connect to a user-defined network
253 253
     --add-host=""    : Add a line to /etc/hosts (host:IP)
254 254
     --mac-address="" : Sets the container's Ethernet device's MAC address
255 255
 
... ...
@@ -15,7 +15,7 @@ DRAFT to prevent building. Keeping for one cycle before deleting.
15 15
 
16 16
 # How the default network
17 17
 
18
-The information in this section explains configuring container DNS within tthe Docker default bridge. This is a `bridge` network named `bridge` created
18
+The information in this section explains configuring container networks within the Docker default bridge. This is a `bridge` network named `bridge` created
19 19
 automatically when you install Docker.
20 20
 
21 21
 **Note**: The [Docker networks feature](../dockernetworks.md) allows you to create user-defined networks in addition to the default bridge network.
... ...
@@ -40,7 +40,7 @@ The steps with which Docker configures a container are:
40 40
 
41 41
 With these steps complete, the container now possesses an `eth0` (virtual) network card and will find itself able to communicate with other containers and the rest of the Internet.
42 42
 
43
-You can opt out of the above process for a particular container by giving the `--net=` option to `docker run`, which takes four possible values.
43
+You can opt out of the above process for a particular container by giving the `--net=` option to `docker run`, which takes these possible values.
44 44
 - `--net=bridge` -- The default action, that connects the container to the Docker bridge as described above.
45 45
 
46 46
 - `--net=host` -- Tells Docker to skip placing the container inside of a separate network stack.  In essence, this choice tells Docker to **not containerize the container's networking**!  While container processes will still be confined to their own filesystem and process list and resource limits, a quick `ip addr` command will show you that, network-wise, they live "outside" in the main Docker host and have full access to its network interfaces.  Note that this does **not** let the container reconfigure the host network stack -- that would require `--privileged=true` -- but it does let container processes open low-numbered ports like any other root process. It also allows the container to access local network services like D-bus.  This can lead to processes in the container being able to do unexpected things like [restart your computer](https://github.com/docker/docker/issues/6401). You should use this option with caution.
... ...
@@ -49,6 +49,8 @@ You can opt out of the above process for a particular container by giving the `-
49 49
 
50 50
 - `--net=none` -- Tells Docker to put the container inside of its own network stack but not to take any steps to configure its network, leaving you free to build any of the custom configurations explored in the last few sections of this document.
51 51
 
52
+- `--net=<network-name>|<network-id>` -- Tells Docker to connect the container to a user-defined network.
53
+
52 54
 ## Manually network
53 55
 
54 56
 To get an idea of the steps that are necessary if you use `--net=none` as described in that last bullet point, here are the commands that you would run to reach roughly the same configuration as if you had let Docker do all of the configuration:
... ...
@@ -227,10 +227,11 @@ This value should always larger than **-m**, so you should always use this with
227 227
 
228 228
 **--net**="*bridge*"
229 229
    Set the Network mode for the container
230
-                               'bridge': creates a new network stack for the container on the docker bridge
231
-                               'none': no networking for this container
232
-                               'container:<name|id>': reuses another container network stack
233
-                               'host': use the host network stack inside the container.  Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
230
+                               'bridge': create a network stack on the default Docker bridge
231
+                               'none': no networking
232
+                               'container:<name|id>': reuse another container's network stack
233
+                               'host': use the Docker host network stack.  Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
234
+                               '<network-name>|<network-id>': connect to a user-defined network
234 235
 
235 236
 **--oom-kill-disable**=*true*|*false*
236 237
 	Whether to disable OOM Killer for the container or not.
... ...
@@ -339,10 +339,11 @@ and foreground Docker containers.
339 339
 
340 340
 **--net**="*bridge*"
341 341
    Set the Network mode for the container
342
-                               'bridge': creates a new network stack for the container on the docker bridge
343
-                               'none': no networking for this container
344
-                               'container:<name|id>': reuses another container network stack
345
-                               'host': use the host network stack inside the container.  Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
342
+                               'bridge': create a network stack on the default Docker bridge
343
+                               'none': no networking
344
+                               'container:<name|id>': reuse another container's network stack
345
+                               'host': use the Docker host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
346
+                               '<network-name>|<network-id>': connect to a user-defined network
346 347
 
347 348
 **--oom-kill-disable**=*true*|*false*
348 349
    Whether to disable OOM Killer for the container or not.