Skip to content

Commit 9ef855f

Browse files
author
Mary Anthony
committed
First pass at consolidating
Removing old networking.md Updating dockernetworks.md with images Adding information on network plugins Adding blurb about links to docker networking Updating the working documentation Adding Overlay Getting Started Downplaying links by removing refs/examples, adding refs/examples for network. Updating getting started to reflect networks not links Pulling out old network material Updating per discussion with Madhu to add Default docs section Updating with bridge default Fix bad merge Updating with new cluster-advertise behavior Update working and NetworkSettings examples Correcting example for default bridge discovery behavior Entering comments Fixing broken Markdown Syntax Updating with comments Updating all the links Signed-off-by: Mary Anthony <mary@docker.com>
1 parent 4eac6d4 commit 9ef855f

File tree

82 files changed

+3120
-2235
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+3120
-2235
lines changed

docs/articles/dockerfile_best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ in a database image.
5959
In almost all cases, you should only run a single process in a single
6060
container. Decoupling applications into multiple containers makes it much
6161
easier to scale horizontally and reuse containers. If that service depends on
62-
another service, make use of [container linking](../userguide/dockerlinks.md).
62+
another service, make use of [container linking](../userguide/networking/default_network/dockerlinks.md).
6363

6464
### Minimize the number of layers
6565

docs/articles/host_integration.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ title = "Automatically start containers"
44
description = "How to generate scripts for upstart, systemd, etc."
55
keywords = ["systemd, upstart, supervisor, docker, documentation, host integration"]
66
[menu.main]
7-
parent = "smn_containers"
8-
weight = 99
7+
parent = "smn_administrate"
98
+++
109
<![end-metadata]-->
1110

docs/articles/networking.md

Lines changed: 0 additions & 1137 deletions
This file was deleted.

docs/articles/security.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ of another container. Of course, if the host system is setup
3939
accordingly, containers can interact with each other through their
4040
respective network interfaces — just like they can interact with
4141
external hosts. When you specify public ports for your containers or use
42-
[*links*](../userguide/dockerlinks.md)
42+
[*links*](../userguide/networking/default_network/dockerlinks.md)
4343
then IP traffic is allowed between containers. They can ping each other,
4444
send/receive UDP packets, and establish TCP connections, but that can be
4545
restricted if necessary. From a network architecture point of view, all
@@ -129,7 +129,7 @@ privilege separation.
129129

130130
Eventually, it is expected that the Docker daemon will run restricted
131131
privileges, delegating operations well-audited sub-processes,
132-
each with its own (very limited) scope of Linux capabilities,
132+
each with its own (very limited) scope of Linux capabilities,
133133
virtual network setup, filesystem management, etc. That is, most likely,
134134
pieces of the Docker engine itself will run inside of containers.
135135

docs/examples/mongodb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,6 @@ the exposed port to two different ports on the host
172172
$ mongo --port 28001
173173
$ mongo --port 28002
174174

175-
- [Linking containers](../userguide/dockerlinks.md)
175+
- [Linking containers](../userguide/networking/default_network/dockerlinks.md)
176176
- [Cross-host linking containers](../articles/ambassador_pattern_linking.md)
177177
- [Creating an Automated Build](https://docs.docker.com/docker-hub/builds/)

docs/examples/postgresql_service.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ parent = "smn_applied"
1010

1111
# Dockerizing PostgreSQL
1212

13-
> **Note**:
13+
> **Note**:
1414
> - **If you don't like sudo** then see [*Giving non-root
1515
> access*](../installation/binaries.md#giving-non-root-access)
1616
@@ -85,7 +85,7 @@ And run the PostgreSQL server container (in the foreground):
8585
$ docker run --rm -P --name pg_test eg_postgresql
8686

8787
There are 2 ways to connect to the PostgreSQL server. We can use [*Link
88-
Containers*](../userguide/dockerlinks.md), or we can access it from our host
88+
Containers*](../userguide/networking/default_network/dockerlinks.md), or we can access it from our host
8989
(or the network).
9090

9191
> **Note**:

docs/extend/plugins.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@ plugins.
1818

1919
Plugins extend Docker's functionality. They come in specific types. For
2020
example, a [volume plugin](plugins_volume.md) might enable Docker
21-
volumes to persist across multiple Docker hosts and a
22-
[network plugin](plugins_network.md) might provide network plumbing
23-
using a favorite networking technology, such as vxlan overlay, ipvlan, EVPN, etc.
21+
volumes to persist across multiple Docker hosts and a
22+
[network plugin](plugins_network.md) might provide network plumbing.
2423

2524
Currently Docker supports volume and network driver plugins. In the future it
2625
will support additional plugin types.

docs/extend/plugins_network.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--[metadata]>
22
+++
33
title = "Docker network driver plugins"
4-
description = "Network drive plugins."
4+
description = "Network driver plugins."
55
keywords = ["Examples, Usage, plugins, docker, documentation, user guide"]
66
[menu.main]
77
parent = "mn_extend"
@@ -11,41 +11,48 @@ weight=-1
1111

1212
# Docker network driver plugins
1313

14-
Docker supports network driver plugins via
15-
[LibNetwork](https://github.com/docker/libnetwork). Network driver plugins are
16-
implemented as "remote drivers" for LibNetwork, which shares plugin
17-
infrastructure with Docker. In effect this means that network driver plugins
18-
are activated in the same way as other plugins, and use the same kind of
19-
protocol.
14+
Docker network plugins enable Docker deployments to be extended to support a
15+
wide range of networking technologies, such as VXLAN, IPVLAN, MACVLAN or
16+
something completely different. Network driver plugins are supported via the
17+
LibNetwork project. Each plugin is implemented asa "remote driver" for
18+
LibNetwork, which shares plugin infrastructure with Docker. Effectively,
19+
network driver plugins are activated in the same way as other plugins, and use
20+
the same kind of protocol.
2021

2122
## Using network driver plugins
2223

23-
The means of installing and running a network driver plugin will depend on the
24-
particular plugin.
24+
The means of installing and running a network driver plugin depend on the
25+
particular plugin. So, be sure to install your plugin according to the
26+
instructions obtained from the plugin developer.
2527

2628
Once running however, network driver plugins are used just like the built-in
2729
network drivers: by being mentioned as a driver in network-oriented Docker
2830
commands. For example,
2931

30-
docker network create -d weave mynet
32+
$ docker network create --driver weave mynet
3133

3234
Some network driver plugins are listed in [plugins](plugins.md)
3335

34-
The network thus created is owned by the plugin, so subsequent commands
35-
referring to that network will also be run through the plugin such as,
36+
The `mynet` network is now owned by `weave`, so subsequent commands
37+
referring to that network will be sent to the plugin,
3638

37-
docker run --net=mynet busybox top
39+
$ docker run --net=mynet busybox top
3840

39-
## Network driver plugin protocol
4041

41-
The network driver protocol, additional to the plugin activation call, is
42-
documented as part of LibNetwork:
42+
## Write a network plugin
43+
44+
Network plugins implement the [Docker plugin
45+
API](https://docs.docker.com/extend/plugin_api/) and the network plugin protocol
46+
47+
## Network plugin protocol
48+
49+
The network driver protocol, in addition to the plugin activation call, is
50+
documented as part of libnetwork:
4351
[https://github.com/docker/libnetwork/blob/master/docs/remote.md](https://github.com/docker/libnetwork/blob/master/docs/remote.md).
4452

45-
# Related GitHub PRs and issues
53+
# Related Information
4654

47-
Please record your feedback in the following issue, on the usual
48-
Google Groups, or the IRC channel #docker-network.
55+
To interact with the Docker maintainers and other interested users, se the IRC channel `#docker-network`.
4956

50-
- [#14083](https://github.com/docker/docker/issues/14083) Feedback on
51-
experimental networking features
57+
- [Docker networks feature overview](../userguide/networking/index.md)
58+
- The [LibNetwork](https://github.com/docker/libnetwork) project

docs/misc/faq.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ with several powerful functionalities:
9898

9999
- *Sharing.* Docker has access to a public registry [on Docker Hub](https://hub.docker.com/)
100100
where thousands of people have uploaded useful images: anything from Redis,
101-
CouchDB, PostgreSQL to IRC bouncers to Rails app servers to Hadoop to base
101+
CouchDB, PostgreSQL to IRC bouncers to Rails app servers to Hadoop to base
102102
images for various Linux distros. The
103103
[*registry*](https://docs.docker.com/registry/) also
104104
includes an official "standard library" of useful containers maintained by the
@@ -135,8 +135,7 @@ thousands or even millions of containers running in parallel.
135135

136136
### How do I connect Docker containers?
137137

138-
Currently the recommended way to link containers is via the link primitive. You
139-
can see details of how to [work with links here](../userguide/dockerlinks.md).
138+
Currently the recommended way to connect containers is via the Docker network feature. You can see details of how to [work with Docker networks here](https://docs.docker.com/networking).
140139

141140
Also useful for more flexible service portability is the [Ambassador linking
142141
pattern](../articles/ambassador_pattern_linking.md).
@@ -154,19 +153,19 @@ the container will continue to as well. You can see a more substantial example
154153

155154
Linux:
156155

157-
- Ubuntu 12.04, 13.04 et al
158-
- Fedora 19/20+
159-
- RHEL 6.5+
160-
- CentOS 6+
161-
- Gentoo
162-
- ArchLinux
163-
- openSUSE 12.3+
156+
- Ubuntu 12.04, 13.04 et al
157+
- Fedora 19/20+
158+
- RHEL 6.5+
159+
- CentOS 6+
160+
- Gentoo
161+
- ArchLinux
162+
- openSUSE 12.3+
164163
- CRUX 3.0+
165164

166165
Cloud:
167166

168-
- Amazon EC2
169-
- Google Compute Engine
167+
- Amazon EC2
168+
- Google Compute Engine
170169
- Microsoft Azure
171170
- Rackspace
172171

@@ -263,11 +262,11 @@ how to do this, check the documentation for your OS.
263262
You can find more answers on:
264263

265264

266-
- [Docker user mailinglist](https://groups.google.com/d/forum/docker-user)
267-
- [Docker developer mailinglist](https://groups.google.com/d/forum/docker-dev)
268-
- [IRC, docker on freenode](irc://chat.freenode.net#docker)
269-
- [GitHub](https://github.com/docker/docker)
270-
- [Ask questions on Stackoverflow](http://stackoverflow.com/search?q=docker)
265+
- [Docker user mailinglist](https://groups.google.com/d/forum/docker-user)
266+
- [Docker developer mailinglist](https://groups.google.com/d/forum/docker-dev)
267+
- [IRC, docker on freenode](irc://chat.freenode.net#docker)
268+
- [GitHub](https://github.com/docker/docker)
269+
- [Ask questions on Stackoverflow](http://stackoverflow.com/search?q=docker)
271270
- [Join the conversation on Twitter](http://twitter.com/docker)
272271

273272
Looking for something else to read? Checkout the [User Guide](../userguide/).

0 commit comments

Comments
 (0)