networkallocator

type Config struct {
	// DefaultAddrPool specifies default subnet pool for global scope networks
	DefaultAddrPool []string

	// SubnetSize specifies the subnet size of the networks created from
	// the default subnet pool
	SubnetSize uint32

	// VXLANUDPPort specifies the UDP port number for VXLAN traffic
	VXLANUDPPort uint32
}

type DriverValidator interface {
	ValidateNetworkDriver(*api.Driver) error
	ValidateIngressNetworkDriver(*api.Driver) error
	ValidateIPAMDriver(*api.Driver) error
}

type Inert struct{}

type InertProvider struct{}

type NetworkAllocator interface {

	// IsAllocated returns if the passed network has been allocated or not.
	IsAllocated(n *api.Network) bool

	// Allocate allocates all the necessary resources both general
	// and driver-specific which may be specified in the NetworkSpec
	Allocate(n *api.Network) error

	// Deallocate frees all the general and driver specific resources
	// which were assigned to the passed network.
	Deallocate(n *api.Network) error

	// IsServiceAllocated returns false if the passed service
	// needs to have network resources allocated/updated.
	IsServiceAllocated(s *api.Service, flags ...func(*ServiceAllocationOpts)) bool

	// AllocateService allocates all the network resources such as virtual
	// IP and ports needed by the service.
	AllocateService(s *api.Service) (err error)

	// DeallocateService de-allocates all the network resources such as
	// virtual IP and ports associated with the service.
	DeallocateService(s *api.Service) error

	// IsTaskAllocated returns if the passed task has its network
	// resources allocated or not.
	IsTaskAllocated(t *api.Task) bool

	// AllocateTask allocates all the endpoint resources for all the
	// networks that a task is attached to.
	AllocateTask(t *api.Task) error

	// DeallocateTask releases all the endpoint resources for all the
	// networks that a task is attached to.
	DeallocateTask(t *api.Task) error

	// AllocateAttachment Allocates a load balancer endpoint for the node
	AllocateAttachment(node *api.Node, networkAttachment *api.NetworkAttachment) error

	// DeallocateAttachment Deallocates a load balancer endpoint for the node
	DeallocateAttachment(node *api.Node, networkAttachment *api.NetworkAttachment) error

	// IsAttachmentAllocated If lb endpoint is allocated on the node
	IsAttachmentAllocated(node *api.Node, networkAttachment *api.NetworkAttachment) bool
}

type OnGetNetworker interface {
	// OnGetNetwork is called with a copy of the network object that will be
	// returned in a GetNetwork or ListNetworks Control API response. Any
	// modifications to the network object will be reflected in the
	// response. The modified network object will not be persisted to the
	// store. Errors returned will be bubbled up to the Control API client.
	//
	// The appdataTypeURL and appdata parameters are set to the TypeUrl and
	// value, respectively, of the appdata field in the ListNetworks or
	// GetNetwork Control API request.
	//
	// The network may not have been allocated at the time of the call.
	// Calling OnGetNetwork with an unallocated network should not be an
	// error.
	//
	// This method may be called concurrently from multiple goroutines.
	OnGetNetwork(ctx context.Context, network *api.Network, appdataTypeURL string, appdata []byte) error
}

type PredefinedNetworkData struct {
	Name   string
	Driver string
}

type Provider interface {
	DriverValidator
	PredefinedNetworks() []PredefinedNetworkData
	SetDefaultVXLANUDPPort(uint32) error
	NewAllocator(*Config) (NetworkAllocator, error)
}

type ServiceAllocationOpts struct {
	OnInit bool
}