The Deckhouse Platform installs CRDs but does not remove them when a module is disabled. If you no longer need the created CRDs, delete them.

The module lifecycle stage: General Availability

MetalLoadBalancerBGPPeer

Short names: mlbbp

Scope: Cluster
Version: v1alpha1

Describes the settings of a BGP router (neighbor) and the parameters for establishing a session with it.

  • apiVersion
    string
  • kind
    string
  • metadata
    object
  • spec
    object
    • spec.bfd
      object

      BFD profile configuration. Note: BFD is currently not supported as it requires the FRR BGP implementation, which is not yet available in Deckhouse MetalLB. This field is a placeholder for future use.

      • spec.bfd.detectMultiplier
        integer

        The number of missed BFD packets to consider a session down.

      • spec.bfd.echoInterval
        integer

        The minimum interval (in milliseconds) between transmitted BFD echo packets.

      • spec.bfd.echoMode
        boolean

        Enables or disables BFD echo mode.

      • spec.bfd.minimumTTL
        integer

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

        The TTL is measured in network hops.

      • spec.bfd.passiveMode
        boolean

        Enables passive mode for BFD (does not attempt to bring up the session first).

      • spec.bfd.receiveInterval
        integer

        The minimum interval (in milliseconds) between received BFD control packets.

      • spec.bfd.transmitInterval
        integer

        The minimum interval (in milliseconds) between transmitted BFD control packets.

    • spec.holdTime
      string

      The requested BGP hold time.

      Pattern: ^([0-9]+(ms|s|m|h))+$

    • spec.myASN
      integer

      Required value

      The local Autonomous System Number (ASN) used for peering.

      Allowed values: 1 <= X <= 4294967295

    • spec.passwordSecretRef
      object

      Reference to the Secret containing the password for BGP session authentication.

      Important: the target Secret MUST have the label network.deckhouse.io/metallb-bgp-password: "true".

      • spec.passwordSecretRef.name
        string

        Required value

        Name of the Secret.

      • spec.passwordSecretRef.namespace
        string

        Required value

        Namespace of the Secret.

    • spec.peerASN
      integer

      Required value

      The Autonomous System Number (ASN) of the BGP peer.

      Allowed values: 1 <= X <= 4294967295

    • spec.peerAddress
      string

      Required value

      The IP address of the BGP peer.

    • spec.peerPort
      integer

      The port of the BGP peer.

      Allowed values: 1 <= X <= 65535

    • spec.routerID
      string

      BGP router ID to advertise to the peer. Must be a valid IPv4 address.

    • spec.sourceAddresses
      array of objects

      Per-node override of the local IP address used for peering.

      • spec.sourceAddresses.address
        string

        Required value

        IP address to peer from this node.

      • spec.sourceAddresses.nodeName
        string

        Required value

        Name of the node.

  • status
    object

MetalLoadBalancerClass

Short names: mlbc

Scope: Cluster
Version: v1alpha1

MetalLoadBalancerClass is the Schema for the metalloadbalancerclasses API

  • apiVersion
    string
  • kind
    string
  • metadata
    object
  • spec
    object
    • spec.addressPool
      array of strings

      An array of public IP address ranges. Each range can be specified using a CIDR notation or by directly specifying the range, for example, 10.10.10.1-10.10.10.100.

      Examples:

      addressPool: 10.42.0.0/24

      addressPool: 10.33.5.100-10.33.5.106
    • spec.isDefault
      boolean

      Whether MetalLoadBalancerClass is selected for all services by default.

      Example:

      isDefault: true
    • spec.l2
      object

      Available in editions: SE, SE+, Ultimate/EE

      • spec.l2.interfaces
        array of strings

        Available in editions: SE, SE+, Ultimate/EE

        A list of network interfaces from which the assigned IP addresses will be announced. If this field is not filled in or an empty array is specified, the announcement will occur from all interfaces on the node. It is highly recommended to configure this parameter to prevent the announcement of addresses from all node interfaces.

        Example:

        interfaces:
- eth1
- eth2
    • spec.nodeSelector
      object

      Allows restricting the list of nodes from which the announcement will occur. Specified as a set of labels for filtering nodes.

    • spec.type
      string

      Selecting the load balancer operating mode.

      Example:

      type: L2
  • status
    object

MetalLoadBalancerConfiguration

Short names: mlbconfig

Scope: Cluster
Version: v1alpha1

Defines the routing topology: from which nodes, to which BGP peers, and which IP address pools to advertise.

  • apiVersion
    string
  • kind
    string
  • metadata
    object
  • spec
    object
    • spec.advertisements
      array of objects

      List of advertisements and their configurations.

      • spec.advertisements.bgp
        object

        BGP-specific advertisement configuration.

        • spec.advertisements.bgp.aggregationLength
          integer

          Subnet mask for route aggregation.

          Allowed values: 0 <= X <= 128

        • spec.advertisements.bgp.communities
          array of strings

          BGP communities to associate with the advertisement.

          • Element of the array
            string

            Pattern: ^([0-9]+:[0-9]+|no-export|no-advertise|local-as|none)$

        • spec.advertisements.bgp.localPref
          integer

          BGP LOCAL_PREF attribute.

          Allowed values: 0 <= X <= 4294967295

      • spec.advertisements.poolNames
        array of strings

        Required value

        List of MetalLoadBalancerPool names to advertise.

    • spec.bgp
      object

      BGP specific configuration.

      • spec.bgp.peerNames
        array of strings

        List of MetalLoadBalancerBGPPeer names to associate with this configuration.

    • spec.mode
      string

      Required value

      The routing mode. Only BGP is supported in this configuration.

      Allowed values: BGP

    • spec.nodeSelector
      object

      Allows limiting the list of nodes from which addresses will be announced.

      Specified as a set of labels for node filtering.

  • status
    object

MetalLoadBalancerPool

Short names: mlbp

Scope: Cluster
Version: v1alpha1

Describes an IP address pool (MetalLoadBalancerPool) to be used by the load balancer in BGP mode.

  • apiVersion
    string
  • kind
    string
  • metadata
    object
  • spec
    object
    • spec.addresses
      array of strings

      Required value

      An array of public IP address ranges.

      Each range can be specified using a CIDR notation or by directly specifying the range, for example, 10.10.10.1-10.10.10.100.

    • spec.autoAssign
      boolean

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

      Default: true

    • spec.avoidBuggyIPs
      boolean

      AvoidBuggyIPs prevents addresses ending with .0 and .255 from being used by a pool.

      Default: false

  • status
    object