Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/SUNET/cnaas-nms

Campus Network as-a-Service - Network Management System (Campus network automation software)
https://github.com/SUNET/cnaas-nms

automation network network-automation network-programming

Last synced: 3 months ago
JSON representation

Campus Network as-a-Service - Network Management System (Campus network automation software)

Host: GitHub
URL: https://github.com/SUNET/cnaas-nms
Owner: SUNET
License: other
Created: 2019-02-01T14:29:08.000Z (over 5 years ago)
Default Branch: develop
Last Pushed: 2024-01-17T13:39:58.000Z (6 months ago)
Last Synced: 2024-01-18T00:32:09.215Z (6 months ago)
Topics: automation, network, network-automation, network-programming
Language: Python
Homepage:
Size: 2.86 MB
Stars: 66
Watchers: 20
Forks: 13
Open Issues: 30
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt

Lists

awesome-networking - CNaaS-NMS - Campus Network-as-a-Service - Network Management System. Software to automate management of a campus network (LAN). (Network Automation / SD-WAN)

README

[![Documentation Status](https://readthedocs.org/projects/cnaas-nms/badge/?version=latest)](https://cnaas-nms.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/gh/SUNET/cnaas-nms/branch/master/graph/badge.svg)](https://codecov.io/gh/SUNET/cnaas-nms) [![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110/)

# CNaaS-NMS

Campus Network-as-a-Service - Network Management System. Software to automate management of a campus network (LAN). This is an open source software developed as part of SUNETs managed service.

Planned features:
1. Zero-touch provisioning of switches
1. Automation of common changes for campus LAN
1. Automated procedure for firmware upgrades
1. Multi-vendor support

[Documentation](https://cnaas-nms.readthedocs.io/)

## Components

![CNaaS component architecture](cnaas-components-20190408.png?raw=true)

## Requirements

Docker and docker-compose or:

1. python3.7 or later
1. install requirements.txt
1. SQL database, Redis

## Installation

Install docker and docker-compose and run: docker-compose build -f docker/docker-compose.yaml

Or install locally by creating a virtualenv and activate the environment, then:

```
python3 -m pip install -r requirements.txt
cp etc/db_config.yml.sample /etc/cnaas-nms/db_config.yml
```

Edit db_config.yml to point to your SQL and redis database.

## Test

```
cd src/
python3 -m cnaas_nms.api.tests.test_api
python3 -m cnaas_nms.confpush.tests.test_get
```

## Authorization

Currently we can use two styles for the authorization. We can use the original style or use OIDC style. For OIDC we need to define some env variables or add a auth_config.yaml in the config. The needed variables are: OIDC_CONF_WELL_KNOWN_URL, OIDC_CLIENT_SECRET, OIDC_CLIENT_ID, FRONTEND_CALLBACK_URL and OIDC_ENABLED. To use the OIDC style the last variable needs to be set to true.

## License

See LICENSE.txt for more info.