From 3ea9acb9e4e1ce5858fc97617fd1ab0fd8272eeb Mon Sep 17 00:00:00 2001 From: Peng Xiao Date: Fri, 29 Jan 2016 11:37:03 +0800 Subject: [PATCH] changed doc index page Signed-off-by: Peng Xiao --- doc/source/feature.rst | 36 ++++++++++++++++++++++++++++ doc/source/index.rst | 53 +++++------------------------------------- 2 files changed, 42 insertions(+), 47 deletions(-) create mode 100644 doc/source/feature.rst diff --git a/doc/source/feature.rst b/doc/source/feature.rst new file mode 100644 index 0000000..018118f --- /dev/null +++ b/doc/source/feature.rst @@ -0,0 +1,36 @@ +Features +======== + +- It can establish BGP session based on IPv4 address (TCP Layer) in + active mode(as TCP client); + +- Support TCP MD5 authentication(IPv4 and does not support Windows + now); + +- 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 + + - IPv4 MPLSVPN + + - EVPN (partially supported) + +- Decode all BGP messages to json format and write them into files in local disk(configurable); + +- Support basic RESTFUL API for getting running information and sending BGP messages. + +- Platform support: Linux/Unix(recommended), Mac OS and Windows. + +.. note:: + + yabgp is a light weight BGP agent used for connecting network devices. It only can be + TCP client in one BGP peering connection and can't send any update messages by itself(send through REST API). + We recommend that each yabgp process connect only one BGP neighbor, so each process is independent with each other, + we can start many yabgp processes within the same machine or in different machines. There can be a central controller + which can controll all yabgp processes through REST API to send BGP update messages. \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index 121281e..16edc6e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -14,58 +14,14 @@ future analysis. Support sending BGP messages(route refresh/update) to the peer through RESTful API. YABGP can't send any BGP update messages by itself, it's just a agent, so there can be many agents and they can be controlled by a contoller. -We write it in strict accordance with the specifications of RFCs. -This software can be used on Linux/Unix, Mac OS and Windows systems. - -Features -======== - -- It can establish BGP session based on IPv4 address (TCP Layer) in - active mode(as TCP client); - -- Support TCP MD5 authentication(IPv4 and does not support Windows - now); - -- 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 - - - IPv4 MPLSVPN - - - EVPN (partially supported) - -- Decode all BGP messages to json format and write them into files in local disk(configurable); - -- Support basic RESTFUL API for getting running information and sending BGP messages. - -.. note:: - - yabgp is a light weight BGP agent used for connecting network devices. It only can be - TCP client in one BGP peering connection and can't send any update messages by itself(send through REST API). - We recommend that each yabgp process connect only one BGP neighbor, so each process is independent with each other, - we can start many yabgp processes within the same machine or in different machines. There can be a central controller - which can controll all yabgp processes through REST API to send BGP update messages. - -Application -=========== - -There are many jobs need to do in future. - -We are working hardly on that. So any of your ideas is welcome. - -Quickstarts -=========== +Table of Contents +================= .. toctree:: :maxdepth: 2 + feature install tutorial msg_format @@ -76,6 +32,9 @@ Quickstarts Support ======= +There are many jobs need to do in future. +We are working hardly on that. So any of your ideas is welcome. + Please use GitHub issue system or submit pull request.