Skip to content

Commit

Permalink
Improved BGP docs on MD5
Browse files Browse the repository at this point in the history
Update Documentation/network/bgp-control-plane.rst

Co-authored-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Nico Vibert <nicolas.vibert@isovalent.com>
  • Loading branch information
2 people authored and pull[bot] committed Mar 5, 2024
1 parent bb7b82b commit b4c3e10
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions Documentation/network/bgp-control-plane.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ The policy in ``yaml`` form is defined below:
neighbors: # []CiliumBGPNeighbor
- peerAddress: 'fc00:f853:ccd:e793::50/128'
peerASN: 64512
authSecretRef: secretname
eBGPMultihopTTL: 10
connectRetryTimeSeconds: 120
holdTimeSeconds: 90
Expand Down Expand Up @@ -314,7 +315,7 @@ An example of creating a secret is:

.. code-block:: shell-session
# kubectl create secret generic -n cilium-bgp-secrets --type=string secretName --from-literal=password=my-secret-password
$ kubectl create secret generic -n cilium-bgp-secrets --type=string secretname --from-literal=password=my-secret-password
Because TCP MD5 passwords sign the header of the packet they cannot be used if
the session will be address translated by Cilium (i.e. the Cilium Agent's pod
Expand All @@ -326,6 +327,10 @@ Cilium Agent's logs rather than a more specific error message.

.. _RFC-2385 : https://www.rfc-editor.org/rfc/rfc2385.html

If a ``CiliumBGPPeeringPolicy`` is deployed with an ``authSecretRef`` that Cilium cannot find, the BGP session will use an empty password and the agent will log an error such as in the following example::

level=error msg="Failed to fetch secret \"secretname\": not found (will continue with empty password)" component=manager.fetchPeerPassword subsys=bgp-control-plane

Graceful Restart
''''''''''''''''
The Cilium BGP control plane can be configured to act as a graceful restart
Expand Down Expand Up @@ -607,7 +612,7 @@ Cilium CLI displays the BGP peering status of all nodes.

.. code-block:: shell-session
# cilium bgp peers -h
$ cilium bgp peers -h
Gets BGP peering status from all nodes in the cluster
Usage:
Expand Down

0 comments on commit b4c3e10

Please sign in to comment.