Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
Signed-off-by: Peng Xiao <[email protected]>
  • Loading branch information
xiaopeng163 committed Dec 10, 2015
1 parent 32fb67c commit f45623d
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
23 changes: 14 additions & 9 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,13 @@ YABGP Project

YABGP is a yet another Python implementation for BGP Protocol. It can be used to establish BGP connections with all kinds
of routers (include real Cisco/HuaWei/Juniper routers and some router
simulators like Cisco's IOL/IOU, Junipers' JUOS, and GNS3) and receive/parse BGP messages for
future analysis. Now we open sourced it.
simulators like GNS3) and receive/parse BGP messages for
future analysis.

We write it accordance with the specifications of RFCs.
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.

Expand All @@ -24,20 +27,22 @@ Features
- Support TCP MD5 authentication(IPv4 and does not support Windows
now);

- BGP capabilities support: 4 Bytes ASN, IPv4 address family, Route
Refresh(Cisco Route Refresh);
- BGP capabilities support: 4 Bytes ASN, Route Refresh(Cisco Route Refresh), Add Path send/receive;

- Address family support: IPv4 unicast, IPv4 Flowspec(limited);

- Decode all BGP messages to human readable strings and write files to
disk(configurable);

- Support basic RESTFUL API.
- 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 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.
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
===========
Expand Down
3 changes: 2 additions & 1 deletion doc/source/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ If you change the default setting (like change the ``write_dir``), please start

.. code:: bash
$ yabgpd --bgp-local_addr=10.75.44.11 --bgp-local_as=23650 --bgp-remote_addr=10.124.1.245 --bgp-remote_as=23650 --bgp-md5=cisco --config-file=yabgp.ini
$ cp etc/yabgp/yabgp.ini.sample etc/yabgp/yabgp.ini
$ yabgpd --bgp-local_addr=10.75.44.11 --bgp-local_as=23650 --bgp-remote_addr=10.124.1.245 --bgp-remote_as=23650 --bgp-md5=cisco --config-file=../etc/yabgp/yabgp.ini
Running Mode
~~~~~~~~~~~~
Expand Down

0 comments on commit f45623d

Please sign in to comment.