Commit Graph

216 Commits

Author SHA1 Message Date
Quentin Young
cc4345d438 doc: use correct specifier for code block
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-10-28 16:19:36 +00:00
Quentin Young
740449aba0 doc: remove mention of 'secondary' ip[v6] commands
These haven't existed for 14 years

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-10-28 07:24:36 +00:00
Lou Berger
50daf9a2d5
Merge pull request #3313 from qlyoung/doc-strip-whitespace
doc: strip trailing whitespace
2018-11-13 14:56:14 +07:00
Quentin Young
eebfb2335b doc: add missing docs for ipv6 isis router cmd
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-10-28 01:31:08 +00:00
Donald Sharp
ff38f0fa7a
Merge pull request #3281 from opensourcerouting/update-libyang-instructions
doc: update libyang build instructions
2018-11-12 09:35:09 -05:00
Olivier Dugeon
ddd73a968d OSPF: Add support to multi-area to Router Info.
Router Information needs to specify the area ID when flooding scope is set to
  AREA. However, this authorize only one AREA. Thus, Area Border Router (ABR) are
  unable to flood Router Information Opaque LSA in all areas they are belongs to.

  The path implies that the area ID is no more necessary for the command
  'router-info area'. It remains suported for compatibility, but mark as
  deprecated. Documentation has been updated accordingly.

Signed-off-by: Olivier Dugeon <olivier.dugeon@orange.com>
2018-11-09 10:09:47 +01:00
Renato Westphal
f805c84eaf doc: update libyang build instructions
The --with-yangmodelsdir and --with-libyang-pluginsdir build-time options
pertain to FRR so they shouldn't be placed along with the libyang build
instructions. Move these instructions to where they belong to avoid
confusion.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2018-11-03 15:42:56 -02:00
Donald Sharp
0100dfb9c1
Merge pull request #2705 from opensourcerouting/northbound-yang-v2
Northbound API
2018-10-31 18:50:45 -04:00
Tim Bray
30980e0adc
Link-detect documentation
As a quagga user, I didn't realise link-detect is on by default.
2018-10-29 21:12:14 +00:00
Quentin Young
4c97fd1a87 doc: strip trailing whitespace
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-10-28 01:07:06 +00:00
Renato Westphal
a7ca2199b7 lib: add a new northbound plugin for Sysrepo
This plugin leverages the northbound API to integrate FRR with Sysrepo,
a YANG-based configuration and operational state data store.

The plugin is linked to the libsysrepo library and communicates with
the sysrepod daemon using GPB (Google Protocol Buffers) over AF_UNIX
sockets. The integration consists mostly of glue code that calls the
appropriate FRR northbound callbacks in response to events triggered
by the sysrepod daemon (e.g. request to change the configuration or to
fetch operational data).

To build the sysrepo plugin, provide the --enable-sysrepo option to the
configure script while building FRR (the libsysrepo library needs to be
installed in the system).

When installed, the sysrepo plugin will be available for all FRR daemons
and can be loaded using the -M (or --module) command line option.

Example: bgpd -M sysrepo.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2018-10-27 16:16:12 -02:00
Renato Westphal
5bce33b3c1 lib: add a new northbound plugin for ConfD
This plugin leverages the northbound API to integrate FRR with the ConfD
management agent.

The plugin is linked to the libconfd library and communicates with the
confd daemon using local TCP sockets. The integration consists mostly
of glue code that calls the appropriate FRR northbound callbacks in
response to events triggered by the confd daemon (e.g. request to change
the configuration or to fetch operational data).

By integrating FRR with the libconfd library, FRR can be managed using
all northbound interfaces provided by ConfD, including NETCONF, RESTCONF
and their Web API.

The ConfD CDB API is used to handle configuration changes and the ConfD
Data Provider API is used to provide operational data, process RPCs and
send notifications. Support for configuration management using the ConfD
Data Provider API is not available at this point.

The ConfD optional 'get_object()' and 'get_next_object()' callbacks were
implemented for optimal performance when fetching operational data.

This plugins requires ConfD 6.5 or later since it uses the new leaf-list
API introduced in ConfD 6.5.

To install the plugin, the --enable-confd option should be given to the
configure script, specifying the location where ConfD is installed.

Example: ./configure --enable-confd=/root/confd-6.6

When installed, the confd plugin will be available for all FRR daemons
and can be loaded using the -M (or --module) command line option.

Example: zebra -M confd.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2018-10-27 16:16:12 -02:00
Renato Westphal
1c2facd12d lib: introduce new northbound API
Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2018-10-27 16:16:12 -02:00
David Lamparter
62e712146b build: work around automake wtf
For some reason, automake was "randomizing" the order of these few lines
in the generated output Makefile.in.

I have absolutely no clue what's going on, but it's the only thing
preventing me from building reproducible source tarballs (i.e.
bit-exactly identical), so... just slightly "rephrase" this.

Should behave exactly the same as before.

Signed-off-by: David Lamparter <equinox@diac24.net>
2018-10-24 18:35:12 +02:00
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