Commit Graph

127 Commits

Author SHA1 Message Date
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
Quentin Young
9eb51ce361 doc: fix distclean
Apparently Automake has some undocumented logic somewhere that makes it
so any Makefile generated from an Automake Makefile.am is removed from
its secret list of things to delete that it deletes when performing a
recursive distclean before actually performing the recursive distclean
and since the secret list is automatically generated from the list of
things that Autoconf should generate in configure.ac we can't remove the
Makefile from that list or it will break Automake's list of things to
automatically generate that it generates from Autoconf's list of things
to automatically generate.

Thus, to prevent Automake from deleting Makefiles and then immediately
trying to use the Makefiles it just deleted to delete said Makefiles, we
must remove ourselves from the secret list, which is accomplished by
changing the file extension to '.am' instead of '.in'.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-18 19:35:24 +00:00
Russ White
4ae3a2de37
Merge pull request #2252 from donaldsharp/instance_rm_match
Instance routemap match
2018-05-18 02:41:23 -04:00
Donald Sharp
af21c68244 doc: Add some doc for source-instance
Add the documentation for match source-instance.
I also noticed that 'match source-protocol' was missing
add that in too.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-05-17 11:05:08 -04:00
Quentin Young
3a7177f0fe doc: remove notes about ipv6 packages
Kernel 2.2 was released in 1999, I'm pretty sure everybody has it by
now. Plus these links don't even exist anymore.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-16 20:24:19 +00:00
Quentin Young
717b48667f doc: add "Getting Started" section
While we have docs on various pieces of the build system we don't have
any docs on how to actually get FRR running once it's installed, nor do
we have comprehensive documentation on the basic procedure for building
from source. This patch remedies both of those.

Also updated the services list in the docs and removed the SERVICES file
from the project root.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-16 20:24:15 +00:00
Russ White
439fcfd306
Merge pull request #2216 from qlyoung/fix-doc-warnings
doc: cleanup zebra vrf docs
2018-05-12 06:40:14 -04:00
Russ White
16c3f08823
Merge pull request #2189 from qlyoung/move-bug-reports-to-docs
doc: move REPORTING-BUGS to user docs
2018-05-12 06:25:48 -04:00
Russ White
6b50b12ac7
Merge pull request #2162 from qlyoung/fix-vpath-build
doc: support VPATH builds
2018-05-12 06:23:03 -04:00
Russ White
71ef4ee49a
Merge pull request #2132 from donaldsharp/missed_stuff
Missed stuff
2018-05-12 06:18:15 -04:00
Quentin Young
80ca5b6d75 doc: cleanup zebra vrf docs
* Fix missing references
* Fix displaced reference target
* Fix miscellaneous typos
* Remove duplicate CLI documentation
* Rewrap lines to 80 characters

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-11 16:08:06 -04:00
Pascal Mathis
322e2d5c69
lib: Ported 'no (enable) password' from stable/3.0
The pull request #1545 from @donaldsharp introduced the command 'no
password' to remove an existing terminal connection password.
Additionally, warnings have been added to both 'no password' and 'no
enable password' to make the user aware of any security implications.

It seems that this specific pull request was never merged against master
and got lost. This commit is a cherry-pick of d4961273cb with fixed
conflicts and updated documentation.

Thanks to @donaldsharp and @pogojotz for the original PR.

Signed-off-by: Pascal Mathis <mail@pascalmathis.com>
2018-05-11 02:54:30 +02:00
Jafar Al-Gharaibeh
3dc755e492
Merge pull request #2195 from qlyoung/docuser
doc: update doc titles
2018-05-10 10:24:06 -05:00
Lou Berger
f3c8da18cb
Merge pull request #2075 from pguibert6WIND/doc_vrf
doc: add information about zebra VRF configuration
2018-05-10 06:56:56 -04:00
Quentin Young
f0d96d1d32 doc: update doc titles
Should be a bit easier to Google this way.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-09 10:44:08 -04:00
Quentin Young
216972dd3f
Merge pull request #2183 from Thomas-Gelf/fix/doc-snmp-file-formatting
doc, snmp: fix file formatting
2018-05-09 10:41:59 -04:00
Philippe Guibert
204ed384be doc: add information about zebra VRF configuration
As there are subtle differences between VRF-lite and VRF-netns,
some information is given to the operator on what can be/ can not be
done.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-05-09 09:52:36 +02:00
Jafar Al-Gharaibeh
6b3725b354
Merge pull request #2182 from qlyoung/docuser
doc: remove duplicate option doc
2018-05-08 23:40:21 -05:00
Thomas Gelf
b8df060063 doc, snmp: fix file formatting
Signed-off-by: Thomas Gelf <thomas@gelf.net>
2018-05-09 02:00:06 +02:00
Donald Sharp
e543616348 doc: Fix pbr documentation to be correct
The recent change of pbr necessitates this change in the doc

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-05-08 19:31:40 -04:00
Quentin Young
32452dd2ec doc: move REPORTING-BUGS to user docs
Doesn't belong here anymore.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-08 14:52:20 -04:00
Quentin Young
46a6698304 doc: remove duplicate option doc
Earlier commit added docs on `--enable-multipath` but it was already
documented.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-07 18:12:17 -04:00
Zefan Xu
2de01166c5
Default hello interval is wrong 2018-05-07 14:16:42 -07:00
Donald Sharp
0d8df93443 doc: Explain ecmp building and startup for zebra
Explain the --enable-ecmp=X configure option as well as
modify the zebra user doc to explain the -e X option.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-05-03 23:13:15 -04:00
Quentin Young
524ada7f23 doc: support VPATH builds
Documentation was not fully using Automake / Autoconf and therefore needs
modifications to support black magic VPATH builds.

* Convert Makefile's to Autoconf-controlled Makefile.in's
* Tweak loading of pygments lexer to handle runtime paths
* Update .gitignore's as necessary

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-05-02 17:15:31 -04:00
Donald Sharp
a3488351b4 doc: Add some documentation for the sharp daemon
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-04-30 15:40:54 -04:00
Donald Sharp
e967a1d0c0 doc: Fixup doc for vrf-2-vrf as per suggestions in Review
Fixup the documentation to suggested changes from the Review.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-04-25 12:39:17 -04:00
Donald Sharp
fb3d9f3e0f doc: Update VRF 2 VRF route leaking documentation for bgp
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-04-25 12:39:17 -04:00
Quentin Young
d1e7591eb2 doc: spelling fixes
* Run sphinxcontrib-spelling over docs
* Correct spelling errors
* Compile a dictionary for future spellchecking efforts

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-20 17:59:38 -04:00
Renato Westphal
6b4fdc1cb1
Merge pull request #2036 from LabNConsulting/working/master/bgp-vpn-leak-labelmgr
bgpd: dynamic mpls label pool
2018-04-15 19:05:27 -03:00
Rafael Zalamena
a6528075a8
Merge pull request #2039 from qlyoung/docuser
doc: more cleanup, config syntax highlighting
2018-04-12 18:02:22 -03:00
G. Paul Ziemba
e70e9f8e24 bgpd: vpn-vrf leaking: use dynamic label pool for "auto" labels
Add support for CLI "auto" keyword in vrf->vpn export label:

    router bgp NNN vrf FOO
	address-family ipv4 unicast
	    label vpn export auto
	exit-address-family

Signed-off-by: G. Paul Ziemba <paulz@labn.net>
2018-04-11 23:18:35 -07:00
Russ White
058054cac1
Merge pull request #1903 from donaldsharp/PBRD
Pbrd
2018-04-11 09:06:45 -04:00
Quentin Young
aef62d258b
doc: gracefully handle missing config.status
The docs extract various configuration values from config.status and
substitute them into placeholders throughout the docs. Add the ability
to build the docs with some reasonable defaults set instead of failing
when config.status doesn't exist.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-10 15:26:56 -04:00
Quentin Young
dff213a968
doc: load lexer differently
Pygments 2.2+ has `load_lexer_from_file`, but it looks like some of our
build platforms are on an older version.

Also gotta include the new file in dist tarball.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-10 13:51:50 -04:00
Quentin Young
9eb95b3b0a
doc: use frr syntax highlighting
* Use highlighter added in previous commit
* Correct indentation where I came across it

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-09 17:30:57 -04:00