Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: document options for default network driver 

Fixes issue #18410

Signed-off-by: Wen Cheng Ma <wenchma@cn.ibm.com>
This commit is contained in:
Wen Cheng Ma 2016-01-18 13:02:10 +08:00 committed by Tibor Vass
parent c1c803cbe8
commit 27686523be
2 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/reference/commandline/network_create.md
View File

@ -21,8 +21,8 @@ parent = "smn_cli"
--internal Restricts external access to the network --internal Restricts external access to the network
--ip-range=[] Allocate container ip from a sub-range --ip-range=[] Allocate container ip from a sub-range
--ipam-driver=default IP Address Management Driver --ipam-driver=default IP Address Management Driver
-o --opt=map[] Set custom network plugin options --ipam-opt=map[] Set custom IPAM driver specific options
--ipam-opt=map[] Set custom IPAM plugin options -o --opt=map[] Set custom driver specific options
--subnet=[] Subnet in CIDR format that represents a network segment --subnet=[] Subnet in CIDR format that represents a network segment
Creates a new network. The `DRIVER` accepts `bridge` or `overlay` which are the Creates a new network. The `DRIVER` accepts `bridge` or `overlay` which are the
@ -122,6 +122,26 @@ docker network create -d overlay
``` ```
Be sure that your subnetworks do not overlap. If they do, the network create fails and Engine returns an error. Be sure that your subnetworks do not overlap. If they do, the network create fails and Engine returns an error.
# Bridge driver options
When creating a custom network, the default network driver (i.e. `bridge`) has additional options that can be passed.
The following are those options and the equivalent docker daemon flags used for docker0 bridge:
| Option | Equivalent | Description |
|--------------------------------------------------|-------------|-------------------------------------------------------|
| `com.docker.network.bridge.name` | - | bridge name to be used when creating the Linux bridge |
| `com.docker.network.bridge.enable_ip_masquerade` | `--ip-masq` | Enable IP masquerading |
| `com.docker.network.bridge.enable_icc` | `--icc` | Enable or Disable Inter Container Connectivity |
| `com.docker.network.bridge.host_binding_ipv4` | `--ip` | Default IP when binding container ports |
| `com.docker.network.mtu` | `--mtu` | Set the containers network MTU |
| `com.docker.network.enable_ipv6` | `--ipv6` | Enable IPv6 networking |
For example, let's use `-o` or `--opt` options to specify an IP address binding when publishing ports:
```bash
docker network create -o "com.docker.network.bridge.host_binding_ipv4"="172.19.0.1" simple-network
```
### Network internal mode ### Network internal mode
By default, when you connect a container to an `overlay` network, Docker also connects a bridge network to it to provide external connectivity. By default, when you connect a container to an `overlay` network, Docker also connects a bridge network to it to provide external connectivity.

4
man/docker-network-create.1.md
View File

@ -150,10 +150,10 @@ If you want to create an externally isolated `overlay` network, you can specify
IP Address Management Driver IP Address Management Driver
**--ipam-opt**=map[] **--ipam-opt**=map[]
Set custom IPAM plugin options Set custom IPAM driver options
**-o**, **--opt**=map[] **-o**, **--opt**=map[]
Set custom network plugin options Set custom driver options
**--subnet**=[] **--subnet**=[]
Subnet in CIDR format that represents a network segment Subnet in CIDR format that represents a network segment