Commit Graph

363 Commits

Author SHA1 Message Date
Mark Stapp
eb3e4dc35c
Merge pull request #8128 from qlyoung/docs-cleanup
General docs cleanup
2021-02-24 16:53:42 -05:00
Quentin Young
689d992703
Merge pull request #8134 from ton31337/fix/doc_formatting
doc: Format highlighted syntax properly for Systemtap examples
2021-02-23 18:50:18 -05:00
Mark Stapp
15869cd81d
Merge pull request #8035 from qlyoung/remove-more-sprintf
*: remove more sprintf()
2021-02-23 15:55:02 -05:00
Quentin Young
e1ac6ff442 doc: update docs on docs
- Don't document 'no' commands
- Don't use .. index:: for clicmds
- Don't document all possible variants

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2021-02-23 15:43:13 -05:00
Donatas Abraitis
ccc1af3998 doc: Format highlighted syntax properly for Systemtap examples
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2021-02-23 22:40:06 +02:00
Donatas Abraitis
c952f18422 doc: Instruction how to use Systemtap with FRRouting
Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
2021-02-22 23:36:01 +02:00
Quentin Young
9029461188 doc: document LD_PRELOAD workaround for lttng
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2021-02-12 18:14:53 -05:00
Quentin Young
7533cad751 *: remove more sprintf()
Should be just a couple non-development, non-test occurrences of this
function left now.

Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2021-02-09 15:40:40 -05:00
Donald Sharp
6ddbc710cc
Merge pull request #7218 from kuldeepkash/multicast_pim_bsm
tests: Add multicast-pim-bsm-topo1 suite
2021-02-05 10:20:15 -05:00
Mark Stapp
7534d64f0f
Merge pull request #8007 from wesleycoakley/xcompile-writeup
doc: cross compilation guide
2021-02-04 13:31:49 -05:00
Wesley Coakley
8cc2aca441
doc: cross compilation guide
Wrote a little guide for cross-compiling FRR, gleaned from notes I took
while compiling for a RPi 3B+ on a Gentoo x86_64 system.

Care was taken to keep this documentation as generic as possible so
these steps could be applied to any cross-compile targeting a supported
architecture.

Signed-off-by: Wesley Coakley <wcoakley@nvidia.com>
2021-02-03 14:33:56 -05:00
David Lamparter
08a73c422d lib/xref: work around GCC bug 41091
gcc fucks up global variables with section attributes when they're used
in templated C++ code.  The template instantiation "magic" kinda breaks
down (it's implemented through COMDAT in the linker, which clashes with
the section attribute.)

The workaround provides full runtime functionality, but the xref
extraction tool (xrelfo.py) won't work on C++ code compiled by GCC.

FWIW, clang gets this right.

Signed-off-by: David Lamparter <equinox@diac24.net>
2021-02-03 00:55:07 +01:00
Donald Sharp
cc73a06499
Merge pull request #7314 from kuldeepkash/multicast-sm-topo1
Add multicast-pim-sm-topo1 test suite
2021-02-02 10:43:09 -05:00
David Lamparter
87d383171d doc/developer: xrefs
Signed-off-by: David Lamparter <equinox@diac24.net>
2021-02-01 17:28:11 +01:00
kuldeepkash
a91530499a doc: Updated topotest.rst doc with iperf
1. We are using iperf to send IGMP join and traffic for multicast suites. Iperf must be
   used to run all multicast suite

Signed-off-by: kuldeepkash <kashyapk@vmware.com>
2021-01-29 16:12:48 +00:00
kuldeepkash
ccdf4a5ea5 doc: topotests-markers typo error
Fixed topotests-markers typo error

Signed-off-by: kuldeepkash <kashyapk@vmware.com>
2021-01-27 19:45:31 +00:00
Russ White
a9294a8cbd
Merge pull request #7127 from opensourcerouting/ospf_ti-lfa
ospfd: add support for Topology Independent LFA (TI-LFA)
2021-01-26 07:32:04 -05:00
David Schweizer
c8bcb7bd37
doc: fixed confusing statements in topotest marker doc
Signed-off-by: David Schweizer <dschweizer@opensourcerouting.org>
2021-01-22 15:14:18 +01:00
David Schweizer
0f84d13839
doc: developer documentation for pytest markers
Signed-off-by: David Schweizer <dschweizer@opensourcerouting.org>
2021-01-21 16:22:39 +01:00
Donatas Abraitis
44ba9e779d
Merge pull request #7832 from pjdruddy/snmp-test-infra
Snmp test infra
2021-01-20 09:15:14 +02:00
GalaxyGorilla
3e94c9a4a3 doc: Add TI-LFA developer docs
Signed-off-by: GalaxyGorilla <sascha@netdef.org>
2021-01-19 15:32:13 +00:00
Russ White
c0b6ef23f7
Merge pull request #7639 from qlyoung/frr-lua
Scripting
2021-01-19 07:17:03 -05:00
Kuldeep Kashyap
bf17e2dffe doc: Updated topotest.rst doc with scapy details
1. Scapy, is a python tool, which would be used in multicast-pim-bsm-topo1
   suite automation. We have some BSM raw packets captured and saved in
   JSON file, these packets would be sent using scapy on tests demands.

Signed-off-by: Kuldeep Kashyap <kashyapk@vmware.com>
2021-01-18 18:17:13 +00:00
Pat Ruddy
b638685c6c doc: add SNMP instructions for topotests
To run SNMP topotests some utilities and MIBs need to be
installed.

Signed-off-by: Pat Ruddy <pat@voltanet.io>
2021-01-12 20:00:06 +00:00
Mark Stapp
0a9720bda9 doc: fix sphinx warnings
Fix a couple of sphinx source processing warnings.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2021-01-12 13:31:07 -05:00
Mark Stapp
23f520ee2f doc: add missing files to index.rst and subdir.am
Some missing doc files, add them.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2021-01-12 13:30:14 -05:00
Mark Stapp
41cb383f3a doc: remind not to include 'no' in cli doc index statements
Remind folks not to include the 'no' in cli doc index lines.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2021-01-12 13:29:08 -05:00
Russ White
7e9492a9a6
Merge pull request #6810 from Orange-OpenSource/link_state
Lib: Add Link State Database
2021-01-05 10:25:38 -05:00
Olivier Dugeon
bbd85e2038 lib: Add Link State Database
Define new models for Link State Database a.k.a TED
and functions to manipulate the new database as well as exchange Link State
information through ZAPI Opaque message.

Signed-off-by: Olivier Dugeon <olivier.dugeon@orange.com>
2021-01-04 18:19:26 +01:00
Sebastien Merle
efba0985fc pathd: Add optional support for PCEP to pathd
This new dynamic module makes pathd behave as a PCC for dynamic candidate path
using the external library pcpelib https://github.com/volta-networks/pceplib .

The candidate paths defined as dynamic will trigger computation requests to the
configured PCE, and the PCE response will be used to update the policy.

It supports multiple PCE. The one with smaller precedence will be elected
as the master PCE, and only if the connection repeatedly fails, the PCC will
switch to another PCE.

Example of configuration:

segment-routing
 traffic-eng
  pcep
   pce-config CONF
    source-address ip 10.10.10.10
    sr-draft07
   !
   pce PCE1
    config CONF
    address ip 1.1.1.1
   !
   pce PCE2
    config CONF
    address ip 2.2.2.2
   !
   pcc
    peer PCE1 precedence 10
    peer PCE2 precedence 20
   !
  !
 !
!

Co-authored-by: Brady Johnson <brady@voltanet.io>
Co-authored-by: Emanuele Di Pascale <emanuele@voltanet.io>
Co-authored-by: GalaxyGorilla <sascha@netdef.org>
Co-authored-by: Javier Garcia <javier.garcia@voltanet.io>
Co-authored-by: Renato Westphal <renato@opensourcerouting.org>
Co-authored-by: Sebastien Merle <sebastien@netdef.org>
Signed-off-by: Sebastien Merle <sebastien@netdef.org>
2020-12-18 16:47:52 +01:00
Sebastien Merle
4d7b695d3a pathd: New SR-TE policy management daemon
This new daemon manages Segment-Routing Traffic-Engineering
(SR-TE) Policies and installs them into zebra. It provides
the usual yang support and vtysh commands to define or change
SR-TE Policies.

In a nutshell SR-TE Policies provide the possibility to steer
traffic through a (possibly dynamic) list of Segment Routing
segments to the endpoint of the policy. This list of segments
is part of a Candidate Path which again belongs to the SR-TE
Policy. SR-TE Policies are uniquely identified by their color
and endpoint. The color can be used to e.g. match BGP
communities on incoming traffic.

There can be multiple Candidate Paths for a single
policy, the active Candidate Path is chosen according to
certain conditions of which the most important is its
preference. Candidate Paths can be explicit (fixed list of
segments) or dynamic (list of segment comes from e.g. PCEP, see
below).

Configuration example:

segment-routing
 traffic-eng
  segment-list SL
   index 10 mpls label 1111
   index 20 mpls label 2222
  !
  policy color 4 endpoint 10.10.10.4
   name POL4
   binding-sid 104
   candidate-path preference 100 name exp explicit segment-list SL
   candidate-path preference 200 name dyn dynamic
  !
 !
!

There is an important connection between dynamic Candidate
Paths and the overall topic of Path Computation. Later on for
pathd a dynamic module will be introduced that is capable
of communicating via the PCEP protocol with a PCE (Path
Computation Element) which again is capable of calculating
paths according to its local TED (Traffic Engineering Database).
This dynamic module will be able to inject the mentioned
dynamic Candidate Paths into pathd based on calculated paths
from a PCE.

https://tools.ietf.org/html/draft-ietf-spring-segment-routing-policy-06

Co-authored-by: Sebastien Merle <sebastien@netdef.org>
Co-authored-by: Renato Westphal <renato@opensourcerouting.org>
Co-authored-by: GalaxyGorilla <sascha@netdef.org>
Co-authored-by: Emanuele Di Pascale <emanuele@voltanet.io>
Signed-off-by: Sebastien Merle <sebastien@netdef.org>
2020-12-18 16:34:02 +01:00
Javier Garcia
f5b17d200f doc: add building steps for openSUSE
Signed-off-by: Javier Garcia <rampxxxx@gmail.com>
2020-12-03 11:59:01 +01:00
Quentin Young
0833300a7a doc: add scripting docs
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-12-01 18:42:17 -05:00
Igor Ryzhov
fdac05fd9a doc: add description of the new memory macro
Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2020-12-01 11:39:40 +03:00
Philippe Guibert
0dc861fa52 doc: topotest json typo error
fix the typo error.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2020-11-19 13:18:22 +00:00
Donald Sharp
7188145f63 doc: Update release procedure
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2020-11-17 07:39:42 -05:00
Quentin Young
e869d3f0c7 doc: use anonymous link refs
rst...

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-11-09 15:25:26 -05:00
Quentin Young
e862bcc572 doc: add docs on fuzzing stuff
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-11-09 15:25:26 -05:00
Quentin Young
d3f453457b doc: add developer docs for tracing
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-10-23 15:13:51 -04:00
Donald Sharp
ac86c0785e doc: Add %pBD print formatter to doc
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2020-10-17 08:52:35 -04:00
Quentin Young
3656e87b6b doc: document use of black for python formatting
Also moves "Exceptions" for C code under the C subsection.

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-10-08 12:53:13 -04:00
whitespace
701a01920e *: reformat python files
We are now using black.

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-10-07 17:22:26 -04:00
Donald Sharp
32d9e333b7 doc: Update Documentation to note Solaris Unsupported status
With the change of Solaris going from Supported -> UnSupported
the documentation needed to be updated to reflect the reality
on the ground.

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2020-09-21 10:02:20 -04:00
Donatas Abraitis
428d9b5b3f
Merge pull request #7097 from mjstapp/fix_ubu20_doc_pip2
doc: clarify python and pip2 for ubuntu 20
2020-09-19 15:11:25 +03:00
Mark Stapp
e5f0ed147b tests: use .items instead of .iteritems in topotests
Avoid py2-only .iteritems() api.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-09-18 15:55:23 -04:00
Lou Berger
eac139f8f2
Merge pull request #7099 from mjstapp/fix_doc_thread_rw
doc: clarify independence of THREAD_READ and _WRITE
2020-09-15 11:20:13 -04:00
Mark Stapp
942432619e doc: clarify independence of THREAD_READ and _WRITE
Make it clearer that the READ and WRITE tasks/events are
independent in the lib/thread apis.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-09-14 11:01:44 -04:00
Mark Stapp
01ffd5b1ec doc: clarify python and pip2 for ubuntu 20
Must run the pip2 install script with python2 on ubuntu 20.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-09-14 09:52:16 -04:00
Stephen Worley
686c4da9ef doc: fix rpm link under libyang help
Fix the rpm link under libyang help. The link was assuming
it was local without the https.

Signed-off-by: Stephen Worley <sworley@cumulusnetworks.com>
2020-09-11 14:11:48 -04:00
Quentin Young
42404aa0c0 doc: update libyang blurb for 1.x
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-09-08 12:10:34 -04:00