summaryrefslogtreecommitdiff
path: root/doc/developer/index.rst
AgeCommit message (Collapse)Author
2025-03-06doc: The sbfd documentation was not being includedDonald Sharp
Add the sbfd documentation, such as it is, to the developer documentation so that it can be read by people. Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2023-09-27doc: include checkpatch & cspf docs in toctreeQuentin Young
The documentation pages on checkpatch and CSPF were not reachable because they were not included in any toctree. Include them in the tree! Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-09-19doc: add northbound api arch docsQuentin Young
Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2023-06-19doc: start of mgmtd developer docChristian Hopps
- docs on how to convert daemon to mgmtd and some diagrams - and a fix for code-block in cspf.rst Signed-off-by: Christian Hopps <chopps@labn.net>
2021-03-05pceplib: Integrate pcelib into frrJavier Garcia
Signed-off-by: Brady Johnson <brady@voltanet.io> Co-authored-by: Javier Garcia <javier.garcia@voltanet.io> Signed-off-by: Javier Garcia <javier.garcia@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>
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-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-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-04-17doc: update FPM documentationRafael Zalamena
Tell users about new FPM implementation and add more documentation about it. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2019-02-05doc: move topotests docs to developers guideQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-10-29doc: add dev doc for vtyshQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-12Merge pull request #2197 from qlyoung/docuser-debianpkgRuss White
doc: move Debian packaging docs to dev docs
2018-05-09doc: move Debian packaging docs to dev docsQuentin Young
Updated the doc to cross-reference build documentation as well and reformatted to RST. Removed stub section on how to configure daemons and whatnot, as that's the domain of the user docs. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-09doc: update doc titlesQuentin Young
Should be a bit easier to Google this way. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-30doc: add documentation on threading & process archQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-20doc: make ospf sectionQuentin Young
With OSPF API and OSPF-SR docs as subsections. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-07Merge branch 'master' into docuserQuentin Young
2017-12-08doc: more organizing & updatingQuentin Young
* Add chapter on BGPD * Add diagram for git workflow * Convert next-hop tracking documents to ReST * Update & organize workflow document * Move ldpd docs back up to the parent directory Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2017-12-08doc: begin developer's manualQuentin Young
* Move doc/code/ -> doc/developer/ * Move disparate code documentation to doc/developer/ * Convert Markdown docs to reStructuredText * Organize docs into Sphinx tree * Move build docs -> doc/developer/ * Change build doc titles to fit under Building subsection of manual Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>