summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorKevin Kirsche <kevin.kirsche@one.verizon.com>2019-08-27 15:26:56 -0400
committerKevin Kirsche <kevin.kirsche@one.verizon.com>2019-08-27 15:36:48 -0400
commitbf2df3ec6f5fb419dd5ba66d15e16d91decb264c (patch)
tree0adb358940b6aa0aa606373481cb3d7ab9d9d641 /docs
parent2682343deac42e6384f915dd5a1cde0154508019 (diff)
Add BGP Confederation documentation
Fix #2146
Diffstat (limited to 'docs')
-rw-r--r--docs/sources/bgp-confederation.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/sources/bgp-confederation.md b/docs/sources/bgp-confederation.md
new file mode 100644
index 00000000..884ed846
--- /dev/null
+++ b/docs/sources/bgp-confederation.md
@@ -0,0 +1,37 @@
+# BGP Confederation
+
+This page explains how to configure BGP confederation feature when BGP peers
+are part of a larger mesh representing a single autonomous system (AS).
+
+## Prerequisites
+
+Assume you finished [Getting Started](getting-started.md).
+
+## Contents
+
+- [Configuration](#configuration)
+
+## Configuration
+
+If AS30 is a confederation composed of AS65001 and AS65002, the confederation members must configure
+the following attributes to ensure GoBGP communicates in the correct manner with other member ASNs.
+Each confederated autonomous systems must configure the `[global.confederation.config]` with
+`enabled = true` and `identifier = 30`. The identifier parameter is used to designate what the
+confederation should present as it's ASN non-confederation members. Each member of the confederation
+must also configure `member-as-list` with a list of other ASNs which compose the confederation. For
+example, AS65001 would configure this attribute as `member-as-list = [ 65002 ]`.
+
+```toml
+[global.config]
+as = 65001
+router-id = "10.0.0.1"
+ [confederation.config]
+ enabled = true
+ identifier = 30
+ member-as-list = [ 65002 ]
+
+[[neighbors]]
+ [neighbors.config]
+ peer-as = 65002
+ neighbor-address = "10.0.0.2"
+```