Browse Source

document the ExtraHosts parameter for /containers/create for the remote API

I think this was added from version 1.15.

Signed-off-by: Tony Miller <mcfiredrill@gmail.com>
Tony Miller 10 years ago
parent
commit
54c10fe81d

+ 3 - 0
docs/sources/reference/api/docker_remote_api_v1.15.md

@@ -148,6 +148,7 @@ Create a container
                "Privileged": false,
                "Privileged": false,
                "Dns": ["8.8.8.8"],
                "Dns": ["8.8.8.8"],
                "DnsSearch": [""],
                "DnsSearch": [""],
+               "ExtraHosts": null,
                "VolumesFrom": ["parent", "other:ro"],
                "VolumesFrom": ["parent", "other:ro"],
                "CapAdd": ["NET_ADMIN"],
                "CapAdd": ["NET_ADMIN"],
                "CapDrop": ["MKNOD"],
                "CapDrop": ["MKNOD"],
@@ -220,6 +221,8 @@ Json Parameters:
         a boolean value.
         a boolean value.
   -   **Dns** - A list of dns servers for the container to use.
   -   **Dns** - A list of dns servers for the container to use.
   -   **DnsSearch** - A list of DNS search domains
   -   **DnsSearch** - A list of DNS search domains
+  -   **ExtraHosts** - A list of hostnames/IP mappings to be added to the
+      container's `/etc/host` file. Specified in the form `["hostname:IP"]`.
   -   **VolumesFrom** - A list of volumes to inherit from another container.
   -   **VolumesFrom** - A list of volumes to inherit from another container.
         Specified in the form `<container name>[:<ro|rw>]`
         Specified in the form `<container name>[:<ro|rw>]`
   -   **CapAdd** - A list of kernel capabilties to add to the container.
   -   **CapAdd** - A list of kernel capabilties to add to the container.

+ 3 - 0
docs/sources/reference/api/docker_remote_api_v1.16.md

@@ -148,6 +148,7 @@ Create a container
                "Privileged": false,
                "Privileged": false,
                "Dns": ["8.8.8.8"],
                "Dns": ["8.8.8.8"],
                "DnsSearch": [""],
                "DnsSearch": [""],
+               "ExtraHosts": null,
                "VolumesFrom": ["parent", "other:ro"],
                "VolumesFrom": ["parent", "other:ro"],
                "CapAdd": ["NET_ADMIN"],
                "CapAdd": ["NET_ADMIN"],
                "CapDrop": ["MKNOD"],
                "CapDrop": ["MKNOD"],
@@ -220,6 +221,8 @@ Json Parameters:
         a boolean value.
         a boolean value.
   -   **Dns** - A list of dns servers for the container to use.
   -   **Dns** - A list of dns servers for the container to use.
   -   **DnsSearch** - A list of DNS search domains
   -   **DnsSearch** - A list of DNS search domains
+  -   **ExtraHosts** - A list of hostnames/IP mappings to be added to the
+      container's `/etc/host` file. Specified in the form `["hostname:IP"]`.
   -   **VolumesFrom** - A list of volumes to inherit from another container.
   -   **VolumesFrom** - A list of volumes to inherit from another container.
         Specified in the form `<container name>[:<ro|rw>]`
         Specified in the form `<container name>[:<ro|rw>]`
   -   **CapAdd** - A list of kernel capabilties to add to the container.
   -   **CapAdd** - A list of kernel capabilties to add to the container.

+ 3 - 0
docs/sources/reference/api/docker_remote_api_v1.17.md

@@ -149,6 +149,7 @@ Create a container
                "ReadonlyRootfs": false,
                "ReadonlyRootfs": false,
                "Dns": ["8.8.8.8"],
                "Dns": ["8.8.8.8"],
                "DnsSearch": [""],
                "DnsSearch": [""],
+               "ExtraHosts": null,
                "VolumesFrom": ["parent", "other:ro"],
                "VolumesFrom": ["parent", "other:ro"],
                "CapAdd": ["NET_ADMIN"],
                "CapAdd": ["NET_ADMIN"],
                "CapDrop": ["MKNOD"],
                "CapDrop": ["MKNOD"],
@@ -223,6 +224,8 @@ Json Parameters:
         Specified as a boolean value.
         Specified as a boolean value.
   -   **Dns** - A list of dns servers for the container to use.
   -   **Dns** - A list of dns servers for the container to use.
   -   **DnsSearch** - A list of DNS search domains
   -   **DnsSearch** - A list of DNS search domains
+  -   **ExtraHosts** - A list of hostnames/IP mappings to be added to the
+      container's `/etc/host` file. Specified in the form `["hostname:IP"]`.
   -   **VolumesFrom** - A list of volumes to inherit from another container.
   -   **VolumesFrom** - A list of volumes to inherit from another container.
         Specified in the form `<container name>[:<ro|rw>]`
         Specified in the form `<container name>[:<ro|rw>]`
   -   **CapAdd** - A list of kernel capabilties to add to the container.
   -   **CapAdd** - A list of kernel capabilties to add to the container.