Browse code

Add docs for --ipv6 option, also add --internal as appropriate

Signed-off-by: Aidan Hobson Sayers <aidanhs@cantab.net>

Aidan Hobson Sayers authored on 2016/02/12 10:42:15
Showing 6 changed files
... ...
@@ -50,7 +50,7 @@ func (cli *DockerCli) CmdNetworkCreate(args ...string) error {
50 50
 	cmd.Var(flIpamOpt, []string{"-ipam-opt"}, "set IPAM driver specific options")
51 51
 
52 52
 	flInternal := cmd.Bool([]string{"-internal"}, false, "restricts external access to the network")
53
-	flIPv6 := cmd.Bool([]string{"-ipv6"}, false, "enables IPv6 on the network")
53
+	flIPv6 := cmd.Bool([]string{"-ipv6"}, false, "enable IPv6 networking")
54 54
 
55 55
 	cmd.Require(flag.Exact, 1)
56 56
 	err := cmd.ParseFlags(args, true)
... ...
@@ -1275,7 +1275,7 @@ _docker_network_connect() {
1275 1275
 
1276 1276
 _docker_network_create() {
1277 1277
 	case "$prev" in
1278
-		--aux-address|--gateway|--ip-range|--ipam-opt|--opt|-o|--subnet)
1278
+		--aux-address|--gateway|--internal|--ip-range|--ipam-opt|--ipv6|--opt|-o|--subnet)
1279 1279
 			return
1280 1280
 			;;
1281 1281
 		--ipam-driver)
... ...
@@ -1294,7 +1294,7 @@ _docker_network_create() {
1294 1294
 
1295 1295
 	case "$cur" in
1296 1296
 		-*)
1297
-			COMPREPLY=( $( compgen -W "--aux-address --driver -d --gateway --help --internal --ip-range --ipam-driver --ipam-opt --opt -o --subnet" -- "$cur" ) )
1297
+			COMPREPLY=( $( compgen -W "--aux-address --driver -d --gateway --help --internal --ip-range --ipam-driver --ipam-opt --ipv6 --opt -o --subnet" -- "$cur" ) )
1298 1298
 			;;
1299 1299
 	esac
1300 1300
 }
... ...
@@ -332,6 +332,7 @@ __docker_network_subcommand() {
332 332
                 "($help)*--ip-range=[Allocate container ip from a sub-range]:IP/mask: " \
333 333
                 "($help)--ipam-driver=[IP Address Management Driver]:driver:(default)" \
334 334
                 "($help)*--ipam-opt=[Set custom IPAM plugin options]:opt=value: " \
335
+                "($help)--ipv6[Enable IPv6 networking]" \
335 336
                 "($help)*"{-o=,--opt=}"[Set driver specific options]:opt=value: " \
336 337
                 "($help)*--subnet=[Subnet in CIDR format that represents a network segment]:IP/mask: " \
337 338
                 "($help -)1:Network Name: " && ret=0
... ...
@@ -22,6 +22,7 @@ parent = "smn_cli"
22 22
     --ip-range=[]            Allocate container ip from a sub-range
23 23
     --ipam-driver=default    IP Address Management Driver
24 24
     --ipam-opt=map[]         Set custom IPAM driver specific options
25
+    --ipv6                   Enable IPv6 networking
25 26
     -o --opt=map[]           Set custom driver specific options
26 27
     --subnet=[]              Subnet in CIDR format that represents a network segment
27 28
 
... ...
@@ -134,7 +135,13 @@ The following are those options and the equivalent docker daemon flags used for
134 134
 | `com.docker.network.bridge.enable_icc`           | `--icc`     | Enable or Disable Inter Container Connectivity        |
135 135
 | `com.docker.network.bridge.host_binding_ipv4`    | `--ip`      | Default IP when binding container ports               |
136 136
 | `com.docker.network.mtu`                         | `--mtu`     | Set the containers network MTU                        |
137
-| `com.docker.network.enable_ipv6`                 | `--ipv6`    | Enable IPv6 networking                                |
137
+
138
+The following arguments can be passed to `docker network create` for any network driver.
139
+
140
+| Argument     | Equivalent | Description                              |
141
+|--------------|------------|------------------------------------------|
142
+| `--internal` | -          | Restricts external access to the network |
143
+| `--ipv6`     | `--ipv6`   | Enable IPv6 networking                   |
138 144
 
139 145
 For example, let's use `-o` or `--opt` options to specify an IP address binding when publishing ports:
140 146
 
... ...
@@ -111,7 +111,13 @@ The following are those options and the equivalent docker daemon flags used for
111 111
 | `com.docker.network.bridge.enable_icc`           | `--icc`     | Enable or Disable Inter Container Connectivity        |
112 112
 | `com.docker.network.bridge.host_binding_ipv4`    | `--ip`      | Default IP when binding container ports               |
113 113
 | `com.docker.network.mtu`                         | `--mtu`     | Set the containers network MTU                        |
114
-| `com.docker.network.enable_ipv6`                 | `--ipv6`    | Enable IPv6 networking                                |
114
+
115
+The following arguments can be passed to `docker network create` for any network driver.
116
+
117
+| Argument     | Equivalent | Description                              |
118
+|--------------|------------|------------------------------------------|
119
+| `--internal` | -          | Restricts external access to the network |
120
+| `--ipv6`     | `--ipv6`   | Enable IPv6 networking                   |
115 121
 
116 122
 For example, now let's use `-o` or `--opt` options to specify an IP address binding when publishing ports:
117 123
 
... ...
@@ -14,6 +14,7 @@ docker-network-create - create a new network
14 14
 [**--ip-range**=*[]*]
15 15
 [**--ipam-driver**=*default*]
16 16
 [**--ipam-opt**=*map[]*]
17
+[**--ipv6**]
17 18
 [**-o**|**--opt**=*map[]*]
18 19
 [**--subnet**=*[]*]
19 20
 NETWORK-NAME
... ...
@@ -152,6 +153,9 @@ If you want to create an externally isolated `overlay` network, you can specify
152 152
 **--ipam-opt**=map[]
153 153
   Set custom IPAM driver options
154 154
 
155
+**--ipv6**
156
+  Enable IPv6 networking
157
+
155 158
 **-o**, **--opt**=map[]
156 159
   Set custom driver options
157 160