plugins/README.md

[![Build Status](https://travis-ci.org/containernetworking/plugins.svg?branch=master)](https://travis-ci.org/containernetworking/plugins)

# plugins
Some CNI network plugins, maintained by the containernetworking team. For more information, see the individual READMEs.

Read [CONTRIBUTING](CONTRIBUTING.md) for build and test instructions.

## Plugins supplied:
### Main: interface-creating
* `bridge`: Creates a bridge, adds the host and the container to it.
* `ipvlan`: Adds an [ipvlan](https://www.kernel.org/doc/Documentation/networking/ipvlan.txt) interface in the container.
* `loopback`: Set the state of loopback interface to up.
* `macvlan`: Creates a new MAC address, forwards all traffic to that to the container.
* `ptp`: Creates a veth pair.
* `vlan`: Allocates a vlan device.
* `host-device`: Move an already-existing device into a container.
#### Windows: windows specific
* `win-bridge`: Creates a bridge, adds the host and the container to it.
* `win-overlay`: Creates an overlay interface to the container.
### IPAM: IP address allocation
* `dhcp`: Runs a daemon on the host to make DHCP requests on behalf of the container
* `host-local`: Maintains a local database of allocated IPs
* `static`:  Allocate a static IPv4/IPv6 addresses to container and it's useful in debugging purpose.

### Meta: other plugins
* `flannel`: Generates an interface corresponding to a flannel config file
* `tuning`: Tweaks sysctl parameters of an existing interface
* `portmap`: An iptables-based portmapping plugin. Maps ports from the host's address space to the container.
* `bandwidth`: Allows bandwidth-limiting through use of traffic control tbf (ingress/egress).
* `sbr`: A plugin that configures source based routing for an interface (from which it is chained).

### Sample
The sample plugin provides an example for building your own plugin.
Move Windows tests to Travis 2018-12-07 21:39:45 +00:00			`[![Build Status](https://travis-ci.org/containernetworking/plugins.svg?branch=master)](https://travis-ci.org/containernetworking/plugins)`
README.md: Add travis badge 2017-07-05 18:49:07 +00:00
Initial commit 2017-03-10 15:46:52 +00:00			`# plugins`
Add references to all plugins to the README 2017-05-15 17:07:19 +00:00			`Some CNI network plugins, maintained by the containernetworking team. For more information, see the individual READMEs.`
Add simple testing infrastructure 2017-03-13 17:05:55 +00:00
Add build instructions Signed-off-by: Bryan Boreham <bjboreham@gmail.com> 2018-07-04 14:40:24 +00:00			`Read [CONTRIBUTING](CONTRIBUTING.md) for build and test instructions.`

Add simple testing infrastructure 2017-03-13 17:05:55 +00:00			`## Plugins supplied:`
Add references to all plugins to the README 2017-05-15 17:07:19 +00:00			`### Main: interface-creating`
			* `bridge`: Creates a bridge, adds the host and the container to it.
fix_loopback_readme 2018-07-11 15:59:09 +00:00			* `ipvlan`: Adds an [ipvlan](https://www.kernel.org/doc/Documentation/networking/ipvlan.txt) interface in the container.
			* `loopback`: Set the state of loopback interface to up.
			* `macvlan`: Creates a new MAC address, forwards all traffic to that to the container.
Add references to all plugins to the README 2017-05-15 17:07:19 +00:00			* `ptp`: Creates a veth pair.
			* `vlan`: Allocates a vlan device.
Add the missing documents for some existing plugins 2018-10-18 02:20:52 +00:00			* `host-device`: Move an already-existing device into a container.
Windows Support Patch for https://github.com/containernetworking/plugins/pull/85 + Windows cni plugins are added () win-bridge (hostgw) () win-overlay (vxlan) + Windows netconf unit test + Fix appveyor config to run the test + Build release support for windows plugins Address comments From: - https://github.com/containernetworking/plugins/pull/85 - https://github.com/rakelkar/plugins/pull/5/commits/0049c64e3fb5527ab72b9ef1af25e3f6430f3309 2018-08-23 08:52:41 +00:00			`#### Windows: windows specific`
			* `win-bridge`: Creates a bridge, adds the host and the container to it.
			* `win-overlay`: Creates an overlay interface to the container.
Add references to all plugins to the README 2017-05-15 17:07:19 +00:00			`### IPAM: IP address allocation`
			* `dhcp`: Runs a daemon on the host to make DHCP requests on behalf of the container
Updated README to include bandwidth plugin Also standardized to upper case for sentence starts. 2018-05-15 17:15:32 +00:00			* `host-local`: Maintains a local database of allocated IPs
Fix typo from userful to useful in README 2018-12-03 06:35:19 +00:00			* `static`: Allocate a static IPv4/IPv6 addresses to container and it's useful in debugging purpose.
Add references to all plugins to the README 2017-05-15 17:07:19 +00:00
			`### Meta: other plugins`
Updated README to include bandwidth plugin Also standardized to upper case for sentence starts. 2018-05-15 17:15:32 +00:00			* `flannel`: Generates an interface corresponding to a flannel config file
Add references to all plugins to the README 2017-05-15 17:07:19 +00:00			* `tuning`: Tweaks sysctl parameters of an existing interface
plugins/meta/portmap: add an iptables-based host port mapping plugin 2017-05-26 15:50:13 +00:00			* `portmap`: An iptables-based portmapping plugin. Maps ports from the host's address space to the container.
Updated README to include bandwidth plugin Also standardized to upper case for sentence starts. 2018-05-15 17:15:32 +00:00			* `bandwidth`: Allows bandwidth-limiting through use of traffic control tbf (ingress/egress).
Create new Source Based Routing plugin This creates a new plugin (sbr) which sets up source based routing, for use as a chained plugin for multi-network environments. 2018-10-01 13:12:33 +00:00			* `sbr`: A plugin that configures source based routing for an interface (from which it is chained).
Add simple testing infrastructure 2017-03-13 17:05:55 +00:00
			`### Sample`
Add references to all plugins to the README 2017-05-15 17:07:19 +00:00			`The sample plugin provides an example for building your own plugin.`