completing IPv6 docs

Signed-off-by: Malte Janduda <mail@janduda.net>
moby · Nov 5, 2014 · 60dcc31 · 60dcc31
1 parent 3fe5451
commit 60dcc31
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 24 deletions.
diff --git a/docs/man/docker-run.1.md b/docs/man/docker-run.1.md
@@ -21,6 +21,7 @@ docker-run - Run a command in a new container
 [**--entrypoint**[=*ENTRYPOINT*]]
 [**--env-file**[=*[]*]]
 [**--expose**[=*[]*]]
+[**--global-ipv6**[=*false*]]
 [**-h**|**--hostname**[=*HOSTNAME*]]
 [**-i**|**--interactive**[=*false*]]
 [**--security-opt**[=*[]*]]
@@ -136,6 +137,11 @@ ENTRYPOINT.
 **--expose**=[]
    Expose a port or a range of ports (e.g. --expose=3300-3310) from the container without publishing it to your host
 
+**--global-ipv6**=*true*|*false*
+   Assign a global IPv6 to the container and add a default route for IPv6. This
+   requires the daemon to be started with --ipv6 and a global IPv6 subnet
+   defined via daemon's --fixed-cidr-v6 parameter. The default is *false*.
+
 **-h**, **--hostname**=*hostname*
    Sets the container host name that is available inside the container.
 

diff --git a/docs/sources/reference/api/docker_remote_api.md b/docs/sources/reference/api/docker_remote_api.md
@@ -10,7 +10,7 @@ page_keywords: API, Docker, rcli, REST, documentation
    or `--tlsverify`) as with Boot2Docker 1.3.0, then you need to add extra
    parameters to `curl` or `wget` when making test API requests:
    `curl --insecure --cert ~/.docker/cert.pem --key ~/.docker/key.pem https://boot2docker:2376/images/json`
-   or 
+   or
    `wget --no-check-certificate --certificate=$DOCKER_CERT_PATH/cert.pem --private-key=$DOCKER_CERT_PATH/key.pem https://boot2docker:2376/images/json -O - -q`
  - If a group named `docker` exists on your system, docker will apply
    ownership of the socket to the group.
@@ -25,7 +25,7 @@ page_keywords: API, Docker, rcli, REST, documentation
    "serveraddress" : "string", "auth": ""}`. Notice that `auth` is to be left
    empty, `serveraddress` is a domain/ip without protocol, and that double
    quotes (instead of single ones) are required.
- - The Remote API uses an open schema model.  In this model, unknown 
+ - The Remote API uses an open schema model.  In this model, unknown
    properties in incoming messages will be ignored.
    Client applications need to take this into account to ensure
    they will not break when talking to newer Docker daemons.
@@ -54,7 +54,8 @@ total memory available (`MemTotal`).
 
 `POST /containers/create`
 **New!**
-You can set the new container's MAC address explicitly.
+- You can set the new container's MAC address explicitly.
+- Enable global IPv6 networking.
 
 ## v1.15
 
@@ -104,7 +105,7 @@ the `tag` parameter at the same time will return an error.
 The `HostConfig.Links` field is now filled correctly
 
 **New!**
-`Sockets` parameter added to the `/info` endpoint listing all the sockets the 
+`Sockets` parameter added to the `/info` endpoint listing all the sockets the
 daemon is configured to listen on.
 
 `POST /containers/(name)/start`
@@ -432,7 +433,7 @@ Builder (/build):
    intermediary buffers
  - Simpler, less memory usage, less disk usage and faster
 
-> **Warning**: 
+> **Warning**:
 > The /build improvements are not reverse-compatible. Pre 1.3 clients will
 > break on /build.
 

diff --git a/docs/sources/reference/api/docker_remote_api_v1.16.md b/docs/sources/reference/api/docker_remote_api_v1.16.md
@@ -131,6 +131,7 @@ Create a container
              },
              "WorkingDir":"",
              "NetworkDisabled": false,
+             "EnableGlobalIPv6": false,
              "MacAddress":"12:34:56:78:9a:bc",
              "ExposedPorts":{
                      "22/tcp": {}

diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md
@@ -63,8 +63,9 @@ expect an integer, and they can only be specified once.
       --dns=[]                                   Force Docker to use specific DNS servers
       --dns-search=[]                            Force Docker to use specific DNS search domains
       -e, --exec-driver="native"                 Force the Docker runtime to use a specific exec driver
-      --fixed-cidr=""                            IPv4 subnet for fixed IPs (ex: 10.20.0.0/16)
+      --fixed-cidr=""                            IPv4 subnet for fixed IPs (e.g.: 10.20.0.0/16)
                                                    this subnet must be nested in the bridge subnet (which is defined by -b or --bip)
+      --fixed-cidr-v6=""                         IPv6 subnet for global IPs (e.g.: 2a00:1450::/64)
       -G, --group="docker"                       Group to assign the unix socket specified by -H when running in daemon mode
                                                    use '' (the empty string) to disable setting of a group
       -g, --graph="/var/lib/docker"              Path to use as the root of the Docker runtime
@@ -1222,6 +1223,7 @@ removed before the image is removed.
       --entrypoint=""            Overwrite the default ENTRYPOINT of the image
       --env-file=[]              Read in a line delimited file of environment variables
       --expose=[]                Expose a port or a range of ports (e.g. --expose=3300-3310) from the container without publishing it to your host
+      --global-ipv6=false        Assign a global IPv6 to the container and add a default route for IPv6 (see [IPv6](/articles/networking#ipv6)).
       -h, --hostname=""          Container host name
       -i, --interactive=false    Keep STDIN open even if not attached
       --link=[]                  Add link to another container in the form of name:alias

diff --git a/docs/sources/reference/run.md b/docs/sources/reference/run.md
@@ -124,7 +124,7 @@ programs might write out their process ID to a file (you've seen them as
 PID files):
 
     --cidfile="": Write the container ID to the file
-    
+
 ### Image[:tag]
 
 While not strictly a means of identifying a container, you can specify a version of an
@@ -133,14 +133,15 @@ example, `docker run ubuntu:14.04`.
 
 ## Network settings
 
-    --dns=[]         : Set custom dns servers for the container
-    --net="bridge"   : Set the Network mode for the container
-                                  'bridge': creates a new network stack for the container on the docker bridge
-                                  'none': no networking for this container
-                                  'container:<name|id>': reuses another container network stack
-                                  'host': use the host network stack inside the container
-    --add-host=""    : Add a line to /etc/hosts (host:IP)
-    --mac-address="" : Sets the container's Ethernet device's MAC address
+    --dns=[]            : Set custom dns servers for the container
+    --net="bridge"      : Set the Network mode for the container
+                                    'bridge': creates a new network stack for the container on the docker bridge
+                                    'none': no networking for this container
+                                    'container:<name|id>': reuses another container network stack
+                                    'host': use the host network stack inside the container
+    --add-host=""       : Add a line to /etc/hosts (host:IP)
+    --mac-address=""    : Sets the container's Ethernet device's MAC address
+    --global-ipv6=false : Assign a global IPv6 to the container and add a default route for IPv6
 
 By default, all containers have networking enabled and they can make any
 outgoing connections. The operator can completely disable networking
@@ -155,6 +156,12 @@ By default a random MAC is generated. You can set the container's MAC address
 explicitly by providing a MAC via the `--mac-address` parameter (format:
 `12:34:56:78:9a:bc`).
 
+Global IPv6 networking is disabled by default. To assign a global IPv6 to the
+container and add a default route for IPv6 set the `--global-ipv6` flag. This
+requires the daemon to be started with `--ipv6` and a global IPv6 subnet
+defined via daemon's `--fixed-cidr-v6` parameter. You can find further information
+about Docker's IPv6 support in the [Advanced Networking article](/articles/networking#ipv6).
+
 Supported networking modes are:
 
 * none - no networking in the container
@@ -236,7 +243,7 @@ the container exits**, you can add the `--rm` flag:
     --security-opt="label:type:TYPE"   : Set the label type for the container
     --security-opt="label:level:LEVEL" : Set the label level for the container
     --security-opt="label:disable"     : Turn off label confinement for the container
-    --secutity-opt="apparmor:PROFILE"  : Set the apparmor profile to be applied 
+    --secutity-opt="apparmor:PROFILE"  : Set the apparmor profile to be applied
                                          to the container
 
 You can override the default labeling scheme for each container by specifying
@@ -442,7 +449,7 @@ with `-P` or `-p,` or start the client container with `--link`.
 
 If the operator uses `-P` or `-p` then Docker will make the exposed port
 accessible on the host and the ports will be available to any client
-that can reach the host. When using `-P`, Docker will bind the exposed 
+that can reach the host. When using `-P`, Docker will bind the exposed
 ports to a random port on the host between 49153 and 65535. To find the
 mapping between the host ports and the exposed ports, use `docker port`.
 
@@ -469,20 +476,20 @@ variables automatically:
  </tr>
  <tr style="background-color:#E8E8E8">
   <td valign=top> <code>HOSTNAME</code> </td>
-  <td style="padding-left:10px"> 
+  <td style="padding-left:10px">
     The hostname associated with the container
   </td>
  </tr>
  <tr>
   <td valign=top> <code>PATH</code> </td>
-  <td style="padding-left:10px"> 
+  <td style="padding-left:10px">
     Includes popular directories, such as :<br>
     <code>/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin</code>
   </td>
  <tr style="background-color:#E8E8E8">
   <td valign=top> <code>TERM</code> </td>
-  <td style="padding-left:10px"> 
-    <code>xterm</code> if the container is allocated a psuedo-TTY 
+  <td style="padding-left:10px">
+    <code>xterm</code> if the container is allocated a psuedo-TTY
   </td>
  </tr>
 </table>
@@ -492,8 +499,8 @@ as a result of the container being linked with another container. See
 the [*Container Links*](/userguide/dockerlinks/#container-linking)
 section for more details.
 
-Additionally, the operator can **set any environment variable** in the 
-container by using one or more `-e` flags, even overriding those mentioned 
+Additionally, the operator can **set any environment variable** in the
+container by using one or more `-e` flags, even overriding those mentioned
 above, or already defined by the developer with a Dockerfile `ENV`:
 
     $ sudo docker run -e "deep=purple" --rm ubuntu /bin/bash -c export
@@ -567,7 +574,7 @@ container's `/etc/hosts` entry will be automatically updated.
     --volumes-from="": Mount all volumes from the given container(s)
 
 The volumes commands are complex enough to have their own documentation
-in section [*Managing data in 
+in section [*Managing data in
 containers*](/userguide/dockervolumes/#volume-def). A developer can define
 one or more `VOLUME`'s associated with an image, but only the operator
 can give access from one container to another (or from a container to a