summaryrefslogtreecommitdiffhomepage
path: root/docs
AgeCommit message (Collapse)Author
2018-12-25docs: fix outdated comment of the gRPC API examplesFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
2018-12-24docs: delete outdated java/nodejs/ruby gRPC API examplesFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
2018-12-24docs: update C++ gRPC API exampleFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
2018-12-24docs: update python gRPC API exampleFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
2018-11-16api: rename NlriAny in api.Path to NlriFUJITA Tomonori
Also rename PathAttrsAny to PathAttrs. Both are the first choice rather than the binary format members. Support SortType member to ListPathRequest to add an option to return unordered paths. Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2018-11-12server: change monitor API designFUJITA Tomonori
https://github.com/osrg/gobgp/issues/1763#issuecomment-437594975 Follow Chris's proposal; consistent with the rest of the APIs. Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2018-11-09make gRPC server privateFUJITA Tomonori
No need to be exported. Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2018-11-09docs/lib.md: add PeerMonitor APIFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2018-08-28api: change FamilyFUJITA Tomonori
fixes #1812 Avoid the cast and use strightforward data strcuture; two variables for afi and safi instead of squashing two into one variable. Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2018-08-10fix library usage exampleFUJITA Tomonori
also enable the CI for it again. Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2018-07-14cmd: implement ebgp-multihop-ttl option when add neighborchenhaiq@yunify.com
Signed-off-by: Chen Haiquan <oc@yunify.com>
2018-07-06api: decrease the dependencyFUJITA Tomonori
move grpc_server.go to server/ Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2018-06-13table: support AfiSafiIn Policy Condition matchMarcin Ptaszyński
2018-06-05table: support nexthop match policyurban
2018-05-10config: Enable to configure VRF via config fileIWASE Yusuke
This patch enables to configure VRF tables by using config file. This feature is useful when using VRF-Neighbor feature. Example of Usage: ```toml [[vrfs]] [vrfs.config] name = "vrf1" id = 1 rd = "65000:100" both-rt-list = ["65000:100"] ``` Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2018-05-08gobgp/cmd: add router-mac option for BGP EVPN Type 2Paul Greenberg
The `router-mac` option in `gobgp` CLI allows sending Router's MAC Extended Community via BGP EVPN Type 2 and Type 5 advertisements. As explained in below RFC draft, this community is used to carry the MAC address of the VTEP where MAC-IP pair resides. More info: For example, GoBGP router (R1) peers with Cisco router (R2). R1 is used by an orchestraction platform, e.g. OpenStack, Docker Swarm, etc., to advertise container MAC-IP bindings. When R1 advertises the binding it also sets next hop for the route as the host where the MAC-IP binding (i.e. container) resides. When R2 receives the route, it will not install it unless Router's MAC Extended Community is present. R2 will use the MAC address in the community to create an entry in MAC address table of R2 pointint to NVE interface. ``` gobgp global rib -a evpn add macadv e9:72:d7:aa:1f:b4 \ 172.16.100.100 etag 0 label 34567 rd 10.1.1.1:100 \ rt 65001:100 encap vxlan nexthop 10.10.10.10 \ origin igp router-mac e9:72:d7:aa:1f:b4 gobgp global rib -a evpn add nexthop 10.10.10.10 origin igp \ prefix 172.16.100.100/32 esi 0 etag 0 rd 10.1.1.1:100 \ rt 65001:100 gw 10.10.10.10 label 34567 encap vxlan \ router-mac e9:72:d7:aa:1f:b4 ``` In the above example, a host with IP of `10.10.10.10` runs a container connected to an Open vSwitch instance. The container's IP address is `172.16.100.100` and MAC address `e9:72:d7:aa:1f:b4`. The Open vSwitch is VTEP with `tunnel_key=34567`, i.e. VNID `34567`. GoBGP (R1) and Cisco (R2) routers are in BGP AS 65001. R1's IP is `10.1.1.1`. R2 used RT of `65001:100` to import routes and place them into appropriate VRF. In this case the VRF is associated with L2VNI from VLAN 300. Upon the receipt of the above BGP EVPN Type 2 and Type 5 routes, R2 will create create a MAC address entry pointing to it's NVE interface with destination IP address of `10.10.10.10`. ``` Legend: * - primary entry, G - Gateway MAC, (R) - Routed MAC, O - Overlay MAC age - seconds since last seen,+ - primary entry using vPC Peer-Link, (T) - True, (F) - False, C - ControlPlane MAC VLAN MAC Address Type age Secure NTFY Ports ---------+-----------------+--------+---------+------+----+------------------ * 300 e972.d7aa.1fb4 static - F F nve1(10.10.10.10) ``` The R2 will use the `router-mac e9:72:d7:aa:1f:b4` as the destination MAC address of the inner VXLAN packet. For example, an underlay host `20.20.20.20` ping the container. The inner VXLAN L2 destination address is `e9:72:d7:aa:1f:b4`. The inner VXLAN L2 source address is R2's MAC. The outer VXLAN L3 source address, i.e. `10.2.2.2` is R2' NVE address. ``` OUTER VXLAN L2: 10:20:08:d0:ff:23 > b2:0e:19:6a:8d:51 OUTER VXLAN L3: 10.2.2.2.45532 > 10.10.10.10.4789: VXLAN, flags [I] (0x08), vni 34567 INNER VXLAN L2: 4e:f4:ca:aa:f6:7b > e9:72:d7:aa:1f:b4 INNER VXLAN L3: 20.20.20.20 > 172.16.100.100: ICMP echo reply, id 66, seq 1267, length 64 ``` See also: https://tools.ietf.org/html/draft-sajassi-l2vpn-evpn-inter-subnet-forwarding-05#section-6.1 Signed-off-by: Paul Greenberg <greenpau@outlook.com>
2018-05-07docs: update policy about route server setupFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2018-04-02*.md: Improvements for markdownlintIWASE Yusuke
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2018-02-25docs: update gettting-startedFUJITA Tomonori
The way to install GoBGP is outdated. README tells how so let's remove. Also bash completion scripts haven't be updated for long time so let's remove too. [ci skip] Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2018-02-16cli: Support to advertise PMSI Tunnel AttributeIWASE Yusuke
This patch enables "gobgp" command to advertise the PMSI Tunnel Attribute which is appended to the EVPN Inclusive Multicast Ethernet Tag routes for example. Usage Example: $ gobgp global rib -a evpn add multicast 10.0.0.1 etag 10 rd 65000:100 pmsi ingress-repl 100 1.1.1.1 $ gobgp global rib -a evpn Network Labels Next Hop AS_PATH Age Attrs *> [type:multicast][rd:65000:100][etag:10][ip:10.0.0.1] 0.0.0.0 00:00:00 [{Origin: ?} {Pmsi: type: ingress-repl, label: 100, tunnel-id: 1.1.1.1}] Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2018-01-19docs: fix typo in READMEDennis Durling
is, not in
2018-01-18zebra.md: Description for supported version of FRRoutingIWASE Yusuke
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2018-01-18zebra.md: Update for Markdown linterIWASE Yusuke
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2018-01-12cli-command-syntax: Update desc for "monitor" commandIWASE Yusuke
This patch adds a section for "monitor adj-in" command and updates syntax and output examples for other "monitor" sub commands. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-12-30evpn.md: Add description and examples for ESIIWASE Yusuke
Also this patch updates table of contents. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-12-30cli: Support EVPN Default Gateway Extended CommunityIWASE Yusuke
This patch enables to support the Default Gateway Extended Community on the EVPN MAC/IP Advertisement route. Usage Example: $ gobgp global rib -a evpn add macadv aa:bb:cc:dd:ee:ff 10.0.0.1 etag 10 label 20,30 rd 1.1.1.1:65000 default-gateway $ gobgp global rib -a evpn Network Labels Next Hop AS_PATH Age Attrs *> [type:macadv][rd:1.1.1.1:65000][etag:10][mac:aa:bb:cc:dd:ee:ff][ip:10.0.0.1] [20,30] 0.0.0.0 00:00:00 [{Origin: ?} {Extcomms: [default-gateway]} [ESI: single-homed]] Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-12-21doc: CLI Syntax for EVPN routesIWASE Yusuke
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-12-16docs: Update docs for prefix representations in Neighbor SetSatoshi Fujimoto
Signed-off-by: Satoshi Fujimoto <satoshi.fujimoto7@gmail.com>
2017-12-16docs: cli-command-syntax.md: Missing arg to show VRF RIBIWASE Yusuke
This patch fixes the example on the doc for showing the VRF RIB where the "rib" keyword is missing to execute the command. Also, the "-a <adddress family>" is an option and this patch puts it into brackets. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-12-16docs: update evpn.md for with yabgp 0.4.0sanjmonkey
Notable change: extended community formatting. # YaBGP BGP EVPN extended communities: mac-mobility esi-label es-import router-mac
2017-12-11docs: Equal Cost Multipath Routing with ZebraIWASE Yusuke
This patch adds a new document explains Equal Cost Multipath routes with Zebra integration. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-12-05flowspec.md: Update for the details of CLI syntaxIWASE Yusuke
This patch updates the documents for the FlowSpec along with the improvements of the CLI command implementation. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-11-21packet/bgp: Use ESI str in EVPN Ethernet Segment RouteIWASE Yusuke
This patch fixes to use the string representation of ESI in the string representation of EVPN Ethernet Segment Route. Currently, displayed in the default representation of ESI structure. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-11-07evpn.md: Update tutorial using YABGPIWASE Yusuke
This patch updates output examples of GoBGP and YABGP along with changing the format of "gobgp global rib -a evpn" command. Also, this patch provides the curl command examples for sending POST requests. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-11-07evpn.md: Update tutorial using BaGPipeIWASE Yusuke
To interchange routes over iBGP session, this patch add the config of Route Reflector to GoBGP and updates output examples of GoBGP and BaGPipe. Note: The BaGPipe Docker image described on this document does not seem to be maintained for 2 years and contains the old version of BaGPipe. So this patch drops the description of this image. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-11-07docs: Update table of contents of evpn.mdIWASE Yusuke
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-11-02zclient: Enable to connect to FRRoutingIWASE Yusuke
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-11-01doc: Document for Peer Group and Dynamic NeighborSatoshi Fujimoto
Signed-off-by: Satoshi Fujimoto <satoshi.fujimoto7@gmail.com>
2017-10-03docs/sources/mrt: Reduce unrelated config examplesIWASE Yusuke
This patch reduces the unrelated or unimportant configuration examples for the readability. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-10-03docs/sources/mrt: Update contents indexIWASE Yusuke
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-10-03docs: Descriptions for per AFI-SAFI add-paths configurationIWASE Yusuke
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-10-01docs: update broken link in unnumbered-bgp.mdMo Battah
2017-09-13docs: Configuration guide for Additional PathsIWASE Yusuke
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-09-12docs: Configuration guide for TTL SecurityIWASE Yusuke
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-09-11docs: Configuration guide for eBGP MultihopIWASE Yusuke
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-08-30cli: Enable to specify AS_PATHIWASE Yusuke
This patch enables to specify AS_PATH in "gobgp" client command. The syntax is similar to the output of AS_PATH in "global rib" show command. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
2017-08-29doc: Update Flowspec documentSatoshi Fujimoto
Signed-off-by: Satoshi Fujimoto <satoshi.fujimoto7@gmail.com>
2017-07-26improve cli addpath usage messageFUJITA Tomonori
also add an example to cli doc. Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-07-26add addpath send supportFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2017-07-24docs/sources/configuration.md: Update example configurationIWASE Yusuke
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>