Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation: include bgp cli commands in bgp-cp documentation #25691

Merged
merged 1 commit into from
Jun 16, 2023
Merged

Documentation: include bgp cli commands in bgp-cp documentation #25691

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
57 changes: 57 additions & 0 deletions Documentation/network/bgp-control-plane.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,63 @@ When the service has ``externalTrafficPolicy: Local``, ``BGP Control Plane`` kee
of the endpoints for the service on the local node and stops advertisement when there's
no local endpoint.

CLI
---

There are two CLIs available to view cilium BGP peering state. One CLI is present
inside Cilium Agent. The second CLI is the cluster-wide `Cilium CLI <https://github.com/cilium/cilium-cli>`_.

.. warning::

The Cilium CLI is experimental. Consider carefully before using it in production environments!

Cilium Agent CLI
~~~~~~~~~~~~~~~~

The following command shows peering status:

.. code-block:: shell-session

cilium# cilium bgp peers -h
List state of all peers defined in CiliumBGPPeeringPolicy
harsimran-pabla marked this conversation as resolved.
Show resolved Hide resolved

Usage:
cilium bgp peers [flags]

Flags:
-h, --help help for peers
-o, --output string json| yaml| jsonpath='{}'

Global Flags:
--config string Config file (default is $HOME/.cilium.yaml)
-D, --debug Enable debug messages
-H, --host string URI to server-side API


Cilium-CLI
~~~~~~~~~~

Cilium CLI displays the BGP peering status of all nodes.

.. code-block:: shell-session

# cilium-cli bgp peers -h
Gets BGP peering status from all nodes in the cluster
harsimran-pabla marked this conversation as resolved.
Show resolved Hide resolved

Usage:
cilium bgp peers [flags]

Flags:
--agent-pod-selector string Label on cilium-agent pods to select with (default "k8s-app=cilium")
-h, --help help for peers
--node string Node from which BGP status will be fetched, omit to select all nodes
-o, --output string Output format. One of: json, summary (default "summary")
--wait-duration duration Maximum time to wait for result, default 1 minute (default 1m0s)

Global Flags:
--context string Kubernetes configuration context
-n, --namespace string Namespace Cilium is running in (default "kube-system")

Architecture
------------

Expand Down