API reference docs

The minimum interval that this system is capable of receiving control packets in milliseconds. Defaults to 300ms.

The minimum transmission interval (less jitter) that this system wants to use to send BFD control packets in milliseconds. Defaults to 300ms

Configures the detection multiplier to determine packet loss. The remote transmission interval will be multiplied by this value to determine the connection loss detection timer.

Configures the minimal echo receive transmission interval that this system is capable of handling in milliseconds. Defaults to 50ms

Enables or disables the echo transmission mode. This mode is disabled by default, and not supported on multi hops setups.

Mark session as passive: a passive session will not attempt to start the connection and will wait for control packets from peer before it begins replying.

For multi hop sessions only: configure the minimum expected TTL for an incoming BFD control packet.

The aggregation-length advertisement option lets you “roll up” the /32s into a larger prefix. Defaults to 32. Works for IPv4 addresses.

The aggregation-length advertisement option lets you “roll up” the /128s into a larger prefix. Defaults to 128. Works for IPv6 addresses.

The BGP LOCAL_PREF attribute which is used by BGP best path algorithm, Path with higher localpref is preferred over one with lower localpref.

The BGP communities to be associated with the announcement. Each item can be a community of the form 1234:1234 or the name of an alias defined in the Community CRD.

The list of IPAddressPools to advertise via this advertisement, selected by name.

A selector for the IPAddressPools which would get advertised via this advertisement. If no IPAddressPool is selected by this or by the list, the advertisement is applied to all the IPAddressPools.

NodeSelectors allows to limit the nodes to announce as next hops for the LoadBalancer IP. When empty, all the nodes having are announced as next hops.

Peers limits the bgppeer to advertise the ips of the selected pools to. When empty, the loadbalancer IP is announced to all the BGPPeers configured.

A list of IP address ranges over which MetalLB has authority. You can list multiple ranges in a single pool, they will all share the same settings. Each range can be either a CIDR prefix, or an explicit start-end range of IPs.

AutoAssign flag used to prevent MetallB from automatic allocation for a pool.

AvoidBuggyIPs prevents addresses ending with .0 and .255 to be used by a pool.

AllocateTo makes ip pool allocation to specific namespace and/or service. The controller will use the pool with lowest value of priority in case of multiple matches. A pool with no priority set will be used only if the pools with priority can’t be used. If multiple matching IPAddressPools are available it will check for the availability of IPs sorting the matching IPAddressPools by priority, starting from the highest to the lowest. If multiple IPAddressPools have the same priority, choice will be random.

The list of IPAddressPools to advertise via this advertisement, selected by name.

A selector for the IPAddressPools which would get advertised via this advertisement. If no IPAddressPool is selected by this or by the list, the advertisement is applied to all the IPAddressPools.

NodeSelectors allows to limit the nodes to announce as next hops for the LoadBalancer IP. When empty, all the nodes having are announced as next hops.

A list of interfaces to announce from. The LB IP will be announced only from these interfaces. If the field is not set, we advertise from all the interfaces on the host.

AS number to use for the local end of the session.

AS number to expect from the remote end of the session.

Address to dial when establishing the session.

Source address to use when establishing the session.

Port to dial when establishing the session.

Requested BGP hold time, per RFC4271.

Requested BGP keepalive time, per RFC4271.

BGP router ID to advertise to the peer

Only connect to this peer on nodes that match one of these selectors.

Authentication password for routers enforcing TCP MD5 authenticated sessions

passwordSecret is name of the authentication secret for BGP Peer. the secret must be of type “kubernetes.io/basic-auth”, and created in the same namespace as the MetalLB deployment. The password is stored in the secret as the key “password”.

The name of the BFD Profile to be used for the BFD session associated to the BGP session. If not set, the BFD session won’t be set up.

To set if the BGPPeer is multi-hops away. Needed for FRR mode only.

To set if we want to peer with the BGPPeer using an interface belonging to a host vrf