https://github.com/netgroup/rose-srv6-control-plane
This project provides a collection of modules implementing different control plane functionalities of a Software Defined Network (SDN).
https://github.com/netgroup/rose-srv6-control-plane
arango arangodb control-plane grpc sdn sdn-controller sdn-srv6-controller segment-routing srv6 srv6-controller srv6-functions
Last synced: 22 days ago
JSON representation
This project provides a collection of modules implementing different control plane functionalities of a Software Defined Network (SDN).
- Host: GitHub
- URL: https://github.com/netgroup/rose-srv6-control-plane
- Owner: netgroup
- License: apache-2.0
- Created: 2020-05-07T11:55:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-18T10:28:15.000Z (almost 2 years ago)
- Last Synced: 2024-04-20T21:33:38.695Z (almost 2 years ago)
- Topics: arango, arangodb, control-plane, grpc, sdn, sdn-controller, sdn-srv6-controller, segment-routing, srv6, srv6-controller, srv6-functions
- Language: Python
- Homepage: https://netgroup.github.io/rose-srv6-control-plane
- Size: 7.07 MB
- Stars: 21
- Watchers: 9
- Forks: 7
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ROSE SRv6 Control Plane 
> Control plane functionalities for SDN.
## Table of Contents
* [Getting Started](#getting-started)
* [Project Overview](#project-overview)
* [Database utilities](#database-utilities)
* [Control plane functionalities](#control-plane-functionalities)
* [Node manager](#node-manager)
* [Controller](#controller)
* [Protocol Buffers](#protocol-buffers)
* [Usage examples](#usage-examples)
* [How to use the Controller CLI](#how-to-use-the-controller-cli)
* [How to use the Controller API in your Python application](#how-to-use-the-controller-api-in-your-python-application)
* [Docker](#docker)
* [Build the Docker image](build-the-docker-image)
* [Run the controller container](#run-the-controller-container)
* [Run the node-manager container](#run-the-node-manager-container)
* [Access to the Docker container](#access-to-the-docker-container)
* [Requirements](#requirements)
* [Links](#links)
* [Issues](#issues)
* [Contributing](#contributing)
* [Versioning](#versioning)
* [License](#license)
## Getting Started
This project provides a collection of modules implementing different control plane functionalities of a Software Defined Network (SDN), including SRv6 tunnel management aspects, exporting and uploading the network topology to a database and monitoring the performance of a network.
The project is part of a larger ecosystem called [Research on Open SRv6 Ecosystem (ROSE)](https://netgroup.github.io/rose/).
ROSE Homepage:
https://netgroup.github.io/rose
Documentation:
https://netgroup.github.io/rose-srv6-control-plane
Report a bug:
https://github.com/netgroup/rose-srv6-control-plane/issues
Contact page:
https://netgroup.github.io/rose/rose-contacts.html
To start using the project, you need to clone this repository:
```console
$ git clone https://github.com/netgroup/rose-srv6-control-plane
```
## Project Overview
This repository is structured as follows:
.
├── db_update # Database utilities
├── control_plane # Control plane modules
├── Dockerfile # Dockerfile
├── LICENSE # Apache 2.0 license text
└── README.md
## Database utilities
*db_update* is a Python library used to connect the Controller to a database. Using this library, the Controller can interact with a database in order to store information like the topology graph of a network.
## Control plane functionalities
The *control_plane* folder contains the two main components of this project:
* Controller, a SDN Controller
* Node Manager, an agent that must be installed on the node that you want to control through the SDN Controller.
The Controller uses a gRPC API to contact the Linux nodes. A gRPC server (Node Manager) must be run on the Linux nodes that you want to control through the Controller.
The Controller (i.e. the gRPC client from the point of view of the gRPC protocol) interacts with the gRPC server executed on the nodes to enforce rules or configurations, such as the setup of SRv6 paths and behaviors.
The control-plane modules are organized as follows:
.
├── ...
├── control_plane # Control plane modules
| ├── controller # Controller (gRPC client)
| ├── examples # Usage examples
| ├── node-manager # Node Manager (gRPC server)
| └── protos # Protocol buffer files
└── ...
### Node manager
The **control_plane/node-manager** package implements the functionalities of an agent which connects a Linux node to the Controller. A Node Manager must be executed on each node that you want to control through the Controller.
Refer the [Docker](#docker) section for details on how to use the Node Manager in a pre-built docker container. For more information about the installation and usage of the Node Manager follow the instructions contained in the *README.md* file under the *node-manager* folder.
### Controller
The **control_plane/controller** package implements different functionalities of a Controller.
Refer the [Docker](#docker) section for details on how to use the Controller in a pre-built docker container. For more information about the installation and usage of the Node Manager follow the instructions contained in the *README.md* file under the *controller* folder.
### Protocol Buffers
This project depends on the **grpcio** library that provides an implementation of the gRPC protocol. gRPC services use Protocol Buffers as Interface Description Language (IDL). Consequently, both the Controller and the Node Manager require some Python classes generated from the .proto files stored in the **control_plane/protos** folder.
The compilation and generation of the Python classes required by the gRPC protocol has been automated in the setup scripts of the Controller and Node Manager.
### Usage examples
There are two ways to use the functionalities offered by the Controller. You can execute the Python Command-Line Interface (CLI) provided by the Controller or you can import the Controller modules in your Python application and use the API exposed by the Controller.
#### How to use the Controller CLI
For a description of the CLI and the supported commands, see the documentation contained in the [control_plane/controller](control_plane/controller/README.md) folder.
#### How to use the Controller API in your Python application
For a description of the API exposed by the Controller, see the API reference contained in the [control_plane/controller](control_plane/controller/README.md) folder.
Moreover, the usage examples contained in the **control_plane/examples** folder can be an excellent starting point for understanding how to use the API and the features of the Controller.
## Docker
### Build the Docker image
From the root directory of the repository execute the following command
inorder to build the controller image:
docker build --target controller -t rose-srv6-controller:latest . --no-cache
inorder to build the node-manager image:
docker build --target node-manager -t rose-srv6-node-manager:latest . --no-cache
### Run the controller container
docker run --name rose-srv6-controller -it rose-srv6-controller:latest bash
### Run the node-manager container
Currently the exposed port is 12345
docker run --name rose-srv6-node-manager -p 12345:12345 rose-srv6-node-manager:latest
### Access to the Docker container
docker exec -it bash
for instance access to rose-srv6-controller with:
docker exec -it rose-srv6-node-manager bash
## Requirements
* Linux kernel >= 4.14
* Python >= 3.6
## Links
* Research on Open SRv6 Ecosystem (ROSE): https://netgroup.github.io/rose/
* Source code: https://github.com/netgroup/rose-srv6-control-plane
* Documentation: https://netgroup.github.io/rose-srv6-control-plane
* Report a bug: https://github.com/netgroup/rose-srv6-control-plane/issues
## Issues
You are welcome to open github issues for bug reports and feature requests, in [this repository](https://github.com/netgroup/rose-srv6-control-plane/issues) or in the [ROSE repository](https://github.com/netgroup/rose/issues).
## Contributing
If you want to contribute to the ecosystem, provide feedback or get in touch with us, see our contact page: https://netgroup.github.io/rose/rose-contacts.html.
## Versioning
We use [SemVer](https://semver.org/) for versioning.
## License
This project is licensed under the [Apache License, Version 2.0](https://github.com/netgroup/rose-srv6-control-plane/blob/master/LICENSE).