Docs: Update BGP docs to reflect CRD consolidation

Signed-off-by: Rastislav Szabo <rastislav.szabo@isovalent.com>
cilium · Jun 16, 2023 · 5a7620f · 5a7620f
1 parent f7553a2
commit 5a7620f
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 10 deletions.
diff --git a/Documentation/network/bgp-control-plane.rst b/Documentation/network/bgp-control-plane.rst
@@ -78,12 +78,12 @@ The policy in ``yaml`` form is defined below:
        - peerAddress: 'fc00:f853:ccd:e793::50/128'
          peerASN: 64512
          eBGPMultihopTTL: 10
-         connectRetryTime: "120s"
-         holdTime: "90s"
-         keepAliveTime: "30s"
+         connectRetryTimeSeconds: 120
+         holdTimeSeconds: 90
+         keepAliveTimeSeconds: 30
          gracefulRestart:
-            enabled: true
-            restartTime: "20s"
+           enabled: true
+           restartTimeSeconds: 120
 
 Fields
 ^^^^^^
@@ -104,12 +104,12 @@ Fields
            neighbors[*].peerAddress: The address of the peer neighbor
            neighbors[*].peerPort: Optional TCP port number of the neighbor. 1-65535 are valid values and defaults to 179 when unspecified.
            neighbors[*].peerASN: The ASN of the peer
-           neighbors[*].eBGPMultihopTTL: (optional) Time To Live (TTL) value used in BGP packets. 0 if eBGP multi-hop feature is disabled.
-           neighbors[*].connectRetryTime: Initial value for the BGP ConnectRetryTimer (RFC 4271, Section 8). Defaults to 120 seconds.
-           neighbors[*].holdTime: Initial value for the BGP HoldTimer (RFC 4271, Section 4.2). Defaults to 90 seconds.
-           neighbors[*].keepAliveTime: Initial value for the BGP KeepaliveTimer (RFC 4271, Section 8). Defaults to 1/3 of the HoldTime.
+           neighbors[*].eBGPMultihopTTL: Time To Live (TTL) value used in BGP packets. The value 1 implies that eBGP multi-hop feature is disabled.
+           neighbors[*].connectRetryTimeSeconds: Initial value for the BGP ConnectRetryTimer (RFC 4271, Section 8). Defaults to 120 seconds.
+           neighbors[*].holdTimeSeconds: Initial value for the BGP HoldTimer (RFC 4271, Section 4.2). Defaults to 90 seconds.
+           neighbors[*].keepAliveTimeSeconds: Initial value for the BGP KeepaliveTimer (RFC 4271, Section 8). Defaults to 30 seconds.
            neighbors[*].gracefulRestart.enabled: The flag to enable graceful restart capability.
-           neighbors[*].gracefulRestart.restartTime: The restart time advertised to the peer (RFC 4724 section 4.2).
+           neighbors[*].gracefulRestart.restartTimeSeconds: The restart time advertised to the peer (RFC 4724 section 4.2).
 
 .. note::
 

diff --git a/pkg/bgpv1/README.md b/pkg/bgpv1/README.md
@@ -39,6 +39,13 @@ spec: # CiliumBGPPeeringPolicySpec
    neighbors: # []CiliumBGPNeighbor
     - peerAddress: 'fc00:f853:ccd:e793::50/128'
       peerASN: 64512
+      eBGPMultihopTTL: 10
+      connectRetryTimeSeconds: 120
+      holdTimeSeconds: 90
+      keepAliveTimeSeconds: 30
+      gracefulRestart:
+        enabled: true
+        restartTimeSeconds: 120
 ```
 
 #### Fields
@@ -55,6 +62,12 @@ nodeSelector: Nodes which are selected by this label selector will apply the giv
 		neighbors[*].peerAddress: The address of the peer neighbor
 		neighbors[*].peerPort: Optional TCP port number of the neighbor. 1-65535 are valid values and defaults to 179 when unspecified.
 		neighbors[*].peerASN: The ASN of the peer	
+		neighbors[*].eBGPMultihopTTL: Time To Live (TTL) value used in BGP packets. The value 1 implies that eBGP multi-hop feature is disabled.
+		neighbors[*].connectRetryTimeSeconds: Initial value for the BGP ConnectRetryTimer (RFC 4271, Section 8). Defaults to 120 seconds.
+		neighbors[*].holdTimeSeconds: Initial value for the BGP HoldTimer (RFC 4271, Section 4.2). Defaults to 90 seconds.
+		neighbors[*].keepAliveTimeSeconds: Initial value for the BGP KeepaliveTimer (RFC 4271, Section 8). Defaults to 30 seconds.
+		neighbors[*].gracefulRestart.enabled: The flag to enable graceful restart capability.
+		neighbors[*].gracefulRestart.restartTimeSeconds: The restart time advertised to the peer (RFC 4724 section 4.2).
 ```
 
 *Note*: *Setting unique configuration details of a particular instantiated virtual router on a particular Cilium node is explained in [Virtual Router Attributes](#Virtual Router Attributes)*