2015-05-06 20:09:12 -04:00
|
|
|
package driverapi
|
|
|
|
|
2016-02-10 21:09:33 -05:00
|
|
|
import (
|
|
|
|
"net"
|
|
|
|
|
2016-10-07 16:37:57 -04:00
|
|
|
"github.com/docker/docker/pkg/plugingetter"
|
2016-02-10 21:09:33 -05:00
|
|
|
"github.com/docker/libnetwork/discoverapi"
|
|
|
|
)
|
2015-05-06 20:09:12 -04:00
|
|
|
|
|
|
|
// NetworkPluginEndpointType represents the Endpoint Type used by Plugin system
|
|
|
|
const NetworkPluginEndpointType = "NetworkDriver"
|
|
|
|
|
|
|
|
// Driver is an interface that every plugin driver needs to implement.
|
|
|
|
type Driver interface {
|
2016-02-10 21:09:33 -05:00
|
|
|
discoverapi.Discover
|
|
|
|
|
2016-05-08 03:32:51 -04:00
|
|
|
// NetworkAllocate invokes the driver method to allocate network
|
|
|
|
// specific resources passing network id and network specific config.
|
|
|
|
// It returns a key,value pair of network specific driver allocations
|
|
|
|
// to the caller.
|
|
|
|
NetworkAllocate(nid string, options map[string]string, ipV4Data, ipV6Data []IPAMData) (map[string]string, error)
|
|
|
|
|
|
|
|
// NetworkFree invokes the driver method to free network specific resources
|
|
|
|
// associated with a given network id.
|
|
|
|
NetworkFree(nid string) error
|
|
|
|
|
|
|
|
// CreateNetwork invokes the driver method to create a network
|
|
|
|
// passing the network id and network specific config. The
|
|
|
|
// config mechanism will eventually be replaced with labels
|
|
|
|
// which are yet to be introduced. The driver can return a
|
|
|
|
// list of table names for which it is interested in receiving
|
|
|
|
// notification when a CRUD operation is performed on any
|
|
|
|
// entry in that table. This will be ignored for local scope
|
|
|
|
// drivers.
|
|
|
|
CreateNetwork(nid string, options map[string]interface{}, nInfo NetworkInfo, ipV4Data, ipV6Data []IPAMData) error
|
2015-05-06 20:09:12 -04:00
|
|
|
|
|
|
|
// DeleteNetwork invokes the driver method to delete network passing
|
|
|
|
// the network id.
|
2015-09-02 19:42:01 -04:00
|
|
|
DeleteNetwork(nid string) error
|
2015-05-06 20:09:12 -04:00
|
|
|
|
|
|
|
// CreateEndpoint invokes the driver method to create an endpoint
|
|
|
|
// passing the network id, endpoint id endpoint information and driver
|
|
|
|
// specific config. The endpoint information can be either consumed by
|
|
|
|
// the driver or populated by the driver. The config mechanism will
|
|
|
|
// eventually be replaced with labels which are yet to be introduced.
|
2015-10-04 23:02:02 -04:00
|
|
|
CreateEndpoint(nid, eid string, ifInfo InterfaceInfo, options map[string]interface{}) error
|
2015-05-06 20:09:12 -04:00
|
|
|
|
|
|
|
// DeleteEndpoint invokes the driver method to delete an endpoint
|
|
|
|
// passing the network id and endpoint id.
|
2015-09-02 19:42:01 -04:00
|
|
|
DeleteEndpoint(nid, eid string) error
|
2015-05-06 20:09:12 -04:00
|
|
|
|
|
|
|
// EndpointOperInfo retrieves from the driver the operational data related to the specified endpoint
|
2015-09-02 19:42:01 -04:00
|
|
|
EndpointOperInfo(nid, eid string) (map[string]interface{}, error)
|
2015-05-06 20:09:12 -04:00
|
|
|
|
|
|
|
// Join method is invoked when a Sandbox is attached to an endpoint.
|
2015-09-02 19:42:01 -04:00
|
|
|
Join(nid, eid string, sboxKey string, jinfo JoinInfo, options map[string]interface{}) error
|
2015-05-06 20:09:12 -04:00
|
|
|
|
|
|
|
// Leave method is invoked when a Sandbox detaches from an endpoint.
|
2015-09-02 19:42:01 -04:00
|
|
|
Leave(nid, eid string) error
|
2015-05-06 20:09:12 -04:00
|
|
|
|
2016-03-08 21:47:02 -05:00
|
|
|
// ProgramExternalConnectivity invokes the driver method which does the necessary
|
|
|
|
// programming to allow the external connectivity dictated by the passed options
|
|
|
|
ProgramExternalConnectivity(nid, eid string, options map[string]interface{}) error
|
|
|
|
|
|
|
|
// RevokeExternalConnectivity aks the driver to remove any external connectivity
|
|
|
|
// programming that was done so far
|
|
|
|
RevokeExternalConnectivity(nid, eid string) error
|
|
|
|
|
2016-05-08 03:32:51 -04:00
|
|
|
// EventNotify notifies the driver when a CRUD operation has
|
|
|
|
// happened on a table of its interest as soon as this node
|
|
|
|
// receives such an event in the gossip layer. This method is
|
|
|
|
// only invoked for the global scope driver.
|
|
|
|
EventNotify(event EventType, nid string, tableName string, key string, value []byte)
|
|
|
|
|
2015-05-06 20:09:12 -04:00
|
|
|
// Type returns the the type of this driver, the network type this driver manages
|
|
|
|
Type() string
|
2016-12-19 08:30:41 -05:00
|
|
|
|
|
|
|
// IsBuiltIn returns true if it is a built-in driver
|
|
|
|
IsBuiltIn() bool
|
2015-05-06 20:09:12 -04:00
|
|
|
}
|
|
|
|
|
2016-05-08 03:32:51 -04:00
|
|
|
// NetworkInfo provides a go interface for drivers to provide network
|
|
|
|
// specific information to libnetwork.
|
|
|
|
type NetworkInfo interface {
|
|
|
|
// TableEventRegister registers driver interest in a given
|
|
|
|
// table name.
|
|
|
|
TableEventRegister(tableName string) error
|
|
|
|
}
|
|
|
|
|
2015-05-06 20:09:12 -04:00
|
|
|
// InterfaceInfo provides a go interface for drivers to retrive
|
|
|
|
// network information to interface resources.
|
|
|
|
type InterfaceInfo interface {
|
2015-10-04 23:02:02 -04:00
|
|
|
// SetMacAddress allows the driver to set the mac address to the endpoint interface
|
|
|
|
// during the call to CreateEndpoint, if the mac address is not already set.
|
|
|
|
SetMacAddress(mac net.HardwareAddr) error
|
|
|
|
|
|
|
|
// SetIPAddress allows the driver to set the ip address to the endpoint interface
|
|
|
|
// during the call to CreateEndpoint, if the address is not already set.
|
|
|
|
// The API is to be used to assign both the IPv4 and IPv6 address types.
|
|
|
|
SetIPAddress(ip *net.IPNet) error
|
|
|
|
|
2015-05-06 20:09:12 -04:00
|
|
|
// MacAddress returns the MAC address.
|
|
|
|
MacAddress() net.HardwareAddr
|
|
|
|
|
|
|
|
// Address returns the IPv4 address.
|
2015-10-04 23:02:02 -04:00
|
|
|
Address() *net.IPNet
|
2015-05-06 20:09:12 -04:00
|
|
|
|
|
|
|
// AddressIPv6 returns the IPv6 address.
|
2015-10-04 23:02:02 -04:00
|
|
|
AddressIPv6() *net.IPNet
|
2015-05-06 20:09:12 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
// InterfaceNameInfo provides a go interface for the drivers to assign names
|
|
|
|
// to interfaces.
|
|
|
|
type InterfaceNameInfo interface {
|
2015-05-23 02:00:03 -04:00
|
|
|
// SetNames method assigns the srcName and dstPrefix for the interface.
|
|
|
|
SetNames(srcName, dstPrefix string) error
|
2015-05-06 20:09:12 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
// JoinInfo represents a set of resources that the driver has the ability to provide during
|
|
|
|
// join time.
|
|
|
|
type JoinInfo interface {
|
2016-08-11 02:31:01 -04:00
|
|
|
// InterfaceName returns an InterfaceNameInfo go interface to facilitate
|
2015-09-14 14:04:12 -04:00
|
|
|
// setting the names for the interface.
|
|
|
|
InterfaceName() InterfaceNameInfo
|
2015-05-06 20:09:12 -04:00
|
|
|
|
|
|
|
// SetGateway sets the default IPv4 gateway when a container joins the endpoint.
|
|
|
|
SetGateway(net.IP) error
|
|
|
|
|
|
|
|
// SetGatewayIPv6 sets the default IPv6 gateway when a container joins the endpoint.
|
|
|
|
SetGatewayIPv6(net.IP) error
|
|
|
|
|
2016-03-08 21:47:02 -05:00
|
|
|
// AddStaticRoute adds a route to the sandbox.
|
|
|
|
// It may be used in addition to or instead of a default gateway (as above).
|
2015-09-14 14:04:12 -04:00
|
|
|
AddStaticRoute(destination *net.IPNet, routeType int, nextHop net.IP) error
|
2015-12-07 18:46:14 -05:00
|
|
|
|
|
|
|
// DisableGatewayService tells libnetwork not to provide Default GW for the container
|
|
|
|
DisableGatewayService()
|
2016-05-08 03:32:51 -04:00
|
|
|
|
|
|
|
// AddTableEntry adds a table entry to the gossip layer
|
|
|
|
// passing the table name, key and an opaque value.
|
|
|
|
AddTableEntry(tableName string, key string, value []byte) error
|
2015-05-06 20:09:12 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
// DriverCallback provides a Callback interface for Drivers into LibNetwork
|
|
|
|
type DriverCallback interface {
|
2016-09-30 14:57:14 -04:00
|
|
|
// GetPluginGetter returns the pluginv2 getter.
|
2016-10-07 16:37:57 -04:00
|
|
|
GetPluginGetter() plugingetter.PluginGetter
|
2015-05-06 20:09:12 -04:00
|
|
|
// RegisterDriver provides a way for Remote drivers to dynamically register new NetworkType and associate with a driver instance
|
2015-06-12 16:51:57 -04:00
|
|
|
RegisterDriver(name string, driver Driver, capability Capability) error
|
|
|
|
}
|
|
|
|
|
|
|
|
// Capability represents the high level capabilities of the drivers which libnetwork can make use of
|
|
|
|
type Capability struct {
|
2015-10-04 23:02:02 -04:00
|
|
|
DataScope string
|
2015-05-06 20:09:12 -04:00
|
|
|
}
|
2015-10-01 23:04:31 -04:00
|
|
|
|
2015-10-04 23:02:02 -04:00
|
|
|
// IPAMData represents the per-network ip related
|
|
|
|
// operational information libnetwork will send
|
|
|
|
// to the network driver during CreateNetwork()
|
|
|
|
type IPAMData struct {
|
|
|
|
AddressSpace string
|
|
|
|
Pool *net.IPNet
|
|
|
|
Gateway *net.IPNet
|
|
|
|
AuxAddresses map[string]*net.IPNet
|
|
|
|
}
|
2016-05-08 03:32:51 -04:00
|
|
|
|
|
|
|
// EventType defines a type for the CRUD event
|
|
|
|
type EventType uint8
|
|
|
|
|
|
|
|
const (
|
|
|
|
// Create event is generated when a table entry is created,
|
|
|
|
Create EventType = 1 + iota
|
|
|
|
// Update event is generated when a table entry is updated.
|
|
|
|
Update
|
|
|
|
// Delete event is generated when a table entry is deleted.
|
|
|
|
Delete
|
|
|
|
)
|