diff --git a/docs/bgp-policy.md b/docs/bgp-policy.md index 50e955610ad..79dc6230534 100644 --- a/docs/bgp-policy.md +++ b/docs/bgp-policy.md @@ -20,7 +20,7 @@ ## What is BGPPolicy? `BGPPolicy` is a CRD API that allows users to initialize BGP process on selected Kubernetes Nodes and advertise Service -IPs, Pod IPs and Egress IPs to remote BGP peers. +IPs, Pod IPs, and Egress IPs to remote BGP peers. ## Prerequisites @@ -78,11 +78,11 @@ spec: The `nodeSelector` field specifies which Kubernetes Nodes the BGPPolicy applies to based on the labels specified. If `nodeSelector` is empty, no Node will be selected. The field is mandatory. -**Note**: If multiple BGPPolicy objects select a Node, the effective one will be selected randomly. +**Note**: If multiple BGPPolicy objects select a Node, the effective one will be chosen randomly. ### LocalASN -The `localASN` field defines the Autonomous System Number (ASN) used by the local BGP process. The available private ASN +The `localASN` field defines the Autonomous System Number (ASN) the local BGP process uses. The available private ASN range is 64512-65535. The field is mandatory. ### ListenPort @@ -104,11 +104,11 @@ The `bgpPeers` field lists the BGP peers to which the advertisements are sent. - `address`: The IP address on which the BGP peer listens. - `asn`: The Autonomous System Number of the BGP peer. -- `port`: The port number on which the BGP peer listens. Default is 179. +- `port`: The port number on which the BGP peer listens. The default value is 179. - `multihopTTL`: The Time To Live (TTL) value used in BGP packets sent to the BGP peer, with a range of 1 to 255. - Default is 1. + The default value is 1. - `gracefulRestartTimeSeconds`: Specifies how long the BGP peer waits for the BGP session to re-establish after a - restart before deleting stale routes, with a range of 1 to 3600 seconds. Default is 120 seconds. + restart before deleting stale routes, with a range of 1 to 3600 seconds. The default value is 120 seconds. ## Usage examples