Skip to content

telekom/sysrepo-plugin-interfaces

Folders and files

NameName
Last commit message
Last commit date

Latest commit

dddd672 · Oct 11, 2022
Aug 23, 2022
Feb 19, 2022
Mar 22, 2021
Sep 29, 2021
Sep 9, 2022
Oct 11, 2022
Sep 6, 2022
Sep 29, 2021
Aug 9, 2022
Feb 11, 2022
Jul 22, 2021
Feb 19, 2022
Aug 11, 2022
Nov 19, 2021
Jun 29, 2021
Jun 29, 2021
Sep 26, 2022
Jun 29, 2021
Feb 20, 2021
Mar 25, 2022
Jun 29, 2021

Repository files navigation

Sysrepo Plugin Interfaces

DevelopmentDocumentationSupportContributeContributorsLicensing

The goal of this project is to provide a method of configuring networking on generic Linux systems using the Sysrepo NETCONF server implementation.

About this component

This repository contains several Sysrepo plugins related to newtork management.

The first, sysrepo-plugin-interfaces is based on the ietf-interfaces YANG module which contains "a collection of YANG definitions for managing network interfaces". More information about the specific YANG module can be found in RFC 7223: A YANG Data Model for Interface Management.

The second, sysrepo-plugin-routing is based on the ietf-routing YANG module which contains "generic components of a routing data model" and ietf-ipv4-unicast-routing and ietf-ipv6-unicast-routing which augment ietf-routing with IPv4 and IPv6 specific data. More information about ietf-routing is available in RFC 8022: A YANG Data Model for Routing Management

Development

Besides the usual C development environment, the following additional dependencies are required:

  • libyang
  • sysrepo
  • pthreads
  • netlink

Build

First clone the repository:

# clone recursively to also clone uthash library
$ git clone https://github.com/telekom/sysrepo-plugin-interfaces --recursive

Next, create a build directory and generate the build recipes using CMake:

$ mkdir build
$ cd build
$ cmake ..

By default both plugins will be built, but either of them can be disabled by setting the appropriate CMake plugin option to OFF. For example, to build only the routing plugin the following command should be executed instead:

$ cmake -DINTERFACES_PLUGIN=OFF ..

The default configuration builds the plugins as stand-alone foreground applications. To build the plugins as shared object files for use with sysrepo-plugind, run the following instead:

$ cmake -DPLUGIN=ON ..

Lastly, invoke the build and install using make:

$ make -j$(nproc) install

The plugins require several YANG modules to be loaded into the Sysrepo datastore and several features need to be enabled. For the interfaces plugin this can be achieved by invoking the following commands:

$ sysrepoctl -i ./yang/[email protected]
$ sysrepoctl -i ./yang/[email protected]
$ sysrepoctl -i ./yang/[email protected]
$ sysrepoctl -i ./yang/[email protected]
$ sysrepoctl -i ./yang/ieee802-dot1q-types.yang
$ sysrepoctl -i ./yang/[email protected]
$ sysrepoctl --change ietf-interfaces --enable-feature if-mib
$ sysrepoctl --change ietf-if-extensions --enable-feature sub-interfaces

For the routing plugin, the following models have to be installed:

$ sysrepoctl -i ./yang/[email protected]
$ sysrepoctl -i ./yang/[email protected]
$ sysrepoctl -i ./yang/[email protected]
$ sysrepoctl -i ./yang/[email protected]
$ sysrepoctl -i ./yang/[email protected]
$ sysrepoctl -i ./yang/[email protected] -s ./yang

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.

Working Language

We decided to apply English as the primary project language.

Consequently, all content will be made available primarily in English. We also ask all interested people to use English as language to create issues, in their code (comments, documentation etc.) and when you send requests to us. The application itself and all end-user facing content will be made available in other languages as needed.

Documentation

The full documentation for the Sysrepo interfaces and routing plugins can be found in the documentation directory.

Support and Feedback

The following channels are available for discussions, feedback, and support requests:

Type Channel
Issues
Other Requests

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

Copyright (C) 2021 Deutsche Telekom AG.

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.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published