Browse code

Update docs for enableipv6

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

Aidan Hobson Sayers authored on 2016/02/24 01:08:09
Showing 3 changed files
... ...
@@ -117,7 +117,9 @@ This section lists each version from latest to oldest.  Each listing includes a
117 117
 
118 118
 * `GET /containers/json` returns the state of the container, one of `created`, `restarting`, `running`, `paused`, `exited` or `dead`.
119 119
 * `GET /networks/(name)` now returns an `Internal` field showing whether the network is internal or not.
120
+* `GET /networks/(name)` now returns an `EnableIPv6` field showing whether the network has ipv6 enabled or not.
120 121
 * `POST /containers/(name)/update` now supports updating container's restart policy.
122
+* `POST /networks/create` now supports enabling ipv6 on the network by setting the `EnableIPv6` field (doing this with a label will no longer work).
121 123
 
122 124
 ### v1.22 API changes
123 125
 
... ...
@@ -142,7 +144,7 @@ This section lists each version from latest to oldest.  Each listing includes a
142 142
 * `POST /containers/create` now allows you to set the static IPv4 and/or IPv6 address for the container.
143 143
 * `POST /networks/(id)/connect` now allows you to set the static IPv4 and/or IPv6 address for the container.
144 144
 * `GET /info` now includes the number of containers running, stopped, and paused.
145
-* `POST /networks/create` now supports restricting external access to the network by setting the `internal` field.
145
+* `POST /networks/create` now supports restricting external access to the network by setting the `Internal` field.
146 146
 * `POST /networks/(id)/disconnect` now includes a `Force` option to forcefully disconnect a container from network
147 147
 * `GET /containers/(id)/json` now returns the `NetworkID` of containers.
148 148
 * `POST /networks/create` Now supports an options field in the IPAM config that provides options
... ...
@@ -2890,6 +2890,8 @@ Content-Type: application/json
2890 2890
     "Id": "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566",
2891 2891
     "Scope": "local",
2892 2892
     "Driver": "bridge",
2893
+    "EnableIPv6": false,
2894
+    "Internal": false,
2893 2895
     "IPAM": {
2894 2896
       "Driver": "default",
2895 2897
       "Config": [
... ...
@@ -2920,6 +2922,8 @@ Content-Type: application/json
2920 2920
     "Id": "e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794",
2921 2921
     "Scope": "local",
2922 2922
     "Driver": "null",
2923
+    "EnableIPv6": false,
2924
+    "Internal": false,
2923 2925
     "IPAM": {
2924 2926
       "Driver": "default",
2925 2927
       "Config": []
... ...
@@ -2932,6 +2936,8 @@ Content-Type: application/json
2932 2932
     "Id": "13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e",
2933 2933
     "Scope": "local",
2934 2934
     "Driver": "host",
2935
+    "EnableIPv6": false,
2936
+    "Internal": false,
2935 2937
     "IPAM": {
2936 2938
       "Driver": "default",
2937 2939
       "Config": []
... ...
@@ -2973,6 +2979,7 @@ Content-Type: application/json
2973 2973
   "Id": "7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99",
2974 2974
   "Scope": "local",
2975 2975
   "Driver": "bridge",
2976
+  "EnableIPv6": false,
2976 2977
   "IPAM": {
2977 2978
     "Driver": "default",
2978 2979
     "Config": [
... ...
@@ -3026,6 +3033,7 @@ Content-Type: application/json
3026 3026
 {
3027 3027
   "Name":"isolated_nw",
3028 3028
   "Driver":"bridge",
3029
+  "EnableIPv6": false,
3029 3030
   "IPAM":{
3030 3031
     "Config":[{
3031 3032
       "Subnet":"172.20.0.0/16",
... ...
@@ -3062,7 +3070,9 @@ JSON Parameters:
3062 3062
 
3063 3063
 - **Name** - The new network's name. this is a mandatory field
3064 3064
 - **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver
3065
+- **Internal** - Restrict external access to the network
3065 3066
 - **IPAM** - Optional custom IP scheme for the network
3067
+- **EnableIPv6** - Enable IPv6 on the network
3066 3068
 - **Options** - Network specific options to be used by the drivers
3067 3069
 - **CheckDuplicate** - Requests daemon to check for networks with same name
3068 3070
 
... ...
@@ -136,12 +136,16 @@ The following are those options and the equivalent docker daemon flags used for
136 136
 | `com.docker.network.bridge.host_binding_ipv4`    | `--ip`      | Default IP when binding container ports               |
137 137
 | `com.docker.network.mtu`                         | `--mtu`     | Set the containers network MTU                        |
138 138
 
139
-The following arguments can be passed to `docker network create` for any network driver.
140
-
141
-| Argument     | Equivalent | Description                              |
142
-|--------------|------------|------------------------------------------|
143
-| `--internal` | -          | Restricts external access to the network |
144
-| `--ipv6`     | `--ipv6`   | Enable IPv6 networking                   |
139
+The following arguments can be passed to `docker network create` for any network driver, again with their approximate
140
+equivalents to `docker daemon`.
141
+
142
+| Argument     | Equivalent     | Description                                |
143
+|--------------|----------------|--------------------------------------------|
144
+| `--gateway`  | -              | ipv4 or ipv6 Gateway for the master subnet |
145
+| `--ip-range` | `--fixed-cidr` | Allocate IPs from a range                  |
146
+| `--internal` | -              | Restricts external access to the network   |
147
+| `--ipv6`     | `--ipv6`       | Enable IPv6 networking                     |
148
+| `--subnet`   | `--bip`        | Subnet for network                         |
145 149
 
146 150
 For example, let's use `-o` or `--opt` options to specify an IP address binding when publishing ports:
147 151