aws

Documentation

Index

• func HasBugBrokenVPCCidrs(meta MetadataClient) bool
• func Jitter(d time.Duration, pct float64) time.Duration
• type AllocateClient
• type AllocationResult
  • func FindFreeIPsAtIndex(index int, updateRegistry bool) ([]*AllocationResult, error)
• type Bug
  • func ListBugs(meta MetadataClient) []Bug
• type Client
• type ENILimit
  • func ENILimitsForInstanceType(itype string) (limit ENILimit)
• type Interface
  • func (i Interface) LocalName() string
• type InterfaceClient
• type Interfaces
  • func (a Interfaces) Len() int
  • func (a Interfaces) Less(i, j int) bool
  • func (a Interfaces) Swap(i, j int)
• type LimitsClient
• type MetadataClient
• type Registry
  • func (r *Registry) Clear() error
  • func (r *Registry) ForgetIP(ip net.IP) error
  • func (r *Registry) HasIP(ip net.IP) (bool, error)
  • func (r *Registry) List() (ret []net.IP, err error)
  • func (r *Registry) TrackIP(ip net.IP) error
  • func (r *Registry) TrackedBefore(t time.Time) ([]net.IP, error)
• type Subnet
• type SubnetsByAvailableAddressCount
  • func (a SubnetsByAvailableAddressCount) Len() int
  • func (a SubnetsByAvailableAddressCount) Less(i, j int) bool
  • func (a SubnetsByAvailableAddressCount) Swap(i, j int)
• type SubnetsClient
• type VPCClient

Functions

func HasBugBrokenVPCCidrs

func HasBugBrokenVPCCidrs(meta MetadataClient) bool

HasBugBrokenVPCCidrs returns true if this instance has a known defective meta-data service which will not return secondary VPC CIDRs. As of January 2018, this covers c5 and m5 class hardware.

func Jitter

func Jitter(d time.Duration, pct float64) time.Duration

Jitter takes a duration and adjusts it forward by a up to `pct` percent uniformly.

Types

type AllocateClient

type AllocateClient interface {
	AllocateIPOn(intf Interface) (*AllocationResult, error)
	AllocateIPFirstAvailableAtIndex(index int) (*AllocationResult, error)
	AllocateIPFirstAvailable() (*AllocationResult, error)
	DeallocateIP(ipToRelease *net.IP) error
}

AllocateClient offers IP allocation on interfaces

type AllocationResult

type AllocationResult struct {
	*net.IP
	Interface Interface
}

AllocationResult contains a net.IP / Interface pair

func FindFreeIPsAtIndex

func FindFreeIPsAtIndex(index int, updateRegistry bool) ([]*AllocationResult, error)

FindFreeIPsAtIndex locates free IP addresses by comparing the assigned list from the EC2 metadata service and the currently used addresses within netlink. This is inherently somewhat racey - for example newly provisioned addresses may not show up immediately in metadata and are subject to a few seconds of delay.

type Bug

type Bug struct {
	Name   string
	HasBug func() bool
}

Bug defines a bug name and a function to check if the system is affected

func ListBugs

func ListBugs(meta MetadataClient) []Bug

ListBugs returns an enumerated set of all known bugs in AWS or instances that this instance is afflicted by

type Client

type Client interface {
	InterfaceClient
	LimitsClient
	MetadataClient
	SubnetsClient
	AllocateClient
	VPCClient
}

Client offers all of the supporting AWS services

var DefaultClient Client

DefaultClient that is setup with known defaults

type ENILimit

type ENILimit struct {
	Adapters int
	IPv4     int
	IPv6     int
}

ENILimit contains limits for adapter count and addresses

func ENILimitsForInstanceType

func ENILimitsForInstanceType(itype string) (limit ENILimit)

ENILimitsForInstanceType returns the limits for ENI for an instance type Returns a zero-limit for unknown instance types

type Interface

type Interface struct {
	ID     string
	Mac    string
	IfName string
	Number int
	IPv4s  []net.IP

	SubnetID   string
	SubnetCidr *net.IPNet

	VpcID            string
	VpcPrimaryCidr   *net.IPNet
	VpcCidrs         []*net.IPNet
	SecurityGroupIds []string
}

Interface describes an interface from the metadata service

func (Interface) LocalName

func (i Interface) LocalName() string

LocalName returns the instance name in string form

type InterfaceClient

type InterfaceClient interface {
	NewInterfaceOnSubnetAtIndex(index int, secGrps []string, subnet Subnet) (*Interface, error)
	NewInterface(secGrps []string, requiredTags map[string]string) (*Interface, error)
	RemoveInterface(interfaceIDs []string) error
}

InterfaceClient provides methods for allocating and deallocating interfaces

type Interfaces

type Interfaces []Interface

Interfaces contains a slice of Interface

func (Interfaces) Len

func (a Interfaces) Len() int

func (Interfaces) Less

func (a Interfaces) Less(i, j int) bool

func (Interfaces) Swap

func (a Interfaces) Swap(i, j int)

type LimitsClient

type LimitsClient interface {
	ENILimits() ENILimit
}

LimitsClient provides methods for locating limits in AWS

type MetadataClient

type MetadataClient interface {
	Available() bool
	GetInterfaces() ([]Interface, error)
	InstanceType() string
}

MetadataClient provides methods to query the metadata service

type Registry

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

Registry defines a re-usable IP registry which tracks IPs that are free in the system and when they were last released back to the pool.

func (*Registry) Clear

func (r *Registry) Clear() error

Clear clears the registry unconditionally

func (*Registry) ForgetIP

func (r *Registry) ForgetIP(ip net.IP) error

ForgetIP removes an IP from the registry

func (*Registry) HasIP

func (r *Registry) HasIP(ip net.IP) (bool, error)

HasIP checks if an IP is in an registry

func (*Registry) List

func (r *Registry) List() (ret []net.IP, err error)

List returns a list of all tracked IPs

func (*Registry) TrackIP

func (r *Registry) TrackIP(ip net.IP) error

TrackIP records an IP in the free registry with the current system time as the current freed-time. If an IP is freed again, the time will be updated to the new current time.

func (*Registry) TrackedBefore

func (r *Registry) TrackedBefore(t time.Time) ([]net.IP, error)

TrackedBefore returns a list of all IPs last recorded time _before_ the time passed to this function. You probably want to call this with time.Now().Add(-duration).

type Subnet

type Subnet struct {
	ID                    string
	Cidr                  string
	IsDefault             bool
	AvailableAddressCount int
	Name                  string
	Tags                  map[string]string
}

Subnet contains attributes of a subnet

type SubnetsByAvailableAddressCount

type SubnetsByAvailableAddressCount []Subnet

SubnetsByAvailableAddressCount contains a list of subnet

func (SubnetsByAvailableAddressCount) Len

func (a SubnetsByAvailableAddressCount) Len() int

func (SubnetsByAvailableAddressCount) Less

func (a SubnetsByAvailableAddressCount) Less(i, j int) bool

func (SubnetsByAvailableAddressCount) Swap

func (a SubnetsByAvailableAddressCount) Swap(i, j int)

type SubnetsClient

type SubnetsClient interface {
	GetSubnetsForInstance() ([]Subnet, error)
}

SubnetsClient provides information about VPC subnets

type VPCClient

type VPCClient interface {
	DescribeVPCCIDRs(vpcID string) ([]*net.IPNet, error)
	DescribeVPCPeerCIDRs(vpcID string) ([]*net.IPNet, error)
}

VPCClient provides a view into a VPC