libnetwork

README

libnetwork - networking for containers

Libnetwork provides a native Go implementation for connecting containers

The goal of libnetwork is to deliver a robust Container Network Model that provides a consistent programming interface and the required network abstractions for applications.

Design

Please refer to the design for more information.

Using libnetwork

There are many networking solutions available to suit a broad range of use-cases. libnetwork uses a driver / plugin model to support all of these solutions while abstracting the complexity of the driver implementations by exposing a simple and consistent Network Model to users.

func main() {
	if reexec.Init() {
		return
	}

	// Select and configure the network driver
	networkType := "bridge"

	// Create a new controller instance
	driverOptions := options.Generic{}
	genericOption := make(map[string]interface{})
	genericOption[netlabel.GenericData] = driverOptions
	controller, err := libnetwork.New(config.OptionDriverConfig(networkType, genericOption))
	if err != nil {
		log.Fatalf("libnetwork.New: %s", err)
	}

	// Create a network for containers to join.
	// NewNetwork accepts Variadic optional arguments that libnetwork and Drivers can use.
	network, err := controller.NewNetwork(networkType, "network1")
	if err != nil {
		log.Fatalf("controller.NewNetwork: %s", err)
	}

	// For each new container: allocate IP and interfaces. The returned network
	// settings will be used for container infos (inspect and such), as well as
	// iptables rules for port publishing. This info is contained or accessible
	// from the returned endpoint.
	ep, err := network.CreateEndpoint("Endpoint1")
	if err != nil {
		log.Fatalf("network.CreateEndpoint: %s", err)
	}

	// Create the sandbox for the container.
	// NewSandbox accepts Variadic optional arguments which libnetwork can use.
	sbx, err := controller.NewSandbox("container1",
		libnetwork.OptionHostname("test"),
		libnetwork.OptionDomainname("docker.io"))
	if err != nil {
		log.Fatalf("controller.NewSandbox: %s", err)
	}

	// A sandbox can join the endpoint via the join api.
	err = ep.Join(sbx)
	if err != nil {
		log.Fatalf("ep.Join: %s", err)
	}

	// libnetwork client can check the endpoint's operational data via the Info() API
	epInfo, err := ep.DriverInfo()
	if err != nil {
		log.Fatalf("ep.DriverInfo: %s", err)
	}

	macAddress, ok := epInfo[netlabel.MacAddress]
	if !ok {
		log.Fatalf("failed to get mac address from endpoint info")
	}

	fmt.Printf("Joined endpoint %s (%s) to sandbox %s (%s)\n", ep.Name(), macAddress, sbx.ContainerID(), sbx.Key())
}

Future

Please refer to roadmap for more information.

Contributing

Want to hack on libnetwork? Docker's contributions guidelines apply.

Copyright and license

Code and documentation copyright 2015 Docker, inc. Code released under the Apache 2.0 license. Docs released under Creative commons.

Documentation

Overview

Package libnetwork provides the basic functionality and extension points to create network namespaces and allocate interfaces for containers to use.

networkType := "bridge"

// Create a new controller instance
driverOptions := options.Generic{}
genericOption := make(map[string]interface{})
genericOption[netlabel.GenericData] = driverOptions
controller, err := libnetwork.New(config.OptionDriverConfig(networkType, genericOption))
if err != nil {
	return
}

// Create a network for containers to join.
// NewNetwork accepts Variadic optional arguments that libnetwork and Drivers can make use of
network, err := controller.NewNetwork(networkType, "network1")
if err != nil {
	return
}

// For each new container: allocate IP and interfaces. The returned network
// settings will be used for container infos (inspect and such), as well as
// iptables rules for port publishing. This info is contained or accessible
// from the returned endpoint.
ep, err := network.CreateEndpoint("Endpoint1")
if err != nil {
	return
}

// Create the sandbox for the container.
// NewSandbox accepts Variadic optional arguments which libnetwork can use.
sbx, err := controller.NewSandbox("container1",
	libnetwork.OptionHostname("test"),
	libnetwork.OptionDomainname("docker.io"))

// A sandbox can join the endpoint via the join api.
err = ep.Join(sbx)
if err != nil {
	return
}

Index

• func SetExternalKey(controllerID string, containerID string, key string) error
• type ActiveContainerError
  • func (ace *ActiveContainerError) Error() string
  • func (ace *ActiveContainerError) Forbidden()
• type ActiveEndpointsError
  • func (aee *ActiveEndpointsError) Error() string
  • func (aee *ActiveEndpointsError) Forbidden()
• type Endpoint
• type EndpointInfo
• type EndpointOption
  • func CreateOptionAlias(name string, alias string) EndpointOption
  • func CreateOptionAnonymous() EndpointOption
  • func CreateOptionDisableResolution() EndpointOption
  • func CreateOptionExposedPorts(exposedPorts []types.TransportPort) EndpointOption
  • func CreateOptionIpam(ipV4, ipV6 net.IP, ipamOptions map[string]string) EndpointOption
  • func CreateOptionMyAlias(alias string) EndpointOption
  • func CreateOptionPortMapping(portBindings []types.PortBinding) EndpointOption
  • func EndpointOptionGeneric(generic map[string]interface{}) EndpointOption
  • func JoinOptionPriority(ep Endpoint, prio int) EndpointOption
• type EndpointWalker
• type ErrInvalidConfigFile
  • func (cf ErrInvalidConfigFile) Error() string
• type ErrInvalidID
  • func (ii ErrInvalidID) BadRequest()
  • func (ii ErrInvalidID) Error() string
• type ErrInvalidJoin
  • func (ij ErrInvalidJoin) BadRequest()
  • func (ij ErrInvalidJoin) Error() string
• type ErrInvalidName
  • func (in ErrInvalidName) BadRequest()
  • func (in ErrInvalidName) Error() string
• type ErrInvalidNetworkDriver
  • func (ind ErrInvalidNetworkDriver) BadRequest()
  • func (ind ErrInvalidNetworkDriver) Error() string
• type ErrNoContainer
  • func (nc ErrNoContainer) Error() string
  • func (nc ErrNoContainer) Maskable()
• type ErrNoSuchEndpoint
  • func (nse ErrNoSuchEndpoint) Error() string
  • func (nse ErrNoSuchEndpoint) NotFound()
• type ErrNoSuchNetwork
  • func (nsn ErrNoSuchNetwork) Error() string
  • func (nsn ErrNoSuchNetwork) NotFound()
• type InterfaceInfo
• type InvalidContainerIDError
  • func (id InvalidContainerIDError) BadRequest()
  • func (id InvalidContainerIDError) Error() string
• type IpamConf
  • func (c *IpamConf) CopyTo(dstC *IpamConf) error
  • func (c *IpamConf) Validate() error
• type IpamInfo
  • func (i *IpamInfo) CopyTo(dstI *IpamInfo) error
  • func (i *IpamInfo) MarshalJSON() ([]byte, error)
  • func (i *IpamInfo) UnmarshalJSON(data []byte) error
• type Network
• type NetworkController
  • func New(cfgOptions ...config.Option) (NetworkController, error)
• type NetworkInfo
• type NetworkNameError
  • func (nnr NetworkNameError) Error() string
  • func (nnr NetworkNameError) Forbidden()
• type NetworkOption
  • func NetworkOptionDeferIPv6Alloc(enable bool) NetworkOption
  • func NetworkOptionDriverOpts(opts map[string]string) NetworkOption
  • func NetworkOptionEnableIPv6(enableIPv6 bool) NetworkOption
  • func NetworkOptionGeneric(generic map[string]interface{}) NetworkOption
  • func NetworkOptionInternalNetwork() NetworkOption
  • func NetworkOptionIpam(ipamDriver string, addrSpace string, ipV4 []*IpamConf, ipV6 []*IpamConf, ...) NetworkOption
  • func NetworkOptionPersist(persist bool) NetworkOption
• type NetworkTypeError
  • func (nt NetworkTypeError) Error() string
  • func (nt NetworkTypeError) NotFound()
• type NetworkWalker
• type Resolver
  • func NewResolver(sb *sandbox) Resolver
• type Sandbox
• type SandboxOption
  • func OptionDNS(dns string) SandboxOption
  • func OptionDNSOptions(options string) SandboxOption
  • func OptionDNSSearch(search string) SandboxOption
  • func OptionDomainname(name string) SandboxOption
  • func OptionExposedPorts(exposedPorts []types.TransportPort) SandboxOption
  • func OptionExtraHost(name string, IP string) SandboxOption
  • func OptionGeneric(generic map[string]interface{}) SandboxOption
  • func OptionHostname(name string) SandboxOption
  • func OptionHostsPath(path string) SandboxOption
  • func OptionOriginHostsPath(path string) SandboxOption
  • func OptionOriginResolvConfPath(path string) SandboxOption
  • func OptionParentUpdate(cid string, name, ip string) SandboxOption
  • func OptionPortMapping(portBindings []types.PortBinding) SandboxOption
  • func OptionResolvConfPath(path string) SandboxOption
  • func OptionUseDefaultSandbox() SandboxOption
  • func OptionUseExternalKey() SandboxOption
• type SandboxWalker
  • func SandboxContainerWalker(out *Sandbox, containerID string) SandboxWalker
  • func SandboxKeyWalker(out *Sandbox, key string) SandboxWalker
• type UnknownEndpointError
  • func (uee *UnknownEndpointError) Error() string
  • func (uee *UnknownEndpointError) NotFound()
• type UnknownNetworkError
  • func (une *UnknownNetworkError) Error() string
  • func (une *UnknownNetworkError) NotFound()

Functions

func SetExternalKey

func SetExternalKey(controllerID string, containerID string, key string) error

SetExternalKey provides a convenient way to set an External key to a sandbox

Types

type ActiveContainerError

type ActiveContainerError struct {
	// contains filtered or unexported fields
}

ActiveContainerError is returned when an endpoint is deleted which has active containers attached to it.

func (*ActiveContainerError) Error

func (ace *ActiveContainerError) Error() string

func (*ActiveContainerError) Forbidden

func (ace *ActiveContainerError) Forbidden()

Forbidden denotes the type of this error

type ActiveEndpointsError

type ActiveEndpointsError struct {
	// contains filtered or unexported fields
}

ActiveEndpointsError is returned when a network is deleted which has active endpoints in it.

func (*ActiveEndpointsError) Error

func (aee *ActiveEndpointsError) Error() string

func (*ActiveEndpointsError) Forbidden

func (aee *ActiveEndpointsError) Forbidden()

Forbidden denotes the type of this error

type Endpoint

type Endpoint interface {
	// A system generated id for this endpoint.
	ID() string

	// Name returns the name of this endpoint.
	Name() string

	// Network returns the name of the network to which this endpoint is attached.
	Network() string

	// Join joins the sandbox to the endpoint and populates into the sandbox
	// the network resources allocated for the endpoint.
	Join(sandbox Sandbox, options ...EndpointOption) error

	// Leave detaches the network resources populated in the sandbox.
	Leave(sandbox Sandbox, options ...EndpointOption) error

	// Return certain operational data belonging to this endpoint
	Info() EndpointInfo

	// DriverInfo returns a collection of driver operational data related to this endpoint retrieved from the driver
	DriverInfo() (map[string]interface{}, error)

	// Delete and detaches this endpoint from the network.
	Delete(force bool) error
}

Endpoint represents a logical connection between a network and a sandbox.

type EndpointInfo

type EndpointInfo interface {
	// Iface returns InterfaceInfo, go interface that can be used
	// to get more information on the interface which was assigned to
	// the endpoint by the driver. This can be used after the
	// endpoint has been created.
	Iface() InterfaceInfo

	// Gateway returns the IPv4 gateway assigned by the driver.
	// This will only return a valid value if a container has joined the endpoint.
	Gateway() net.IP

	// GatewayIPv6 returns the IPv6 gateway assigned by the driver.
	// This will only return a valid value if a container has joined the endpoint.
	GatewayIPv6() net.IP

	// StaticRoutes returns the list of static routes configured by the network
	// driver when the container joins a network
	StaticRoutes() []*types.StaticRoute

	// Sandbox returns the attached sandbox if there, nil otherwise.
	Sandbox() Sandbox
}

EndpointInfo provides an interface to retrieve network resources bound to the endpoint.

type EndpointOption

type EndpointOption func(ep *endpoint)

EndpointOption is an option setter function type used to pass various options to Network and Endpoint interfaces methods. The various setter functions of type EndpointOption are provided by libnetwork, they look like <Create|Join|Leave>Option[...](...)

func CreateOptionAlias

func CreateOptionAlias(name string, alias string) EndpointOption

CreateOptionAlias function returns an option setter for setting endpoint alias

func CreateOptionAnonymous

func CreateOptionAnonymous() EndpointOption

CreateOptionAnonymous function returns an option setter for setting this endpoint as anonymous

func CreateOptionDisableResolution

func CreateOptionDisableResolution() EndpointOption

CreateOptionDisableResolution function returns an option setter to indicate this endpoint doesn't want embedded DNS server functionality

func CreateOptionExposedPorts

func CreateOptionExposedPorts(exposedPorts []types.TransportPort) EndpointOption

CreateOptionExposedPorts function returns an option setter for the container exposed ports option to be passed to network.CreateEndpoint() method.

func CreateOptionIpam

func CreateOptionIpam(ipV4, ipV6 net.IP, ipamOptions map[string]string) EndpointOption

CreateOptionIpam function returns an option setter for the ipam configuration for this endpoint

func CreateOptionMyAlias

func CreateOptionMyAlias(alias string) EndpointOption

CreateOptionMyAlias function returns an option setter for setting endpoint's self alias

func CreateOptionPortMapping

func CreateOptionPortMapping(portBindings []types.PortBinding) EndpointOption

CreateOptionPortMapping function returns an option setter for the mapping ports option to be passed to network.CreateEndpoint() method.

func EndpointOptionGeneric

func EndpointOptionGeneric(generic map[string]interface{}) EndpointOption

EndpointOptionGeneric function returns an option setter for a Generic option defined in a Dictionary of Key-Value pair

func JoinOptionPriority

func JoinOptionPriority(ep Endpoint, prio int) EndpointOption

JoinOptionPriority function returns an option setter for priority option to be passed to the endpoint.Join() method.

type EndpointWalker

type EndpointWalker func(ep Endpoint) bool

EndpointWalker is a client provided function which will be used to walk the Endpoints. When the function returns true, the walk will stop.

type ErrInvalidConfigFile

type ErrInvalidConfigFile string

ErrInvalidConfigFile type is returned when an invalid LibNetwork config file is detected

func (ErrInvalidConfigFile) Error

func (cf ErrInvalidConfigFile) Error() string

type ErrInvalidID

type ErrInvalidID string

ErrInvalidID is returned when a query-by-id method is being invoked with an empty id parameter

func (ErrInvalidID) BadRequest

func (ii ErrInvalidID) BadRequest()

BadRequest denotes the type of this error

func (ErrInvalidID) Error

func (ii ErrInvalidID) Error() string

type ErrInvalidJoin

type ErrInvalidJoin struct{}

ErrInvalidJoin is returned if a join is attempted on an endpoint which already has a container joined.

func (ErrInvalidJoin) BadRequest

func (ij ErrInvalidJoin) BadRequest()

BadRequest denotes the type of this error

func (ErrInvalidJoin) Error

func (ij ErrInvalidJoin) Error() string

type ErrInvalidName

type ErrInvalidName string

ErrInvalidName is returned when a query-by-name or resource create method is invoked with an empty name parameter

func (ErrInvalidName) BadRequest

func (in ErrInvalidName) BadRequest()

BadRequest denotes the type of this error

func (ErrInvalidName) Error

func (in ErrInvalidName) Error() string

type ErrInvalidNetworkDriver

type ErrInvalidNetworkDriver string

ErrInvalidNetworkDriver is returned if an invalid driver name is passed.

func (ErrInvalidNetworkDriver) BadRequest

func (ind ErrInvalidNetworkDriver) BadRequest()

BadRequest denotes the type of this error

func (ErrInvalidNetworkDriver) Error

func (ind ErrInvalidNetworkDriver) Error() string

type ErrNoContainer

type ErrNoContainer struct{}

ErrNoContainer is returned when the endpoint has no container attached to it.

func (ErrNoContainer) Error

func (nc ErrNoContainer) Error() string

func (ErrNoContainer) Maskable

func (nc ErrNoContainer) Maskable()

Maskable denotes the type of this error

type ErrNoSuchEndpoint

type ErrNoSuchEndpoint string

ErrNoSuchEndpoint is returned when a endpoint query finds no result

func (ErrNoSuchEndpoint) Error

func (nse ErrNoSuchEndpoint) Error() string

func (ErrNoSuchEndpoint) NotFound

func (nse ErrNoSuchEndpoint) NotFound()

NotFound denotes the type of this error

type ErrNoSuchNetwork

type ErrNoSuchNetwork string

ErrNoSuchNetwork is returned when a network query finds no result

func (ErrNoSuchNetwork) Error

func (nsn ErrNoSuchNetwork) Error() string

func (ErrNoSuchNetwork) NotFound

func (nsn ErrNoSuchNetwork) NotFound()

NotFound denotes the type of this error

type InterfaceInfo

type InterfaceInfo interface {
	// MacAddress returns the MAC address assigned to the endpoint.
	MacAddress() net.HardwareAddr

	// Address returns the IPv4 address assigned to the endpoint.
	Address() *net.IPNet

	// AddressIPv6 returns the IPv6 address assigned to the endpoint.
	AddressIPv6() *net.IPNet
}

InterfaceInfo provides an interface to retrieve interface addresses bound to the endpoint.

type InvalidContainerIDError

type InvalidContainerIDError string

InvalidContainerIDError is returned when an invalid container id is passed in Join/Leave

func (InvalidContainerIDError) BadRequest

func (id InvalidContainerIDError) BadRequest()

BadRequest denotes the type of this error

func (InvalidContainerIDError) Error

func (id InvalidContainerIDError) Error() string

type IpamConf

type IpamConf struct {
	// The master address pool for containers and network interfaces
	PreferredPool string
	// A subset of the master pool. If specified,
	// this becomes the container pool
	SubPool string
	// Preferred Network Gateway address (optional)
	Gateway string
	// Auxiliary addresses for network driver. Must be within the master pool.
	// libnetwork will reserve them if they fall into the container pool
	AuxAddresses map[string]string
}

IpamConf contains all the ipam related configurations for a network

func (*IpamConf) CopyTo

func (c *IpamConf) CopyTo(dstC *IpamConf) error

CopyTo deep copies to the destination IpamConfig

func (*IpamConf) Validate

func (c *IpamConf) Validate() error

Validate checks whether the configuration is valid

type IpamInfo

type IpamInfo struct {
	PoolID string
	Meta   map[string]string
	driverapi.IPAMData
}

IpamInfo contains all the ipam related operational info for a network

func (*IpamInfo) CopyTo

func (i *IpamInfo) CopyTo(dstI *IpamInfo) error

CopyTo deep copies to the destination IpamInfo

func (*IpamInfo) MarshalJSON

func (i *IpamInfo) MarshalJSON() ([]byte, error)

MarshalJSON encodes IpamInfo into json message

func (*IpamInfo) UnmarshalJSON

func (i *IpamInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes json message into PoolData

type Network

type Network interface {
	// A user chosen name for this network.
	Name() string

	// A system generated id for this network.
	ID() string

	// The type of network, which corresponds to its managing driver.
	Type() string

	// Create a new endpoint to this network symbolically identified by the
	// specified unique name. The options parameter carry driver specific options.
	CreateEndpoint(name string, options ...EndpointOption) (Endpoint, error)

	// Delete the network.
	Delete() error

	// Endpoints returns the list of Endpoint(s) in this network.
	Endpoints() []Endpoint

	// WalkEndpoints uses the provided function to walk the Endpoints
	WalkEndpoints(walker EndpointWalker)

	// EndpointByName returns the Endpoint which has the passed name. If not found, the error ErrNoSuchEndpoint is returned.
	EndpointByName(name string) (Endpoint, error)

	// EndpointByID returns the Endpoint which has the passed id. If not found, the error ErrNoSuchEndpoint is returned.
	EndpointByID(id string) (Endpoint, error)

	// Return certain operational data belonging to this network
	Info() NetworkInfo
}

A Network represents a logical connectivity zone that containers may join using the Link method. A Network is managed by a specific driver.

type NetworkController

type NetworkController interface {
	// ID provides an unique identity for the controller
	ID() string

	// Config method returns the bootup configuration for the controller
	Config() config.Config

	// Create a new network. The options parameter carries network specific options.
	NewNetwork(networkType, name string, options ...NetworkOption) (Network, error)

	// Networks returns the list of Network(s) managed by this controller.
	Networks() []Network

	// WalkNetworks uses the provided function to walk the Network(s) managed by this controller.
	WalkNetworks(walker NetworkWalker)

	// NetworkByName returns the Network which has the passed name. If not found, the error ErrNoSuchNetwork is returned.
	NetworkByName(name string) (Network, error)

	// NetworkByID returns the Network which has the passed id. If not found, the error ErrNoSuchNetwork is returned.
	NetworkByID(id string) (Network, error)

	// NewSandbox cretes a new network sandbox for the passed container id
	NewSandbox(containerID string, options ...SandboxOption) (Sandbox, error)

	// Sandboxes returns the list of Sandbox(s) managed by this controller.
	Sandboxes() []Sandbox

	// WlakSandboxes uses the provided function to walk the Sandbox(s) managed by this controller.
	WalkSandboxes(walker SandboxWalker)

	// SandboxByID returns the Sandbox which has the passed id. If not found, a types.NotFoundError is returned.
	SandboxByID(id string) (Sandbox, error)

	// SandboxDestroy destroys a sandbox given a container ID
	SandboxDestroy(id string) error

	// Stop network controller
	Stop()

	// ReloadCondfiguration updates the controller configuration
	ReloadConfiguration(cfgOptions ...config.Option) error
}

NetworkController provides the interface for controller instance which manages networks.

func New

func New(cfgOptions ...config.Option) (NetworkController, error)

New creates a new instance of network controller.

type NetworkInfo

type NetworkInfo interface {
	IpamConfig() (string, map[string]string, []*IpamConf, []*IpamConf)
	IpamInfo() ([]*IpamInfo, []*IpamInfo)
	DriverOptions() map[string]string
	Scope() string
	IPv6Enabled() bool
	Internal() bool
}

NetworkInfo returns some configuration and operational information about the network

type NetworkNameError

type NetworkNameError string

NetworkNameError is returned when a network with the same name already exists.

func (NetworkNameError) Error

func (nnr NetworkNameError) Error() string

func (NetworkNameError) Forbidden

func (nnr NetworkNameError) Forbidden()

Forbidden denotes the type of this error

type NetworkOption

type NetworkOption func(n *network)

NetworkOption is an option setter function type used to pass various options to NewNetwork method. The various setter functions of type NetworkOption are provided by libnetwork, they look like NetworkOptionXXXX(...)

func NetworkOptionDeferIPv6Alloc

func NetworkOptionDeferIPv6Alloc(enable bool) NetworkOption

NetworkOptionDeferIPv6Alloc instructs the network to defer the IPV6 address allocation until after the endpoint has been created It is being provided to support the specific docker daemon flags where user can deterministically assign an IPv6 address to a container as combination of fixed-cidr-v6 + mac-address TODO: Remove this option setter once we support endpoint ipam options

func NetworkOptionDriverOpts

func NetworkOptionDriverOpts(opts map[string]string) NetworkOption

NetworkOptionDriverOpts function returns an option setter for any parameter described by a map

func NetworkOptionEnableIPv6

func NetworkOptionEnableIPv6(enableIPv6 bool) NetworkOption

NetworkOptionEnableIPv6 returns an option setter to explicitly configure IPv6

func NetworkOptionGeneric

func NetworkOptionGeneric(generic map[string]interface{}) NetworkOption

NetworkOptionGeneric function returns an option setter for a Generic option defined in a Dictionary of Key-Value pair

func NetworkOptionInternalNetwork

func NetworkOptionInternalNetwork() NetworkOption

NetworkOptionInternalNetwork returns an option setter to config the network to be internal which disables default gateway service

func NetworkOptionIpam

func NetworkOptionIpam(ipamDriver string, addrSpace string, ipV4 []*IpamConf, ipV6 []*IpamConf, opts map[string]string) NetworkOption

NetworkOptionIpam function returns an option setter for the ipam configuration for this network

func NetworkOptionPersist

func NetworkOptionPersist(persist bool) NetworkOption

NetworkOptionPersist returns an option setter to set persistence policy for a network

type NetworkTypeError

type NetworkTypeError string

NetworkTypeError type is returned when the network type string is not known to libnetwork.

func (NetworkTypeError) Error

func (nt NetworkTypeError) Error() string

func (NetworkTypeError) NotFound

func (nt NetworkTypeError) NotFound()

NotFound denotes the type of this error

type NetworkWalker

type NetworkWalker func(nw Network) bool

NetworkWalker is a client provided function which will be used to walk the Networks. When the function returns true, the walk will stop.

type Resolver

type Resolver interface {
	// Start starts the name server for the container
	Start() error
	// Stop stops the name server for the container. Stopped resolver
	// can be reused after running the SetupFunc again.
	Stop()
	// SetupFunc() provides the setup function that should be run
	// in the container's network namespace.
	SetupFunc() func()
	// NameServer() returns the IP of the DNS resolver for the
	// containers.
	NameServer() string
	// To configure external name servers the resolver should use
	SetExtServers([]string)
	// ResolverOptions returns resolv.conf options that should be set
	ResolverOptions() []string
}

Resolver represents the embedded DNS server in Docker. It operates by listening on container's loopback interface for DNS queries.

func NewResolver

func NewResolver(sb *sandbox) Resolver

NewResolver creates a new instance of the Resolver

type Sandbox

type Sandbox interface {
	// ID returns the ID of the sandbox
	ID() string
	// Key returns the sandbox's key
	Key() string
	// ContainerID returns the container id associated to this sandbox
	ContainerID() string
	// Labels returns the sandbox's labels
	Labels() map[string]interface{}
	// Statistics retrieves the interfaces' statistics for the sandbox
	Statistics() (map[string]*types.InterfaceStatistics, error)
	// Refresh leaves all the endpoints, resets and re-apply the options,
	// re-joins all the endpoints without destroying the osl sandbox
	Refresh(options ...SandboxOption) error
	// SetKey updates the Sandbox Key
	SetKey(key string) error
	// Rename changes the name of all attached Endpoints
	Rename(name string) error
	// Delete destroys this container after detaching it from all connected endpoints.
	Delete() error
	// ResolveName searches for the service name in the networks to which the sandbox
	// is connected to.
	ResolveName(name string) []net.IP
	// ResolveIP returns the service name for the passed in IP. IP is in reverse dotted
	// notation; the format used for DNS PTR records
	ResolveIP(name string) string
	// Endpoints returns all the endpoints connected to the sandbox
	Endpoints() []Endpoint
}

Sandbox provides the control over the network container entity. It is a one to one mapping with the container.

type SandboxOption

type SandboxOption func(sb *sandbox)

SandboxOption is an option setter function type used to pass various options to NewNetContainer method. The various setter functions of type SandboxOption are provided by libnetwork, they look like ContainerOptionXXXX(...)

func OptionDNS

func OptionDNS(dns string) SandboxOption

OptionDNS function returns an option setter for dns entry option to be passed to container Create method.

func OptionDNSOptions

func OptionDNSOptions(options string) SandboxOption

OptionDNSOptions function returns an option setter for dns options entry option to be passed to container Create method.

func OptionDNSSearch

func OptionDNSSearch(search string) SandboxOption

OptionDNSSearch function returns an option setter for dns search entry option to be passed to container Create method.

func OptionDomainname

func OptionDomainname(name string) SandboxOption

OptionDomainname function returns an option setter for domainname option to be passed to NewSandbox method.

func OptionExposedPorts

func OptionExposedPorts(exposedPorts []types.TransportPort) SandboxOption

OptionExposedPorts function returns an option setter for the container exposed ports option to be passed to container Create method.

func OptionExtraHost

func OptionExtraHost(name string, IP string) SandboxOption

OptionExtraHost function returns an option setter for extra /etc/hosts options which is a name and IP as strings.

func OptionGeneric

func OptionGeneric(generic map[string]interface{}) SandboxOption

OptionGeneric function returns an option setter for Generic configuration that is not managed by libNetwork but can be used by the Drivers during the call to net container creation method. Container Labels are a good example.

func OptionHostname

func OptionHostname(name string) SandboxOption

OptionHostname function returns an option setter for hostname option to be passed to NewSandbox method.

func OptionHostsPath

func OptionHostsPath(path string) SandboxOption

OptionHostsPath function returns an option setter for hostspath option to be passed to NewSandbox method.

func OptionOriginHostsPath

func OptionOriginHostsPath(path string) SandboxOption

OptionOriginHostsPath function returns an option setter for origin hosts file path tbeo passed to NewSandbox method.

func OptionOriginResolvConfPath

func OptionOriginResolvConfPath(path string) SandboxOption

OptionOriginResolvConfPath function returns an option setter to set the path to the origin resolv.conf file to be passed to net container methods.

func OptionParentUpdate

func OptionParentUpdate(cid string, name, ip string) SandboxOption

OptionParentUpdate function returns an option setter for parent container which needs to update the IP address for the linked container.

func OptionPortMapping

func OptionPortMapping(portBindings []types.PortBinding) SandboxOption

OptionPortMapping function returns an option setter for the mapping ports option to be passed to container Create method.

func OptionResolvConfPath

func OptionResolvConfPath(path string) SandboxOption

OptionResolvConfPath function returns an option setter for resolvconfpath option to be passed to net container methods.

func OptionUseDefaultSandbox

func OptionUseDefaultSandbox() SandboxOption

OptionUseDefaultSandbox function returns an option setter for using default sandbox to be passed to container Create method.

func OptionUseExternalKey

func OptionUseExternalKey() SandboxOption

OptionUseExternalKey function returns an option setter for using provided namespace instead of creating one.

type SandboxWalker

type SandboxWalker func(sb Sandbox) bool

SandboxWalker is a client provided function which will be used to walk the Sandboxes. When the function returns true, the walk will stop.

func SandboxContainerWalker

func SandboxContainerWalker(out *Sandbox, containerID string) SandboxWalker

SandboxContainerWalker returns a Sandbox Walker function which looks for an existing Sandbox with the passed containerID

func SandboxKeyWalker

func SandboxKeyWalker(out *Sandbox, key string) SandboxWalker

SandboxKeyWalker returns a Sandbox Walker function which looks for an existing Sandbox with the passed key

type UnknownEndpointError

type UnknownEndpointError struct {
	// contains filtered or unexported fields
}

UnknownEndpointError is returned when libnetwork could not find in it's database an endpoint with the same name and id.

func (*UnknownEndpointError) Error

func (uee *UnknownEndpointError) Error() string

func (*UnknownEndpointError) NotFound

func (uee *UnknownEndpointError) NotFound()

NotFound denotes the type of this error

type UnknownNetworkError

type UnknownNetworkError struct {
	// contains filtered or unexported fields
}

UnknownNetworkError is returned when libnetwork could not find in it's database a network with the same name and id.

func (*UnknownNetworkError) Error

func (une *UnknownNetworkError) Error() string

func (*UnknownNetworkError) NotFound

func (une *UnknownNetworkError) NotFound()

NotFound denotes the type of this error