Augyang

Augyang is a framework that adds YANG support for configuration files supported by Augeas. In other words, using this suite you can ultimately add support for remote management of configuration files described by Augeas lenses without writing any specific code.

This framework consists of the following components:

augyang - tool for generating YANG files for Augeas lenses
srds_augeas - sysrepo custom datastore plugin that handles transformation of Augeas data to YANG data and vice versa
ay_startup - small utility using srds_augeas functionality to get current system configuration for a particular Augeas lens and printing it in YANG XML data

Requirements

Build Requirements

C compiler (gcc >= 4.8.4, clang >= 3.0, ...)
cmake >= 2.8.12
augeas
- is statically linked to augyang so as part of the build process it is downloaded and compiled locally
libyang
sysrepo

Optional

cmocka >= 1.0.1 (for tests only, see Tests)
netopeer2 (adding NETCONF support on top of sysrepo)

Building And Installation

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

Target install_lens installs new and fixed lens by replacing the ones provided by the Augeas packages. The changes include only fixed bugs in the lenses and without them the tests may fail or it will not be possible to read/write valid values of configuration files managed by srds_augeas.

Note that by default, these steps will fully install the whole suite. That means generating YANG modules for all the supported Augeas lenses, installing these modules into sysrepo with their current content read from the system and put into the startup datastore, and finally installing srds_augeas custom DS plugin into sysrepo. All this can be customized by compile-time variables mentioned in the following section.

Also, all the supported lenses pass basic tests but they have not been used much in practice yet. So, bear this in mind when configuring core system daemons.

Useful CMake Augyang Options

Set the list of supported Augeas lenses to generate/install:

-DSUPPORTED_LENSES="passwd simplevars"

Set whether to install custom DS plugin and YANG modules into sysrepo:

-DINSTALL_MODULES=OFF

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" ..

Tests

There are several tests included and 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_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

Usage

You can take a look at the tutorial.

Code of Conduct

This project has adopted the Contributor Covenant in version 2.0 as our code of conduct. Please see the details in our CODE_OF_CONDUCT.md. All contributors must abide by the code of conduct.

How to Contribute

Contribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines. By participating in this project, you agree to abide by its Code of Conduct at all times.

Contributors

Our commitment to open source means that we are enabling -in fact encouraging- all interested parties to contribute and become part of its developer community.

Licensing

Licensed under the BSD 3-Clause License (the "License"); you may not use this file except in compliance with the License.

You may obtain a copy of the License by reviewing the file LICENSE in the repository.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.

wungad/sysrepo-augeas