Commit Graph

856 Commits

Author SHA1 Message Date
Donald Sharp
c447ad08b2 doc, zebra: Remove "table X" command
This command is broken and has been broken since the introduction
of vrf's.  Since no-one has complained it is safe to assume that
there is no call for this specialized linux command.  Remove
from the system with extreme prejudice.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-05-06 13:42:23 -04:00
Juergen Werner
54e53978fc doc: Fix failing make doc
This build system bug was introduced with 9251d1f596.

Signed-off-by: Juergen Werner <pogojotz@gmx.net>
2019-05-03 20:17:08 +02:00
Lou Berger
e8b9ad5cdd
Revert "Zebra diet" 2019-05-02 06:54:59 -04:00
Donald Sharp
820b3b6596 doc: Some minor doc cleanup for new data structures
Noticed during attempts at usage that the documentation
needed a couple small updates:

1) Tell the user which header to include
2) Some functions want the address of the data structure

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-05-01 20:28:57 -04:00
Lou Berger
31e944a8a7
Merge pull request #3045 from opensourcerouting/atoms
READY: lists/skiplists/rb-trees new API & sequence lock & atomic lists
2019-04-30 10:26:35 -04:00
David Lamparter
737d6e0956 doc: add developer docs for type-safe lists
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-04-27 19:33:45 +02:00
Mark Stapp
bbd8da796b
Merge pull request #4187 from donaldsharp/doc_pim
doc: Cleanup output of new PIM-EVPN doc
2019-04-24 15:18:27 -04:00
Mark Stapp
850af7ac4a
Merge pull request #4176 from qlyoung/doc-cleanup-ospf-apiserver
Cleanup OSPF API server docs
2019-04-24 14:49:16 -04:00
Quentin Young
7c8c9c8827 doc: typo / grammar pass on OSPF API docs
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-04-24 17:41:06 +00:00
Quentin Young
06fa7bb966 doc: add copyright notice from Ralph Keller
Ralph has kindly granted us GPLv2+ license to use this documentation,
and requests that we keep a reference to his name. Add these facts to
the documentation.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-04-24 17:37:09 +00:00
Quentin Young
e7a664c198 doc: pim evpn tabs -> spaces
And remove `interface` highlight directive

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-04-23 19:04:45 +00:00
Donald Sharp
e2b5880e7b doc: Cleanup output of new PIM-EVPN doc
The PIM-EVPN doc was not rendering very well on the
website.  So Update documentation to allow it to render
better.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-04-23 02:15:58 -04:00
Donald Sharp
79b50aa561 doc: Update show ip mroute command docs.
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-04-22 19:56:02 -04:00
Quentin Young
5354eea9e2 doc: add --apiserver to ospfd manpage
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-04-22 20:22:59 +00:00
Quentin Young
37f92f2215 doc: cleanup OSPF API server documentation
* Reflow to 80 columns
* Improve markup
* Add --apiserver option to example ospfd invocations
* Add note on requirement of this option to use api server

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-04-22 20:22:00 +00:00
Jafar Al-Gharaibeh
c6f637132f
Merge pull request #4025 from AnuradhaKaruppiah/pim-evpn
pim-evpn: Forwarding overlay BUM traffic via multicast VxLAN tunnels in the underlay
2019-04-22 11:44:52 -05:00
Anuradha Karuppiah
745fc7a5ec doc: add config sample for pim-evpn
Sample l2-vni config via ifupdown2 -
auto vx-10100
iface vx-10100
	vxlan-id 10100
	bridge-access 100
	vxlan-local-tunnelip 27.0.0.11
	vxlan-mcastgrp 239.1.1.100 >>>>>>>>>.

Signed-off-by: Anuradha Karuppiah <anuradhak@cumulusnetworks.com>
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-04-20 08:33:23 -07:00
Donald Sharp
ca02cf8d11 doc: Cleanup documentation for new pim commands
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-04-18 16:41:35 -04:00
Russ White
fe586c647b Merge pull request #4084 from qlyoung/bgp-prefix-md5-auth
Support TCP MD5 auth on prefixes & enable MD5 auth for BGP listen ranges
2019-04-16 19:25:43 -04:00
Quentin Young
d79e0e085b doc: document bgp listen ranges and md5 behavior
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-04-16 15:28:20 +00:00
Renato Westphal
45242058ec doc: update libyang build instructions to enable compiler optimizations
libyang defaults CMAKE_BUILD_TYPE to "Debug", which disables compiler
optimizations. We should instruct our users to build libyang in the
"Release" mode so that compiler optimizations are enabled and they
can benefit from the associated performance improvements.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2019-04-16 09:52:20 -03:00
Quentin Young
03e72d8071 doc: document libyang cache bug workaround
Document workaround for
https://github.com/CESNET/libyang/issues/752

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-04-15 19:29:10 +00:00
Wojciech Kozlowski
560470b552 doc: replace old text with info about integrated configuration mode
Signed-off-by: W. Kozlowski <wk@wojciechkozlowski.eu>
2019-04-09 22:38:35 +02:00
F. Aragon
39e97e8732
doc: fix typo
Signed-off-by: F. Aragon <paco@voltanet.io>
2019-04-08 16:46:33 +02:00
Quentin Young
7d9a2e6d23 doc: remove unneeded build deps
Remove the following:
* gawk
* dejagnu

Add the following for FreeBSD 9 and OpenBSD 6:
* libexecinfo

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-29 18:56:20 +00:00
Rafael Zalamena
5264c1cc64
Merge pull request #4002 from qlyoung/doc-update-build-docs-fedora
update build docs - Fedora, Ubuntu
2019-03-27 19:31:45 -03:00
Quentin Young
0844023418 doc: update build docs for Ubuntu 14.04
Same as priors

Tested on Ubuntu 14.04

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-26 22:04:49 +00:00
Quentin Young
650c632224 doc: update build docs for Ubuntu 16.04
Same updates as Ubuntu 18.04 doc

Tested on Ubuntu 16.04

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-26 21:16:34 +00:00
Quentin Young
749461a631 doc: exclude bfd-options.rst from toctree
This is an include file, needs to be explicitly excluded to suppress
Sphinx warnings.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-26 20:53:58 +00:00
David Lamparter
da1a93983a
Merge pull request #3998 from pguibert6WIND/workflow_bug_fixes_older
doc: permit maintenance on more than the 2 last maintenance releases
2019-03-26 16:45:48 +01:00
Quentin Young
ae999ff862 doc: update build docs for Ubuntu 18.04
* Update build package list
* Update ./configure options
* Fix some RST syntax errors
* Use monolithic config examples
* Use compile include snippet
* Reorganize a bit

Tested on Ubuntu 18.04

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 20:29:49 +00:00
Quentin Young
4983c2177f doc: update building.rst for new fedora doc
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 20:29:49 +00:00
Quentin Young
4ff6f66ac9 doc: reorganize fedora doc a bit
* Use compile include snippet
* Move daemons enable section to end
* Fix a couple syntax errors

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 20:29:34 +00:00
Quentin Young
c2793eda33 doc: pull out compile instructions into snippet
We're going to use this same snippet across every build doc so let's
just pull it into its own include file now.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 20:21:10 +00:00
Quentin Young
0ac848ab87 doc: mv Fedora 24 docs to cover 24+
Tested these on Fedora 24 and 28, so they should be true for all
versions in-between as well as Fedora 29 and all upcoming versions.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 15:48:09 +00:00
Quentin Young
ba8083e5ce doc: update Fedora 24 build doc
* Cross reference RPM build docs
* Add perl and patch to build deps
* Add libyang-pluginsdir to ./configure options
* Change instructions to unified config

Verified on Fedora 28.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 15:48:07 +00:00
Quentin Young
63374e1d8b doc: update Fedora 24 build doc style
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-25 15:47:09 +00:00
David Lamparter
46ba857461
Merge pull request #4001 from qlyoung/doc-update-libyang-building
doc: update instructions for building libyang
2019-03-23 14:24:27 +01:00
David Lamparter
cdec5d956b
Merge pull request #3996 from qlyoung/doc-move-rpm-to-devdocs
move rpm build doc to devdocs
2019-03-23 14:22:49 +01:00
David Lamparter
59ce748be0
Merge pull request #3985 from rubenk/doc-fix-a-few-typos
doc: fix a couple of typos
2019-03-23 13:49:20 +01:00
Quentin Young
d758f97a24 doc: update instructions for building libyang
* Upstream libyang now works with FRR; use it
* Install libyang to system library directories to satisfy pkg-config
* Remove warnings about ABI version
* Remove outdated binary package links
* Cleanup formatting

Validated that these instructions work on:
- Fedora 24
- Fedora 28.
- Ubuntu 18.04

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-22 18:57:20 +00:00
Quentin Young
9251d1f596 doc: move rpm build doc to dev docs
------------{ <(O.O)> }------------

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-22 16:08:28 +00:00
Philippe Guibert
07ff01d255 doc: permit maintenance on more than the 2 last maintenance releases
it is possible to do some ponctual backporting of bug fixes, on older
than the 2 last maintenance releases.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2019-03-22 15:56:11 +01:00
Mark Stapp
d039436fd1
Merge pull request #3935 from FRRouting/doc-add-fabricd-seealso
doc: include fabricd in see-also programs
2019-03-22 07:34:44 -04:00
Quentin Young
924947e412 doc: fix underline level
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-21 18:50:25 +00:00
Rubens Figueiredo
749afd7dce doc: route reflector documentation
Signed-off-by: Rubens Figueiredo <rubens@bisdn.de>
2019-03-21 10:34:28 +01:00
Ruben Kerkhof
f6aa36f5c6 doc: address review comment
'cannot' feels more natural

Signed-off-by: Ruben Kerkhof <ruben@rubenkerkhof.com>
2019-03-20 21:20:31 +01:00
Ruben Kerkhof
56f0bea718 doc: fix a couple of typos
Found with https://github.com/codespell-project/codespell

Signed-off-by: Ruben Kerkhof <ruben@rubenkerkhof.com>
2019-03-20 20:08:33 +01:00
Quentin Young
f53928bf42
doc: include fabricd in see-also programs
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-12 16:42:04 -04:00
Donald Sharp
b16b7e0756 doc: Update documentation about multipath
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-03-06 10:47:21 -05:00