summaryrefslogtreecommitdiff
path: root/doc/developer
AgeCommit message (Collapse)Author
2021-01-21doc: developer documentation for pytest markersDavid Schweizer
Signed-off-by: David Schweizer <dschweizer@opensourcerouting.org>
2021-01-20Merge pull request #7832 from pjdruddy/snmp-test-infraDonatas Abraitis
Snmp test infra
2021-01-19Merge pull request #7639 from qlyoung/frr-luaRuss White
Scripting
2021-01-12doc: add SNMP instructions for topotestsPat Ruddy
To run SNMP topotests some utilities and MIBs need to be installed. Signed-off-by: Pat Ruddy <pat@voltanet.io>
2021-01-12doc: fix sphinx warningsMark Stapp
Fix a couple of sphinx source processing warnings. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2021-01-12doc: add missing files to index.rst and subdir.amMark Stapp
Some missing doc files, add them. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2021-01-12doc: remind not to include 'no' in cli doc index statementsMark Stapp
Remind folks not to include the 'no' in cli doc index lines. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2021-01-05Merge pull request #6810 from Orange-OpenSource/link_stateRuss White
Lib: Add Link State Database
2021-01-04lib: Add Link State DatabaseOlivier Dugeon
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>
2020-12-18pathd: Add optional support for PCEP to pathdSebastien Merle
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-18pathd: New SR-TE policy management daemonSebastien Merle
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-03doc: add building steps for openSUSEJavier Garcia
Signed-off-by: Javier Garcia <rampxxxx@gmail.com>
2020-12-01doc: add scripting docsQuentin Young
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-12-01doc: add description of the new memory macroIgor Ryzhov
Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2020-11-19doc: topotest json typo errorPhilippe Guibert
fix the typo error. Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2020-11-17doc: Update release procedureDonald Sharp
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2020-11-09doc: use anonymous link refsQuentin Young
rst... Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-11-09doc: add docs on fuzzing stuffQuentin Young
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-10-23doc: add developer docs for tracingQuentin Young
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-10-17doc: Add %pBD print formatter to docDonald Sharp
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2020-10-08doc: document use of black for python formattingQuentin Young
Also moves "Exceptions" for C code under the C subsection. Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-10-07*: reformat python fileswhitespace
We are now using black. Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-09-21doc: Update Documentation to note Solaris Unsupported statusDonald Sharp
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-19Merge pull request #7097 from mjstapp/fix_ubu20_doc_pip2Donatas Abraitis
doc: clarify python and pip2 for ubuntu 20
2020-09-18tests: use .items instead of .iteritems in topotestsMark Stapp
Avoid py2-only .iteritems() api. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-09-15Merge pull request #7099 from mjstapp/fix_doc_thread_rwLou Berger
doc: clarify independence of THREAD_READ and _WRITE
2020-09-14doc: clarify independence of THREAD_READ and _WRITEMark Stapp
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-14doc: clarify python and pip2 for ubuntu 20Mark Stapp
Must run the pip2 install script with python2 on ubuntu 20. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-09-11doc: fix rpm link under libyang helpStephen Worley
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-08doc: update libyang blurb for 1.xQuentin Young
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-09-08doc: add notes about hash table invariantsQuentin Young
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-09-08Merge pull request #6376 from opensourcerouting/bump-libyang-req-version-1.xDonald Sharp
build, yang: bump libyang minimum required version to 1.0.184
2020-08-20ospfd: Add Segment Routing Local BlockOlivier Dugeon
RFC 8665 defines a Segment Routing Local Block for Adjacency SID. This patch provides the possibility to modify the SRLB as well as reserved the block range from the Label Manager. - Introduce new CLI 'segment-routing local-block' - Add local block to SRDB structure - Parse / Serialize SRLB in Router Information LSA - Update OSPF-SR topotest - Update documentation Signed-off-by: Olivier Dugeon <olivier.dugeon@orange.com>
2020-08-12lib, zebra: add support for sending ARP requestsJakub Urbańczyk
We can make the Linux kernel send an ARP/NDP request by adding a neighbour with the 'NUD_INCOMPLETE' state and the 'NTF_USE' flag. This commit adds new dataplane operation as well as new zapi message to allow other daemons send ARP/NDP requests. Signed-off-by: Jakub Urbańczyk <xthaid@gmail.com>
2020-08-11Merge pull request #6755 from xThaid/dplane_batchingDonald Sharp
zebra: dataplane batching
2020-08-10doc: add documentation for the dataplane batchingJakub Urbańczyk
Signed-off-by: Jakub Urbańczyk <xthaid@gmail.com>
2020-08-10doc: initial documentation for gRPCRafael Zalamena
Give the FRR users some examples of gRPC usage in scripts to let them start experimenting with the new configuration interface provided by YANG/northbound. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-08-07build, yang: bump libyang minimum required version to 1.0.184Renato Westphal
It's time to say good bye to libyang 0.16.105. The recently released libyang 1.0.184 includes numerous bug fixes and performance improvements that we need. Despite the major version bump from 0.x to 1.x, the libyang API is the same except for a single backward-incompatible change in the user types interface (which we're currently not using). Hence no code changes were necessary to adapt FRR to libyang 1.x. This commit also reintroduces some leafrefs that needed to be removed from our YANG modules due to a bug that was present on libyang 0.16.105. Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
2020-08-06doc: Update instructions for building for OpenWrtPawel Dembicki
Frr was added to official OpenWrt repo. No need to use unofficial sources from Github PR. Signed-off-by: Pawel Dembicki <p.dembicki@wb.com.pl>
2020-07-08Merge pull request #6693 from qlyoung/doc-value-initialization-practicesDonatas Abraitis
Document value initialization practices
2020-07-07doc: remove trailing whitespaceQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-07-07doc: note preferences for value initializationQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-07-07doc: add note about generous BGP topotest timeoutsMark Stapp
Add note blocks to the topotest and topotest-json dev docs to emphasize the need for generous BGP retry/convergence timers. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-07-06doc: specify output for json commands w/ no outputQuentin Young
JSON commands should always return valid JSON Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-06-24doc: add docker image build instructionsQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-06-10Merge pull request #6493 from opensourcerouting/workflow-debianDonald Sharp
doc/workflow: write down debian/* branch semantics
2020-06-02doc: update zebra/zapi docMark Stapp
Add the new OPAQUE zapi messages; a couple of edits. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-06-01doc/workflow: write down debian/* branch semanticsDavid Lamparter
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2020-05-28doc: encourage const in the developer docMark Stapp
Add a little text about using 'const' in the dev doc. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-05-27doc: add dev doc for ubuntu 20.04Mark Stapp
Add a doc for ubuntu 20 LTS; it's mainly the same as the 18 LTS doc, with a couple of extra notes. Signed-off-by: Mark Stapp <mjs@voltanet.io>
generated by cgit v1.2.3 (git 2.39.1) at 2025-12-09 18:45:16 +0000