BGPInstanceConfig

apiVersion: v1alpha1
kind: BGPInstanceConfig
name: fabric # Name of the BGP routing instance.
localASN: 65001 # Local autonomous system number for the BGP instance.
# Names or aliases of the links whose addresses are originated into BGP as host routes (/32, /128).
advertise:
    - dummy0
multipath: true # Enable ECMP (multipath) for routes learned from multiple neighbors. Defaults to false.
# Selected routes to import from other BGP instances. Imports are one-way: matching best paths
importRoutes:
    - bgpInstance: workload # Name of the source BGP instance.
      # CIDR selectors. A learned route matches when it is contained by one of these prefixes.
      prefixes:
        - 198.51.100.0/24
# BGP neighbors in this routing instance.
neighbors:
    - link: enp1s0 # Link name or alias for an unnumbered (IPv6 link-local) session. Mutually exclusive with `address`.
      peerASN: 65000 # Expected peer ASN. Zero accepts any ASN advertised by the peer (eBGP "external").
      holdTime: 9s # BGP hold time for this neighbor. Zero uses the implementation default.
      # BFD (Bidirectional Forwarding Detection) settings for this neighbor.
      bfd:
        transmitInterval: 300ms # Desired minimum transmit interval. Zero uses the implementation default.
        receiveInterval: 300ms # Required minimum receive interval. Zero uses the implementation default.
        detectMultiplier: 3 # BFD detection multiplier. Zero uses the implementation default.
    - link: enp2s0 # Link name or alias for an unnumbered (IPv6 link-local) session. Mutually exclusive with `address`.
      peerASN: 65000 # Expected peer ASN. Zero accepts any ASN advertised by the peer (eBGP "external").
      holdTime: 9s # BGP hold time for this neighbor. Zero uses the implementation default.
      # BFD (Bidirectional Forwarding Detection) settings for this neighbor.
      bfd:
        transmitInterval: 300ms # Desired minimum transmit interval. Zero uses the implementation default.
        receiveInterval: 300ms # Required minimum receive interval. Zero uses the implementation default.
        detectMultiplier: 3 # BFD detection multiplier. Zero uses the implementation default.

# # BGP router-id. If not set, it is derived from the first advertised address.
# routerID: 10.0.0.1

# # Preferred source address set on routes installed from BGP (the kernel route `src` / RTA_PREFSRC,
# routeSource: 10.0.0.1

Field	Type	Description
`name`	string	Name of the BGP routing instance.
`vrf`	string	Linux VRF link used by this routing instance. If unset, the default routing domain is used.
`localASN`	uint32	Local autonomous system number for the BGP instance.
`routerID`	Addr	BGP router-id. If not set, it is derived from the first advertised address.
`routeSource`	Addr	Preferred source address set on routes installed from BGP (the kernel route `src` / RTA_PREFSRC, equivalent to FRR’s `ip protocol bgp route-map SETSRC`). If not set, the kernel selects the source address.
`advertise`	[]string	Names or aliases of the links whose addresses are originated into BGP as host routes (/32, /128).
`multipath`	bool	Enable ECMP (multipath) for routes learned from multiple neighbors. Defaults to false.
`maxPaths`	uint8	Maximum number of ECMP next-hops to install. Zero uses the implementation default.
`installRoutes`	bool	Install routes learned from BGP neighbors into the Linux routing table. Defaults to true. When false, learned routes remain in this instance’s BGP RIB and can still be selected by `importRoutes`, but Talos does not install them into the Linux FIB.
`importRoutes`	BGPImportRoute	Selected routes to import from other BGP instances. Imports are one-way: matching best paths learned from each source instance are preserved and advertised by this instance with its own next hop. Locally originated and previously imported paths are not recursively imported. Selectors in a single target instance must not overlap, giving each imported prefix one source.
`neighbors`	BGPNeighborConfig	BGP neighbors in this routing instance.

importRoutes[]

BGPImportRoute selects routes learned by another BGP instance for one-way import.

Field	Type	Description	Value(s)
`bgpInstance`	string	Name of the source BGP instance.
`prefixes`	[]Prefix	CIDR selectors. A learned route matches when it is contained by one of these prefixes.

neighbors[]

BGPNeighborConfig configures a concrete BGP neighbor.

Field	Type	Description
`address`	Addr	Neighbor IP address for a numbered session. Mutually exclusive with `link`.
`link`	string	Link name or alias for an unnumbered (IPv6 link-local) session. Mutually exclusive with `address`.
`peerASN`	uint32	Expected peer ASN. Zero accepts any ASN advertised by the peer (eBGP “external”).
`localASN`	uint32	Local ASN override for this neighbor. Zero uses the instance local ASN.
`passive`	bool	Wait for the neighbor to establish the connection instead of initiating it.
`holdTime`	Duration	BGP hold time for this neighbor. Zero uses the implementation default.
`bfd`	BGPBFDConfig	BFD (Bidirectional Forwarding Detection) settings for this neighbor. The presence of this block enables BFD; an empty block uses the implementation defaults. BFD is supported only when the BGP instance uses the default routing domain, not a VRF.

bfd

BGPBFDConfig configures BFD for a BGP neighbor.

Field	Type	Description
`transmitInterval`	Duration	Desired minimum transmit interval. Zero uses the implementation default.
`receiveInterval`	Duration	Required minimum receive interval. Zero uses the implementation default.
`detectMultiplier`	uint8	BFD detection multiplier. Zero uses the implementation default.

Overview

Getting Started

Platform specific installation

Deploying and managing workloads

Networking

Security

Build and extend Talos

Configure your Talos cluster

Advanced guides

Reference

Troubleshooting and support

Learn more

importRoutes[]

neighbors[]

bfd

​importRoutes[]

​neighbors[]

​bfd

importRoutes[]

neighbors[]

bfd