github.com/cilium/cilium@v1.16.2/Documentation/network/bgp-control-plane/bgp-control-plane.rst (about)

     1  .. only:: not (epub or latex or html)
     2  
     3      WARNING: You are looking at unreleased Cilium documentation.
     4      Please use the official rendered version released here:
     5      https://docs.cilium.io
     6  
     7  .. _bgp_control_plane:
     8  
     9  Cilium BGP Control Plane
    10  ========================
    11  
    12  BGP Control Plane provides a way for Cilium to advertise routes to connected routers by using the
    13  `Border Gateway Protocol`_ (BGP). BGP Control Plane makes Pod networks and/or Services reachable
    14  from outside the cluster for environments that support BGP. Because BGP
    15  Control Plane does not program the :ref:`datapath <ebpf_datapath>`, do not use it to establish
    16  reachability within the cluster.
    17  
    18  .. admonition:: Video
    19    :class: attention
    20  
    21    For more insights on Cilium's BGP, check out `eCHO episode 101: More BGP fun with Cilium <https://www.youtube.com/watch?v=Tv0R6VxyWhc>`__.
    22  
    23  .. _Border Gateway Protocol: https://datatracker.ietf.org/doc/html/rfc4271
    24  
    25  Prerequisites
    26  -------------
    27  
    28  - If you are using the older MetalLB-based :ref:`bgp` feature, it must be disabled.
    29  
    30  Installation
    31  ------------
    32  
    33  .. tabs::
    34  
    35    .. group-tab:: Helm
    36  
    37          Cilium BGP Control Plane can be enabled with Helm flag ``bgpControlPlane.enabled``
    38          set as true.
    39  
    40          .. parsed-literal::
    41  
    42              $ helm upgrade cilium |CHART_RELEASE| \\
    43                  --namespace kube-system \\
    44                  --reuse-values \\
    45                  --set bgpControlPlane.enabled=true
    46              $ kubectl -n kube-system rollout restart ds/cilium
    47  
    48    .. group-tab:: Cilium CLI
    49  
    50          .. include:: ../../installation/cli-download.rst
    51  
    52          Cilium BGP Control Plane can be enabled with the following command
    53  
    54          .. parsed-literal::
    55  
    56              $ cilium install |CHART_VERSION| --set bgpControlPlane.enabled=true
    57  
    58  IPv4/IPv6 single-stack and dual-stack setup are supported. Note that the BGP
    59  Control Plane can only advertise the route of the address family that the
    60  Cilium is configured to use. You cannot advertise IPv4 routes when the Cilium
    61  Agent is configured to use only IPv6 address family. Conversely, you cannot advertise
    62  IPv6 routes when Cilium Agent is configured to use only IPv4 address family.
    63  
    64  Configuring BGP Control Plane
    65  -----------------------------
    66  
    67  There are two ways to configure the BGP Control Plane. Using legacy ``CiliumBGPPeeringPolicy`` resource,
    68  or using newer BGP resources like ``CiliumBGPClusterConfig``. Currently, both configuration options are
    69  supported, however ``CiliumBGPPeeringPolicy`` will be deprecated in the future.
    70  
    71  .. toctree::
    72      :maxdepth: 2
    73      :glob:
    74  
    75      bgp-control-plane-v2
    76      bgp-control-plane-v1
    77  
    78  Troubleshooting and Operation Guide
    79  -----------------------------------
    80  
    81  .. toctree::
    82      :maxdepth: 2
    83      :glob:
    84  
    85      bgp-control-plane-troubleshooting
    86      bgp-control-plane-operation