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

@ -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,

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
}

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