EVPN Configuration

Underlay Configuration #

In addition to the configuration described in the underlay configuration section, the VTEP IP allocation strategy must be provided (Note the evpn field).

Basic Underlay Configuration #

apiVersion: openpe.openperouter.github.io/v1alpha1
kind: Underlay
metadata:
  name: underlay
  namespace: openperouter-system
spec:
  asn: 64514
  evpn:
    vtepcidr: 100.65.0.0/24
  nics:
    - toswitch
  neighbors:
    - asn: 64512
      address: 192.168.11.2

Configuration Fields #

Field	Type	Description	Required
`asn`	integer	Local ASN for BGP sessions	Yes
`evpn.vtepcidr`	string	CIDR block for VTEP IP allocation	Yes
`nics`	array	List of network interface names to move to router namespace	Yes
`neighbors`	array	List of BGP neighbors to peer with	Yes

VTEP IP Allocation #

The evpn.vtepcidr field defines the IP range used for VTEP (Virtual Tunnel End Point) addresses. OpenPERouter automatically assigns a unique VTEP IP to each node from this range. For example, with 100.65.0.0/24:

Node 1: 100.65.0.1
Node 2: 100.65.0.2
Node 3: 100.65.0.3
etc.

L3 VNI Configuration #

L3 VNI (Virtual Network Identifier) configurations define EVPN L3 overlays. Each L3VNI creates a separate routing domain and BGP session with the host.

Basic L3VNI Configuration #

apiVersion: openpe.openperouter.github.io/v1alpha1
kind: L3VNI
metadata:
  name: blue
  namespace: openperouter-system
spec:
  vrf: blue
  hostsession:
    asn: 64514
    hostasn: 64515
    localcidr:
      ipv4: 192.169.11.0/24
  vni: 200

Configuration Fields #

Field	Type	Description	Required
`vrf`	string	Name of the VRF (Virtual Routing and Forwarding) instance	Yes
`vni`	integer	Virtual Network Identifier (1-16777215)	Yes
`hostsession.asn`	integer	Router ASN for BGP session with host	Yes
`hostsession.hostasn`	integer	Host ASN for BGP session	Yes
`hostsession.localcidr`	string	CIDR for veth pair IP allocation	Yes

Multiple VNIs Example #

You can create multiple VNIs for different network segments:

# Production VNI
apiVersion: openpe.openperouter.github.io/v1alpha1
kind: L3VNI
metadata:
  name: signal
  namespace: openperouter-system
spec:
  vrf: signal
  vni: 100
  hostsession:
    asn: 64514
    hostasn: 64515
    localcidr:
      ipv4: 192.168.10.0/24
---
# Development VNI
apiVersion: openpe.openperouter.github.io/v1alpha1
kind: L3VNI
metadata:
  name: oam
  namespace: openperouter-system
spec:
  vrf: oam
  vni: 200
  hostsession:
    asn: 64514
    hostasn: 64515
    localcidr:
      ipv4: 192.168.20.0/24

What Happens During Reconciliation #

When you create or update VNI configurations, OpenPERouter automatically:

Creates Network Interfaces: Sets up VXLAN interface and Linux VRF named after the VNI
Establishes Connectivity: Creates veth pair and moves one end to the router’s namespace
Assigns IP Addresses: Allocates IPs from the localcidr range:
- Router side: First IP in the CIDR (e.g., 192.169.11.1)
- Host side: Each node gets a free IP in the CIDR, starting from the second (e.g., 192.169.11.15)
Creates BGP Session: Opens BGP session between router and host using the specified ASNs

L2VNI Configuration #

L2VNIs provide Layer 2 connectivity across nodes using EVPN tunnels. Unlike L3VNIs, L2VNIs extend Layer 2 domains rather than routing domains.

Configuration Fields #

Field	Type	Description	Required
`vni`	integer	Virtual Network Identifier for the EVPN tunnel	Yes
`vrf`	string	Name of the VRF to associate with this L2VNI	Yes
`hostmaster.type`	string	Type of host interface management (`bridge` or `direct`)	Yes
`hostmaster.autocreate`	boolean	Whether to automatically create a bridge if type is `bridge`	No
`hostmaster.bridgeName`	string	Name of the bridge to attach to (if not auto-creating)	No

L2VNI Example #

apiVersion: openpe.openperouter.github.io/v1alpha1
kind: L2VNI
metadata:
  name: l2red
  namespace: openperouter-system
spec:
  vni: 210
  vrf: red
  hostmaster:
    type: bridge
    autocreate: true

What Happens During Reconciliation #

When you create or update VNI configurations, OpenPERouter automatically:

Creates Network Interfaces: Sets up VXLAN interface and Linux VRF named after the VNI
Establishes Connectivity: Creates veth pair and moves one end to the router’s namespace
Enslaves the veth: the veth is connected to the bridge corresponding to the l2 domain
Optionally creates a bridge on the host: if hostmaster.autocreate is set to true
Optionally connects the host veth to the bridge on the host: if hostmaster.autocreate is set to true or name is set

API Reference #

For detailed information about all available configuration fields, validation rules, and API specifications, see the API Reference documentation.