diff --git a/content/docs/main/docs/api-reference.html b/content/docs/main/docs/api-reference.html index 1c51ac9f..0ca15e49 100644 --- a/content/docs/main/docs/api-reference.html +++ b/content/docs/main/docs/api-reference.html @@ -2784,12 +2784,139 @@

TLSProtocol

crd.antrea.io/v1alpha1

Resource Types: +

BGPPolicy +

+

+

BGPPolicy defines BGP configuration applied to Nodes.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string
+ +crd.antrea.io/v1alpha1 + +
+kind
+string +
BGPPolicy
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +
+

Standard metadata of the object.

+Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +BGPPolicySpec + + +
+
+
+ + + + + + + + + + + + + + + + + + + + + +
+nodeSelector
+ + +Kubernetes meta/v1.LabelSelector + + +
+

NodeSelector selects Nodes to which the BGPPolicy is applied. If multiple BGPPolicies select a Node, only one +will be effective and enforced; others serve as alternatives.

+
+localASN
+ +int32 + +
+

LocalASN is the AS number used by the BGP process. The available private AS number range is 64512-65535.

+
+listenPort
+ +int32 + +
+

ListenPort is the port on which the BGP process listens, and the default value is 179.

+
+advertisements
+ + +Advertisements + + +
+

Advertisements configures IPs or CIDRs to be advertised to BGP peers.

+
+bgpPeers
+ + +[]BGPPeer + + +
+

BGPPeers is the list of BGP peers.

+
+

ExternalNode

@@ -3091,6 +3218,221 @@

SupportBundleCollection +

Advertisements +

+

+(Appears on: +BGPPolicySpec) +

+

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+service
+ + +ServiceAdvertisement + + +
+

Service specifies how to advertise Service IPs.

+
+pod
+ + +PodAdvertisement + + +
+

Pod specifies how to advertise Pod IPs. Currently, if this is set, NodeIPAM Pod CIDR instead of specific Pods IPs +will be advertised since pod selector is not added yet.

+
+egress
+ + +EgressAdvertisement + + +
+

Egress specifies how to advertise Egress IPs. Currently, if this is set, all Egress IPs will be advertised since +Egress selector is not added yet.

+
+

BGPPeer +

+

+(Appears on: +BGPPolicySpec) +

+

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+address
+ +string + +
+

The IP address on which the BGP peer listens.

+
+port
+ +int32 + +
+

The port number on which the BGP peer listens. The default value is 179, the well-known port of BGP protocol.

+
+asn
+ +int32 + +
+

The AS number of the BGP peer.

+
+multihopTTL
+ +int32 + +
+

The Time To Live (TTL) value used in BGP packets sent to the BGP peer. The range of the value is from 1 to 255, +and the default value is 1.

+
+gracefulRestartTimeSeconds
+ +int32 + +
+

GracefulRestartTimeSeconds specifies how long the BGP peer would wait for the BGP session to re-establish after +a restart before deleting stale routes. The range of the value is from 1 to 3600, and the default value is 120.

+
+

BGPPolicySpec +

+

+(Appears on: +BGPPolicy) +

+

+

BGPPolicySpec defines the specification for a BGPPolicy.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+nodeSelector
+ + +Kubernetes meta/v1.LabelSelector + + +
+

NodeSelector selects Nodes to which the BGPPolicy is applied. If multiple BGPPolicies select a Node, only one +will be effective and enforced; others serve as alternatives.

+
+localASN
+ +int32 + +
+

LocalASN is the AS number used by the BGP process. The available private AS number range is 64512-65535.

+
+listenPort
+ +int32 + +
+

ListenPort is the port on which the BGP process listens, and the default value is 179.

+
+advertisements
+ + +Advertisements + + +
+

Advertisements configures IPs or CIDRs to be advertised to BGP peers.

+
+bgpPeers
+ + +[]BGPPeer + + +
+

BGPPeers is the list of BGP peers.

+

BundleExternalNodes

@@ -3276,6 +3618,14 @@

BundleServerAuthType

BundleServerAuthType defines the authentication type to access the BundleFileServer.

+

EgressAdvertisement +

+

+(Appears on: +Advertisements) +

+

+

ExternalNodeSpec

@@ -3534,6 +3884,54 @@

NodeLatencyMonitorSpec +

PodAdvertisement +

+

+(Appears on: +Advertisements) +

+

+

+

ServiceAdvertisement +

+

+(Appears on: +Advertisements) +

+

+

+ + + + + + + + + + + + + +
FieldDescription
+ipTypes
+ + +[]ServiceIPType + + +
+

IPTypes specifies the types of Service IPs from the selected Services to be advertised. Currently, all Services +will be selected since Service selector is not added yet.

+
+

ServiceIPType +(string alias)

+

+(Appears on: +ServiceAdvertisement) +

+

+

SupportBundleCollectionCondition

@@ -11363,5 +11761,5 @@

BundleStatus

Generated with gen-crd-api-reference-docs -on git commit 25899c3. +on git commit 28b38ad.