Commit Graph

202 Commits

Author SHA1 Message Date
Philippe Guibert
47f47873d6 doc: inform user that expanded communities can not be used in set mode
Expanded communities can not be used in route-map set actions.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-10-15 15:01:52 +02:00
Philippe Guibert
49606d5872 doc: fix warning of doc compilation with bgp draft
Some draft ietf are not handle by :rfc: keyword. A workaround is
proposed, like it has been done for flowspec.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-10-10 11:50:38 +02:00
Tore Anderson
ec3bff6fd5 doc: correct route map match for prefix lists
This corrects the route map documentation to add the missing "prefix-list"
keyword, which is necessary when matching against a prefix list (as opposed to
an access list).

Additionally, change hyphens for underscores in the variables the user is
supposed to substitute in those commands, to prevent any confusion with the
"prefix-list" keyword itself, and also to make it more consistent with the
other documented commands (which are already using underscores).

Signed-off-by: Tore Anderson <tore@redpill-linpro.com>
2018-10-05 09:06:54 +02:00
Quentin Young
195c746165 doc: embellish bgp view docs
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-10-02 20:14:14 +00:00
Quentin Young
edde3ce9c2 doc: add extra information on bgp views and vrfs
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-10-02 20:14:14 +00:00
Quentin Young
c8a5e5e190 doc: clarify documentation on BGP multiple AS
Documentation on how to use multiple autonomous systems was inaccurate
and a bit scattered. Clarify usage of VRFs with multiple autonomous
systems, how to configure them, and their distinction from views. Also
moves a block on L3VPN VRFs out of the 'Basic Concepts' section.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-10-02 20:14:14 +00:00
Russ White
82977e243a
Merge pull request #3020 from donaldsharp/global_5549
Allow v6 global addresses to be nexthops for v4 addresses in bgp
2018-09-24 09:55:50 -04:00
Quentin Young
e6f1b83103 ospfd: add docs on multi-instance ospf
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-09-21 18:31:05 +00:00
Donald Sharp
19f2b5e875 doc: Update documentation with the extended-nexthop bgp command
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-09-18 20:53:22 -04:00
Donald Sharp
eb938189a1 doc: Update docs to mention 'no bgp fast-external-failover'
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-09-13 10:31:08 -04:00
Donald Sharp
714e135429
Merge pull request #2875 from opensourcerouting/fabricd
OpenFabric support
2018-09-08 13:48:48 -04:00
Donald Sharp
fa83edf08b doc: Update sharp documentation
Update the sharp documentation to note v6 nexthops are able
to be installed now.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-09-05 21:03:58 -04:00
Christian Franke
f3c7b99d05 doc: add documentation for fabricd
Signed-off-by: Christian Franke <chris@opensourcerouting.org>
2018-09-05 11:41:47 +02:00
Christian Franke
2c92bee499 isisd: add purge originator identification support
Implement RFC 6232, optionally allowing to flood isisd's NET and
hostname in purges it originates.

Signed-off-by: Christian Franke <chris@opensourcerouting.org>
2018-09-05 11:38:13 +02:00
Quentin Young
1dae463ea5 zebra: remove invalid ref "frr-configuration"
There is, in fact, no such additional information

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-08-31 18:04:31 +00:00
David Lamparter
2282d92812 doc: drop colspan/rowspan elements
The sphinx 'text' writer apparently doesn't support these, and the
'dummy' writer is only available on recent versions, and all of this
makes the build a bit annoying...

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-30 08:06:44 +02:00
David Lamparter
9e53b31551 build: non-recursive doc + parallel sphinx
Sphinx actually does work with a parallel build, if the doctree creation
is a separate step (which the other builds will then just read
unmodified.)  This can be done with the "dummy" target.

This also adds "-j6" to sphinx-build and adds a "--disable-doc-html"
switch on ./configure to turn on/off building HTML docs separately.

Also, HTML docs are now installed by "make install" to
/usr/share/doc/frr/html.

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-30 08:06:44 +02:00
Philippe Guibert
cc6743c290 zebra: add an option to zebra command to change default vrf name
There is a possibility to change the default vrf name, using the '-o'
option.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-08-28 16:23:50 +02:00
Philippe Guibert
c94e67258c doc: add information about dynamic update of default vrf name
It is possible to dynamically change default VRF name, if vrf backend is
a netns backend. By creating a link to the default netns in
/var/run/netns folder, then the file name will be used to name the
default VRF. If no backend netns is chosen, it is explained that it is
still possible to statically configure the default vrf name to new
define.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-08-28 16:23:50 +02:00
Donald Sharp
18d93bbb5a
Merge pull request #2910 from opensourcerouting/doc-summerclean-20180825
protocol vs. OS docs + SMUX leftovers
2018-08-25 06:35:14 -04:00
David Lamparter
3175ea5a14 doc/user: drop SMUX reference, rework intro
Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-25 02:16:59 +02:00
David Lamparter
36372632dd doc/user: add protocols vs. platform table
A nicely-formatted colorful table of all our daemons and target OS'.
Based off & intended to replace / extend
https://github.com/FRRouting/frr/wiki/Features-and-Kernel-Support

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-25 02:12:42 +02:00
Christoffer
cae770d31d
doc: Add documentation for IANA well-known communities
Coded as part of #2684 and most code written while participating at
BornHack@2018.

bgp.rst: Explain what the communities does and a summarized edition of
the communities purpose.

Signed-off-by: Christoffer <netravnen@gmail.com>
2018-08-24 23:57:06 +02:00
Donald Sharp
807ed4e9c0 lib: Remove smux option for snmp
The smux.c code has not been able to compile for 2+ years
and no-one has noticed. Additionally net-snmp has marked
smux integration as deprecated for quite some time as well.

Since no-one has noticed and it's been broken and smux integration
is deprecated let's just remove this from the code base.

From looking at the code, it sure looks like SNMP could use
a decent cleanup.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-08-23 08:36:07 -04:00
Rafael Zalamena
e36ff3f3a8 bfdd: fix documentation warnings
* Extend dashes on 'OSPF BFD Configuration' title;
* Add JSON output code indentation;

Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2018-08-20 23:22:16 +02:00
Rafael Zalamena
123582b3c3 bfdd: improve docs
Improvements:
* Show command line as code, to avoid confusion about single dash (`-`)
  and double dash;
* Tell the user where the BGP BFD commands can be found;
* Document OSPF/OSPF6/PIM BFD commands;
* Document JSON commands;
* Tell about session counters;

Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2018-08-15 17:09:54 -03:00
Donald Sharp
c4a811668d
Merge pull request #2843 from LabNConsulting/working/lb/doc-solo
bgpd: document how to avoid reflecting advertised information back to originator
2018-08-15 07:54:08 -04:00
Lou Berger
199ad5c47f user: document neighbor ... solo config
Signed-off-by: Lou Berger <lberger@labn.net>
2018-08-14 23:58:25 -04:00
Quentin Young
94cb1f61a4
Merge pull request #2805 from opensourcerouting/malloc-size
lib: track total memory per MTYPE if possible
2018-08-14 11:43:39 -04:00
David Lamparter
0a62b87392 doc: add "show memory" user documentation
Signed-off-by: David Lamparter <equinox@diac24.net>
2018-08-09 22:53:08 +02:00
Rafael Zalamena
c44032c1ff bfdd: add documentation
Add BFD daemon documentation:
* commands;
* man page;
* manual / description;

Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2018-08-08 18:25:04 -03:00
David Lamparter
a6c3e82348
Merge pull request #2794 from netravnen/feature/docs/set-origin
doc: set origin
2018-08-08 20:28:36 +02:00
Martin Winter
09890489cc
Merge pull request #2122 from donaldsharp/zebra_nhs
Create Staticd
2018-08-08 08:07:24 -07:00
Christoffer
90da9a1478
doc/user/routemap.rst 2018-08-07 23:31:16 +02:00
Quentin Young
a4a2a47555 doc: remove unknown option role from rpki.rst
Options must be documented before they can be cross-referenced, and the
scope for configure options is not present in rpki.rst. Remove the
option role tag from the `-M` option to remove the build warning.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-30 18:58:38 +00:00
Quentin Young
379064db76 doc: unindent index block content in rpki.rst
Index directives cannot contain content.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-30 18:55:48 +00:00
Donald Sharp
614aa5c166 doc: Add some documentation for staticd
Remove the ip route specific sections from zebra documenation and
create a specific one for the new staticd.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-07-29 12:43:21 -04:00
Philippe Guibert
521191140d zebra: fix missing table identifier passed for ip route vrf commands
The parameter was missing in that vty command. Then it is being added.
Also some documentation is refreshed.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-07-27 08:42:14 +02:00
Russ White
7e9c591278
Merge pull request #2729 from qlyoung/doc-misc-bgp-fixes
doc: misc bgp.rst fixes
2018-07-26 22:32:40 -04:00
Jafar Al-Gharaibeh
c11b11d566
Merge pull request #2681 from qlyoung/doc-cleanup-rpki
doc: cleanup rpki.rst
2018-07-25 17:04:02 -05:00
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
Quentin Young
fdd8e252d4 doc: move rpki reference to correct spot
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-24 21:13:58 +00:00
Quentin Young
79d702c130
Merge pull request #2640 from pguibert6WIND/doc_ldp
doc: add Ldp user documentation
2018-07-24 11:34:22 -04:00
Quentin Young
1e18601b07 doc: cleanup rpki.rst
Previous commit on this file introduced formatting issues.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-18 19:22:14 +00:00
Christoffer
04a18e3267 doc: Update rpki.rst for how-to enable rpki module
It has not been properly documented yet how to enable the RPKI module with BGP when having installed FRR with RPKI support. This PR seeks to add a section to the user documentation about this. So users will not have to resolve to searching the internet and looking through the FROG mailing list threads for answers.
2018-07-17 18:45:33 +02:00
Quentin Young
8f61e2b13e
Merge pull request #2625 from pguibert6WIND/ipv4_ipv6_bgp_show
doc: add more information about show ip bgp and show bgp
2018-07-17 11:19:13 -04:00
Quentin Young
2dae54733c
Merge pull request #2469 from ajones-rvbd/ajones-issue-2442
unit tests: support code coverage instrumentation and reports
2018-07-11 13:34:52 -04:00
Russ White
93387e540a
Merge pull request #2627 from rtrlib/revalidation
bgpd: rpki revalidation
2018-07-10 18:50:47 -04:00
Philippe Guibert
4535bb2c1e doc: add Ldp user documentation
This commit gathers some basic information on how to configure and setup
Ldp, as well as depict some main principles for that protocol.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-07-10 13:06:14 +02: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