ipam

Documentation

Index

• Constants
• type GetCapabilitiesRequest
• type GetCapabilitiesResponse
• type GetDefaultAddressSpacesRequest
• type GetDefaultAddressSpacesResponse
• type GetPoolInfoRequest
• type GetPoolInfoResponse
• type IpamPlugin
  • func NewPlugin(config *common.PluginConfig) (IpamPlugin, error)
• type ReleaseAddressRequest
• type ReleaseAddressResponse
• type ReleasePoolRequest
• type ReleasePoolResponse
• type RequestAddressRequest
• type RequestAddressResponse
• type RequestPoolRequest
• type RequestPoolResponse

Constants

const (
	// Libnetwork IPAM plugin endpoint type
	EndpointType = "IpamDriver"

	// Libnetwork IPAM plugin remote API paths
	GetCapabilitiesPath  = "/IpamDriver.GetCapabilities"
	GetAddressSpacesPath = "/IpamDriver.GetDefaultAddressSpaces"
	RequestPoolPath      = "/IpamDriver.RequestPool"
	ReleasePoolPath      = "/IpamDriver.ReleasePool"
	GetPoolInfoPath      = "/IpamDriver.GetPoolInfo"
	RequestAddressPath   = "/IpamDriver.RequestAddress"
	ReleaseAddressPath   = "/IpamDriver.ReleaseAddress"

	// Libnetwork IPAM plugin options
	OptAddressType        = "RequestAddressType"
	OptAddressTypeGateway = "com.docker.network.gateway"
)

Types

type GetCapabilitiesRequest

type GetCapabilitiesRequest struct {
}

Request sent by libnetwork when querying plugin capabilities.

type GetCapabilitiesResponse

type GetCapabilitiesResponse struct {
	Err                   string
	RequiresMACAddress    bool
	RequiresRequestReplay bool
}

Response sent by plugin when registering its capabilities with libnetwork.

type GetDefaultAddressSpacesRequest

type GetDefaultAddressSpacesRequest struct {
}

Request sent by libnetwork when querying the default address space names.

type GetDefaultAddressSpacesResponse

type GetDefaultAddressSpacesResponse struct {
	Err                       string
	LocalDefaultAddressSpace  string
	GlobalDefaultAddressSpace string
}

Response sent by plugin when returning the default address space names.

type GetPoolInfoRequest

type GetPoolInfoRequest struct {
	PoolID string
}

Request sent when querying address pool information.

type GetPoolInfoResponse

type GetPoolInfoResponse struct {
	Err                string
	Capacity           int
	Available          int
	UnhealthyAddresses []string
}

Response sent by plugin when returning address pool information.

type IpamPlugin

type IpamPlugin interface {
	common.PluginApi
}

func NewPlugin

func NewPlugin(config *common.PluginConfig) (IpamPlugin, error)

NewPlugin creates a new IpamPlugin object.

type ReleaseAddressRequest

type ReleaseAddressRequest struct {
	PoolID  string
	Address string
	Options map[string]string
}

Request sent by libnetwork when releasing an address back to the pool.

type ReleaseAddressResponse

type ReleaseAddressResponse struct {
	Err string
}

Response sent by plugin when an address is successfully released.

type ReleasePoolRequest

type ReleasePoolRequest struct {
	PoolID string
}

Request sent by libnetwork when releasing a previously registered address pool.

type ReleasePoolResponse

type ReleasePoolResponse struct {
	Err string
}

Response sent by plugin when an address pool is successfully released.

type RequestAddressRequest

type RequestAddressRequest struct {
	PoolID  string
	Address string
	Options map[string]string
}

Request sent by libnetwork when reserving an address from a pool.

type RequestAddressResponse

type RequestAddressResponse struct {
	Err     string
	Address string
	Data    map[string]string
}

Response sent by plugin when an address is successfully reserved.

type RequestPoolRequest

type RequestPoolRequest struct {
	AddressSpace string
	Pool         string
	SubPool      string
	Options      map[string]string
	V6           bool
}

Request sent by libnetwork when acquiring a reference to an address pool.

type RequestPoolResponse

type RequestPoolResponse struct {
	Err    string
	PoolID string
	Pool   string
	Data   map[string]string
}

Response sent by plugin when an address pool is successfully referenced.