Home

Awesome

Documentation Status codecov Python 3.11

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
  2. Automation of common changes for campus LAN
  3. Automated procedure for firmware upgrades
  4. Multi-vendor support

Documentation

Components

CNaaS component architecture

Requirements

Docker and docker-compose or:

  1. python3.7 or later
  2. install requirements.txt
  3. 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

Copyright (c) 2019 - 2020, SUNET (BSD 2-clause license)

See LICENSE.txt for more info.