util

Documentation

Overview

Package util contains utility functions which are used in the agent implementation.

Index

• Constants
• func ConfigureLinkAddresses(idx int, ipNets []*net.IPNet) error
• func ConfigureLinkRoutes(link netlink.Link, routes []interface{}) error
• func DeleteOVSPort(brName, portName string) error
• func DialLocalSocket(address string) (net.Conn, error)
• func EnsureIPv6EnabledOnInterface(ifaceName string) error
• func ExtendCIDRWithIP(ipNet *net.IPNet, ip net.IP) (*net.IPNet, error)
• func GenerateContainerHostVethName(podName, podNamespace, containerID, containerVeth string) string
• func GenerateContainerInterfaceKey(containerID string) string
• func GenerateContainerInterfaceName(podName, podNamespace, containerID string) string
• func GenerateNodeTunnelInterfaceKey(nodeName string) string
• func GenerateNodeTunnelInterfaceName(nodeName string) string
• func GenerateOVSDatapathID(macString string) string
• func GenerateRandomMAC() net.HardwareAddr
• func GenerateUplinkInterfaceName(name string) string
• func GetAllIPNetsByName(ifaceName string) ([]*net.IPNet, error)
• func GetAllNodeAddresses(excludeDevices []string) ([]net.IP, []net.IP, error)
• func GetIPNetDeviceByCIDRs(cidrsList []string) (v4IPNet, v6IPNet *net.IPNet, link *net.Interface, err error)
• func GetIPNetDeviceByName(ifaceName string) (v4IPNet *net.IPNet, v6IPNet *net.IPNet, link *net.Interface, err error)
• func GetIPNetDeviceFromIP(localIPs *ip.DualStackIPs, ignoredInterfaces sets.Set[string]) (v4IPNet *net.IPNet, v6IPNet *net.IPNet, iface *net.Interface, err error)
• func GetIPNetsByLink(link *net.Interface) ([]*net.IPNet, error)
• func GetIPWithFamily(ips []net.IP, addrFamily uint8) (net.IP, error)
• func GetIPv4Addr(ips []net.IP) net.IP
• func GetInterfaceConfig(ifName string) (*net.Interface, []*net.IPNet, []interface{}, error)
• func GetNSDevInterface(nsPath, dev string) (*net.Interface, error)
• func GetNSPath(netnsName string) (string, error)
• func GetNSPeerDevBridge(nsPath, dev string) (*net.Interface, string, error)
• func HostInterfaceExists(ifName string) bool
• func ListenLocalSocket(address string) (net.Listener, error)
• func NewIPNet(ip net.IP) *net.IPNet
• func PortToUint16(port int) uint16
• func RemoveLinkIPs(link netlink.Link) error
• func RemoveLinkRoutes(link netlink.Link) error
• func RenameInterface(from, to string) error
• func SetAdapterMACAddress(adapterName string, macConfig *net.HardwareAddr) error
• func SetLinkUp(name string) (net.HardwareAddr, int, error)
• type LinkNotFound

Constants

const (
	FamilyIPv4 uint8 = 4
	FamilyIPv6 uint8 = 6
)

Functions

func ConfigureLinkAddresses

func ConfigureLinkAddresses(idx int, ipNets []*net.IPNet) error

ConfigureLinkAddresses adds the provided addresses to the interface identified by index idx, if they are missing from the interface. Any other existing address already configured for the interface will be removed, unless it is a link-local address.

func ConfigureLinkRoutes

func ConfigureLinkRoutes(link netlink.Link, routes []interface{}) error

func DeleteOVSPort

func DeleteOVSPort(brName, portName string) error

DeleteOVSPort deletes specific OVS port. This function calls ovs-vsctl command to bypass OVS bridge client to work when agent exiting.

func DialLocalSocket

func DialLocalSocket(address string) (net.Conn, error)

DialLocalSocket connects to a Unix domain socket.

func EnsureIPv6EnabledOnInterface

func EnsureIPv6EnabledOnInterface(ifaceName string) error

func ExtendCIDRWithIP

func ExtendCIDRWithIP(ipNet *net.IPNet, ip net.IP) (*net.IPNet, error)

ExtendCIDRWithIP is used for extending an IPNet with an IP.

func GenerateContainerHostVethName

func GenerateContainerHostVethName(podName, podNamespace, containerID, containerVeth string) string

GenerateContainerHostVethName generates a unique interface name using the Pod's Name, container ID, and the container veth interface name. The output should be deterministic.

func GenerateContainerInterfaceKey

func GenerateContainerInterfaceKey(containerID string) string

GenerateContainerInterfaceKey generates a unique string for a Pod's interface as: container/<Container-ID>. We must use ContainerID instead of PodNamespace + PodName because there could be more than one container associated with the same Pod at some point. For example, when deleting a StatefulSet Pod with 0 second grace period, the Pod will be removed from the Kubernetes API very quickly and a new Pod will be created immediately, and kubelet may process the deletion of the previous Pod and the addition of the new Pod simultaneously.

func GenerateContainerInterfaceName

func GenerateContainerInterfaceName(podName, podNamespace, containerID string) string

GenerateContainerInterfaceName generates a unique interface name using the Pod's Namespace, name and container ID. The output should be deterministic (so that multiple calls to GenerateContainerInterfaceName with the same parameters return the same value). The output has the length of interfaceNameLength(15). The probability of collision should be neglectable.

func GenerateNodeTunnelInterfaceKey

func GenerateNodeTunnelInterfaceKey(nodeName string) string

GenerateNodeTunnelInterfaceKey generates a unique string for a Node's tunnel interface as: node/<Node-name>.

func GenerateNodeTunnelInterfaceName

func GenerateNodeTunnelInterfaceName(nodeName string) string

GenerateNodeTunnelInterfaceName generates a unique interface name for the tunnel to the Node, using the Node's name.

func GenerateOVSDatapathID

func GenerateOVSDatapathID(macString string) string

GenerateOVSDatapathID generates an OVS datapath ID string.

func GenerateRandomMAC

func GenerateRandomMAC() net.HardwareAddr

func GenerateUplinkInterfaceName

func GenerateUplinkInterfaceName(name string) string

GenerateUplinkInterfaceName generates the uplink interface name after bridged to OVS

func GetAllIPNetsByName

func GetAllIPNetsByName(ifaceName string) ([]*net.IPNet, error)

func GetAllNodeAddresses

func GetAllNodeAddresses(excludeDevices []string) ([]net.IP, []net.IP, error)

GetAllNodeAddresses gets all Node IP addresses (not including IPv6 link local address).

func GetIPNetDeviceByCIDRs

func GetIPNetDeviceByCIDRs(cidrsList []string) (v4IPNet, v6IPNet *net.IPNet, link *net.Interface, err error)

func GetIPNetDeviceByName

func GetIPNetDeviceByName(ifaceName string) (v4IPNet *net.IPNet, v6IPNet *net.IPNet, link *net.Interface, err error)

func GetIPNetDeviceFromIP

func GetIPNetDeviceFromIP(localIPs *ip.DualStackIPs, ignoredInterfaces sets.Set[string]) (v4IPNet *net.IPNet, v6IPNet *net.IPNet, iface *net.Interface, err error)

GetIPNetDeviceFromIP returns local IPs/masks and associated device from IP, and ignores the interfaces which have names in the ignoredInterfaces.

func GetIPNetsByLink

func GetIPNetsByLink(link *net.Interface) ([]*net.IPNet, error)

func GetIPWithFamily

func GetIPWithFamily(ips []net.IP, addrFamily uint8) (net.IP, error)

func GetIPv4Addr

func GetIPv4Addr(ips []net.IP) net.IP

func GetInterfaceConfig

func GetInterfaceConfig(ifName string) (*net.Interface, []*net.IPNet, []interface{}, error)

func GetNSDevInterface

func GetNSDevInterface(nsPath, dev string) (*net.Interface, error)

GetNSDevInterface returns interface of dev in namespace nsPath.

func GetNSPath

func GetNSPath(netnsName string) (string, error)

GetNSPath returns the path of the specified netns.

func GetNSPeerDevBridge

func GetNSPeerDevBridge(nsPath, dev string) (*net.Interface, string, error)

GetNSPeerDevBridge returns peer device and its attached bridge (if applicable) for device dev in network space indicated by nsPath

func HostInterfaceExists

func HostInterfaceExists(ifName string) bool

func ListenLocalSocket

func ListenLocalSocket(address string) (net.Listener, error)

ListenLocalSocket creates a listener on a Unix domain socket.

func NewIPNet

func NewIPNet(ip net.IP) *net.IPNet

Copied from github.com/vishvananda/netlink/netlink.go NewIPNet generates an IPNet from an ip address using a netmask of 32 or 128.

func PortToUint16

func PortToUint16(port int) uint16

func RemoveLinkIPs

func RemoveLinkIPs(link netlink.Link) error

func RemoveLinkRoutes

func RemoveLinkRoutes(link netlink.Link) error

func RenameInterface

func RenameInterface(from, to string) error

func SetAdapterMACAddress

func SetAdapterMACAddress(adapterName string, macConfig *net.HardwareAddr) error

SetAdapterMACAddress set specified MAC address on interface.

func SetLinkUp

func SetLinkUp(name string) (net.HardwareAddr, int, error)

Types

type LinkNotFound

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