mirror of https://github.com/docker/cli.git
Updating network commands: adding man pages
Adding Related information blocks Final first draft pass: ready for review Review comments Entering comments from the gang Updating connect to include paused Signed-off-by: Mary Anthony <mary@docker.com>
This commit is contained in:
Mary Anthony
Tibor Vass
parent
7f6859ce5a
commit
4985b20ea1
|
|
@ -16,14 +16,40 @@ parent = "smn_cli"
|
|||
|
||||
--help=false Print usage
|
||||
|
||||
Connects a running container to a network. This enables instant communication with other containers belonging to the same network.
|
||||
Connects a running container to a network. You can connect a container by name
|
||||
or by ID. Once connected, the container can communicate with other containers in
|
||||
the same network.
|
||||
|
||||
```
|
||||
$ docker network create -d overlay multi-host-network
|
||||
$ docker run -d --name=container1 busybox top
|
||||
$ docker network connect multi-host-network container1
|
||||
```bash
|
||||
$ docker network connect multi-host-network container1
|
||||
```
|
||||
|
||||
the container will be connected to the network that is created and managed by the driver (multi-host overlay driver in the above example) or external network plugins.
|
||||
You can also use the `docker run --net=<network-name>` option to start a container and immediately connect it to a network.
|
||||
|
||||
Multiple containers can be connected to the same network and the containers in the same network will start to communicate with each other. If the driver/plugin supports multi-host connectivity, then the containers connected to the same multi-host network will be able to communicate seamlessly.
|
||||
```bash
|
||||
$ docker run -itd --net=multi-host-network busybox
|
||||
```
|
||||
|
||||
You can pause, restart, and stop containers that are connected to a network.
|
||||
Paused containers remain connected and a revealed by a `network inspect`. When
|
||||
the container is stopped, it does not appear on the network until you restart
|
||||
it. The container's IP address is not guaranteed to remain the same when a
|
||||
stopped container rejoins the network.
|
||||
|
||||
To verify the container is connected, use the `docker network inspect` command. Use `docker network disconnect` to remove a container from the network.
|
||||
|
||||
Once connected in network, containers can communicate using only another
|
||||
container's IP address or name. For `overlay` networks or custom plugins that
|
||||
support multi-host connectivity, containers connected to the same multi-host
|
||||
network but launched from different Engines can also communicate in this way.
|
||||
|
||||
You can connect a container to one or more networks. The networks need not be the same type. For example, you can connect a single container bridge and overlay networks.
|
||||
|
||||
## Related information
|
||||
|
||||
* [network inspect](network_inspect.md)
|
||||
* [network create](network_create.md)
|
||||
* [network disconnect](network_disconnect.md)
|
||||
* [network ls](network_ls.md)
|
||||
* [network rm](network_rm.md)
|
||||
* [Understand Docker container networks](../../userguide/networking/dockernetworks.md)
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
+++
|
||||
title = "network create"
|
||||
description = "The network create command description and usage"
|
||||
keywords = ["network, create"]
|
||||
keywords = ["network create"]
|
||||
[menu.main]
|
||||
parent = "smn_cli"
|
||||
+++
|
||||
|
|
@ -14,18 +14,117 @@ parent = "smn_cli"
|
|||
|
||||
Creates a new network with a name specified by the user
|
||||
|
||||
-d, --driver= Driver to manage the Network
|
||||
--help=false Print usage
|
||||
--aux-address=map[] Auxiliary ipv4 or ipv6 addresses used by network driver
|
||||
-d --driver=DRIVER Driver to manage the Network bridge or overlay. The default is bridge.
|
||||
--gateway=[] ipv4 or ipv6 Gateway for the master subnet
|
||||
--help=false Print usage
|
||||
--ip-range=[] Allocate container ip from a sub-range
|
||||
--ipam-driver=default IP Address Management Driver
|
||||
-o --opt=map[] Set custom network plugin options
|
||||
--subnet=[] Subnet in CIDR format that represents a network segment
|
||||
|
||||
Creates a new network that containers can connect to. If the driver supports multi-host networking, the created network will be made available across all the hosts in the cluster. Daemon will do its best to identify network name conflicts. But its the users responsibility to make sure network name is unique across the cluster. You create a network and then configure the container to use it, for example:
|
||||
Creates a new network. The `DRIVER` accepts `bridge` or `overlay` which are the
|
||||
built-in network drivers. If you have installed a third party or your own custom
|
||||
network driver you can specify that `DRIVER` here also. If you don't specify the
|
||||
`--driver` option, the command automatically creates a `bridge` network for you.
|
||||
When you install Docker Engine it creates a `bridge` network automatically. This
|
||||
network corresponds to the `docker0` bridge that Engine has traditionally relied
|
||||
on. When launch a new container with `docker run` it automatically connects to
|
||||
this bridge network. You cannot remove this default bridge network but you can
|
||||
create new ones using the `network create` command.
|
||||
|
||||
```
|
||||
$ docker network create -d overlay multi-host-network
|
||||
$ docker run -itd --net=multi-host-network busybox
|
||||
```bash
|
||||
$ docker network create -d bridge my-bridge-network
|
||||
```
|
||||
|
||||
the container will be connected to the network that is created and managed by the driver (multi-host overlay driver in the above example) or external network plugins.
|
||||
Bridge networks are isolated networks on a single Engine installation. If you
|
||||
want to create a network that spans multiple Docker hosts each running an
|
||||
Engine, you must create an `overlay` network. Unlike `bridge` networks overlay
|
||||
networks require some pre-existing conditions before you can create one. These
|
||||
conditions are:
|
||||
|
||||
Multiple containers can be connected to the same network and the containers in the same network will start to communicate with each other. If the driver/plugin supports multi-host connectivity, then the containers connected to the same multi-host network will be able to communicate seamlessly.
|
||||
* Access to a key-value store. Engine supports Consul, Etcd, and Zookeeper (Distributed store) key-value stores.
|
||||
* A cluster of hosts with connectivity to the key-value store.
|
||||
* A properly configured Engine `daemon` on each host in the cluster.
|
||||
|
||||
*Note*: UX needs enhancement to accept network options to be passed to the drivers
|
||||
The `docker daemon` options that support the `overlay` network are:
|
||||
|
||||
* `--cluster-store`
|
||||
* `--cluster-store-opt`
|
||||
* `--cluster-advertise`
|
||||
|
||||
To read more about these options and how to configure them, see ["*Get started
|
||||
with multi-host network*"](../../userguide/networking/get-started-overlay.md).
|
||||
|
||||
It is also a good idea, though not required, that you install Docker Swarm on to
|
||||
manage the cluster that makes up your network. Swarm provides sophisticated
|
||||
discovery and server management that can assist your implementation.
|
||||
|
||||
Once you have prepared the `overlay` network prerequisites you simply choose a
|
||||
Docker host in the cluster and issue the following to create the network:
|
||||
|
||||
```bash
|
||||
$ docker network create -d overlay my-multihost-network
|
||||
```
|
||||
|
||||
Network names must be unique. The Docker daemon attempts to identify naming
|
||||
conflicts but this is not guaranteed. It is the user's responsibility to avoid
|
||||
name conflicts.
|
||||
|
||||
## Connect containers
|
||||
|
||||
When you start a container use the `--net` flag to connect it to a network.
|
||||
This adds the `busybox` container to the `mynet` network.
|
||||
|
||||
```bash
|
||||
$ docker run -itd --net=mynet busybox
|
||||
```
|
||||
|
||||
If you want to add a container to a network after the container is already
|
||||
running use the `docker network connect` subcommand.
|
||||
|
||||
You can connect multiple containers to the same network. Once connected, the
|
||||
containers can communicate using only another container's IP address or name.
|
||||
For `overlay` networks or custom plugins that support multi-host connectivity,
|
||||
containers connected to the same multi-host network but launched from different
|
||||
Engines can also communicate in this way.
|
||||
|
||||
You can disconnect a container from a network using the `docker network
|
||||
disconnect` command.
|
||||
|
||||
## Specifying advanced options
|
||||
|
||||
When you create a network, Engine creates a non-overlapping subnetwork for the network by default. This subnetwork is not a subdivision of an existing network. It is purely for ip-addressing purposes. You can override this default and specify subnetwork values directly using the the `--subnet` option. On a `bridge` network you can only create a single subnet:
|
||||
|
||||
```bash
|
||||
docker network create -d --subnet=192.168.0.0/16
|
||||
```
|
||||
Additionally, you also specify the `--gateway` `--ip-range` and `--aux-address` options.
|
||||
|
||||
```bash
|
||||
network create --driver=bridge --subnet=172.28.0.0/16 --ip-range=172.28.5.0/24 --gateway=172.28.5.254 br0
|
||||
```
|
||||
|
||||
If you omit the `--gateway` flag the Engine selects one for you from inside a
|
||||
preferred pool. For `overlay` networks and for network driver plugins that
|
||||
support it you can create multiple subnetworks.
|
||||
|
||||
```bash
|
||||
docker network create -d overlay
|
||||
--subnet=192.168.0.0/16 --subnet=192.170.0.0/16
|
||||
--gateway=192.168.0.100 --gateway=192.170.0.100
|
||||
--ip-range=192.168.1.0/24
|
||||
--aux-address a=192.168.1.5 --aux-address b=192.168.1.6
|
||||
--aux-address a=192.170.1.5 --aux-address b=192.170.1.6
|
||||
my-multihost-newtork
|
||||
```
|
||||
Be sure that your subnetworks do not overlap. If they do, the network create fails and Engine returns an error.
|
||||
|
||||
## Related information
|
||||
|
||||
* [network inspect](network_inspect.md)
|
||||
* [network connect](network_connect.md)
|
||||
* [network disconnect](network_disconnect.md)
|
||||
* [network ls](network_ls.md)
|
||||
* [network rm](network_rm.md)
|
||||
* [Understand Docker container networks](../../userguide/networking/dockernetworks.md)
|
||||
|
|
|
|||
|
|
@ -16,12 +16,18 @@ parent = "smn_cli"
|
|||
|
||||
--help=false Print usage
|
||||
|
||||
Disconnects a running container from a network.
|
||||
Disconnects a container from a network. The container must be running to disconnect it from the network.
|
||||
|
||||
```
|
||||
$ docker network create -d overlay multi-host-network
|
||||
$ docker run -d --net=multi-host-network --name=container1 busybox top
|
||||
```bash
|
||||
$ docker network disconnect multi-host-network container1
|
||||
```
|
||||
|
||||
the container will be disconnected from the network.
|
||||
|
||||
## Related information
|
||||
|
||||
* [network inspect](network_inspect.md)
|
||||
* [network connect](network_connect.md)
|
||||
* [network create](network_create.md)
|
||||
* [network ls](network_ls.md)
|
||||
* [network rm](network_rm.md)
|
||||
* [Understand Docker container networks](../../userguide/networking/dockernetworks.md)
|
||||
|
|
|
|||
|
|
@ -10,42 +10,55 @@ parent = "smn_cli"
|
|||
|
||||
# network inspect
|
||||
|
||||
Usage: docker network inspect [OPTIONS] NETWORK
|
||||
Usage: docker network inspect [OPTIONS] NETWORK [NETWORK..]
|
||||
|
||||
Displays detailed information on a network
|
||||
|
||||
--help=false Print usage
|
||||
|
||||
Returns information about a network. By default, this command renders all results
|
||||
in a JSON object.
|
||||
Returns information about one or more networks. By default, this command renders all results in a JSON object. For example, if you connect two containers to a network:
|
||||
|
||||
Example output:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo docker run -itd --name=container1 busybox
|
||||
f2870c98fd504370fb86e59f32cd0753b1ac9b69b7d80566ffc7192a82b3ed27
|
||||
|
||||
$ sudo docker run -itd --name=container2 busybox
|
||||
bda12f8922785d1f160be70736f26c1e331ab8aaf8ed8d56728508f2e2fd4727
|
||||
|
||||
$ sudo docker network inspect bridge
|
||||
{
|
||||
"name": "bridge",
|
||||
"id": "7fca4eb8c647e57e9d46c32714271e0c3f8bf8d17d346629e2820547b2d90039",
|
||||
"driver": "bridge",
|
||||
"containers": {
|
||||
"bda12f8922785d1f160be70736f26c1e331ab8aaf8ed8d56728508f2e2fd4727": {
|
||||
"endpoint": "e0ac95934f803d7e36384a2029b8d1eeb56cb88727aa2e8b7edfeebaa6dfd758",
|
||||
"mac_address": "02:42:ac:11:00:03",
|
||||
"ipv4_address": "172.17.0.3/16",
|
||||
"ipv6_address": ""
|
||||
},
|
||||
"f2870c98fd504370fb86e59f32cd0753b1ac9b69b7d80566ffc7192a82b3ed27": {
|
||||
"endpoint": "31de280881d2a774345bbfb1594159ade4ae4024ebfb1320cb74a30225f6a8ae",
|
||||
"mac_address": "02:42:ac:11:00:02",
|
||||
"ipv4_address": "172.17.0.2/16",
|
||||
"ipv6_address": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The `network inspect` command shows the containers, by id, in its results.
|
||||
|
||||
```bash
|
||||
$ sudo docker network inspect bridge
|
||||
[
|
||||
{
|
||||
"name": "bridge",
|
||||
"id": "7fca4eb8c647e57e9d46c32714271e0c3f8bf8d17d346629e2820547b2d90039",
|
||||
"driver": "bridge",
|
||||
"containers": {
|
||||
"bda12f8922785d1f160be70736f26c1e331ab8aaf8ed8d56728508f2e2fd4727": {
|
||||
"endpoint": "e0ac95934f803d7e36384a2029b8d1eeb56cb88727aa2e8b7edfeebaa6dfd758",
|
||||
"mac_address": "02:42:ac:11:00:03",
|
||||
"ipv4_address": "172.17.0.3/16",
|
||||
"ipv6_address": ""
|
||||
},
|
||||
"f2870c98fd504370fb86e59f32cd0753b1ac9b69b7d80566ffc7192a82b3ed27": {
|
||||
"endpoint": "31de280881d2a774345bbfb1594159ade4ae4024ebfb1320cb74a30225f6a8ae",
|
||||
"mac_address": "02:42:ac:11:00:02",
|
||||
"ipv4_address": "172.17.0.2/16",
|
||||
"ipv6_address": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
|
||||
## Related information
|
||||
|
||||
* [network disconnect ](network_disconnect.md)
|
||||
* [network connect](network_connect.md)
|
||||
* [network create](network_create.md)
|
||||
* [network ls](network_ls.md)
|
||||
* [network rm](network_rm.md)
|
||||
* [Understand Docker container networks](../../userguide/networking/dockernetworks.md)
|
||||
|
|
|
|||
|
|
@ -17,14 +17,35 @@ parent = "smn_cli"
|
|||
--no-trunc=false Do not truncate the output
|
||||
-q, --quiet=false Only display numeric IDs
|
||||
|
||||
Lists all the networks Docker knows about. This include the networks that spans across multiple hosts in a cluster.
|
||||
Lists all the networks the Engine `daemon` knows about. This includes the
|
||||
networks that span across multiple hosts in a cluster, for example:
|
||||
|
||||
Example output:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo docker network ls
|
||||
NETWORK ID NAME DRIVER
|
||||
7fca4eb8c647 bridge bridge
|
||||
9f904ee27bf5 none null
|
||||
cf03ee007fb4 host host
|
||||
78b03ee04fc4 multi-host overlay
|
||||
```
|
||||
|
||||
Use the `--no-trunc` option to display the full network id:
|
||||
|
||||
```bash
|
||||
docker network ls --no-trunc
|
||||
NETWORK ID NAME DRIVER
|
||||
18a2866682b85619a026c81b98a5e375bd33e1b0936a26cc497c283d27bae9b3 none null
|
||||
c288470c46f6c8949c5f7e5099b5b7947b07eabe8d9a27d79a9cbf111adcbf47 host host
|
||||
7b369448dccbf865d397c8d2be0cda7cf7edc6b0945f77d2529912ae917a0185 bridge bridge
|
||||
95e74588f40db048e86320c6526440c504650a1ff3e9f7d60a497c4d2163e5bd foo bridge
|
||||
```
|
||||
|
||||
|
||||
## Related information
|
||||
|
||||
* [network disconnect ](network_disconnect.md)
|
||||
* [network connect](network_connect.md)
|
||||
* [network create](network_create.md)
|
||||
* [network inspect](network_inspect.md)
|
||||
* [network rm](network_rm.md)
|
||||
* [Understand Docker container networks](../../userguide/networking/dockernetworks.md)
|
||||
|
|
|
|||
|
|
@ -10,14 +10,23 @@ parent = "smn_cli"
|
|||
|
||||
# network rm
|
||||
|
||||
Usage: docker network rm [OPTIONS] NETWORK
|
||||
Usage: docker network rm [OPTIONS] NAME | ID
|
||||
|
||||
Deletes a network
|
||||
|
||||
--help=false Print usage
|
||||
|
||||
Removes a network. You cannot remove a network that is in use by 1 or more containers.
|
||||
Removes a network by name or identifier. To remove a network, you must first disconnect any containers connected to it.
|
||||
|
||||
```
|
||||
```bash
|
||||
$ docker network rm my-network
|
||||
```
|
||||
|
||||
## Related information
|
||||
|
||||
* [network disconnect ](network_disconnect.md)
|
||||
* [network connect](network_connect.md)
|
||||
* [network create](network_create.md)
|
||||
* [network ls](network_ls.md)
|
||||
* [network inspect](network_inspect.md)
|
||||
* [Understand Docker container networks](../../userguide/networking/dockernetworks.md)
|
||||
|
|
|
|||
|
|
@ -54,7 +54,12 @@ parent = "smn_cli"
|
|||
--memory-swap="" Total memory (memory + swap), '-1' to disable swap
|
||||
--memory-swappiness="" Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
|
||||
--name="" Assign a name to the container
|
||||
--net="default" Set the Network mode for the container
|
||||
--net="bridge" Connects a container to a network
|
||||
'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
|
||||
'NETWORK': connects the container to user-created network using `docker network create` command
|
||||
--oom-kill-disable=false Whether to disable OOM Killer for the container or not
|
||||
-P, --publish-all=false Publish all exposed ports to random ports
|
||||
-p, --publish=[] Publish a container's port(s) to the host
|
||||
|
|
|
|||
|
|
@ -0,0 +1,55 @@
|
|||
% DOCKER(1) Docker User Manuals
|
||||
% Docker Community
|
||||
% OCT 2015
|
||||
# NAME
|
||||
docker-network-connect - connect a container to a network
|
||||
|
||||
# SYNOPSIS
|
||||
**docker network connect NAME CONTAINER**
|
||||
|
||||
[**--help**]
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
Connects a running container to a network. You can connect a container by name
|
||||
or by ID. Once connected, the container can communicate with other containers in
|
||||
the same network.
|
||||
|
||||
```bash
|
||||
$ 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.
|
||||
|
||||
```bash
|
||||
$ docker run -itd --net=multi-host-network busybox
|
||||
```
|
||||
|
||||
You can pause, restart, and stop containers that are connected to a network.
|
||||
Paused containers remain connected and a revealed by a `network inspect`. When
|
||||
the container is stopped, it does not appear on the network until you restart
|
||||
it. The container's IP address is not guaranteed to remain the same when a
|
||||
stopped container rejoins the network.
|
||||
|
||||
To verify the container is connected, use the `docker network inspect` command. Use `docker network disconnect` to remove a container from the network.
|
||||
|
||||
Once connected in network, containers can communicate using only another
|
||||
container's IP address or name. For `overlay` networks or custom plugins that
|
||||
support multi-host connectivity, containers connected to the same multi-host
|
||||
network but launched from different Engines can also communicate in this way.
|
||||
|
||||
You can connect a container to one or more networks. The networks need not be the same type. For example, you can connect a single container bridge and overlay networks.
|
||||
|
||||
|
||||
# OPTIONS
|
||||
**NAME**
|
||||
Specify network driver name
|
||||
|
||||
**CONTAINER**
|
||||
Specify container name
|
||||
|
||||
**--help**
|
||||
Print usage statement
|
||||
|
||||
# HISTORY
|
||||
OCT 2015, created by Mary Anthony <mary@docker.com>
|
||||
|
|
@ -0,0 +1,149 @@
|
|||
% DOCKER(1) Docker User Manuals
|
||||
% Docker Community
|
||||
% OCT 2015
|
||||
# NAME
|
||||
docker-network-create - create a new network
|
||||
|
||||
# SYNOPSIS
|
||||
**docker network create**
|
||||
|
||||
**--aux-address=map[]**
|
||||
**-d** | **--driver=DRIVER**
|
||||
**--gateway=[]**
|
||||
**--help=false**
|
||||
**--ip-range=[]**
|
||||
**--ipam-driver=default**
|
||||
**-o** | **--opt=map[]**
|
||||
**--subnet=[]**
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
Creates a new network. The `DRIVER` accepts `bridge` or `overlay` which are the
|
||||
built-in network drivers. If you have installed a third party or your own custom
|
||||
network driver you can specify that `DRIVER` here also. If you don't specify the
|
||||
`--driver` option, the command automatically creates a `bridge` network for you.
|
||||
When you install Docker Engine it creates a `bridge` network automatically. This
|
||||
network corresponds to the `docker0` bridge that Engine has traditionally relied
|
||||
on. When launch a new container with `docker run` it automatically connects to
|
||||
this bridge network. You cannot remove this default bridge network but you can
|
||||
create new ones using the `network create` command.
|
||||
|
||||
```bash
|
||||
$ docker network create -d bridge my-bridge-network
|
||||
```
|
||||
|
||||
Bridge networks are isolated networks on a single Engine installation. If you
|
||||
want to create a network that spans multiple Docker hosts each running an
|
||||
Engine, you must create an `overlay` network. Unlike `bridge` networks overlay
|
||||
networks require some pre-existing conditions before you can create one. These
|
||||
conditions are:
|
||||
|
||||
* Access to a key-value store. Engine supports Consul, Etcd, and Zookeeper (Distributed store) key-value stores.
|
||||
* A cluster of hosts with connectivity to the key-value store.
|
||||
* A properly configured Engine `daemon` on each host in the cluster.
|
||||
|
||||
The `docker daemon` options that support the `overlay` network are:
|
||||
|
||||
* `--cluster-store`
|
||||
* `--cluster-store-opt`
|
||||
* `--cluster-advertise`
|
||||
|
||||
To read more about these options and how to configure them, see ["*Get started
|
||||
with multi-host
|
||||
network*"](https://www.docker.com/engine/userguide/networking/get-started-overlay.md).
|
||||
|
||||
It is also a good idea, though not required, that you install Docker Swarm on to
|
||||
manage the cluster that makes up your network. Swarm provides sophisticated
|
||||
discovery and server management that can assist your implementation.
|
||||
|
||||
Once you have prepared the `overlay` network prerequisites you simply choose a
|
||||
Docker host in the cluster and issue the following to create the network:
|
||||
|
||||
```bash
|
||||
$ docker network create -d overlay my-multihost-network
|
||||
```
|
||||
|
||||
Network names must be unique. The Docker daemon attempts to identify naming
|
||||
conflicts but this is not guaranteed. It is the user's responsibility to avoid
|
||||
name conflicts.
|
||||
|
||||
## Connect containers
|
||||
|
||||
When you start a container use the `--net` flag to connect it to a network.
|
||||
This adds the `busybox` container to the `mynet` network.
|
||||
|
||||
```bash
|
||||
$ docker run -itd --net=mynet busybox
|
||||
```
|
||||
|
||||
If you want to add a container to a network after the container is already
|
||||
running use the `docker network connect` subcommand.
|
||||
|
||||
You can connect multiple containers to the same network. Once connected, the
|
||||
containers can communicate using only another container's IP address or name.
|
||||
For `overlay` networks or custom plugins that support multi-host connectivity,
|
||||
containers connected to the same multi-host network but launched from different
|
||||
Engines can also communicate in this way.
|
||||
|
||||
You can disconnect a container from a network using the `docker network
|
||||
disconnect` command.
|
||||
|
||||
## Specifying advanced options
|
||||
|
||||
When you create a network, Engine creates a non-overlapping subnetwork for the
|
||||
network by default. This subnetwork is not a subdivision of an existing network.
|
||||
It is purely for ip-addressing purposes. You can override this default and
|
||||
specify subnetwork values directly using the the `--subnet` option. On a
|
||||
`bridge` network you can only create a single subnet:
|
||||
|
||||
```bash
|
||||
docker network create -d --subnet=192.168.0.0/16
|
||||
```
|
||||
Additionally, you also specify the `--gateway` `--ip-range` and `--aux-address` options.
|
||||
|
||||
```bash
|
||||
network create --driver=bridge --subnet=172.28.0.0/16 --ip-range=172.28.5.0/24 --gateway=172.28.5.254 br0
|
||||
```
|
||||
|
||||
If you omit the `--gateway` flag the Engine selects one for you from inside a
|
||||
preferred pool. For `overlay` networks and for network driver plugins that
|
||||
support it you can create multiple subnetworks.
|
||||
|
||||
```bash
|
||||
docker network create -d overlay
|
||||
--subnet=192.168.0.0/16 --subnet=192.170.0.0/16
|
||||
--gateway=192.168.0.100 --gateway=192.170.0.100
|
||||
--ip-range=192.168.1.0/24
|
||||
--aux-address a=192.168.1.5 --aux-address b=192.168.1.6
|
||||
--aux-address a=192.170.1.5 --aux-address b=192.170.1.6
|
||||
my-multihost-newtork
|
||||
```
|
||||
Be sure that your subnetworks do not overlap. If they do, the network create fails and Engine returns an error.
|
||||
|
||||
# OPTIONS
|
||||
**--aux-address=map[]**
|
||||
Auxiliary ipv4 or ipv6 addresses used by network driver
|
||||
|
||||
**-d** | **--driver=DRIVER**
|
||||
Driver to manage the Network bridge or overlay. The default is bridge.
|
||||
|
||||
**--gateway=[] **
|
||||
ipv4 or ipv6 Gateway for the master subnet
|
||||
|
||||
**--help=false **
|
||||
Print usage
|
||||
|
||||
**--ip-range=[] **
|
||||
Allocate container ip from a sub-range
|
||||
|
||||
**--ipam-driver=default **
|
||||
IP Address Management Driver
|
||||
|
||||
**-o | --opt=map[]**
|
||||
Set custom network plugin options
|
||||
|
||||
**--subnet=[]**
|
||||
Subnet in CIDR format that represents a network segment
|
||||
|
||||
# HISTORY
|
||||
OCT 2015, created by Mary Anthony <mary@docker.com>
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
% DOCKER(1) Docker User Manuals
|
||||
% Docker Community
|
||||
% OCT 2015
|
||||
# NAME
|
||||
docker-network-disconnect - disconnect a container from a network
|
||||
|
||||
# SYNOPSIS
|
||||
**docker network disconnect NETWORK CONTAINER**
|
||||
|
||||
[**--help**]
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
Disconnects a container from a network. The container must be running to disconnect it from the network.
|
||||
|
||||
```bash
|
||||
$ docker network disconnect multi-host-network container1
|
||||
```
|
||||
|
||||
|
||||
# OPTIONS
|
||||
**NETWORK**
|
||||
Specify network name
|
||||
|
||||
**CONTAINER**
|
||||
Specify container name
|
||||
|
||||
**--help**
|
||||
Print usage statement
|
||||
|
||||
# HISTORY
|
||||
OCT 2015, created by Mary Anthony <mary@docker.com>
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
% DOCKER(1) Docker User Manuals
|
||||
% Docker Community
|
||||
% OCT 2015
|
||||
# NAME
|
||||
docker-network-inspect - inspect a network
|
||||
|
||||
# SYNOPSIS
|
||||
**docker network inspect NETWORK [NETWORK...]**
|
||||
|
||||
[**--help**]
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
Returns information about one or more networks. By default, this command renders all results in a JSON object. For example, if you connect two containers to a network:
|
||||
|
||||
```bash
|
||||
$ sudo docker run -itd --name=container1 busybox
|
||||
f2870c98fd504370fb86e59f32cd0753b1ac9b69b7d80566ffc7192a82b3ed27
|
||||
|
||||
$ sudo docker run -itd --name=container2 busybox
|
||||
bda12f8922785d1f160be70736f26c1e331ab8aaf8ed8d56728508f2e2fd4727
|
||||
```
|
||||
|
||||
The `network inspect` command shows the containers, by id, in its results.
|
||||
|
||||
```bash
|
||||
$ sudo docker network inspect bridge
|
||||
[
|
||||
{
|
||||
"name": "bridge",
|
||||
"id": "7fca4eb8c647e57e9d46c32714271e0c3f8bf8d17d346629e2820547b2d90039",
|
||||
"driver": "bridge",
|
||||
"containers": {
|
||||
"bda12f8922785d1f160be70736f26c1e331ab8aaf8ed8d56728508f2e2fd4727": {
|
||||
"endpoint": "e0ac95934f803d7e36384a2029b8d1eeb56cb88727aa2e8b7edfeebaa6dfd758",
|
||||
"mac_address": "02:42:ac:11:00:03",
|
||||
"ipv4_address": "172.17.0.3/16",
|
||||
"ipv6_address": ""
|
||||
},
|
||||
"f2870c98fd504370fb86e59f32cd0753b1ac9b69b7d80566ffc7192a82b3ed27": {
|
||||
"endpoint": "31de280881d2a774345bbfb1594159ade4ae4024ebfb1320cb74a30225f6a8ae",
|
||||
"mac_address": "02:42:ac:11:00:02",
|
||||
"ipv4_address": "172.17.0.2/16",
|
||||
"ipv6_address": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
|
||||
# OPTIONS
|
||||
|
||||
**--help**
|
||||
Print usage statement
|
||||
|
||||
# HISTORY
|
||||
OCT 2015, created by Mary Anthony <mary@docker.com>
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
% DOCKER(1) Docker User Manuals
|
||||
% Docker Community
|
||||
% OCT 2015
|
||||
# NAME
|
||||
docker-network-ls - list networks
|
||||
|
||||
# SYNOPSIS
|
||||
**docker network ls**
|
||||
|
||||
[**--no-trunc**]
|
||||
[**-q** | **--quiet**]
|
||||
[**--help**]
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
Lists all the networks the Engine `daemon` knows about. This includes the
|
||||
networks that span across multiple hosts in a cluster, for example:
|
||||
|
||||
```bash
|
||||
$ sudo docker network ls
|
||||
NETWORK ID NAME DRIVER
|
||||
7fca4eb8c647 bridge bridge
|
||||
9f904ee27bf5 none null
|
||||
cf03ee007fb4 host host
|
||||
78b03ee04fc4 multi-host overlay
|
||||
```
|
||||
|
||||
Use the `--no-trunc` option to display the full network id:
|
||||
|
||||
```bash
|
||||
docker network ls --no-trunc
|
||||
NETWORK ID NAME DRIVER
|
||||
18a2866682b85619a026c81b98a5e375bd33e1b0936a26cc497c283d27bae9b3 none null
|
||||
c288470c46f6c8949c5f7e5099b5b7947b07eabe8d9a27d79a9cbf111adcbf47 host host
|
||||
7b369448dccbf865d397c8d2be0cda7cf7edc6b0945f77d2529912ae917a0185 bridge bridge
|
||||
95e74588f40db048e86320c6526440c504650a1ff3e9f7d60a497c4d2163e5bd foo bridge
|
||||
```
|
||||
|
||||
# OPTIONS
|
||||
|
||||
[**--no-trunc**]
|
||||
Do not truncate the output
|
||||
|
||||
[**-q** | **--quiet**]
|
||||
Only display numeric IDs
|
||||
|
||||
**--help**
|
||||
Print usage statement
|
||||
|
||||
# HISTORY
|
||||
OCT 2015, created by Mary Anthony <mary@docker.com>
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
% DOCKER(1) Docker User Manuals
|
||||
% Docker Community
|
||||
% OCT 2015
|
||||
# NAME
|
||||
docker-network-rm - remove a new network
|
||||
|
||||
# SYNOPSIS
|
||||
**docker network rm NETWORK**
|
||||
|
||||
[**--help**]
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
Removes a network by name or identifier. To remove a network, you must first disconnect any containers connected to it.
|
||||
|
||||
```
|
||||
$ docker network rm my-network
|
||||
```
|
||||
|
||||
|
||||
# OPTIONS
|
||||
**NETWORK**
|
||||
Specify network name
|
||||
|
||||
**--help**
|
||||
Print usage statement
|
||||
|
||||
# HISTORY
|
||||
OCT 2015, created by Mary Anthony <mary@docker.com>
|
||||
Loading…
Reference in New Issue