config

Documentation

Index

• Variables
• func DiscardFRROnly(c ClusterResources) error
• func DiscardNativeOnly(c ClusterResources) error
• func DontValidate(c ClusterResources) error
• func NewValidator(validate Validate) apivalidate.ClusterObjects
• func ParseCIDR(cidr string) ([]*net.IPNet, error)
• type BFDProfile
• type BGPAdvertisement
• type ClusterResources
• type Config
  • func For(resources ClusterResources, validate Validate) (*Config, error)
• type L2Advertisement
• type Peer
• type Pool
• type Pools
  • func (p *Pools) IsEmpty(pool string) bool
• type Proto
• type ServiceAllocation
• type TransientError
  • func (e TransientError) Error() string
• type Validate
  • func ValidationFor(bgpImpl string) Validate

Variables

var Protocols = []Proto{
	BGP, Layer2,
}

Functions

func DiscardFRROnly

func DiscardFRROnly(c ClusterResources) error

DiscardFRROnly returns an error if the current configFile contains any options that are available only in the FRR implementation.

func DiscardNativeOnly

func DiscardNativeOnly(c ClusterResources) error

DiscardNativeOnly returns an error if the current configFile contains any options that are available only in the native implementation.

func DontValidate

func DontValidate(c ClusterResources) error

DontValidate is a Validate function that always returns success.

func NewValidator

func NewValidator(validate Validate) apivalidate.ClusterObjects

func ParseCIDR

func ParseCIDR(cidr string) ([]*net.IPNet, error)

Types

type BFDProfile

type BFDProfile struct {
	Name             string
	ReceiveInterval  *uint32
	TransmitInterval *uint32
	DetectMultiplier *uint32
	EchoInterval     *uint32
	EchoMode         bool
	PassiveMode      bool
	MinimumTTL       *uint32
}

BFDProfile describes a BFD profile to be applied to a set of peers.

type BGPAdvertisement

type BGPAdvertisement struct {
	// The name of the advertisement
	Name string
	// Roll up the IP address into a CIDR prefix of this
	// length. Optional, defaults to 32 (i.e. no aggregation) if not
	// specified.
	AggregationLength int
	// Optional, defaults to 128 (i.e. no aggregation) if not
	// specified.
	AggregationLengthV6 int
	// Value of the LOCAL_PREF BGP path attribute. Used only when
	// advertising to IBGP peers (i.e. Peer.MyASN == Peer.ASN).
	LocalPref uint32
	// Value of the COMMUNITIES path attribute.
	Communities map[community.BGPCommunity]bool
	// The map of nodes allowed for this advertisement
	Nodes map[string]bool
	// Used to declare the intent of announcing IPs
	// only to the BGPPeers in this list.
	Peers []string
}

BGPAdvertisement describes one translation from an IP address to a BGP advertisement.

type ClusterResources

type ClusterResources struct {
	Pools           []metallbv1beta1.IPAddressPool    `json:"ipaddresspools"`
	Peers           []metallbv1beta2.BGPPeer          `json:"bgppeers"`
	BFDProfiles     []metallbv1beta1.BFDProfile       `json:"bfdprofiles"`
	BGPAdvs         []metallbv1beta1.BGPAdvertisement `json:"bgpadvertisements"`
	L2Advs          []metallbv1beta1.L2Advertisement  `json:"l2advertisements"`
	Communities     []metallbv1beta1.Community        `json:"communities"`
	PasswordSecrets map[string]corev1.Secret          `json:"passwordsecrets"`
	Nodes           []corev1.Node                     `json:"nodes"`
	Namespaces      []corev1.Namespace                `json:"namespaces"`
	BGPExtras       corev1.ConfigMap                  `json:"bgpextras"`
}

type Config

type Config struct {
	// Routers that MetalLB should peer with.
	Peers map[string]*Peer
	// Address pools from which to allocate load balancer IPs.
	Pools *Pools
	// BFD profiles that can be used by peers.
	BFDProfiles map[string]*BFDProfile
	// Protocol dependent extra config. Currently used only by FRR
	BGPExtras string
}

Config is a parsed MetalLB configuration.

func For

func For(resources ClusterResources, validate Validate) (*Config, error)

Parse loads and validates a Config from bs.

type L2Advertisement

type L2Advertisement struct {
	// The map of nodes allowed for this advertisement
	Nodes map[string]bool
	// The interfaces in Nodes allowed for this advertisement
	Interfaces []string
	// AllInterfaces tells if all the interfaces are allowed for this advertisement
	AllInterfaces bool
}

type Peer

type Peer struct {
	// Peer name.
	Name string
	// AS number to use for the local end of the session.
	MyASN uint32
	// AS number to expect from the remote end of the session.
	ASN uint32
	// Address to dial when establishing the session.
	Addr net.IP
	// Source address to use when establishing the session.
	SrcAddr net.IP
	// Port to dial when establishing the session.
	Port uint16
	// Requested BGP hold time, per RFC4271.
	HoldTime time.Duration
	// Requested BGP keepalive time, per RFC4271.
	KeepaliveTime time.Duration
	// Requested BGP connect time, controls how long BGP waits between connection attempts to a neighbor.
	ConnectTime *time.Duration
	// BGP router ID to advertise to the peer
	RouterID net.IP
	// Only connect to this peer on nodes that match one of these
	// selectors.
	NodeSelectors []labels.Selector
	// Authentication password for routers enforcing TCP MD5 authenticated sessions
	Password string
	// The password set in the secret referenced by the secret reference, in clear text
	SecretPassword string
	// Optional reference to the secret that holds the password.
	PasswordRef corev1.SecretReference
	// The optional BFD profile to be used for this BGP session
	BFDProfile string
	// Optional EnableGracefulRestart enable BGP graceful restart functionality at the peer level.
	EnableGracefulRestart bool
	// Optional ebgp peer is multi-hops away.
	EBGPMultiHop bool
	// Optional name of the vrf to establish the session from
	VRF string
	// Option to disable MP BGP that will result in separation of IPv4 and IPv6 route exchanges into distinct BGP sessions.
	DisableMP bool
}

Peer is the configuration of a BGP peering session.

type Pool

type Pool struct {
	// Pool Name
	Name string
	// The addresses that are part of this pool, expressed as CIDR
	// prefixes. config.Parse guarantees that these are
	// non-overlapping, both within and between pools.
	CIDR []*net.IPNet
	// Some buggy consumer devices mistakenly drop IPv4 traffic for IP
	// addresses ending in .0 or .255, due to poor implementations of
	// smurf protection. This setting marks such addresses as
	// unusable, for maximum compatibility with ancient parts of the
	// internet.
	AvoidBuggyIPs bool
	// If false, prevents IP addresses to be automatically assigned
	// from this pool.
	AutoAssign bool

	// The list of BGPAdvertisements associated with this address pool.
	BGPAdvertisements []*BGPAdvertisement

	// The list of L2Advertisements associated with this address pool.
	L2Advertisements []*L2Advertisement

	ServiceAllocations *ServiceAllocation
	// contains filtered or unexported fields
}

Pool is the configuration of an IP address pool.

type Pools

type Pools struct {
	// ByName a map containing all configured pools.
	ByName map[string]*Pool
	// ByNamespace contains pool names pinned to specific namespace.
	ByNamespace map[string][]string
	// ByServiceSelector contains pool names which has service selection labels.
	ByServiceSelector []string
}

Pools contains address pools and its namespace/service specific allocations.

func (*Pools) IsEmpty

func (p *Pools) IsEmpty(pool string) bool

type Proto

type Proto string

Proto holds the protocol we are speaking.

const (
	BGP    Proto = "bgp"
	Layer2 Proto = "layer2"
)

MetalLB supported protocols.

type ServiceAllocation

type ServiceAllocation struct {
	// The priority of ip pool for a given service allocation.
	Priority int
	// Set of namespaces on which ip pool can be attached.
	Namespaces sets.Set[string]
	// Service selectors to select service for which ip pool can be used
	// for ip allocation.
	ServiceSelectors []labels.Selector
}

ServiceAllocation makes ip pool allocation to specific namespace and/or service.

type TransientError

type TransientError struct {
	Message string
}

TransientError is an error that happens due to interdependencies between crds, such as referencing non-existing bfd profile.

func (TransientError) Error

func (e TransientError) Error() string

type Validate

type Validate func(ClusterResources) error

func ValidationFor

func ValidationFor(bgpImpl string) Validate