Commit Graph

162 Commits

Author SHA1 Message Date
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
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
Marcel Röthke
1dacdd8b25 bgpd: add support for rpki revalidation on rpki updates
Signed-off-by: Marcel Röthke <marcel.roethke@haw-hamburg.de>
2018-07-05 16:06:37 +02:00
Arthur Jones
8328420909 unit tests: support code coverage instrumentation and reports
Currently, make check runs the unit tests and reports pass/fail,
but we have no way to guage how much of the code is covered by
these tests.  gcov provides those statistics on a per source
file basis, but requires special CFLAGS and LDFLAGS.  Here, we
add the --enable-gcov configure option to setup those options
correctly.  We also add a make target called check-coverage,
which runs the unit tests, runs gcov and uploads the data to
the codecov.io cloud service for display.

Finally, we include a Dockerfile-coverage which creates a
container image in alpine linux to run the tests.  To create
the image:

$ docker build \
	--build-arg commit=`git rev-parse HEAD` \
	--build-arg token=<upload token from codecov.io> \
	-t frr-gcov:latest \
	-f docker/alpine/Dockerfile-coverage .

and to create and upload the report:

$ docker run -it --rm frr-gcov:latest

Testing done:

Created and uploaded a report from my fork using alpine linux 3.7.
Non-coverage alpine 3.7 build still works.

Issue: https://github.com/FRRouting/frr/issues/2442
Signed-off-by: Arthur Jones <arthur.jones@riverbed.com>
2018-07-04 11:06:11 -07:00
Philippe Guibert
b03d34322d doc: add MPLS configuration commands
Add MPLS information to statically handle label from zebra.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-07-04 19:11:20 +02:00
Jafar Al-Gharaibeh
7f04893904
Merge pull request #2619 from pguibert6WIND/show_ipv6_bgp_wrong
doc: bgp wrong command displayed
2018-07-03 10:47:27 -05:00
Quentin Young
9c8726a33e doc: clean up flowspec.rst
* Fix broken citations
* Remove trailing whitespace
* Rewrap to 80 lines
* Tweak capitalization of section headers
* Clean up a few indented blocks

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-07-03 17:42:41 +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
Russ White
8d6d6b2581
Merge pull request #2475 from LabNConsulting/working/master/no_vrf_socket_4l3mdev
Don't open per vrf sockets when net.ipv4.tcp|udp_l3mdev_accept != 0
2018-07-01 23:06:22 -04:00
Lou Berger
3c29c38d25 user: add 'Linux sysctl settings and kernel modules' installation considerations
Signed-off-by: Lou Berger <lberger@labn.net>
2018-06-23 12:08:44 -04: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
Lou Berger
ec446a4673
Merge pull request #2449 from donaldsharp/lib_delayed_read
Lib delayed read
2018-06-22 13:13:05 -04:00
Russ White
418a4330c6
Merge pull request #2415 from qlyoung/pbr-table-range
PBR table range configuration + misc cleanups
2018-06-20 07:55:56 -04:00
Mladen Sablic
f93128c139 doc: added parameters to two PIM commands
ip igmp join and mtrace have parameters which were missing from
the command spec.

Signed-off-by: Mladen Sablic <mladen.sablic@gmail.com>
2018-06-20 11:48:15 +02:00
Donald Sharp
3cf3e018a9 doc: Add --log-level documentation
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-06-19 09:06:37 -04:00
Donald Sharp
ed74ddf403 doc: Add some documentation for cli logging
Add some basic documentation for the new cli added to all daemons.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-06-19 08:43:59 -04:00
Quentin Young
2e7c93acec doc: document pbr table range & a couple others
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-12 20:27:38 +00:00
Jafar Al-Gharaibeh
ef3428731e
Merge pull request #2379 from qlyoung/docuser
Improve introductory user docs
2018-06-12 11:04:26 -05:00
Jafar Al-Gharaibeh
e6731bccbe
Merge pull request #2384 from qlyoung/docs-bgp-update
doc: massive cleanup of bgp.rst
2018-06-12 10:57:36 -05: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
8421b1401d doc: move find command docs to better spot
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 07:55:55 +00:00
Quentin Young
bab676248b doc: remove :caption: from toctree
Older versions of Sphinx don't support toctree captions, so we can't use
them yet unfortunately.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 07:54:25 +00:00
Quentin Young
2da6ccc392 doc: clean up introductory user docs
* Update the list of protocol daemons from 5 to the current 13
* Rewrap and clean up formatting for lots of miscellaneous code blocks
* Improve English in various spots
* Update architecture description and diagram
* Remove duplicate information on reporting bugs

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 07:54:25 +00:00
Quentin Young
db910447b8 doc: reorganize into multiple toctrees
Use multiple toctrees to reorganize the user docs into logical sections.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-08 07:54:25 +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
Quentin Young
4c54343ffb doc: add docs on | actions, find command
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-06-06 19:51:34 +00:00
Lou Berger
480e99c6c1
Merge pull request #2351 from donaldsharp/bgp_deprecation
Bgp deprecation
2018-06-05 12:05:39 -04:00
Lou Berger
6a296ecb8b
Merge pull request #2344 from pguibert6WIND/bgp_vrf_usecase
doc: add BGP VRF use case
2018-06-05 12:02:45 -04:00
Donald Sharp
0bc39980a9
Merge pull request #2366 from msablic/pim_doc
doc: expanded PIM doc. w/ missing commands
2018-06-05 07:41:31 -04:00
Mladen Sablic
14916095ee doc: expanded PIM doc. w/ missing commands
PIM documantation was missing commands relevant to PIM protocol
that were documented in COMMANDS file of pimd directory.

Signed-off-by: Mladen Sablic <mladen.sablic@gmail.com>
2018-06-05 10:10:50 +02:00
Renato Westphal
401c174473 doc: list RFCs supported by ldpd in overview.rst
This is only a minor step in the direction of actually writing
documentation for ldpd...

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2018-06-02 22:36:10 -03: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
Quentin Young
65757481f0
Merge pull request #2329 from pguibert6WIND/issue_2275_proposal
doc: inform the diff between config from zebra and outside
2018-06-01 12:39:20 -04:00
Philippe Guibert
d66a93dd93 doc: replace 'intact' keyword with something more clear
Keeping the config intact might be misunderstood. I say that even if VRF
netns is automatically discovered, it is possible for administrator to
save the netns information in the config file, to bring more clarity (
hence the config commands available).

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-06-01 13:18:35 +02:00
Philippe Guibert
4d25da4f1e doc: inform the diff between config from zebra and outside
To avoid some confusions, it is precised in the documentation that
the configuration not done from zebra will not be injected in the
configuration context. As consequence, the config file will not be
impacted by underlying network context. But also, this will not be
possible for *Zebra* to attempt to modify outside networking objects.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-06-01 13:18:31 +02: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
20b35e468d doc: cleanup sharp.rst
The user doc index was not displaying correctly because of some syntax
errors in sharp.rst

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-29 21:08:03 +00: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
Renato Westphal
b16c827adf
Merge pull request #2262 from donaldsharp/v6_replace_semantics
V6 replace semantics
2018-05-22 09:05:06 -03:00
Donald Sharp
4354d381a6 doc: Add --v6-rr-semantics option to zebra doc
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-05-18 15:46:56 -04:00