mirror of https://github.com/docker/cli.git
83 lines
3.1 KiB
Markdown
83 lines
3.1 KiB
Markdown
---
|
|
description: "Network driver plugins."
|
|
keywords: "Examples, Usage, plugins, docker, documentation, user guide"
|
|
---
|
|
|
|
<!-- This file is maintained within the docker/cli GitHub
|
|
repository at https://github.com/docker/cli/. Make all
|
|
pull requests against that repo. If you see this file in
|
|
another repository, consider it read-only there, as it will
|
|
periodically be overwritten by the definitive file. Pull
|
|
requests which include edits to this file in other repositories
|
|
will be rejected.
|
|
-->
|
|
|
|
# Docker network driver plugins
|
|
|
|
This document describes Docker Engine network driver plugins generally
|
|
available in Docker Engine. To view information on plugins
|
|
managed by Docker Engine, refer to [Docker Engine plugin system](index.md).
|
|
|
|
Docker Engine network plugins enable Engine deployments to be extended to
|
|
support a wide range of networking technologies, such as VXLAN, IPVLAN, MACVLAN
|
|
or something completely different. Network driver plugins are supported via the
|
|
LibNetwork project. Each plugin is implemented as a "remote driver" for
|
|
LibNetwork, which shares plugin infrastructure with Engine. Effectively, network
|
|
driver plugins are activated in the same way as other plugins, and use the same
|
|
kind of protocol.
|
|
|
|
## Network plugins and swarm mode
|
|
|
|
[Legacy plugins](legacy_plugins.md) do not work in swarm mode. However,
|
|
plugins written using the [v2 plugin system](index.md) do work in swarm mode, as
|
|
long as they are installed on each swarm worker node.
|
|
|
|
## Use network driver plugins
|
|
|
|
The means of installing and running a network driver plugin depend on the
|
|
particular plugin. So, be sure to install your plugin according to the
|
|
instructions obtained from the plugin developer.
|
|
|
|
Once running however, network driver plugins are used just like the built-in
|
|
network drivers: by being mentioned as a driver in network-oriented Docker
|
|
commands. For example,
|
|
|
|
```console
|
|
$ docker network create --driver weave mynet
|
|
```
|
|
|
|
Some network driver plugins are listed in [plugins](legacy_plugins.md)
|
|
|
|
The `mynet` network is now owned by `weave`, so subsequent commands
|
|
referring to that network will be sent to the plugin,
|
|
|
|
```console
|
|
$ docker run --network=mynet busybox top
|
|
```
|
|
|
|
|
|
## Find network plugins
|
|
|
|
Network plugins are written by third parties, and are published by those
|
|
third parties, either on
|
|
[Docker Store](https://store.docker.com/search?category=network&q=&type=plugin)
|
|
or on the third party's site.
|
|
|
|
## Write a network plugin
|
|
|
|
Network plugins implement the [Docker plugin API](plugin_api.md) and the network
|
|
plugin protocol
|
|
|
|
## Network plugin protocol
|
|
|
|
The network driver protocol, in addition to the plugin activation call, is
|
|
documented as part of libnetwork:
|
|
[https://github.com/moby/moby/blob/master/libnetwork/docs/remote.md](https://github.com/moby/moby/blob/master/libnetwork/docs/remote.md).
|
|
|
|
## Related Information
|
|
|
|
To interact with the Docker maintainers and other interested users, see the IRC channel `#docker-network`.
|
|
|
|
- [Docker networks feature overview](https://docs.docker.com/engine/userguide/networking/)
|
|
- The [LibNetwork](https://github.com/docker/libnetwork) project
|