README.md

YANG System management for embedded devices running Linux

Together with sysrepo, this software provides "general system management" of embedded devices. The target platform is anything that runs Linux with systemd. This runs in production on CzechLight SDN DWDM devices.

Health tracking

This component tracks the overal health state of the system, including various sensors, or the state of systemd units. As an operator-friendly LED at the front panel of the appliance shows the aggregated health state.

System management

Firmware can be updated via RAUC, and various aspects of the system's configuration can be adjusted. This includes a firewall, basic network settings, and authentication management.

Supported YANG models

For a full list, consult the yang/ directory in this repository.

• ietf-access-control-list, RFC 8519 (with deviations)
• ietf-hardware, RFC 8348
• ietf-system, RFC 7317 (partial support)
• ietf-interfaces, RFC 8343 (generating config for systemd-networkd, with extensions)
• ietf-routing, RFC 8349 (see above)
• czechlight-system

Installation

For building, one needs:

• C++20 compiler (e.g., GCC 10.x+, clang 10+)
• CMake 3.19+
• Boost (we're testing with 1.78)
• pkg-config
• libnl-route for talking to the Linux kernel
• libsystemd and systemd at runtime
• libyang-cpp - C++ bindings for libyang
• sysrepo-cpp - C++ bindings for sysrepo
• spdlog - a logging library
• sdbus-c++ - C++ library for D-Bus
• fmt - C++ string formatting library
• nlohmann_json - C++ JSON library
• docopt for CLI option parsing
• nft - the netfilter tool
• optionally, Doctest as a C++ unit test framework
• optionally, trompeloeil for mock objects in C++
• optionally, iproute2 - the ip tool for testing
• optionally, jq to run some CLI utilities and for testing them

The build process uses CMake. A quick-and-dirty build with no fancy options can be as simple as mkdir build && cd build && cmake .. && make && make install.