VXLANConfig - Sidero Documentation

apiVersion: v1alpha1
kind: VXLANConfig
name: vxlan900 # Name of the vxlan link (interface) to be created.
id: 100 # VXLAN network identifier (VNI) to be used for the vxlan link.
local: 10.255.0.1 # Source IP address (IPv4 or IPv6) to use in outgoing packets for the tunnel endpoint.
parent: vtep0 # Name of the parent link (interface) used as the physical device for the tunnel endpoint.
learning: false # Enable learning of source link addresses (MAC learning).

# # Multicast group IP address (IPv4 or IPv6) to join for the tunnel.
# group: 239.1.1.1

# # Destination UDP port for VXLAN traffic.
# port: 4789

# # Override the hardware (MAC) address of the link.
# hardwareAddr: 2e:3c:4d:5e:6f:70

Field	Type	Description	Value(s)
`name`	string	Name of the vxlan link (interface) to be created.
`id`	uint32	VXLAN network identifier (VNI) to be used for the vxlan link.
`local`	Addr	Source IP address (IPv4 or IPv6) to use in outgoing packets for the tunnel endpoint.
`group`	Addr	Multicast group IP address (IPv4 or IPv6) to join for the tunnel. Either the group or the local address should be set, not both.
`parent`	string	Name of the parent link (interface) used as the physical device for the tunnel endpoint. Link aliases can be used here as well.
`port`	uint16	Destination UDP port for VXLAN traffic. If not set, defaults to 4789.
`learning`	bool	Enable learning of source link addresses (MAC learning). If not set, defaults to true.
`hardwareAddr`	HardwareAddr	Override the hardware (MAC) address of the link.
`up`	bool	Bring the link up or down. If not specified, the link will be brought up.
`mtu`	uint32	Configure LinkMTU (Maximum Transmission Unit) for the link. If not specified, the system default LinkMTU will be used (usually 1500).
`addresses`	AddressConfig	Configure addresses to be statically assigned to the link.
`routes`	RouteConfig	Configure routes to be statically created via the link.
`multicast`	bool	Set the multicast capability of the link.

addresses[]

AddressConfig represents a network address configuration.

Field	Type	Description	Value(s)
`address`	Prefix	IP address to be assigned to the link. This field must include the network prefix length (e.g. /24 for IPv4, /64 for IPv6).
`routePriority`	uint32	Configure the route priority (metric) for routes created for this address. If not specified, the system default route priority will be used.

routes[]

RouteConfig represents a network route configuration.

Field	Type	Description	Value(s)
`destination`	Prefix	The route’s destination as an address prefix. If not specified, a default route will be created for the address family of the gateway.
`gateway`	Addr	The route’s gateway (if empty, creates link scope route).
`source`	Addr	The route’s source address (optional).
`metric`	uint32	The optional metric for the route.
`mtu`	uint32	The optional MTU for the route.
`table`	RoutingTable	The routing table to use for the route. If not specified, the main routing table will be used.