util

Documentation

Overview

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

Index

• Constants
• func CallPSCommand(cmd string) (string, error)
• func ConfigureInterfaceAddress(ifaceName string, ipConfig *net.IPNet) error
• func ConfigureInterfaceAddressWithDefaultGateway(ifaceName string, ipConfig *net.IPNet, gateway string) error
• func ConfigureLinkAddresses(idx int, ipNets []*net.IPNet) error
• func CreateHNSNetwork(hnsNetName string, subnetCIDR *net.IPNet, nodeIP *net.IPNet, ...) (*hcsshim.HNSNetwork, error)
• func DeleteHNSNetwork(hnsNetName string) error
• func DialLocalSocket(address string) (net.Conn, error)
• func EnableHNSNetworkExtension(hnsNetID string, vSwitchExtension string) error
• func EnableHostInterface(ifaceName string) error
• func EnableIPForwarding(ifaceName string) error
• func GenerateContainerInterfaceKey(containerID string) string
• func GenerateContainerInterfaceName(podName, podNamespace, containerID string) string
• func GenerateNodeTunnelInterfaceKey(nodeName string) string
• func GenerateNodeTunnelInterfaceName(nodeName string) string
• func GetAdapterIPv4Addr(adapterName string) (*net.IPNet, error)
• func GetDNServersByInterfaceIndex(ifIndex int) (string, error)
• func GetDefaultGatewayByInterfaceIndex(ifIndex int) (string, error)
• func GetIPNetDeviceFromIP(localIP net.IP) (*net.IPNet, *net.Interface, error)
• func GetIPWithFamily(ips []net.IP, addrFamily uint8) (net.IP, error)
• func GetIPv4Addr(ips []net.IP) net.IP
• func GetLocalBroadcastIP(ipNet *net.IPNet) net.IP
• func GetNSPath(containerNetNS string) (string, error)
• func InvokePSCommand(cmd string) error
• func ListenLocalSocket(address string) (net.Listener, error)
• func PrepareHNSNetwork(subnetCIDR *net.IPNet, nodeIPNet *net.IPNet, uplinkAdapter *net.Interface) error
• func RemoveIPv4AddrsFromAdapter(adapterName string) error
• func RemoveInterfaceAddress(ifaceName string, ipAddr net.IP) error
• func RemoveManagementInterface(networkName string) error
• func SetAdapterDNSServers(adapterName, dnsServers string) error
• func SetAdapterMACAddress(adapterName string, macConfig *net.HardwareAddr) error
• func SetLinkUp(name string) (net.HardwareAddr, int, error)
• func WindowsHyperVInstalled() (bool, error)
• type ExtensionsPolicy
• type LinkNotFound

Constants

const (
	FamilyIPv4 uint8 = 4
	FamilyIPv6 uint8 = 6
)

const (
	ContainerVNICPrefix = "vEthernet"
	HNSNetworkType      = "Transparent"
	LocalHNSNetwork     = "antrea-hnsnetwork"
	OVSExtensionID      = "583CC151-73EC-4A6A-8B47-578297AD7623"
)

Functions

func CallPSCommand

func CallPSCommand(cmd string) (string, error)

func ConfigureInterfaceAddress

func ConfigureInterfaceAddress(ifaceName string, ipConfig *net.IPNet) error

ConfigureInterfaceAddress adds IPAddress on the specified interface.

func ConfigureInterfaceAddressWithDefaultGateway

func ConfigureInterfaceAddressWithDefaultGateway(ifaceName string, ipConfig *net.IPNet, gateway string) error

ConfigureInterfaceAddressWithDefaultGateway adds IPAddress on the specified interface and sets the default gateway for the host.

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. At the moment, this function only supports IPv4 addresses and will ignore any address in ipNets that is not IPv4.

func CreateHNSNetwork

func CreateHNSNetwork(hnsNetName string, subnetCIDR *net.IPNet, nodeIP *net.IPNet, adapter *net.Interface) (*hcsshim.HNSNetwork, error)

CreateHNSNetwork creates a new HNS Network, whose type is "Transparent". The NetworkAdapter is using the host interface which is configured with Node IP. HNS Network properties "ManagementIP" and "SourceMac" are used to record the original IP and MAC addresses on the network adapter.

func DeleteHNSNetwork

func DeleteHNSNetwork(hnsNetName string) error

func DialLocalSocket

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

DialLocalSocket connects to a Unix domain socket or a Windows named pipe. - If the specified address starts with "\\.\pipe\", connect to a Windows named pipe path. - Else connect to a Unix domain socket.

func EnableHNSNetworkExtension

func EnableHNSNetworkExtension(hnsNetID string, vSwitchExtension string) error

EnableHNSNetworkExtension enables the specified vSwitchExtension on the target HNS Network. Antrea calls this function to enable OVS Extension on the HNS Network.

func EnableHostInterface

func EnableHostInterface(ifaceName string) error

EnableHostInterface sets the specified interface status as UP.

func EnableIPForwarding

func EnableIPForwarding(ifaceName string) error

EnableIPForwarding enables the IP interface to forward packets that arrive on this interface to other interfaces.

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 containerID. 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 GetAdapterIPv4Addr

func GetAdapterIPv4Addr(adapterName string) (*net.IPNet, error)

func GetDNServersByInterfaceIndex

func GetDNServersByInterfaceIndex(ifIndex int) (string, error)

GetDNServersByInterfaceIndex returns the DNS servers configured on the specified interface.

func GetDefaultGatewayByInterfaceIndex

func GetDefaultGatewayByInterfaceIndex(ifIndex int) (string, error)

GetDefaultGatewayByInterfaceIndex returns the default gateway configured on the speicified interface.

func GetIPNetDeviceFromIP

func GetIPNetDeviceFromIP(localIP net.IP) (*net.IPNet, *net.Interface, error)

GetIPNetDeviceFromIP returns a local IP/mask and associated device from IP.

func GetIPWithFamily

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

func GetIPv4Addr

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

func GetLocalBroadcastIP

func GetLocalBroadcastIP(ipNet *net.IPNet) net.IP

GetLocalBroadcastIP returns the last IP address in a subnet. This IP is always working as the broadcast address in the subnet on Windows, and an active route entry that uses it as the destination is added by default when a new IP is configured on the interface.

func GetNSPath

func GetNSPath(containerNetNS string) (string, error)

func InvokePSCommand

func InvokePSCommand(cmd string) error

func ListenLocalSocket

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

ListenLocalSocket creates a listener on a Unix domain socket or a Windows named pipe. - If the specified address starts with "\\.\pipe\", create a listener on the a Windows named pipe path. - Else create a listener on a local Unix domain socket.

func PrepareHNSNetwork

func PrepareHNSNetwork(subnetCIDR *net.IPNet, nodeIPNet *net.IPNet, uplinkAdapter *net.Interface) error

PrepareHNSNetwork creates HNS Network for containers.

func RemoveIPv4AddrsFromAdapter

func RemoveIPv4AddrsFromAdapter(adapterName string) error

func RemoveInterfaceAddress

func RemoveInterfaceAddress(ifaceName string, ipAddr net.IP) error

RemoveInterfaceAddress removes IPAddress from the specified interface.

func RemoveManagementInterface

func RemoveManagementInterface(networkName string) error

RemoveManagementInterface removes the management interface of the HNS Network, and then the physical interface can be added to the OVS bridge. This function is called only if Hyper-V feature is installed on the host.

func SetAdapterDNSServers

func SetAdapterDNSServers(adapterName, dnsServers string) error

SetAdapterDNSServers configures DNSServers on network adapter.

func SetAdapterMACAddress

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

ConfigureMACAddress set specified MAC address on interface.

func SetLinkUp

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

func WindowsHyperVInstalled

func WindowsHyperVInstalled() (bool, error)

WindowsHyperVInstalled checks if the Hyper-V feature is enabled on the host.

Types

type ExtensionsPolicy

type ExtensionsPolicy struct {
	Extensions []vSwitchExtensionPolicy `json:"Extensions"`
}

type LinkNotFound

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