Skip to content
Branch: master
Go to file
Code

README.md

Sysrepo

GitHub license

Sysrepo is a YANG-based configuration and operational state data store for Unix/Linux applications.

Applications can use sysrepo to store their configuration modeled by provided YANG model instead of using e.g. flat configuration files. Sysrepo will ensure data consistency of the data stored in the datastore and enforce data constraints defined by YANG model. Applications can currently use C language API of sysrepo Client Library to access the configuration in the datastore, but the support for other programming languages is planed for later, too.

Sysrepo can be easily integrated with management agents such as NETCONF or RESTCONF servers, using the same client library API that applications use to access their configuration. As of now, sysrepo is integrated with the Netopeer 2 NETCONF server. This means that applications that use sysrepo to store their configuration can automatically benefit from the ability to being controlled via NETCONF.

Branches

The project uses 2 main branches master and devel. Other branches should not be cloned. In master there are files of the last official release. Any latest improvements and changes, which were tested at least briefly are found in devel. On every new release, devel is merged into master.

This means that when only stable official releases are to be used, either master can be used or specific releases downloaded. If all the latest bugfixes should be applied, devel branch is the one to be used. Note that whenever a new issue is created and it occurs on the master branch, the first response will likely be to use devel before any further provided support.

Packages

We are using openSUSE Build Service to automaticaly prepare binary packages for number of GNU/Linux distros. The sysrepo packages are always build from current master branch (latest release). If you are interested in any other packages (such as devel or C++ and Python bindings), you can browse all packages from our repository.

Migration from Sysrepo version 0.7.x or older

This Sysrepo is a complete rewrite of these older versions. Latest version of the 0.7 version is found in the legacy branch. We tried to keep the API as similar as possible but there were some smaller or even bigger changes (mostly for the sake of efficiency). All these changes should be mentioned in CHANGES text file. It is also best to look at least briefly at the documentation where you will find information about major design changes (most importantly, no sysrepod).

Provided Features

  • Ability to store / retrieve YANG-modeled data elements adressed by XPath
  • Startup, running, candidate, and operational datastore support
  • Data consistency and constraints enforcement according to YANG models
  • No single point of failure design (is just a library)
  • Full transaction and concurrency support
  • Notifications of subscribed applications about the changes made in the datastore
  • Commit verifiers (change verification by subscribed applications)
  • Operational data support (publishing of application's state/configuration data to sysrepo)
  • YANG 1.1 support
  • Custom RPC, Event Notifications, YANG 1.1 Actions support
  • Notification store & notification replay

Requirements

Build Requirements

  • C compiler (gcc >= 4.8.4, clang >= 3.0, ...)
  • cmake >= 2.8.12
  • libyang

Optional

  • doxygen (for generating documentation)
  • cmocka >= 1.0.0 (for tests only, see Tests)
  • valgrind (for enhanced testing)

Building

$ mkdir build; cd build
$ cmake ..
$ make
# make install

Documentation

The library documentation is available online (docs), or can be generated locally from the source code using Doxygen tool:

$ make doc
$ google-chrome ../doc/html/index.html

Useful CMake sysrepo Options

Generate C++ and Python3 bindings:

-DGEN_LANGUAGE_BINDINGS=ON

Set custom repository path:

-DREPO_PATH=/opt/sysrepo/my_repository

Set custom sysrepo-plugind plugins path:

-DPLUGINS_PATH=/opt/sysrepo-plugind/plugins

Useful CMake Build Options

Changing Compiler

Set CC variable:

$ CC=/usr/bin/clang cmake ..

Changing Install Path

To change the prefix where the library, headers and any other files are installed, set CMAKE_INSTALL_PREFIX variable:

$ cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr ..

Default prefix is /usr/local.

Build Modes

There are two build modes:

  • Release. This generates library for the production use without any debug information.
  • Debug. This generates library with the debug information and disables optimization of the code.

The Debug mode is currently used as the default one. to switch to the Release mode, enter at the command line:

$ cmake -D CMAKE_BUILD_TYPE:String="Release" ..

Code Coverage

To generate statistical information about code coverage by tests, set ENABLE_COVERAGE option to ON:

$ cmake -D ENABLE_COVERAGE="ON" ..

and then the make's coverage target should be available to geenrate statistics:

$ make coverage

Note that gcc compiler is required for this option and additional tools are required:

  • gcov
  • lcov
  • genhtml

Usage

All Sysrepo functions are available via the main header:

#include <sysrepo.h>

To compile your program with libsysrepo, it is necessary to link it using the following linker parameters:

-lsysrepo

Note, that it may be necessary to call ldconfig(8) after library installation and if the library was installed into a non-standard path, the path to libyang must be specified to the linker. To help with setting all the compiler's options, there is sysrepo.pc file for pkg-config(1) available in the source tree. The file is installed with the library.

Used run-time enviromental variables

It is possible to change the repository path by setting SYSREPO_REPOSITORY_PATH variable.

Examples

See examples directory, which contains an example for basic API functions.

Tests

libyang includes several tests built with cmocka. The tests can be found in tests subdirectory and they are designed for checking library functionality after code changes.

The tests are by default built in the Debug build mode by running

$ make

In case of the Release mode, the tests are not built by default (it requires additional dependency), but they can be enabled via cmake option:

$ cmake -DENABLE_BUILD_TESTS=ON ..

Note that if the necessary cmocka headers are not present in the system include paths, tests are not available despite the build mode or cmake's options.

Tests can be run by the make's test target:

$ make test
You can’t perform that action at this time.