Factor an API out into a module

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

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
}

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
}

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
}

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() {