Commit Graph

39 Commits

Author SHA1 Message Date
Quentin Young
c0868e8b2a doc: misc bgp.rst fixes
* Clean up command stubs
* Document `disable-connected-check`
* Add markup
* Clarify section on autonomous systems
* Rewrap line to 80 characters
* Fix typos
* Fix grammar

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-25 20:02:08 +00:00
Philippe Guibert
e6f594150a doc: add more information about show ip bgp and show bgp
Add some information to inform the user that one can either display ipv4
or ipv6 routing table, with the above commands.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-07-10 12:54:37 +02:00
Philippe Guibert
a69601ac33 doc: bgp wrong command displayed
This command does not exist. Move it to the right one.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-07-03 15:01:21 +02:00
Philippe Guibert
53b758f3e2 doc: fix missing bgp keyword in debug bgp command
Some debug bgp commands were missing bgp keyword.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-07-02 11:47:57 +02:00
Philippe Guibert
00458d014a doc: add flowspec information from user point of view
Add some information for BGP flowspec.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-07-02 11:47:57 +02:00
Lou Berger
f90115c560 user: minor tweaks to bgp VRF documentation
Signed-off-by: Lou Berger <lberger@labn.net>
2018-06-23 10:47:32 -04:00
Quentin Young
aa9eafa4fc doc: cleanup community list docs more
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 09:39:27 +00:00
Quentin Young
8fcedbd2d4 doc: massive cleanup of bgp.rst
This doc needed (and still needs) a lot of love.

* Reorganize doc into logical sections
* Clean up lots of grammatical mistakes and misspellings
* Clean up lots of bad formatting
* Remove non-existent configuration options and commands
* Mark deprecated configuration options as deprecated
* Fix all cross-references to follow a standard format
* Fix capitalization on section and subsection titles
* Fix section and subsection level underlines

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-07 22:35:52 +00:00
Lou Berger
480e99c6c1
Merge pull request #2351 from donaldsharp/bgp_deprecation
Bgp deprecation
2018-06-05 12:05:39 -04:00
Donald Sharp
ad0b64d18d bgpd: Note deprecation in documentation
Note that these commands:

bgp config-type cisco
no bgp multiple-instance

are now deprecated and will be removed in a future version of FRR.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-06-01 15:15:30 -04:00
Philippe Guibert
a35947d06b doc: add BGP VRF use case
This commit brings some information about BGP VRF case with peering
using multiple VRF instances.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-05-30 15:15:25 +02:00
Quentin Young
da7e1a9212 doc: move -r option docs to zebra only
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-22 17:55:20 +00:00
Donald Sharp
e967a1d0c0 doc: Fixup doc for vrf-2-vrf as per suggestions in Review
Fixup the documentation to suggested changes from the Review.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-04-25 12:39:17 -04:00
Donald Sharp
fb3d9f3e0f doc: Update VRF 2 VRF route leaking documentation for bgp
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-04-25 12:39:17 -04:00
Quentin Young
d1e7591eb2 doc: spelling fixes
* Run sphinxcontrib-spelling over docs
* Correct spelling errors
* Compile a dictionary for future spellchecking efforts

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-20 17:59:38 -04:00
Renato Westphal
6b4fdc1cb1
Merge pull request #2036 from LabNConsulting/working/master/bgp-vpn-leak-labelmgr
bgpd: dynamic mpls label pool
2018-04-15 19:05:27 -03:00
G. Paul Ziemba
e70e9f8e24 bgpd: vpn-vrf leaking: use dynamic label pool for "auto" labels
Add support for CLI "auto" keyword in vrf->vpn export label:

    router bgp NNN vrf FOO
	address-family ipv4 unicast
	    label vpn export auto
	exit-address-family

Signed-off-by: G. Paul Ziemba <paulz@labn.net>
2018-04-11 23:18:35 -07:00
Quentin Young
9eb95b3b0a
doc: use frr syntax highlighting
* Use highlighter added in previous commit
* Correct indentation where I came across it

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-09 17:30:57 -04:00
Quentin Young
c936589468
doc: cleanup daemon option flags
Short and long form options can be written on the same line, Sphinx
understands how to cross-reference using either one of them. Also
replace some - with _ where appropriate.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-09 17:30:47 -04:00
kishiguro
db759bb009 Update document about -p 0. When port number is 0, that means do not listen bgp port.
Signed-off-by: Kunihiro Ishiguro <ishi@coreswitch.io>
2018-04-06 14:43:36 -07:00
Donald Sharp
5413757f02 doc: Cleanup a couple of issues in the bgp doc
Add the documentation for 'remote-as [internal|external]`
Cleanup some old obsolete information
Specify that interfaces can be used as a peer in bgp

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-03-28 15:37:25 -04:00
Quentin Young
0773854304
doc: work around broken makeinfo on centos7
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-22 12:01:13 -04:00
Quentin Young
4da7fda369
doc: bgp.rst cleanup
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-20 15:24:00 -04:00
G. Paul Ziemba
b572f82665 doc: bgp vpn-vrf leaking CLI
Signed-off-by: G. Paul Ziemba <paulz@labn.net>
2018-03-19 21:25:59 -07:00
Quentin Young
11ab5329e0
doc: reference style cleanup
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-02 13:45:12 -05:00
Quentin Young
9e146a818b
doc: fix more broken refs, restore routeserver.rst
At some point the routeserver docs got lost, converted those from texi
and put them back. Also fixed some broken cli xrefs.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-01 17:38:05 -05:00
Quentin Young
0efdf0fe50
doc: clean up cross references
Format reference directives and roles to match best practices.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-01 16:33:14 -05:00
Quentin Young
013f9762db
doc: fixup some build warnings
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-01 16:10:11 -05:00
Quentin Young
4b44467c9e
doc: remove last bits of texinfo directives
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-31 17:27:07 -05:00
Quentin Young
76bd149987
doc: remove trailing whitespace
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-31 17:27:07 -05:00
Quentin Young
d38549c99d
Merge branch 'master' into docs-user
Manually merged these doc commits:

3bb7cd7f56
ff21655441
2018-01-30 15:05:15 -05:00
Quentin Young
c1a54c054d
doc: manually finish conversion
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-29 16:38:07 -05:00
Quentin Young
29adcd5008
doc: fix cli documentation formatting
* Use new 'clicmd' directive / role
* Convert old style range syntax to new style

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 16:15:43 -05:00
Quentin Young
07a17e6d4e
doc: shotgun cleanup
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 14:43:21 -05:00
Quentin Young
8fa64b2a3f
doc: @smp{foo} -> `foo`
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 13:50:36 -05:00
Quentin Young
f381786082
doc: move routeserver.rst into bgp.rst
This is an incomplete stub of a chapter and goes under BGP docs anyway.
Also fix an include statement for RPKI.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-19 17:09:03 -05:00
Quentin Young
dc1046f726
doc: Frr -> FRR
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-19 17:05:13 -05:00
Quentin Young
c3c5a71ff6
doc: fixup bgpd.rst
Will probably need more cleanup.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-16 13:11:25 -05:00
Quentin Young
42fc5d2669
doc: start translating user manual to rst
Automatically translated all Texinfo files to RST using a script found
on the GCC mailing list[0]. Some formatting manually corrected.

Also created index.rst for building as well as boilerplate Sphinx
conf.py and Makefile.

[0] https://gcc.gnu.org/ml/gcc-patches/2015-11/msg01095.html

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2017-12-18 16:29:24 -05:00