summaryrefslogtreecommitdiffstats
path: root/doc/user
diff options
context:
space:
mode:
authorRenato Westphal <renato@opensourcerouting.org>2018-05-24 01:12:29 +0200
committerRenato Westphal <renato@opensourcerouting.org>2018-10-27 20:16:12 +0200
commita7ca2199b709e268196878554e01c9e78bc1c60f (patch)
tree571dc3748ee20405f21b3973525f7d6d039e33f5 /doc/user
parentlib: add a new northbound plugin for ConfD (diff)
downloadfrr-a7ca2199b709e268196878554e01c9e78bc1c60f.tar.xz
frr-a7ca2199b709e268196878554e01c9e78bc1c60f.zip
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>
Diffstat (limited to 'doc/user')
-rw-r--r--doc/user/installation.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/user/installation.rst b/doc/user/installation.rst
index c575d4cdf..b7f0712a1 100644
--- a/doc/user/installation.rst
+++ b/doc/user/installation.rst
@@ -231,6 +231,10 @@ options from the list below.
Build the ConfD northbound plugin. Look for the libconfd libs and headers
in `dir`.
+.. option:: --enable-sysrepo
+
+ Build the Sysrepo northbound plugin.
+
You may specify any combination of the above options to the configure
script. By default, the executables are placed in :file:`/usr/local/sbin`
and the configuration files in :file:`/usr/local/etc`. The :file:`/usr/local/`