api

Documentation

Index

• Constants
• type Client
  • func NewClient(addr string, log Logger) *Client
  • func (client *Client) AllocateIP(ID string) (*net.IPNet, error)
  • func (client *Client) AllocateIPInSubnet(ID string, subnet *net.IPNet) (*net.IPNet, error)
  • func (client *Client) ClaimIP(ID string, cidr *net.IPNet) error
  • func (client *Client) Connect(remote string) error
  • func (client *Client) DNSDomain() (string, error)
  • func (client *Client) DefaultSubnet() (*net.IPNet, error)
  • func (client *Client) DeregisterWithDNS(ID string, ip string) error
  • func (client *Client) LookupIP(ID string) (*net.IPNet, error)
  • func (client *Client) RegisterWithDNS(ID string, fqdn string, ip string) error
  • func (client *Client) ReleaseIPsFor(ID string) error
• type Logger

Constants

const (
	WeaveHTTPHost = "127.0.0.1"
	WeaveHTTPPort = 6784
)

const NoContainerID string = "_"

Special token used in place of a container identifier when: - the caller does not know the container ID, or - the caller is unsure whether IPAM was previously told the container ID.

While addresses are typically stored under their container IDs, when this token is used, the address will be stored under its own string, something which should be kept in mind if the entry needs to be removed at any point.

Types

type Client

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

func NewClient

func NewClient(addr string, log Logger) *Client

func (*Client) AllocateIP

func (client *Client) AllocateIP(ID string) (*net.IPNet, error)

returns an IP for the ID given, allocating a fresh one if necessary

func (*Client) AllocateIPInSubnet

func (client *Client) AllocateIPInSubnet(ID string, subnet *net.IPNet) (*net.IPNet, error)

func (*Client) ClaimIP

func (client *Client) ClaimIP(ID string, cidr *net.IPNet) error

Claim a specific IP on behalf of the ID

func (*Client) Connect

func (client *Client) Connect(remote string) error

func (*Client) DNSDomain

func (client *Client) DNSDomain() (string, error)

func (*Client) DefaultSubnet

func (client *Client) DefaultSubnet() (*net.IPNet, error)

func (*Client) DeregisterWithDNS

func (client *Client) DeregisterWithDNS(ID string, ip string) error

func (*Client) LookupIP

func (client *Client) LookupIP(ID string) (*net.IPNet, error)

returns an IP for the ID given, or nil if one has not been allocated

func (*Client) RegisterWithDNS

func (client *Client) RegisterWithDNS(ID string, fqdn string, ip string) error

func (*Client) ReleaseIPsFor

func (client *Client) ReleaseIPsFor(ID string) error

release all IPs owned by an ID

type Logger

type Logger interface {
	Infof(string, ...interface{})
	Debugf(string, ...interface{})
}