all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Stefan Lendl <s.lendl@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH v2 pve-docs 4/6] sdn: Controllers
Date: Fri, 17 Nov 2023 14:55:29 +0100	[thread overview]
Message-ID: <20231117135531.3198353-5-s.lendl@proxmox.com> (raw)
In-Reply-To: <20231117135531.3198353-1-s.lendl@proxmox.com>

Signed-off-by: Stefan Lendl <s.lendl@proxmox.com>
---
 pvesdn.adoc | 56 +++++++++++++++++++++++++++++------------------------
 1 file changed, 31 insertions(+), 25 deletions(-)

diff --git a/pvesdn.adoc b/pvesdn.adoc
index c4b77f0..73d3dee 100644
--- a/pvesdn.adoc
+++ b/pvesdn.adoc
@@ -336,36 +336,41 @@ DNS Zone Prefix:: Add a prefix to the domain registration, like
 
 [[pvesdn_config_controllers]]
 Controllers
------------
+-------------
+
+Some zones implement a separated control and data plane that require an external
+external controller to manage the VNet's control plane.
+
+Currently, only the `EVPN` zone requires an external controller.
 
-Some zone types need an external controller to manage the VNet control-plane.
-Currently this is only required for the `bgp-evpn` zone plugin.
 
 [[pvesdn_controller_plugin_evpn]]
 EVPN Controller
-~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~
 
-For `BGP-EVPN`, we need a controller to manage the control plane.
-The currently supported software controller is the "frr" router.
-You may need to install it on each node where you want to deploy EVPN zones.
+The `EVPN`, zone requires an external controller to manage the control plane.
+The EVPN controller plugin configures the Free Range Routing (frr) router.
+
+To enable the EVPN controller, you need to install frr on every node that shall
+participate in the EVPN zone.
 
 ----
 apt install frr frr-pythontools
 ----
 
-Configuration options:
+EVPN controller configuration options:
 
-asn:: A unique BGP ASN number. It's highly recommended to use a private ASN
+ASN #:: A unique BGP ASN number. It's highly recommended to use a private ASN
   number (64512 – 65534, 4200000000 – 4294967294), as otherwise you could end up
   breaking global routing by mistake.
 
-peers:: An IP list of all nodes where you want to communicate for the EVPN
-  (could also be external nodes or route reflectors servers)
+Peers:: An IP list of all nodes that are part of the EVPN zone.  (could also be
+  external nodes or route reflector servers)
 
 
 [[pvesdn_controller_plugin_BGP]]
 BGP Controller
-~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~
 
 The BGP controller is not used directly by a zone.
 You can use it to configure FRR to manage BGP peers.
@@ -376,20 +381,20 @@ It can also be used to export EVPN routes to an external BGP peer.
 NOTE: By default, for a simple full mesh EVPN, you don't need to define a BGP
 controller.
 
-Configuration options:
+BGP controller configuration options:
 
-node:: The node of this BGP controller
+Node:: The node of this BGP controller
 
-asn:: A unique BGP ASN number. It's highly recommended to use a private ASN
+ASN #:: A unique BGP ASN number. It's highly recommended to use a private ASN
   number in the range (64512 - 65534) or (4200000000 - 4294967294), as otherwise
   you could break global routing by mistake.
 
-peers:: A list of peer IP addresses you want to communicate with using the
+Peer:: A list of peer IP addresses you want to communicate with using the
   underlying BGP network.
 
-ebgp:: If your peer's remote-AS is different, this enables EBGP.
+EBGP:: If your peer's remote-AS is different, this enables EBGP.
 
-loopback:: Use a loopback or dummy interface as the source of the EVPN network
+Loopback Interface:: Use a loopback or dummy interface as the source of the EVPN network
   (for multipath).
 
 ebgp-mutltihop:: Increase the number of hops to reach peers, in case they are
@@ -403,21 +408,22 @@ ISIS Controller
 ~~~~~~~~~~~~~~~
 
 The ISIS controller is not used directly by a zone.
-You can use it to configure FRR to export evpn routes to an ISIS domain.
+You can use it to configure FRR to export EVPN routes to an ISIS domain.
 
-Configuration options:
+ISIS controller configuration options:
 
-node:: The node of this ISIS controller.
+Node:: The node of this ISIS controller.
 
-domain:: A unique ISIS domain.
+Domain:: A unique ISIS domain.
 
-network entity title:: A Unique ISIS network address that identifies this node.
+Network Entity Title:: A Unique ISIS network address that identifies this node.
 
-interfaces:: A list of physical interface(s) used by ISIS.
+Interfaces:: A list of physical interface(s) used by ISIS.
 
-loopback:: Use a loopback or dummy interface as the source of the EVPN network
+Loopback:: Use a loopback or dummy interface as the source of the EVPN network
   (for multipath).
 
+
 [[pvesdn_config_ipam]]
 IPAMs
 -----
-- 
2.42.0





  parent reply	other threads:[~2023-11-17 13:56 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-17 13:55 [pve-devel] [PATCH v2 pve-docs 0/6] sdn: Documentation Stefan Lendl
2023-11-17 13:55 ` [pve-devel] [PATCH v2 pve-docs 1/6] sdn: installation, overview and main configuration Stefan Lendl
2023-11-17 13:55 ` [pve-devel] [PATCH v2 pve-docs 2/6] sdn: Zones Stefan Lendl
2023-11-17 13:55 ` [pve-devel] [PATCH v2 pve-docs 3/6] sdn: VNets and Subnets Stefan Lendl
2023-11-17 13:55 ` Stefan Lendl [this message]
2023-11-17 13:55 ` [pve-devel] [PATCH v2 pve-docs 5/6] sdn: IPAM Stefan Lendl
2023-11-17 13:55 ` [pve-devel] [PATCH v2 pve-docs 6/6] sdn: Examples Stefan Lendl
2023-11-18 16:51 ` [pve-devel] [PATCH v2 pve-docs 0/6] sdn: Documentation Thomas Lamprecht
2023-11-20  8:48 ` [pve-devel] applied: " Thomas Lamprecht

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20231117135531.3198353-5-s.lendl@proxmox.com \
    --to=s.lendl@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal