diff options
| author | Renato Westphal <renato@opensourcerouting.org> | 2018-05-24 01:11:59 +0200 |
|---|---|---|
| committer | Renato Westphal <renato@opensourcerouting.org> | 2018-10-27 20:16:12 +0200 |
| commit | 5bce33b3c1dd9860dd5671935f6b399d4986b55a (patch) | |
| tree | 1a4899c66e0f626bf0252cee76f964ee53f80fe9 /doc/user | |
| parent | *: add empty array of YANG modules (diff) | |
| download | frr-5bce33b3c1dd9860dd5671935f6b399d4986b55a.tar.xz frr-5bce33b3c1dd9860dd5671935f6b399d4986b55a.zip | |
lib: add a new northbound plugin for ConfD
This plugin leverages the northbound API to integrate FRR with the ConfD
management agent.
The plugin is linked to the libconfd library and communicates with the
confd daemon using local TCP sockets. The integration consists mostly
of glue code that calls the appropriate FRR northbound callbacks in
response to events triggered by the confd daemon (e.g. request to change
the configuration or to fetch operational data).
By integrating FRR with the libconfd library, FRR can be managed using
all northbound interfaces provided by ConfD, including NETCONF, RESTCONF
and their Web API.
The ConfD CDB API is used to handle configuration changes and the ConfD
Data Provider API is used to provide operational data, process RPCs and
send notifications. Support for configuration management using the ConfD
Data Provider API is not available at this point.
The ConfD optional 'get_object()' and 'get_next_object()' callbacks were
implemented for optimal performance when fetching operational data.
This plugins requires ConfD 6.5 or later since it uses the new leaf-list
API introduced in ConfD 6.5.
To install the plugin, the --enable-confd option should be given to the
configure script, specifying the location where ConfD is installed.
Example: ./configure --enable-confd=/root/confd-6.6
When installed, the confd plugin will be available for all FRR daemons
and can be loaded using the -M (or --module) command line option.
Example: zebra -M confd.
Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
Diffstat (limited to 'doc/user')
| -rw-r--r-- | doc/user/installation.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/user/installation.rst b/doc/user/installation.rst index 59ae5830e..c575d4cdf 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -226,6 +226,11 @@ options from the list below. Build with configuration rollback support. Requires SQLite3. +.. option:: --enable-confd=<dir> + + Build the ConfD northbound plugin. Look for the libconfd libs and headers + in `dir`. + 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/` |