network

Documentation

Index

• Variables
• func NewRouter(b Backend, c *cluster.Cluster) router.Router
• type Backend

Variables

var (
	// AcceptedFilters is an acceptable filters for validation
	AcceptedFilters = map[string]bool{
		"driver": true,
		"type":   true,
		"name":   true,
		"id":     true,
		"label":  true,
	}
)

Functions

func NewRouter

func NewRouter(b Backend, c *cluster.Cluster) router.Router

NewRouter initializes a new network router

Types

type Backend

type Backend interface {
	FindNetwork(idName string) (libnetwork.Network, error)
	GetNetworkByName(idName string) (libnetwork.Network, error)
	GetNetworksByID(partialID string) []libnetwork.Network
	GetNetworks() []libnetwork.Network
	CreateNetwork(nc types.NetworkCreateRequest) (*types.NetworkCreateResponse, error)
	ConnectContainerToNetwork(containerName, networkName string, endpointConfig *network.EndpointSettings) error
	DisconnectContainerFromNetwork(containerName string, networkName string, force bool) error
	DeleteNetwork(name string) error
	NetworksPrune(config *types.NetworksPruneConfig) (*types.NetworksPruneReport, error)
}

Backend is all the methods that need to be implemented to provide network specific functionality.