Sysrepo

Software applications and daemons almost always provide some sort of configuration mechanism. This is usually done via flat files which are often located somewhere in the /etc/ directory structure on Unix machines. There have been no successful approaches in the past to improve the current situation in which every application uses a different configuration style. A similar situation can be found with Inter-process communication (IPC) mechanisms which are often used for fetching the operational data and triggering arbitrary remote procedure call (RPC). The Sysrepo project aims to improve the current diverse situation and finally resolve the open questions on configuration and operational data management such as addressing various cofiguration file formats and glue code. Sysrepo enables the developers to write code and focus on the important functionality while Sysrepo takes care of configuration and operational data.

The main parts of Sysrepo project are Sysrepo Datastore and Netopeer 2 NETCONF Server, both described below. The possible ways of application integration are shown on the integration page.

Sysrepo team members participated in the latest IETF Hackathon. Find out more.

Sysrepo Datastore

Sysrepo is aYANG-based configuration and operational datastore 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 the YANG model. With the help of Netopeer 2 NETCONF server, the applications also automatically become remotely manageable via NETCONF.

A high-level overview of Sysrepo can be seen in the image below

Sysrepo high-level architecture

Find out more about sysrepo datastore on this page or on GitHub.

Netopeer 2 NETCONF Server

Netopeer 2 is the 2nd generation of the well-known open-source NETCONF server, that uses sysrepo as the datastore implementation. Together they provide a complete NETCONF management framework for Linux.

Find out more about Netopeer 2 on the github.

To see how Sysrepo & Netopeer 2 can be used to make an existing Linux application remotely manageable via NETCONF in a few hours, see our dnsmasq demo, snabb demo or openssh demo.

For an existing Lua Linux application see snabb demo.

Other utilities used by the sysrepo project

The sysrepo project uses or is used by other projects in the ecosystem. At the moment we are keeping these tools available here with more information available on their respective pages.

YANG Creator

YANG creator is an online tool for creating, editing, and exporting YANG. The tool enables you to:

Find out more about YANG Creatorhere.

testconf

The aim of this project is to provide a NETCONF testing suite.

testconf is implemented in Node.js and supports fast prototyping through testing of both NETCONF clients and NETCONF servers. That way developers can easily:

testconf can be used to run interoperability tests as well which testifies to Sysrepo's cross-use functionality. Additionally, it can be used to generate template code from YANG models.

Extending testconf with your custom defined tests shortens the time spent on repetitive tasks and helps to pinpoint bugs. This way developers can focus more on the implementation of new features.

More info on the NETCONF testing suite can be found here.

Make testconf automatically run tests for data leafs of existing configuration data on the server. Check out more about autotesting feature here.

The configuration management feature uses an ncurses-like interface for getting existing nodes from the device and editing them to your liking. Find out more about it here.

Similarly to snmp, testconf uses get, set and walk commands. All of these commands use XPATH to manipulate data nodes in NETCONF. Read more about it here.

Language bindings

Sysrepo supports Python 2, Python 3, Lua 5.1, Lua 5.2 and Java.

If you want to find out how to build and use the Python 3 bindings take a look at here.

If you want to find out how to build and use the Lua 5.2 bindings take a look at here.

If you want to find out how to build and use the Java bindings take a look at here.

If you want to find out how to use the Go bindings take a look at here.

Performance

The Sysrepo project has performance tests written in C and in Python2, the C performance tests are here and the Python2 performance tests are here.

Network performance tests via testconf are available here.

Contact

It's easy to get in touch with the team. You can reach us via public sysrepo-announce@sysrepo.org or sysrepo-devel@sysrepo.org mailing list. For non-public communication feel free to reach us at sysrepo-private@sysrepo.org . One can subscribe to the mailing lists here. We can also be reached via GitHub.

Sysrepo (last edited 2017-04-08 14:40:21 by mikael)