IPAddressPool

Scope: Namespaced
Version: v1beta1

IPAddressPool represents a pool of IP addresses that can be allocated to LoadBalancer services.

  • apiVersion
    string

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

  • kind
    string

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • metadata
    object
  • spec
    object

    Required value

    IPAddressPoolSpec defines the desired state of IPAddressPool.

    • spec.addresses
      array of strings

      Required value

      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.

    • 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 to be used by a pool.

      Default: false

L2Advertisement

Scope: Namespaced
Version: v1beta1

L2Advertisement allows to advertise the LoadBalancer IPs provided by the selected pools via L2.

  • apiVersion
    string

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

  • kind
    string

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • metadata
    object
  • spec
    object

    L2AdvertisementSpec defines the desired state of L2Advertisement.

    • spec.interfaces
      array of strings

      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.

    • spec.ipAddressPoolSelectors
      array of objects

      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.

      A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

      • spec.ipAddressPoolSelectors.matchExpressions
        array of objects

        matchExpressions is a list of label selector requirements. The requirements are ANDed.

        A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

        • spec.ipAddressPoolSelectors.matchExpressions.key
          string

          Required value

          key is the label key that the selector applies to.

        • spec.ipAddressPoolSelectors.matchExpressions.operator
          string

          Required value

          operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

        • spec.ipAddressPoolSelectors.matchExpressions.values
          array of strings

          values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

      • spec.ipAddressPoolSelectors.matchLabels
        object

        matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

    • spec.ipAddressPools
      array of strings

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

    • spec.nodeSelectors
      array of objects

      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 label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

      • spec.nodeSelectors.matchExpressions
        array of objects

        matchExpressions is a list of label selector requirements. The requirements are ANDed.

        A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

        • spec.nodeSelectors.matchExpressions.key
          string

          Required value

          key is the label key that the selector applies to.

        • spec.nodeSelectors.matchExpressions.operator
          string

          Required value

          operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

        • spec.nodeSelectors.matchExpressions.values
          array of strings

          values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

      • spec.nodeSelectors.matchLabels
        object

        matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

L2LoadBalancer

Scope: Cluster
Version: v1alpha1

L2LoadBalancer is the Schema for the l2loadbalancers 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.interfaces
      array of strings

      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.

      Examples:

      interfaces: eth1

      interfaces: 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.