From c9e3fc4890767a619624e804029a8f5975ff28a3 Mon Sep 17 00:00:00 2001 From: Casey Callendrello Date: Mon, 15 May 2017 19:07:19 +0200 Subject: [PATCH] Add references to all plugins to the README --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 69c46457..5aa1dd55 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,23 @@ # plugins -Some additional CNI network plugins, matinained by the containernetworking team +Some CNI network plugins, maintained by the containernetworking team. For more information, see the individual READMEs. ## 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`: Creates a loopback interface +* `macvlan`: Creates a new MAC address, forwards all traffic to that to the container +* `ptp`: Creates a veth pair. +* `vlan`: Allocates a vlan device. + +### 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 + +### Meta: other plugins +* `flannel`: generates an interface corresponding to a flannel config file +* `tuning`: Tweaks sysctl parameters of an existing interface + ### Sample - The sample plugin provides a base for building a sample plugin with tests. +The sample plugin provides an example for building your own plugin.