change doc source for ipv4 mpls vpn

Signed-off-by: Peng Xiao <xiaoquwl@gmail.com>
smartbgp · Jan 20, 2016 · 7d44fcc · 7d44fcc
1 parent 0438104
commit 7d44fcc
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 8 deletions.
diff --git a/README.rst b/README.rst
@@ -29,7 +29,7 @@ Features
 
 -  BGP capabilities support: 4 Bytes ASN, Route Refresh(Cisco Route Refresh), Add Path send/receive;
 
--  Address family support: IPv4 unicast, IPv4 Flowspec(limited),IPv6 unicast;
+-  Address family support: IPv4 unicast, IPv4 Flowspec(limited),IPv6 unicast, IPv4 MPLSVPN;
 
 -  Decode all BGP messages to json format and write files to
    disk(configurable);
@@ -88,12 +88,6 @@ Support
 
 Send email to xiaoquwl@gmail.com, or use GitHub issue system.
 
-TODO
-~~~~
-
--  support more address family (VPNv4, VPNv6, etc.)
--  more unittest
--  others
 
 Contribute
 ~~~~~~~~~~

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -29,7 +29,7 @@ Features
 
 -  BGP capabilities support: 4 Bytes ASN, Route Refresh(Cisco Route Refresh), Add Path send/receive;
 
--  Address family support: IPv4 unicast, IPv6 unicast, IPv4 Flowspec(limited);
+-  Address family support: IPv4 unicast, IPv6 unicast, IPv4 Flowspec(limited), IPv4 VPNv4;
 
 -  Decode all BGP messages to human readable strings and write files to
    disk(configurable);

diff --git a/doc/source/msg_format.rst b/doc/source/msg_format.rst
@@ -350,11 +350,31 @@ In addition to IPv4 Unicast, Now we support IPv6 Unicast and IPv4 Flowspec, here
 ========= ===
 Value     Meaning
 ========= ===
+[1, 128]  IPv4 MPLSVPN
 [1, 133]  IPv4 Flowspec
 [2, 1]    IPv6 Unicast
 ...       ...
 ========= ===
 
+IPv4 MPLSVPN
+""""""""""""
+
+.. code-block:: json
+
+    {
+        "attr":{
+            "14": {
+                "afi_safi": [1, 128],
+                "nexthop": {"rd": "0:0", "str": "2.2.2.2"},
+                "nlri": [
+                    {
+                        "label": [25],
+                        "rd": "100:100",
+                        "rd_type": 0,
+                        "str": "11.11.11.11/32"}]}
+            }
+    }
+
 IPv4 FlowSpec
 """""""""""""
 
@@ -395,6 +415,23 @@ MP_UNREACH_NLRI
 The difference between ``MP_REACH_NLRI`` and ``MP_UNREACH_NLRI`` is that ``MP_UNREACH_NLRI`` only has two keys,
 ``afi_safi`` and ``withdraw``, and there structure is the same.
 
+IPv4 MPLSVPN
+""""""""""""
+
+.. code-block:: json
+
+    {
+        "attr":{
+            "15": {
+                "afi_safi": [1, 128],
+                "withdraw": [
+                    {
+                        "rd": "100:100",
+                        "rd_type": 0,
+                        "str": "11.11.11.11/32"}]}
+            }
+    }
+
 IPv4 FlowSpec
 """""""""""""
 

diff --git a/etc/yabgp/yabgp.ini.sample b/etc/yabgp/yabgp.ini.sample
@@ -54,6 +54,7 @@
 
 # The Global config for address family and sub address family
 # if you want to support more than one address family, you can set afi_safi = ipv4, ipv6, ....
+# we support: ipv4, ipv6, flowspec, vpnv4
 # afi_safi = ipv4
 
 # role tag