← Back to index Esc
Kind
Bgppeer
Group
metallb.io
Version
v1beta2
apiVersion: metallb.io/v1beta2 kind: Bgppeer metadata: name: example
View raw schema
apiVersion string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind string
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata object
spec object
BGPPeerSpec defines the desired state of Peer.
bfdProfile string
The name of the BFD Profile to be used for the BFD session associated to the BGP session. If not set, the BFD session won't be set up.
connectTime string
Requested BGP connect time, controls how long BGP waits between connection attempts to a neighbor.
disableMP boolean
To set if we want to disable MP BGP that will separate IPv4 and IPv6 route exchanges into distinct BGP sessions. Deprecated: DisableMP is deprecated in favor of dualStackAddressFamily.
dualStackAddressFamily boolean
To set if we want to enable the neighbor not only for the ipfamily related to its session, but also the other one. This allows to advertise/receive IPv4 prefixes over IPv6 sessions and vice versa.
dynamicASN string
DynamicASN detects the AS number to use for the remote end of the session without explicitly setting it via the ASN field. Limited to: internal - if the neighbor's ASN is different than MyASN connection is denied. external - if the neighbor's ASN is the same as MyASN the connection is denied. ASN and DynamicASN are mutually exclusive and one of them must be specified.
enum: internal, external
ebgpMultiHop boolean
To set if the BGPPeer is multi-hops away. Needed for FRR mode only.
enableGracefulRestart boolean
EnableGracefulRestart allows BGP peer to continue to forward data packets along known routes while the routing protocol information is being restored. This field is immutable because it requires restart of the BGP session. Supported for FRR mode only.
holdTime string
Requested BGP hold time, per RFC4271.
interface string
Interface is the node interface over which the unnumbered BGP peering will be established. No API validation takes place as that string value represents an interface name on the host and if user provides an invalid value, only the actual BGP session will not be established. Address and Interface are mutually exclusive and one of them must be specified.
keepaliveTime string
Requested BGP keepalive time, per RFC4271.
myASN integer required
AS number to use for the local end of the session.
format: int32
minimum: 0
maximum: 4.294967295e+09
nodeSelectors []object
Only connect to this peer on nodes that match one of these selectors.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key string required
key is the label key that the selector applies to.
operator string required
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values []string
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
password string
Authentication password for routers enforcing TCP MD5 authenticated sessions
passwordSecret object
passwordSecret is name of the authentication secret for BGP Peer. the secret must be of type "kubernetes.io/basic-auth", and created in the same namespace as the MetalLB deployment. The password is stored in the secret as the key "password".
name string
name is unique within a namespace to reference a secret resource.
namespace string
namespace defines the space within which the secret name must be unique.
peerASN integer
AS number to expect from the remote end of the session. ASN and DynamicASN are mutually exclusive and one of them must be specified.
format: int32
minimum: 0
maximum: 4.294967295e+09
peerAddress string
Address to dial when establishing the session.
peerPort integer
Port to dial when establishing the session.
minimum: 1
maximum: 16384
routerID string
BGP router ID to advertise to the peer
sourceAddress string
Source address to use when establishing the session.
vrf string
To set if we want to peer with the BGPPeer using an interface belonging to a host vrf
status object
BGPPeerStatus defines the observed state of Peer.
Copied!