Rename `--net` to `--network`

Add a `--network` flag which replaces `--net` without deprecating it
yet. The `--net` flag remains hidden and supported.

Add a `--network-alias` flag which replaces `--net-alias` without deprecating
it yet. The `--net-alias` flag remains hidden and supported.

Signed-off-by: Arnaud Porterie (icecrime) <arnaud.porterie@docker.com>
This commit is contained in:
Arnaud Porterie (icecrime) 2016-06-06 16:33:00 -07:00 committed by Tibor Vass
parent b41c0c8696
commit 253a5f4ea2
9 changed files with 29 additions and 29 deletions

View File

@ -46,7 +46,7 @@ Some network driver plugins are listed in [plugins](plugins.md)
The `mynet` network is now owned by `weave`, so subsequent commands The `mynet` network is now owned by `weave`, so subsequent commands
referring to that network will be sent to the plugin, referring to that network will be sent to the plugin,
$ docker run --net=mynet busybox top $ docker run --network=mynet busybox top
## Write a network plugin ## Write a network plugin

View File

@ -72,13 +72,13 @@ Options:
--memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap --memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap
--memory-swappiness int Tune container memory swappiness (0 to 100) (default -1) --memory-swappiness int Tune container memory swappiness (0 to 100) (default -1)
--name string Assign a name to the container --name string Assign a name to the container
--net string Connect a container to a network (default "default") --network-alias value Add network-scoped alias for the container (default [])
--network string Connect a container to a network (default "default")
'bridge': create a network stack on the default Docker bridge 'bridge': create a network stack on the default Docker bridge
'none': no networking 'none': no networking
'container:<name|id>': reuse another container's network stack 'container:<name|id>': reuse another container's network stack
'host': use the Docker host network stack 'host': use the Docker host network stack
'<network-name>|<network-id>': connect to a user-defined network '<network-name>|<network-id>': connect to a user-defined network
--net-alias value Add network-scoped alias for the container (default [])
--no-healthcheck Disable any container-specified HEALTHCHECK --no-healthcheck Disable any container-specified HEALTHCHECK
--oom-kill-disable Disable OOM Killer --oom-kill-disable Disable OOM Killer
--oom-score-adj int Tune host's OOM preferences (-1000 to 1000) --oom-score-adj int Tune host's OOM preferences (-1000 to 1000)

View File

@ -921,7 +921,7 @@ This option will completely disable user namespace mapping for the container's u
The following standard Docker features are currently incompatible when The following standard Docker features are currently incompatible when
running a Docker daemon with user namespaces enabled: running a Docker daemon with user namespaces enabled:
- sharing PID or NET namespaces with the host (`--pid=host` or `--net=host`) - sharing PID or NET namespaces with the host (`--pid=host` or `--network=host`)
- A `--read-only` container filesystem (this is a Linux kernel restriction against remounting with modified flags of a currently mounted filesystem when inside a user namespace) - A `--read-only` container filesystem (this is a Linux kernel restriction against remounting with modified flags of a currently mounted filesystem when inside a user namespace)
- external (volume or graph) drivers which are unaware/incapable of using daemon user mappings - external (volume or graph) drivers which are unaware/incapable of using daemon user mappings
- Using `--privileged` mode flag on `docker run` (unless also specifying `--userns=host`) - Using `--privileged` mode flag on `docker run` (unless also specifying `--userns=host`)

View File

@ -32,10 +32,10 @@ the same network.
$ docker network connect multi-host-network container1 $ docker network connect multi-host-network container1
``` ```
You can also use the `docker run --net=<network-name>` option to start a container and immediately connect it to a network. You can also use the `docker run --network=<network-name>` option to start a container and immediately connect it to a network.
```bash ```bash
$ docker run -itd --net=multi-host-network busybox $ docker run -itd --network=multi-host-network busybox
``` ```
You can specify the IP address you want to be assigned to the container's interface. You can specify the IP address you want to be assigned to the container's interface.

View File

@ -82,11 +82,11 @@ name conflicts.
## Connect containers ## Connect containers
When you start a container, use the `--net` flag to connect it to a network. When you start a container, use the `--network` flag to connect it to a network.
This example adds the `busybox` container to the `mynet` network: This example adds the `busybox` container to the `mynet` network:
```bash ```bash
$ docker run -itd --net=mynet busybox $ docker run -itd --network=mynet busybox
``` ```
If you want to add a container to a network after the container is already If you want to add a container to a network after the container is already

View File

@ -78,13 +78,13 @@ Options:
--memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap --memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap
--memory-swappiness int Tune container memory swappiness (0 to 100) (default -1). --memory-swappiness int Tune container memory swappiness (0 to 100) (default -1).
--name string Assign a name to the container --name string Assign a name to the container
--net string Connect a container to a network (default "default") --network-alias value Add network-scoped alias for the container (default [])
--network string Connect a container to a network
'bridge': create a network stack on the default Docker bridge 'bridge': create a network stack on the default Docker bridge
'none': no networking 'none': no networking
'container:<name|id>': reuse another container's network stack 'container:<name|id>': reuse another container's network stack
'host': use the Docker host network stack 'host': use the Docker host network stack
'<network-name>|<network-id>': connect to a user-defined network '<network-name>|<network-id>': connect to a user-defined network
--net-alias value Add network-scoped alias for the container (default [])
--no-healthcheck Disable any container-specified HEALTHCHECK --no-healthcheck Disable any container-specified HEALTHCHECK
--oom-kill-disable Disable OOM Killer --oom-kill-disable Disable OOM Killer
--oom-score-adj int Tune host's OOM preferences (-1000 to 1000) --oom-score-adj int Tune host's OOM preferences (-1000 to 1000)
@ -360,20 +360,20 @@ For additional information on working with labels, see [*Labels - custom
metadata in Docker*](../../userguide/labels-custom-metadata.md) in the Docker User metadata in Docker*](../../userguide/labels-custom-metadata.md) in the Docker User
Guide. Guide.
### Connect a container to a network (--net) ### Connect a container to a network (--network)
When you start a container use the `--net` flag to connect it to a network. When you start a container use the `--network` flag to connect it to a network.
This adds the `busybox` container to the `my-net` network. This adds the `busybox` container to the `my-net` network.
```bash ```bash
$ docker run -itd --net=my-net busybox $ docker run -itd --network=my-net busybox
``` ```
You can also choose the IP addresses for the container with `--ip` and `--ip6` You can also choose the IP addresses for the container with `--ip` and `--ip6`
flags when you start the container on a user-defined network. flags when you start the container on a user-defined network.
```bash ```bash
$ docker run -itd --net=my-net --ip=10.10.9.75 busybox $ docker run -itd --network=my-net --ip=10.10.9.75 busybox
``` ```
If you want to add a running container to a network use the `docker network connect` subcommand. If you want to add a running container to a network use the `docker network connect` subcommand.
@ -673,4 +673,4 @@ network namespace, run this command:
`Network Namespace`: `Network Namespace`:
Sysctls beginning with net.* Sysctls beginning with net.*
If you use the `--net=host` option using these sysctls will not be allowed. If you use the `--network=host` option using these sysctls will not be allowed.

View File

@ -259,7 +259,7 @@ $ strace -p 1
The UTS namespace is for setting the hostname and the domain that is visible The UTS namespace is for setting the hostname and the domain that is visible
to running processes in that namespace. By default, all containers, including to running processes in that namespace. By default, all containers, including
those with `--net=host`, have their own UTS namespace. The `host` setting will those with `--network=host`, have their own UTS namespace. The `host` setting will
result in the container using the same UTS namespace as the host. Note that result in the container using the same UTS namespace as the host. Note that
`--hostname` is invalid in `host` UTS mode. `--hostname` is invalid in `host` UTS mode.
@ -289,13 +289,13 @@ of the containers.
## Network settings ## Network settings
--dns=[] : Set custom dns servers for the container --dns=[] : Set custom dns servers for the container
--net="bridge" : Connect a container to a network --network="bridge" : Connect a container to a network
'bridge': create a network stack on the default Docker bridge 'bridge': create a network stack on the default Docker bridge
'none': no networking 'none': no networking
'container:<name|id>': reuse another container's network stack 'container:<name|id>': reuse another container's network stack
'host': use the Docker host network stack 'host': use the Docker host network stack
'<network-name>|<network-id>': connect to a user-defined network '<network-name>|<network-id>': connect to a user-defined network
--net-alias=[] : Add network-scoped alias for the container --network-alias=[] : Add network-scoped alias for the container
--add-host="" : Add a line to /etc/hosts (host:IP) --add-host="" : Add a line to /etc/hosts (host:IP)
--mac-address="" : Sets the container's Ethernet device's MAC address --mac-address="" : Sets the container's Ethernet device's MAC address
--ip="" : Sets the container's Ethernet device's IPv4 address --ip="" : Sets the container's Ethernet device's IPv4 address
@ -304,7 +304,7 @@ of the containers.
By default, all containers have networking enabled and they can make any By default, all containers have networking enabled and they can make any
outgoing connections. The operator can completely disable networking outgoing connections. The operator can completely disable networking
with `docker run --net none` which disables all incoming and outgoing with `docker run --network none` which disables all incoming and outgoing
networking. In cases like this, you would perform I/O through files or networking. In cases like this, you would perform I/O through files or
`STDIN` and `STDOUT` only. `STDIN` and `STDOUT` only.
@ -404,14 +404,14 @@ docker daemon. It is recommended to run containers in this mode when their
networking performance is critical, for example, a production Load Balancer networking performance is critical, for example, a production Load Balancer
or a High Performance Web Server. or a High Performance Web Server.
> **Note**: `--net="host"` gives the container full access to local system > **Note**: `--network="host"` gives the container full access to local system
> services such as D-bus and is therefore considered insecure. > services such as D-bus and is therefore considered insecure.
#### Network: container #### Network: container
With the network set to `container` a container will share the With the network set to `container` a container will share the
network stack of another container. The other container's name must be network stack of another container. The other container's name must be
provided in the format of `--net container:<name|id>`. Note that `--add-host` provided in the format of `--network container:<name|id>`. Note that `--add-host`
`--hostname` `--dns` `--dns-search` `--dns-opt` and `--mac-address` are `--hostname` `--dns` `--dns-search` `--dns-opt` and `--mac-address` are
invalid in `container` netmode, and `--publish` `--publish-all` `--expose` are invalid in `container` netmode, and `--publish` `--publish-all` `--expose` are
also invalid in `container` netmode. also invalid in `container` netmode.
@ -422,7 +422,7 @@ running the `redis-cli` command and connecting to the Redis server over the
$ docker run -d --name redis example/redis --bind 127.0.0.1 $ docker run -d --name redis example/redis --bind 127.0.0.1
$ # use the redis container's network stack to access localhost $ # use the redis container's network stack to access localhost
$ docker run --rm -it --net container:redis example/redis-cli -h 127.0.0.1 $ docker run --rm -it --network container:redis example/redis-cli -h 127.0.0.1
#### User-defined network #### User-defined network
@ -440,7 +440,7 @@ driver and running a container in the created network
``` ```
$ docker network create -d bridge my-net $ docker network create -d bridge my-net
$ docker run --net=my-net -itd --name=container3 busybox $ docker run --network=my-net -itd --name=container3 busybox
``` ```
### Managing /etc/hosts ### Managing /etc/hosts

View File

@ -52,8 +52,8 @@ docker-create - Create a new container
[**--memory-swap**[=*LIMIT*]] [**--memory-swap**[=*LIMIT*]]
[**--memory-swappiness**[=*MEMORY-SWAPPINESS*]] [**--memory-swappiness**[=*MEMORY-SWAPPINESS*]]
[**--name**[=*NAME*]] [**--name**[=*NAME*]]
[**--net**[=*"bridge"*]] [**--network-alias**[=*[]*]]
[**--net-alias**[=*[]*]] [**--network**[=*"bridge"*]]
[**--oom-kill-disable**] [**--oom-kill-disable**]
[**--oom-score-adj**[=*0*]] [**--oom-score-adj**[=*0*]]
[**-P**|**--publish-all**] [**-P**|**--publish-all**]
@ -276,7 +276,7 @@ unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
'host': use the Docker host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure. 'host': use the Docker host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
'<network-name>|<network-id>': connect to a user-defined network '<network-name>|<network-id>': connect to a user-defined network
**--net-alias**=[] **--network-alias**=[]
Add network-scoped alias for the container Add network-scoped alias for the container
**--oom-kill-disable**=*true*|*false* **--oom-kill-disable**=*true*|*false*

View File

@ -54,8 +54,8 @@ docker-run - Run a command in a new container
[**--memory-swap**[=*LIMIT*]] [**--memory-swap**[=*LIMIT*]]
[**--memory-swappiness**[=*MEMORY-SWAPPINESS*]] [**--memory-swappiness**[=*MEMORY-SWAPPINESS*]]
[**--name**[=*NAME*]] [**--name**[=*NAME*]]
[**--net**[=*"bridge"*]] [**--network-alias**[=*[]*]]
[**--net-alias**[=*[]*]] [**--network**[=*"bridge"*]]
[**--oom-kill-disable**] [**--oom-kill-disable**]
[**--oom-score-adj**[=*0*]] [**--oom-score-adj**[=*0*]]
[**-P**|**--publish-all**] [**-P**|**--publish-all**]
@ -395,7 +395,7 @@ and foreground Docker containers.
'host': use the Docker host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure. 'host': use the Docker host network stack. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
'<network-name>|<network-id>': connect to a user-defined network '<network-name>|<network-id>': connect to a user-defined network
**--net-alias**=[] **--network-alias**=[]
Add network-scoped alias for the container Add network-scoped alias for the container
**--oom-kill-disable**=*true*|*false* **--oom-kill-disable**=*true*|*false*