Commit Graph

914 Commits

Author SHA1 Message Date
Renato Westphal
773fc72b1f
Merge pull request #4242 from donaldsharp/zebra_diet
Zebra diet
2019-05-10 08:29:59 -03:00
Jafar Al-Gharaibeh
58d9d6ac7c
Merge pull request #4284 from donaldsharp/conf_t
Conf t
2019-05-09 17:01:51 -05:00
Quentin Young
886026c8d2 doc: add doc for bgp maximum-prefix knob
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-05-08 19:29:13 +00:00
Dinesh Dutt
982589a31a doc: Modify documentation to reflect new configure changes
This is the document changes to reflect the configure option
making `terminal` optional.

Signed-off-by: Dinesh Dutt <dd.ps4u@gmail.com>
2019-05-07 21:06:00 -04:00
Philippe Guibert
c3771c91fa doc: change bfd show commands with vrfname keyword
now that bfd show commands have changed, update documentation so as to
reflect how to use vrf keyword in the show bfd commands.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2019-05-07 16:01:47 +02:00
Philippe Guibert
626618caee doc: update bfd documentation
add a bfd vrf example. explain that it is possible to use both interface
and vrf keyword.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2019-05-07 15:54:30 +02:00
Donald Sharp
46677ed266 doc: Add a couple of missed show zebra ... comamnds to doc
Noticed that a couple of the `show zebra ...` commands are missing
from the zebra documentation that I use a bunch.  Let's add them
in.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-05-06 22:51:45 -04:00
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
Donald Sharp
21fee7927f 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-02 16:21:38 -04: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
Donald Sharp
5fa3430885
Merge pull request #3836 from opensourcerouting/debian/master-kill-backports
[master] debian packaging
2019-02-23 18:23:21 -05:00
Donald Sharp
02c2ba9767
Merge pull request #3830 from opensourcerouting/cherrypicks
[master] cherrypick backlog
2019-02-21 07:58:34 -05:00
David Lamparter
bd2893d57f doc: update for new daemons settings
watchfrr_enable is ignored, watchfrr_options is unneeded and the
valgrind options have been replaced with daemon_wrap/all_wrap.

Signed-off-by: David Lamparter <equinox@diac24.net>
2019-02-19 21:38:23 +01:00
Martin Winter
f6ff9aa59e doc: Fix path and order in debian package build doc
Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>
2019-02-19 21:34:08 +01:00
David Lamparter
443b605e76 doc/developer: document new Debian packaging
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-02-19 21:32:18 +01:00
David Lamparter
081253fcd5 tools/tarsource.sh: create debian changelog
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-02-19 21:31:18 +01:00
David Lamparter
fbeed19878 doc: drop deprecated Ubuntu 12.04 docs
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-02-19 21:31:18 +01:00
David Lamparter
b3c4c164b5 debian: make package "official"
Move us into place in debian/

Signed-off-by: David Lamparter <equinox@diac24.net>
2019-02-19 21:30:54 +01:00
Quentin Young
ccb50d4e9f
Merge pull request #3816 from opensourcerouting/doc-pager-theme
[master] doc: VTYSH_PAGER docs + new FRR theme
2019-02-19 12:41:08 -05:00
David Lamparter
23ebff805c
Merge pull request #3790 from qlyoung/doc-add-buildessential-libsystemdev-docs
doc: update build dependencies for debian systems
2019-02-19 17:54:25 +01:00
Quentin Young
b02525800b doc: update build dependencies for debian systems
Add build-essential and, for platforms with systemd, libsystemd-dev to
the package list for builds

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-02-19 16:51:34 +00:00
sergey
5ba3319778
XSTRDUP function signature fix
I think  there is a mistake in XSTRDUP function signature.
2019-02-18 16:06:37 +02:00
David Lamparter
afec87502a doc: document VTYSH_PAGER and "terminal paginate"
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-02-18 14:39:13 +01:00
David Lamparter
856d02a59a doc: orange FRR theme
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-02-18 14:39:13 +01:00
Donald Sharp
80d5ff338d sharpd: Add ability to track import-check nexthops
Add the ability to sharp to track import-check type routes
from the cli.  Update docs too.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-02-13 09:28:38 -05:00
David Lamparter
0fe29323f5
Merge pull request #3723 from slrz/zebra-rtadv-add-rfc8106-support
zebra: add support for IPv6 RA options for DNS configuration (RFC8106)
2019-02-12 14:30:00 +01:00
Donald Sharp
86da53ab0e sharpd: Add 'sharp data nexthop' data dump
Add some basic data dumping about what we have watched
from the vty/vtysh cli for nexthops.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-02-07 10:14:17 -05:00
Donald Sharp
f59e641827 sharpd: Add 'sharp data route" dump command
When you are using the install/remove routes command, the
output goes to a log file.  This command allows for ease
of dump of timing information from the vty or vtysh.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-02-07 10:14:17 -05:00
Quentin Young
370c8e079f doc: move topotests docs to developers guide
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-02-05 19:25:16 +00:00
Quentin Young
c9cf9db6b6 doc: fix missing backtick
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-02-04 17:37:54 +00:00
Lars Seipel
f9e824c5f8 doc: describe RA options for DNS configuration in ipv6.rst
Signed-off-by: Lars Seipel <ls@slrz.net>
2019-02-02 19:10:19 +01:00
Lars Seipel
8166d84086 doc: fix up mangled config example in ipv6.rst
Appears to be a remaining artifact of the Sphinx conversion.

Signed-off-by: Lars Seipel <ls@slrz.net>
2019-02-02 19:10:19 +01:00
Renato Westphal
65aef3a8bb
Merge pull request #3621 from donaldsharp/modules_doc_update
doc: Update modules.rst to better represent what is needed
2019-01-29 11:58:55 -02:00
Quentin Young
a2bd5d4c8f doc: fix mistaken indentation
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-01-25 16:32:18 +00:00
David Lamparter
02a0df1f22 build, lib/yang: bake in extensions if possible
Starting with libyang 0.16.74, we can load internally embedded yang
extensions instead of going through the file system/dlopen.  Detect
support for this at build time and use if available.

NB: the fallback mechanism will go away in a short while.

Signed-off-by: David Lamparter <equinox@diac24.net>
2019-01-24 17:44:41 +01:00
Renato Westphal
177a547ab2 doc: fix small inconsistencies in the table of zapi command values
Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2019-01-18 16:06:00 -02:00
Donald Sharp
2a7d947108 doc: Update modules.rst to better represent what is needed
The modules.rst documents how to create a module, let's update
it a bit to reflect what an end user needs to do a bit more.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-01-16 09:32:06 -05:00
Lou Berger
9af649da4b
Merge pull request #3570 from donaldsharp/dire_warning
more doc stuff for configure
2019-01-15 11:44:25 -05:00
Lou Berger
5e686af495
Merge pull request #3610 from donaldsharp/bgp_default_doc
doc: Add `[no] bgp default ipv4-unicast` documentation
2019-01-15 10:27:09 -05:00
Donald Sharp
31107203da
Merge pull request #3611 from opensourcerouting/nb-fixes
Minor northbound fixes
2019-01-14 17:28:49 -05:00
Renato Westphal
0e3bfb0df7 doc: update build instructions for freebsd on how to obtain libyang
Unfortunately the first version of the FreeBSD libyang port contained
a bug in which the libyang pkginfo file wasn't being installed
correctly in the system, and this prevented the FRR build system from
detecting the library. This bug was already fixed months ago but some
FreeBSD package repositories still have the old bugged version of the
port. This means we can't suggest people to install libyang using
"pkg install" since this causes problems for most people. In this
case, suggest FreeBSD users to build and install libyang manually
as we suggest for other BSD platforms.

This commit should be reverted once all FreeBSD package repositories
are updated with the new version of the libyang port.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2019-01-14 16:34:33 -02:00
Donald Sharp
bc1320290f doc: Add [no] bgp default ipv4-unicast documentation
This command had no documentation so add it in.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com.
2019-01-14 11:32:44 -05:00
Donald Sharp
7b5301f59d doc: Add more documentation around configure options
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-01-09 08:47:52 -05:00
Quentin Young
2b5443c567
Merge pull request #3531 from marauderlabs/docs-fix
doc: Fix typos and grammar
2019-01-08 11:04:46 -05:00
Anand
fe93e2e396
doc: Fix typos and grammar
Signed-off-by: Anand <anandakumar.u@gmail.com>
2019-01-08 04:45:02 +00:00
Donald Sharp
413908931c doc: Update documentation to new functionality
Update sharp.rst to reflect new functionality in the `sharp install ..`
command.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-01-03 09:57:06 -05:00
Renato Westphal
bbfaa7054a
Merge pull request #3516 from qlyoung/doc-ip-nht-resolve-via-default
doc: add `ip nht resolve-via-default`
2018-12-20 10:05:01 -02:00
Quentin Young
be11dfbf87 doc: exclude snmptrap.rst from build
This doc is .. include::'d in snmp.rst and needs to be ignored as part
of the main toctree build. This patch squashes a Sphinx build warning.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-12-19 18:10:41 +00:00
Quentin Young
43b8e264c8 doc: add ip nht resolve-via-default
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-12-19 17:55:05 +00:00
Philippe Guibert
e2abcff860 doc: add a community rule to permit usage of GPLv3
explain why GPLv3 must be permitted, and explicitly mention that code
not compatible with GPLv3 is prohibited.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-12-17 12:14:48 +01:00
David Lamparter
fa62815e08 doc: re-add copyright & license note
This was mistakenly removed in the texi -> sphinx conversion.

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-12-14 16:24:06 +01:00
David Lamparter
9c830772cd *: get rid of most daemons.conf references
There's a few left over to get compatibility and not break user
installs, but most is gone.

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-12-06 23:05:48 +01:00