Browse Source

Merge pull request #20613 from aidanhs/aphs-ipv6-docs-followup

Update docs for enableipv6
Vincent Demeester 9 years ago
parent
commit
20fc13b56d

+ 3 - 1
docs/reference/api/docker_remote_api.md

@@ -117,7 +117,9 @@ This section lists each version from latest to oldest.  Each listing includes a
 
 * `GET /containers/json` returns the state of the container, one of `created`, `restarting`, `running`, `paused`, `exited` or `dead`.
 * `GET /networks/(name)` now returns an `Internal` field showing whether the network is internal or not.
+* `GET /networks/(name)` now returns an `EnableIPv6` field showing whether the network has ipv6 enabled or not.
 * `POST /containers/(name)/update` now supports updating container's restart policy.
+* `POST /networks/create` now supports enabling ipv6 on the network by setting the `EnableIPv6` field (doing this with a label will no longer work).
 
 ### v1.22 API changes
 
@@ -142,7 +144,7 @@ This section lists each version from latest to oldest.  Each listing includes a
 * `POST /containers/create` now allows you to set the static IPv4 and/or IPv6 address for the container.
 * `POST /networks/(id)/connect` now allows you to set the static IPv4 and/or IPv6 address for the container.
 * `GET /info` now includes the number of containers running, stopped, and paused.
-* `POST /networks/create` now supports restricting external access to the network by setting the `internal` field.
+* `POST /networks/create` now supports restricting external access to the network by setting the `Internal` field.
 * `POST /networks/(id)/disconnect` now includes a `Force` option to forcefully disconnect a container from network
 * `GET /containers/(id)/json` now returns the `NetworkID` of containers.
 * `POST /networks/create` Now supports an options field in the IPAM config that provides options

+ 10 - 0
docs/reference/api/docker_remote_api_v1.23.md

@@ -2890,6 +2890,8 @@ Content-Type: application/json
     "Id": "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566",
     "Scope": "local",
     "Driver": "bridge",
+    "EnableIPv6": false,
+    "Internal": false,
     "IPAM": {
       "Driver": "default",
       "Config": [
@@ -2920,6 +2922,8 @@ Content-Type: application/json
     "Id": "e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794",
     "Scope": "local",
     "Driver": "null",
+    "EnableIPv6": false,
+    "Internal": false,
     "IPAM": {
       "Driver": "default",
       "Config": []
@@ -2932,6 +2936,8 @@ Content-Type: application/json
     "Id": "13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e",
     "Scope": "local",
     "Driver": "host",
+    "EnableIPv6": false,
+    "Internal": false,
     "IPAM": {
       "Driver": "default",
       "Config": []
@@ -2973,6 +2979,7 @@ Content-Type: application/json
   "Id": "7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99",
   "Scope": "local",
   "Driver": "bridge",
+  "EnableIPv6": false,
   "IPAM": {
     "Driver": "default",
     "Config": [
@@ -3026,6 +3033,7 @@ Content-Type: application/json
 {
   "Name":"isolated_nw",
   "Driver":"bridge",
+  "EnableIPv6": false,
   "IPAM":{
     "Config":[{
       "Subnet":"172.20.0.0/16",
@@ -3062,7 +3070,9 @@ JSON Parameters:
 
 - **Name** - The new network's name. this is a mandatory field
 - **Driver** - Name of the network driver plugin to use. Defaults to `bridge` driver
+- **Internal** - Restrict external access to the network
 - **IPAM** - Optional custom IP scheme for the network
+- **EnableIPv6** - Enable IPv6 on the network
 - **Options** - Network specific options to be used by the drivers
 - **CheckDuplicate** - Requests daemon to check for networks with same name
 

+ 10 - 6
docs/reference/commandline/network_create.md

@@ -136,12 +136,16 @@ The following are those options and the equivalent docker daemon flags used for
 | `com.docker.network.bridge.host_binding_ipv4`    | `--ip`      | Default IP when binding container ports               |
 | `com.docker.network.mtu`                         | `--mtu`     | Set the containers network MTU                        |
 
-The following arguments can be passed to `docker network create` for any network driver.
-
-| Argument     | Equivalent | Description                              |
-|--------------|------------|------------------------------------------|
-| `--internal` | -          | Restricts external access to the network |
-| `--ipv6`     | `--ipv6`   | Enable IPv6 networking                   |
+The following arguments can be passed to `docker network create` for any network driver, again with their approximate
+equivalents to `docker daemon`.
+
+| Argument     | Equivalent     | Description                                |
+|--------------|----------------|--------------------------------------------|
+| `--gateway`  | -              | ipv4 or ipv6 Gateway for the master subnet |
+| `--ip-range` | `--fixed-cidr` | Allocate IPs from a range                  |
+| `--internal` | -              | Restricts external access to the network   |
+| `--ipv6`     | `--ipv6`       | Enable IPv6 networking                     |
+| `--subnet`   | `--bip`        | Subnet for network                         |
 
 For example, let's use `-o` or `--opt` options to specify an IP address binding when publishing ports: