BGP Peer#
Virtual Networks → BPBGP Peers
A BGPPeer resource is required when setting up a BGP session between two Routers. It represents a single participant in the BGP session, so if both sides of the BGP session are managed by EDA, two of these resources will need to be created.
To set up BGP peers in the default VRF, use
DefaultBGPPeerinstead.
Dependencies#
To configure this resource, the following resources must exist or be created alongside the BGPPeer
- A
BGPGroupthat theBGPPeerwill inherit settings from, such as local and remote AS numbers - An interface that the
BGPPeerwill use to establish the session. This can either be aRoutedInterfaceor anIRBInterface
Referenced resources#
BGPGroup#
A BGPPeer is always linked to a single BGPGroup. In real-world networks, multiple BGP peers share common parameters, such as BGP import and export policies, local and peer autonomous system numbers, and BGP timers. These parameters can be specified in the group instead, allowing the operator to change these settings in a single location for all linked BGP peers. All settings in the group can optionally be overridden in the individual peer resources. Configuration inheritance works as follows:
graph LR
A[BGPPeer] -->|overrides| B
B[BGPGroup] -->|overrides| C
C[Router]
B[BGPGroup resource]
C[Router resource]RoutedInterface#
To know which IP address the router uses to send BGP traffic, EDA must have a reference to a virtual interface. If this interface is a RoutedInterface attached directly to an Interface, a reference to this resource needs to be provided when creating the BGPPeer.
IRBInterface#
To know which IP address the router uses to send BGP traffic, EDA must have a reference to a virtual interface. If this interface is an IRBInterface attached to a BridgeDomain, a reference to this resource needs to be provided when creating the BGPPeer.
Policy#
Routing policies can be specified in various locations of the BGPPeer resource. These policies are used to filter or modify BGP routes sent/received by this BGPPeer. If no policies are configured, the default behavior for the router on which the BGPPeer is configured is followed, which may be different depending on the operating system.
Examples#
Custom Resource Definition#
To browse the Custom Resource Definition go to crd.eda.dev.
BGPPeer
SPEC
BGPPeer enables the configuration of BGP sessions. It allows specifying a description, an interface reference (either RoutedInterface or IRBInterface), and the peer IP address. The resource also supports dynamic neighbors, common BGP settings, and peer-specific configurations.
-
AS Path Options
-
The maximum number of times the global AS number or a local AS number of the BGP instance can appear in any received AS_PATH before it is considered a loop and considered invalid.
default: 0range: 0 to 255 -
Options for removing private AS numbers (2-byte and 4-byte) from the advertised AS path towards all peers.
-
If set to true then do not delete or replace a private AS number that is the same as the peer AS number.
default: false -
If set to true then only delete or replace private AS numbers that appear before the first occurrence of a non-private ASN in the sequence of most recent ASNs in the AS path.
default: false -
The method by which private AS numbers are removed from the advertised AS_PATH attribute.
default: "Disabled"enum: "Disabled", "Replace", "Delete"
-
-
-
Enable or disable Bi-forward Forwarding Detection (BFD) with fast failover.
-
When set to true, all configured and dynamic BGP peers are considered RR clients.
-
Enables route reflect client and sets the cluster ID.
-
Sets the description on the BGP peer
-
When set to true the Interface is added to the dynamic-neighbor list for dynamic peering.
default: false -
The autonomous system numbers allowed from peers if dynamic peering is enabled.
-
Reference to a Policy CR that will be used to filter routes advertised to peers.
-
Enables Graceful Restart on the peer and sets the stale route time in seconds.
range: 1 to 3600 -
Reference to a BGPGroup. When present this BGP peer will be added to the BGP group
-
Reference to a Policy CR that will be used to filter routes received from peers.
-
Reference to a RoutedInterface or IRBInterface resource whose IP will be used as a source IP for the BGP session.
-
InterfaceReference type defines whether the provided Reference is a RoutedInterface or IRBInterface.
enum: "RoutedInterface", "IRBInterface" -
Parameters relating to the IPv4 unicast AFI/SAFI.
-
Enables advertisement of IPv4 Unicast routes with IPv6 next-hops to peers.
-
Enables the IPv4 unicast AFISAFI.
-
Configures the maximum number of IPv4 unicast prefixes that can be received from a BGP peer.
-
Configuration of the maximum number of prefixes that can be accepted from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting only accepted routes.
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be accepted before a warning is logged.
range: 1 to 100
-
-
Configuration of the maximum number of prefixes that can be received from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting all routes (accepted and rejected by import policies).
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be received before a warning is logged.
range: 1 to 100
-
-
-
Enables the advertisement of the RFC 5549 capability to receive IPv4 routes with IPv6 next-hops.
-
-
Parameters relating to the IPv6 unicast AFI/SAFI.
-
Enables the IPv6 unicast AFISAFI
-
Enables advertisement of IPv6 Unicast routes with IPv4 next-hops to peers.
-
Configuration of the maximum number of prefixes that can be accepted from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting only accepted routes.
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be accepted before a warning is logged.
range: 1 to 100
-
-
Configuration of the maximum number of prefixes that can be received from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting all routes (accepted and rejected by import policies).
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be received before a warning is logged.
range: 1 to 100
-
-
-
-
Reference to a Keychain resource that will be used for authentication with the BGP peer.
-
The local autonomous system number advertised to peers.
-
Local Autonomous System number.
range: 1 to 4294967295 -
When set to true, the global ASN value is prepended to the AS path in outbound routes towards each BGP peer.
-
When set to true, the local AS value is prepended to the AS path of inbound routes from each EBGP peer.
-
-
Local Preference attribute added to received routes from the BGP peers, also sets local preference for generated routes.
range: 0 to 4294967295 -
Enable multihop for eBGP peers and sets the maximum number of hops allowed.
range: 1 to 255 -
When set to true, the next-hop in all IPv4-unicast, IPv6-unicast and EVPN BGP routes advertised to the peer is set to the local-address.
-
Node on which to configure the BGP peer. This node must be one of the nodes on which the IRBInterface is configured. When left blank or if the node is not part of the IRBInterface, the peer will not be deployed. Ignored for RoutedInterfaces.
-
Peer IP to which the peering session will be established.
-
When false, all large (12 byte) BGP communities from all outbound routes advertised to the peer are stripped.
-
When false, all standard (4 byte) communities from all outbound routes advertised to the peer are stripped.
-
Options for controlling the generation of default routes towards BGP peers.
-
Enables the sending of a synthetically generated default IPv4 or IPV6 route to each peer.
-
Reference to a Policy that should be applied to the advertised default routes, in order to set their attributes to non-default values.
-
-
Timer configurations
-
The time interval in seconds between successive attempts to establish a session with a peer.
range: 1 to 65535 -
The hold-time interval in seconds that the router proposes to the peer in its OPEN message.
range: 0 to 65535 -
The interval in seconds between successive keepalive messages sent to the peer.
range: 0 to 21845 -
The value assigned to the MinRouteAdvertisementIntervalTimer of RFC 4271, for both EBGP and IBGP sessions, in seconds.
range: 1 to 255
-
STATUS
BGPPeerStatus defines the observed state of BGPPeer
-
Indicated whether the BGP Peer is administratively enabled.
-
Indicates the health score of the BGP peer.
-
Indicates the reason for the health score.
-
The time when the state of the resource last changed.
-
Last event of the BGP peer.
-
Last state of the BGP peer.
-
Hold time negotiated with the BGP peer, in seconds.
-
Keepalive interval negotiated with the BGP peer, in seconds.
-
Operational state of the BGP peer
enum: "Up", "Down", "Degraded", "Unknown" -
Peer AS of the BGP peer.
-
The state of the BGP session.
enum: "Established", "NotEstablished" -
Indicates if the BGP peer is under maintenance.