util

Documentation

Index

• Constants
• func AddressSet(isValid func(ip net.IP) bool, addrs []net.Addr) sets.Set[string]
• func AppendPortIfNeeded(addr string, port int32) string
• func BuildPortsToEndpointsMap(endpoints *v1.Endpoints) map[string][]string
• func EnsureSysctl(sysctl utilsysctl.Interface, name string, newVal int) error
• func GetClusterIPByFamily(ipFamily v1.IPFamily, service *v1.Service) string
• func GetIPFamilyFromIP(ipStr string) v1.IPFamily
• func GetLocalAddrSet() netutils.IPSet
• func GetLocalAddrs() ([]net.IP, error)
• func IPPart(s string) string
• func IsLoopBack(ip string) bool
• func IsVIPMode(ing v1.LoadBalancerIngress) bool
• func IsZeroCIDR(cidr string) bool
• func LogAndEmitIncorrectIPVersionEvent(recorder events.EventRecorder, ...)
• func MapCIDRsByIPFamily(cidrStrings []string) map[v1.IPFamily][]string
• func MapIPsByIPFamily(ipStrings []string) map[v1.IPFamily][]string
• func OtherIPFamily(ipFamily v1.IPFamily) v1.IPFamily
• func PortPart(s string) (int, error)
• func RevertPorts(...)
• func ShouldSkipService(service *v1.Service) bool
• func ShuffleStrings(s []string) []string
• type LineBuffer
  • func NewDiscardLineBuffer() LineBuffer
  • func NewLineBuffer() LineBuffer
• type NetworkInterfacer
• type NodePortAddresses
  • func NewNodePortAddresses(family v1.IPFamily, cidrStrings []string) *NodePortAddresses
  • func (npa *NodePortAddresses) ContainsIPv4Loopback() bool
  • func (npa *NodePortAddresses) GetNodeIPs(nw NetworkInterfacer) ([]net.IP, error)
  • func (npa *NodePortAddresses) MatchAll() bool
  • func (npa *NodePortAddresses) String() string
• type RealNetwork
  • func (RealNetwork) InterfaceAddrs() ([]net.Addr, error)
• type Resolver

Constants

const (
	// IPv4ZeroCIDR is the CIDR block for the whole IPv4 address space
	IPv4ZeroCIDR = "0.0.0.0/0"

	// IPv6ZeroCIDR is the CIDR block for the whole IPv6 address space
	IPv6ZeroCIDR = "::/0"
)

Functions

func AddressSet

func AddressSet(isValid func(ip net.IP) bool, addrs []net.Addr) sets.Set[string]

AddressSet validates the addresses in the slice using the "isValid" function. Addresses that pass the validation are returned as a string Set.

func AppendPortIfNeeded

func AppendPortIfNeeded(addr string, port int32) string

AppendPortIfNeeded appends the given port to IP address unless it is already in "ipv4:port" or "[ipv6]:port" format.

func BuildPortsToEndpointsMap

func BuildPortsToEndpointsMap(endpoints *v1.Endpoints) map[string][]string

BuildPortsToEndpointsMap builds a map of portname -> all ip:ports for that portname. Explode Endpoints.Subsets[*] into this structure.

func EnsureSysctl

func EnsureSysctl(sysctl utilsysctl.Interface, name string, newVal int) error

EnsureSysctl sets a kernel sysctl to a given numeric value.

func GetClusterIPByFamily

func GetClusterIPByFamily(ipFamily v1.IPFamily, service *v1.Service) string

GetClusterIPByFamily returns a service clusterip by family

func GetIPFamilyFromIP

func GetIPFamilyFromIP(ipStr string) v1.IPFamily

GetIPFamilyFromIP Returns the IP family of ipStr, or IPFamilyUnknown if ipStr can't be parsed as an IP

func GetLocalAddrSet

func GetLocalAddrSet() netutils.IPSet

GetLocalAddrSet return a local IPSet. If failed to get local addr, will assume no local ips.

func GetLocalAddrs

func GetLocalAddrs() ([]net.IP, error)

GetLocalAddrs returns a list of all network addresses on the local system

func IPPart

func IPPart(s string) string

IPPart returns just the IP part of an IP or IP:port or endpoint string. If the IP part is an IPv6 address enclosed in brackets (e.g. "[fd00:1::5]:9999"), then the brackets are stripped as well.

func IsLoopBack

func IsLoopBack(ip string) bool

IsLoopBack checks if a given IP address is a loopback address.

func IsVIPMode

func IsVIPMode(ing v1.LoadBalancerIngress) bool

func IsZeroCIDR

func IsZeroCIDR(cidr string) bool

IsZeroCIDR checks whether the input CIDR string is either the IPv4 or IPv6 zero CIDR

func LogAndEmitIncorrectIPVersionEvent

func LogAndEmitIncorrectIPVersionEvent(recorder events.EventRecorder, fieldName, fieldValue, svcNamespace, svcName string, svcUID types.UID)

LogAndEmitIncorrectIPVersionEvent logs and emits incorrect IP version event.

func MapCIDRsByIPFamily

func MapCIDRsByIPFamily(cidrStrings []string) map[v1.IPFamily][]string

MapCIDRsByIPFamily maps a slice of IPs to their respective IP families (v4 or v6)

func MapIPsByIPFamily

func MapIPsByIPFamily(ipStrings []string) map[v1.IPFamily][]string

MapIPsByIPFamily maps a slice of IPs to their respective IP families (v4 or v6)

func OtherIPFamily

func OtherIPFamily(ipFamily v1.IPFamily) v1.IPFamily

OtherIPFamily returns the other ip family

func PortPart

func PortPart(s string) (int, error)

PortPart returns just the port part of an endpoint string.

func RevertPorts

func RevertPorts(replacementPortsMap, originalPortsMap map[netutils.LocalPort]netutils.Closeable)

RevertPorts is closing ports in replacementPortsMap but not in originalPortsMap. In other words, it only closes the ports opened in this sync.

func ShouldSkipService

func ShouldSkipService(service *v1.Service) bool

ShouldSkipService checks if a given service should skip proxying

func ShuffleStrings

func ShuffleStrings(s []string) []string

ShuffleStrings copies strings from the specified slice into a copy in random order. It returns a new slice.

Types

type LineBuffer

type LineBuffer interface {
	// Write takes a list of arguments, each a string or []string, joins all the
	// individual strings with spaces, terminates with newline, and writes them to the
	// buffer. Any other argument type will panic.
	Write(args ...interface{})

	// WriteBytes writes bytes to the buffer, and terminates with newline.
	WriteBytes(bytes []byte)

	// Reset clears the buffer
	Reset()

	// Bytes returns the contents of the buffer as a []byte
	Bytes() []byte

	// String returns the contents of the buffer as a string
	String() string

	// Lines returns the number of lines in the buffer. Note that more precisely, this
	// returns the number of times Write() or WriteBytes() was called; it assumes that
	// you never wrote any newlines to the buffer yourself.
	Lines() int
}

LineBuffer is an interface for writing lines of input to a bytes.Buffer

func NewDiscardLineBuffer

func NewDiscardLineBuffer() LineBuffer

NewDiscardLineBuffer returns a dummy LineBuffer that counts the number of writes but throws away the data. (This is used for iptables proxy partial syncs, to keep track of how many rules we managed to avoid having to sync.)

func NewLineBuffer

func NewLineBuffer() LineBuffer

NewLineBuffer returns a new "real" LineBuffer

type NetworkInterfacer

type NetworkInterfacer interface {
	InterfaceAddrs() ([]net.Addr, error)
}

NetworkInterfacer defines an interface for several net library functions. Production code will forward to net library functions, and unit tests will override the methods for testing purposes.

type NodePortAddresses

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

NodePortAddresses is used to handle the --nodeport-addresses flag

func NewNodePortAddresses

func NewNodePortAddresses(family v1.IPFamily, cidrStrings []string) *NodePortAddresses

NewNodePortAddresses takes an IP family and the `--nodeport-addresses` value (which is assumed to contain only valid CIDRs, potentially of both IP families) and returns a NodePortAddresses object for the given family. If there are no CIDRs of the given family then the CIDR "0.0.0.0/0" or "::/0" will be added (even if there are CIDRs of the other family).

func (*NodePortAddresses) ContainsIPv4Loopback

func (npa *NodePortAddresses) ContainsIPv4Loopback() bool

ContainsIPv4Loopback returns true if npa's CIDRs contain an IPv4 loopback address.

func (*NodePortAddresses) GetNodeIPs

func (npa *NodePortAddresses) GetNodeIPs(nw NetworkInterfacer) ([]net.IP, error)

GetNodeIPs return all matched node IP addresses for npa's CIDRs. If no matching IPs are found, it returns an empty list. NetworkInterfacer is injected for test purpose.

func (*NodePortAddresses) MatchAll

func (npa *NodePortAddresses) MatchAll() bool

MatchAll returns true if npa matches all node IPs (of npa's given family)

func (*NodePortAddresses) String

func (npa *NodePortAddresses) String() string

type RealNetwork

type RealNetwork struct{}

RealNetwork implements the NetworkInterfacer interface for production code, just wrapping the underlying net library function calls.

func (RealNetwork) InterfaceAddrs

func (RealNetwork) InterfaceAddrs() ([]net.Addr, error)

InterfaceAddrs wraps net.InterfaceAddrs(), it's a part of NetworkInterfacer interface.

type Resolver

type Resolver interface {
	LookupIPAddr(ctx context.Context, host string) ([]net.IPAddr, error)
}

Resolver is an interface for net.Resolver