Configure PorterLB in BGP Mode

This document describes how to configure PorterLB in BGP mode. If PorterLB is used in Layer 2 mode, you do not need to configure PorterLB.

Configure Local BGP Properties Using BgpConf

You can create a BgpConf object in the Kubernetes cluster to configure the local BGP properties on PorterLB. The following is an example of the BgpConf YAML configuration:

  1. apiVersion: network.kubesphere.io/v1alpha2
  2. kind: BgpConf
  3. metadata:
  4.   name: default
  5. spec:
  6.   as: 50000
  7.   listenPort: 17900
  8.   routerId: 192.168.0.2

The fields are described as follows:

metadata:

  • name: BgpConf object name. PorterLB recognizes only the name default. BgpConf objects with other names will be ignored.

spec:

  • as: Local ASN, which must be different from the value of spec:conf:peerAS in the BgpPeer configuration.
  • listenPort: Port on which PorterLB listens. The default value is 179 (default BGP port number). If other components (such as Calico) in the Kubernetes cluster also use BGP and port 179, you must set a different value to avoid the conflict.
  • routerID: Local router ID, which is usually set to the IP address of the master NIC of the Kubernetes master node. If this field is not specified, the first IP address of the node where porter-manager is located will be used.

Configure Peer BGP Properties Using BgpPeer

You can create a BgpPeer object in the Kubernetes cluster to configure the peer BGP properties on PorterLB. The following is an example of the BgpPeer YAML configuration:

  1. apiVersion: network.kubesphere.io/v1alpha2
  2. kind: BgpPeer
  3. metadata:
  4.   name: bgppeer-sample
  5. spec:
  6.   conf:
  7.     peerAs: 50001
  8.     neighborAddress: 192.168.0.5
  9.   afiSafis:
  10.     - config:
  11.         family:
  12.           afi: AFI_IP
  13.           safi: SAFI_UNICAST
  14.         enabled: true
  15.       addPaths:
  16.         config:
  17.           sendMax: 10
  18.   nodeSelector:
  19.     matchLabels:
  20.       porter.kubesphere.io/rack: leaf1

The fields are described as follows:

metadata:

  • name: Name of the BgpPeer object. If there are multiple peer BGP routers, you can create multiple BgpPeer objects with different names.

spec:conf:

  • peerAS: ASN of the peer BGP router, which must be different from the value of spec:as in the BgpConf configuration.
  • neighborAddress: IP address of the peer BGP router.

spec:afiSafis:addPaths:config:

  • sendMax: Maximum number of equivalent routes that PorterLB can send to the peer BGP router for Equal-Cost Multi-Path (ECMP) routing. The default value is 10.

spec:nodeSelector:matchLabels:

  • porter.kubesphere.io/rack: If the Kubernetes cluster nodes are deployed under different routers and each node has one PorterLB replica, you need to configure this field so that the PorterLB replica on the correct node establishes a BGP connection with the peer BGP router. By default, all porter-manager replicas will respond to the BgpPeer configuration and attempt to establish a BGP connection with the peer BGP router.

Other fields under spec:afiSafis specify the address family. Currently, PorterLB supports only IPv4 and you can directly use the values in the example configuration.

Last modified March 12, 2021: Added description in bpg-mode-en and changed the YAML item separator. (dc30f3a)