ITQC/containernetworking-plugins
24
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 34 Wiki Activity

Factor an API out into a module

Browse Source 
This takes some of the machinery from CNI and from the rkt networking
code, and turns it into a library that can be linked into go apps.

Included is an example command-line application that uses the library,
called `cnitool`.

Other headline changes:

 * Plugin exec'ing is factored out

The motivation here is to factor out the protocol for invoking
plugins. To that end, a generalisation of the code from api.go and
pkg/plugin/ipam.go goes into pkg/invoke/exec.go.

 * Move argument-handling and conf-loading into public API

The fact that the arguments get turned into an environment for the
plugin is incidental to the API; so, provide a way of supplying them
as a struct or saying "just use the same arguments as I got" (the
latter is for IPAM plugins).
This commit is contained in:
Michael Bridgen
2015-08-07 16:27:52 +01:00
parent 5da5738456
commit b88f173c43
28 changed files with 643 additions and 274 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
plugins/ipam/dhcp/daemon.go
View File

@ -27,8 +27,8 @@ import (
"runtime"
"sync"
"github.com/appc/cni/pkg/plugin"
"github.com/appc/cni/pkg/skel"
"github.com/appc/cni/pkg/types"
"github.com/coreos/go-systemd/activation"
)
@ -50,8 +50,8 @@ func newDHCP() *DHCP {
// Allocate acquires an IP from a DHCP server for a specified container.
// The acquired lease will be maintained until Release() is called.
func (d *DHCP) Allocate(args *skel.CmdArgs, result *plugin.Result) error {
conf := plugin.NetConf{}
func (d *DHCP) Allocate(args *skel.CmdArgs, result *types.Result) error {
conf := types.NetConf{}
if err := json.Unmarshal(args.StdinData, &conf); err != nil {
return fmt.Errorf("error parsing netconf: %v", err)
}
@ -70,7 +70,7 @@ func (d *DHCP) Allocate(args *skel.CmdArgs, result *plugin.Result) error {
d.setLease(args.ContainerID, conf.Name, l)
result.IP4 = &plugin.IPConfig{
result.IP4 = &types.IPConfig{
IP: *ipn,
Gateway: l.Gateway(),
Routes: l.Routes(),
@ -82,7 +82,7 @@ func (d *DHCP) Allocate(args *skel.CmdArgs, result *plugin.Result) error {
// Release stops maintenance of the lease acquired in Allocate()
// and sends a release msg to the DHCP server.
func (d *DHCP) Release(args *skel.CmdArgs, reply *struct{}) error {
conf := plugin.NetConf{}
conf := types.NetConf{}
if err := json.Unmarshal(args.StdinData, &conf); err != nil {
return fmt.Errorf("error parsing netconf: %v", err)
}

4
plugins/ipam/dhcp/lease.go
View File

@ -28,7 +28,7 @@ import (
"github.com/vishvananda/netlink"
"github.com/appc/cni/pkg/ns"
"github.com/appc/cni/pkg/plugin"
"github.com/appc/cni/pkg/types"
)
// RFC 2131 suggests using exponential backoff, starting with 4sec
@ -285,7 +285,7 @@ func (l *DHCPLease) Gateway() net.IP {
return parseRouter(l.opts)
}
func (l *DHCPLease) Routes() []plugin.Route {
func (l *DHCPLease) Routes() []types.Route {
routes := parseRoutes(l.opts)
return append(routes, parseCIDRRoutes(l.opts)...)
}

4
plugins/ipam/dhcp/main.go
View File

@ -20,8 +20,8 @@ import (
"os"
"path/filepath"
"github.com/appc/cni/pkg/plugin"
"github.com/appc/cni/pkg/skel"
"github.com/appc/cni/pkg/types"
)
const socketPath = "/run/cni/dhcp.sock"
@ -35,7 +35,7 @@ func main() {
}
func cmdAdd(args *skel.CmdArgs) error {
result := plugin.Result{}
result := types.Result{}
if err := rpcCall("DHCP.Allocate", args, &result); err != nil {
return err
}

14
plugins/ipam/dhcp/options.go
View File

@ -20,7 +20,7 @@ import (
"net"
"time"
"github.com/appc/cni/pkg/plugin"
"github.com/appc/cni/pkg/types"
"github.com/d2g/dhcp4"
)
@ -40,17 +40,17 @@ func classfulSubnet(sn net.IP) net.IPNet {
}
}
func parseRoutes(opts dhcp4.Options) []plugin.Route {
func parseRoutes(opts dhcp4.Options) []types.Route {
// StaticRoutes format: pairs of:
// Dest = 4 bytes; Classful IP subnet
// Router = 4 bytes; IP address of router
routes := []plugin.Route{}
routes := []types.Route{}
if opt, ok := opts[dhcp4.OptionStaticRoute]; ok {
for len(opt) >= 8 {
sn := opt[0:4]
r := opt[4:8]
rt := plugin.Route{
rt := types.Route{
Dst: classfulSubnet(sn),
GW: r,
}
@ -62,10 +62,10 @@ func parseRoutes(opts dhcp4.Options) []plugin.Route {
return routes
}
func parseCIDRRoutes(opts dhcp4.Options) []plugin.Route {
func parseCIDRRoutes(opts dhcp4.Options) []types.Route {
// See RFC4332 for format (http://tools.ietf.org/html/rfc3442)
routes := []plugin.Route{}
routes := []types.Route{}
if opt, ok := opts[dhcp4.OptionClasslessRouteFormat]; ok {
for len(opt) >= 5 {
width := int(opt[0])
@ -89,7 +89,7 @@ func parseCIDRRoutes(opts dhcp4.Options) []plugin.Route {
gw := net.IP(opt[octets+1 : octets+5])
rt := plugin.Route{
rt := types.Route{
Dst: net.IPNet{
IP: net.IP(sn),
Mask: net.CIDRMask(width, 32),

10
plugins/ipam/dhcp/options_test.go
View File

@ -18,20 +18,20 @@ import (
"net"
"testing"
"github.com/appc/cni/pkg/plugin"
"github.com/appc/cni/pkg/types"
"github.com/d2g/dhcp4"
)
func validateRoutes(t *testing.T, routes []plugin.Route) {
expected := []plugin.Route{
plugin.Route{
func validateRoutes(t *testing.T, routes []types.Route) {
expected := []types.Route{
types.Route{
Dst: net.IPNet{
IP: net.IPv4(10, 0, 0, 0),
Mask: net.CIDRMask(8, 32),
},
GW: net.IPv4(10, 1, 2, 3),
},
plugin.Route{
types.Route{
Dst: net.IPNet{
IP: net.IPv4(192, 168, 1, 0),
Mask: net.CIDRMask(24, 32),

12
plugins/ipam/host-local/allocator.go
View File

@ -19,7 +19,7 @@ import (
"net"
"github.com/appc/cni/pkg/ip"
"github.com/appc/cni/pkg/plugin"
"github.com/appc/cni/pkg/types"
"github.com/appc/cni/plugins/ipam/host-local/backend"
)
@ -69,7 +69,7 @@ func validateRangeIP(ip net.IP, ipnet *net.IPNet) error {
}
// Returns newly allocated IP along with its config
func (a *IPAllocator) Get(id string) (*plugin.IPConfig, error) {
func (a *IPAllocator) Get(id string) (*types.IPConfig, error) {
a.store.Lock()
defer a.store.Unlock()
@ -103,7 +103,7 @@ func (a *IPAllocator) Get(id string) (*plugin.IPConfig, error) {
}
if reserved {
return &plugin.IPConfig{
return &types.IPConfig{
IP: net.IPNet{requestedIP, a.conf.Subnet.Mask},
Gateway: gw,
Routes: a.conf.Routes,
@ -123,7 +123,7 @@ func (a *IPAllocator) Get(id string) (*plugin.IPConfig, error) {
return nil, err
}
if reserved {
return &plugin.IPConfig{
return &types.IPConfig{
IP: net.IPNet{cur, a.conf.Subnet.Mask},
Gateway: gw,
Routes: a.conf.Routes,
@ -135,7 +135,7 @@ func (a *IPAllocator) Get(id string) (*plugin.IPConfig, error) {
// Allocates both an IP and the Gateway IP, i.e. a /31
// This is used for Point-to-Point links
func (a *IPAllocator) GetPtP(id string) (*plugin.IPConfig, error) {
func (a *IPAllocator) GetPtP(id string) (*types.IPConfig, error) {
a.store.Lock()
defer a.store.Unlock()
@ -165,7 +165,7 @@ func (a *IPAllocator) GetPtP(id string) (*plugin.IPConfig, error) {
_, bits := a.conf.Subnet.Mask.Size()
mask := net.CIDRMask(bits-1, bits)
return &plugin.IPConfig{
return &types.IPConfig{
IP: net.IPNet{cur, mask},
Gateway: gw,
Routes: a.conf.Routes,

19
plugins/ipam/host-local/config.go
View File

@ -19,20 +19,19 @@ import (
"fmt"
"net"
"github.com/appc/cni/pkg/ip"
"github.com/appc/cni/pkg/plugin"
"github.com/appc/cni/pkg/types"
)
// IPAMConfig represents the IP related network configuration.
type IPAMConfig struct {
Name string
Type string `json:"type"`
RangeStart net.IP `json:"rangeStart"`
RangeEnd net.IP `json:"rangeEnd"`
Subnet ip.IPNet `json:"subnet"`
Gateway net.IP `json:"gateway"`
Routes []plugin.Route `json:"routes"`
Args *IPAMArgs `json:"-"`
Type string `json:"type"`
RangeStart net.IP `json:"rangeStart"`
RangeEnd net.IP `json:"rangeEnd"`
Subnet types.IPNet `json:"subnet"`
Gateway net.IP `json:"gateway"`
Routes []types.Route `json:"routes"`
Args *IPAMArgs `json:"-"`
}
type IPAMArgs struct {
@ -53,7 +52,7 @@ func LoadIPAMConfig(bytes []byte, args string) (*IPAMConfig, error) {
if args != "" {
ipamArgs := IPAMArgs{}
err := plugin.LoadArgs(args, &ipamArgs)
err := types.LoadArgs(args, &ipamArgs)
if err != nil {
return nil, err
}

8
plugins/ipam/host-local/main.go
View File

@ -19,8 +19,8 @@ import (
"github.com/appc/cni/plugins/ipam/host-local/backend/disk"
"github.com/appc/cni/pkg/plugin"
"github.com/appc/cni/pkg/skel"
"github.com/appc/cni/pkg/types"
)
func main() {
@ -40,7 +40,7 @@ func cmdAdd(args *skel.CmdArgs) error {
defer store.Close()
ipamArgs := IPAMArgs{}
err = plugin.LoadArgs(args.Args, &ipamArgs)
err = types.LoadArgs(args.Args, &ipamArgs)
if err != nil {
return err
}
@ -51,7 +51,7 @@ func cmdAdd(args *skel.CmdArgs) error {
return err
}
var ipConf *plugin.IPConfig
var ipConf *types.IPConfig
switch ipamConf.Type {
case "host-local":
@ -66,7 +66,7 @@ func cmdAdd(args *skel.CmdArgs) error {
return err
}
r := &plugin.Result{
r := &types.Result{
IP4: ipConf,
}
return r.Print()

11
plugins/main/bridge/bridge.go
View File

@ -24,16 +24,17 @@ import (
"syscall"
"github.com/appc/cni/pkg/ip"
"github.com/appc/cni/pkg/ipam"
"github.com/appc/cni/pkg/ns"
"github.com/appc/cni/pkg/plugin"
"github.com/appc/cni/pkg/skel"
"github.com/appc/cni/pkg/types"
"github.com/vishvananda/netlink"
)
const defaultBrName = "cni0"
type NetConf struct {
plugin.NetConf
types.NetConf
BrName string `json:"bridge"`
IsGW bool `json:"isGateway"`
IPMasq bool `json:"ipMasq"`
@ -183,7 +184,7 @@ func cmdAdd(args *skel.CmdArgs) error {
}
// run the IPAM plugin and get back the config to apply
result, err := plugin.ExecAdd(n.IPAM.Type, args.StdinData)
result, err := ipam.ExecAdd(n.IPAM.Type, args.StdinData)
if err != nil {
return err
}
@ -197,7 +198,7 @@ func cmdAdd(args *skel.CmdArgs) error {
}
err = ns.WithNetNSPath(args.Netns, false, func(hostNS *os.File) error {
return plugin.ConfigureIface(args.IfName, result)
return ipam.ConfigureIface(args.IfName, result)
})
if err != nil {
return err
@ -234,7 +235,7 @@ func cmdDel(args *skel.CmdArgs) error {
return err
}
err = plugin.ExecDel(n.IPAM.Type, args.StdinData)
err = ipam.ExecDel(n.IPAM.Type, args.StdinData)
if err != nil {
return err
}

11
plugins/main/ipvlan/ipvlan.go
View File

@ -22,14 +22,15 @@ import (
"runtime"
"github.com/appc/cni/pkg/ip"
"github.com/appc/cni/pkg/ipam"
"github.com/appc/cni/pkg/ns"
"github.com/appc/cni/pkg/plugin"
"github.com/appc/cni/pkg/skel"
"github.com/appc/cni/pkg/types"
"github.com/vishvananda/netlink"
)
type NetConf struct {
plugin.NetConf
types.NetConf
Master string `json:"master"`
Mode string `json:"mode"`
MTU int `json:"mtu"`
@ -122,7 +123,7 @@ func cmdAdd(args *skel.CmdArgs) error {
}
// run the IPAM plugin and get back the config to apply
result, err := plugin.ExecAdd(n.IPAM.Type, args.StdinData)
result, err := ipam.ExecAdd(n.IPAM.Type, args.StdinData)
if err != nil {
return err
}
@ -131,7 +132,7 @@ func cmdAdd(args *skel.CmdArgs) error {
}
err = ns.WithNetNS(netns, false, func(_ *os.File) error {
return plugin.ConfigureIface(args.IfName, result)
return ipam.ConfigureIface(args.IfName, result)
})
if err != nil {
return err
@ -146,7 +147,7 @@ func cmdDel(args *skel.CmdArgs) error {
return err
}
err = plugin.ExecDel(n.IPAM.Type, args.StdinData)
err = ipam.ExecDel(n.IPAM.Type, args.StdinData)
if err != nil {
return err
}

11
plugins/main/macvlan/macvlan.go
View File

@ -22,14 +22,15 @@ import (
"runtime"
"github.com/appc/cni/pkg/ip"
"github.com/appc/cni/pkg/ipam"
"github.com/appc/cni/pkg/ns"
"github.com/appc/cni/pkg/plugin"
"github.com/appc/cni/pkg/skel"
"github.com/appc/cni/pkg/types"
"github.com/vishvananda/netlink"
)
type NetConf struct {
plugin.NetConf
types.NetConf
Master string `json:"master"`
Mode string `json:"mode"`
MTU int `json:"mtu"`
@ -126,7 +127,7 @@ func cmdAdd(args *skel.CmdArgs) error {
}
// run the IPAM plugin and get back the config to apply
result, err := plugin.ExecAdd(n.IPAM.Type, args.StdinData)
result, err := ipam.ExecAdd(n.IPAM.Type, args.StdinData)
if err != nil {
return err
}
@ -135,7 +136,7 @@ func cmdAdd(args *skel.CmdArgs) error {
}
err = ns.WithNetNS(netns, false, func(_ *os.File) error {
return plugin.ConfigureIface(args.IfName, result)
return ipam.ConfigureIface(args.IfName, result)
})
if err != nil {
return err
@ -150,7 +151,7 @@ func cmdDel(args *skel.CmdArgs) error {
return err
}
err = plugin.ExecDel(n.IPAM.Type, args.StdinData)
err = ipam.ExecDel(n.IPAM.Type, args.StdinData)
if err != nil {
return err
}

15
plugins/main/ptp/ptp.go
View File

@ -26,9 +26,10 @@ import (
"github.com/vishvananda/netlink"
"github.com/appc/cni/pkg/ip"
"github.com/appc/cni/pkg/ipam"
"github.com/appc/cni/pkg/ns"
"github.com/appc/cni/pkg/plugin"
"github.com/appc/cni/pkg/skel"
"github.com/appc/cni/pkg/types"
)
func init() {
@ -39,12 +40,12 @@ func init() {
}
type NetConf struct {
plugin.NetConf
types.NetConf
IPMasq bool `json:"ipMasq"`
MTU int `json:"mtu"`
}
func setupContainerVeth(netns, ifName string, mtu int, pr *plugin.Result) (string, error) {
func setupContainerVeth(netns, ifName string, mtu int, pr *types.Result) (string, error) {
var hostVethName string
err := ns.WithNetNSPath(netns, false, func(hostNS *os.File) error {
hostVeth, _, err := ip.SetupVeth(ifName, mtu, hostNS)
@ -52,7 +53,7 @@ func setupContainerVeth(netns, ifName string, mtu int, pr *plugin.Result) (strin
return err
}
err = plugin.ConfigureIface(ifName, pr)
err = ipam.ConfigureIface(ifName, pr)
if err != nil {
return err
}
@ -64,7 +65,7 @@ func setupContainerVeth(netns, ifName string, mtu int, pr *plugin.Result) (strin
return hostVethName, err
}
func setupHostVeth(vethName string, ipConf *plugin.IPConfig) error {
func setupHostVeth(vethName string, ipConf *types.IPConfig) error {
// hostVeth moved namespaces and may have a new ifindex
veth, err := netlink.LinkByName(vethName)
if err != nil {
@ -100,7 +101,7 @@ func cmdAdd(args *skel.CmdArgs) error {
}
// run the IPAM plugin and get back the config to apply
result, err := plugin.ExecAdd(conf.IPAM.Type, args.StdinData)
result, err := ipam.ExecAdd(conf.IPAM.Type, args.StdinData)
if err != nil {
return err
}
@ -152,7 +153,7 @@ func cmdDel(args *skel.CmdArgs) error {
}
}
return plugin.ExecDel(conf.IPAM.Type, args.StdinData)
return ipam.ExecDel(conf.IPAM.Type, args.StdinData)
}
func main() {

15
plugins/meta/flannel/flannel.go
View File

@ -29,8 +29,9 @@ import (
"strconv"
"strings"
"github.com/appc/cni/pkg/plugin"
"github.com/appc/cni/pkg/ipam"
"github.com/appc/cni/pkg/skel"
"github.com/appc/cni/pkg/types"
)
const (
@ -39,7 +40,7 @@ const (
)
type NetConf struct {
plugin.NetConf
types.NetConf
SubnetFile string `json:"subnetFile"`
Delegate map[string]interface{} `json:"delegate"`
}
@ -130,7 +131,7 @@ func delegateAdd(cid string, netconf map[string]interface{}) error {
return err
}
result, err := plugin.ExecAdd(netconf["type"].(string), netconfBytes)
result, err := ipam.ExecAdd(netconf["type"].(string), netconfBytes)
if err != nil {
return err
}
@ -199,8 +200,8 @@ func cmdAdd(args *skel.CmdArgs) error {
n.Delegate["ipam"] = map[string]interface{}{
"type": "host-local",
"subnet": fenv.sn.String(),
"routes": []plugin.Route{
plugin.Route{
"routes": []types.Route{
types.Route{
Dst: *fenv.nw,
},
},
@ -215,12 +216,12 @@ func cmdDel(args *skel.CmdArgs) error {
return err
}
n := &plugin.NetConf{}
n := &types.NetConf{}
if err = json.Unmarshal(netconfBytes, n); err != nil {
return fmt.Errorf("failed to parse netconf: %v", err)
}
return plugin.ExecDel(n.Type, netconfBytes)
return ipam.ExecDel(n.Type, netconfBytes)
}
func main() {