Sign upLogin

intracom-telecom-sdn/nstat

View on GitHub
Star
README.md

Summary

Maintainability
Test Coverage
Trailing spaces
Line length
[![Code Climate](https://codeclimate.com/github/intracom-telecom-sdn/nstat/badges/gpa.svg)](https://codeclimate.com/github/intracom-telecom-sdn/nstat)
Trailing spaces
Line length
[![Documentation Status](https://readthedocs.org/projects/nstat/badge/?version=latest)](http://nstat.readthedocs.io/en/latest/?badge=latest)
Trailing spaces
Line length
[![Build Status](https://travis-ci.org/intracom-telecom-sdn/nstat.svg?branch=master)](https://travis-ci.org/intracom-telecom-sdn/nstat)
Trailing spaces
Line length
[![Docker Automated build](https://img.shields.io/docker/automated/jrottenberg/ffmpeg.svg?maxAge=2592000)](https://hub.docker.com/r/intracom/nstat/)
Trailing spaces
Line length
[![Issue Count](https://codeclimate.com/github/intracom-telecom-sdn/nstat/badges/issue_count.svg)](https://codeclimate.com/github/intracom-telecom-sdn/nstat)
Trailing spaces
Line length
[![Code Health](https://landscape.io/github/intracom-telecom-sdn/nstat/master/landscape.svg?style=flat)](https://landscape.io/github/intracom-telecom-sdn/nstat/master)
Trailing spaces
Line length
[![Coverage Status](https://coveralls.io/repos/intracom-telecom-sdn/nstat/badge.svg?branch=master&service=github)](https://coveralls.io/github/intracom-telecom-sdn/nstat?branch=master)
Trailing spaces
Line length
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2c0663990de243a09e986d4f30b59dd3)](https://www.codacy.com/app/kostis-g-papadopoulos/nstat?utm_source=github.com&utm_medium=referral&utm_content=intracom-telecom-sdn/nstat&utm_campaign=Badge_Grade)
Line length
Trailing spaces
[![Code Issues](https://www.quantifiedcode.com/api/v1/project/fcb21ff93ae24832a562595afafcd94f/badge.svg)](https://www.quantifiedcode.com/app/project/fcb21ff93ae24832a562595afafcd94f)
Trailing spaces
 
Trailing spaces
Headers should be surrounded by blank lines
# NSTAT: Network Stress-Test Automation Toolkit
Trailing spaces
 
Trailing spaces
Headers should be surrounded by blank lines
## Overview
Trailing spaces
 
Trailing spaces
NSTAT is an environment written in Python for easily writing and running
Trailing spaces
SDN controller stress tests in a highly-configurable and modular manner.
Trailing spaces
 
Trailing spaces
Key features in brief:
Trailing spaces
Lists should be surrounded by blank lines
Line length
- [Fully automated, end-to-end testing](https://github.com/intracom-telecom-sdn/nstat/wiki/NSTAT#work-flow) with exhaustive test cases
Trailing spaces
Line length
- Easy and rich [configuration system](https://github.com/intracom-telecom-sdn/nstat/wiki/NSTAT#configuration-keys)
Trailing spaces
Line length
- Scalable traffic generation with [MT-Cbench](https://github.com/intracom-telecom-sdn/mtcbench) emulator,
Trailing spaces
  able to emulate networks in the order of thousands of switches
Trailing spaces
Headers must start at the beginning of the line
- Unification of different stress tests, see below:
Headers must start at the beginning of the line
Line length
Trailing spaces
    - [Switch scalability test with active MT-Cbench switches](https://github.com/intracom-telecom-sdn/nstat/wiki/Switch-scalability-test-with-active-MT-Cbench-switches)
Trailing spaces
Headers must start at the beginning of the line
Line length
    - [Switch scalability test with active Multinet switches](https://github.com/intracom-telecom-sdn/nstat/wiki/Switch-scalability-test-with-active-Multinet-switches)
Headers must start at the beginning of the line
Trailing spaces
Line length
    - [Switch scalability test with idle MT-Cbench switches](https://github.com/intracom-telecom-sdn/nstat/wiki/Switch-scalability-test-with-idle-MT-Cbench-switches)
Headers must start at the beginning of the line
Line length
Trailing spaces
    - [Switch scalability test with idle Multinet switches](https://github.com/intracom-telecom-sdn/nstat/wiki/Switch-scalability-test-with-idle-Multinet-switches)
Trailing spaces
Headers must start at the beginning of the line
Line length
    - [Controller stability test with active MT-Cbench switches](https://github.com/intracom-telecom-sdn/nstat/wiki/Controller-stability-test-with-active-MT-Cbench-switches)
Trailing spaces
Line length
Headers must start at the beginning of the line
    - [Controller stability test with idle Multinet switches](https://github.com/intracom-telecom-sdn/nstat/wiki/Controller-stability-test-with-idle-Multinet-switches)
Trailing spaces
Line length
    - [Flow scalability test with idle Multinet switches](https://github.com/intracom-telecom-sdn/nstat/wiki/Flow-scalability-test-with-idle-Multinet-switches)
Trailing spaces
- Comprehensive reporting and configurable plotting
Trailing spaces
 
Trailing spaces
Line length
For a detailed features listing have a look at the [features](https://github.com/intracom-telecom-sdn/nstat/wiki/Features) page.
Trailing spaces
 
Trailing spaces
-----------------------------------------------------------
Trailing spaces
 
Trailing spaces
Trailing punctuation in header
Headers should be surrounded by blank lines
## Get started!
Trailing spaces
 
Trailing spaces
To get started right away and run some sample test cases, proceed to the
Trailing spaces
[installation](https://github.com/intracom-telecom-sdn/nstat/wiki/Installation)
Trailing spaces
page.
Trailing spaces
 
Trailing spaces
-----------------------------------------------------------
Trailing spaces
 
Trailing spaces
Headers should be surrounded by blank lines
## Read the docs
Trailing spaces
 
Trailing spaces
Line length
- [NSTAT testing procedure, command line options and configuration parameters](https://github.com/intracom-telecom-sdn/nstat/wiki/NSTAT)
Trailing spaces
- documentation for tests
Trailing spaces
Line length
- [MT-Cbench](https://github.com/intracom-telecom-sdn/mtcbench) traffic generator
Trailing spaces
Line length
- [code design, concepts and conventions](https://github.com/intracom-telecom-sdn/nstat/wiki/Code-design)
Line length
Trailing spaces
- [code structure](https://github.com/intracom-telecom-sdn/nstat/wiki/Code-design#code-structure)
Line length
Trailing spaces
- [plotting methodology](https://github.com/intracom-telecom-sdn/nstat/wiki/Plotting)
Trailing spaces
 
Trailing spaces
-----------------------------------------------------------
Trailing spaces
 
Headers should be surrounded by blank lines
Trailing spaces
## Browse performance results
Trailing spaces
 
Trailing spaces
Line length
- [02/07/2017]: Performance Stress Tests Report v1.3: **"Beryllium Vs Boron"** ([pdf](https://raw.githubusercontent.com/wiki/intracom-telecom-sdn/nstat/files/ODL_performance_report_v1.3.pdf))
Trailing spaces
 
Trailing spaces
Line length
- [05/19/2016]: Performance Stress Tests Report v1.2: **"Beryllium Vs Lithium SR3"** ([pdf](https://raw.githubusercontent.com/wiki/intracom-telecom-sdn/nstat/files/ODL_performance_report_v1.2.pdf))
Trailing spaces
 
Trailing spaces
Line length
- [01/02/2016]: Performance Stress Tests Report v1.1: **"Lithium SR3"** ([pdf](https://raw.githubusercontent.com/wiki/intracom-telecom-sdn/nstat/files/ODL_performance_report_v1.1.pdf))
Trailing spaces
 
Line length
Trailing spaces
- [06/29/2015]: Performance Stress Tests Report v1.0: **"Lithium vs Helium Comparison"**: ([pdf](https://raw.githubusercontent.com/wiki/intracom-telecom-sdn/nstat/files/ODL_performance_report_v1.0.pdf))
Trailing spaces
 
Trailing spaces
Line length
Indicative experimental results from [switch  scalability](https://github.com/intracom-telecom-sdn/nstat/wiki/ODL-Helium-SR3-switch-scalability-results)
Line length
Trailing spaces
and [stability](https://github.com/intracom-telecom-sdn/nstat/wiki/ODL-Helium-SR3-stability-results)
Trailing spaces
test cases with OpenDaylight controller are also provided.
Trailing spaces
 
Trailing spaces
Line length
The [CPU shares](https://github.com/intracom-telecom-sdn/nstat/wiki/Capping-controller-and-generator-CPU-resources-in-collocated-tests) page
Trailing spaces
shows the performance effect of allocating different CPU partitions
Trailing spaces
to individual NSTAT test components.
Trailing spaces
 
Trailing spaces
-----------------------------------------------------------
Trailing spaces
 
Trailing spaces
Trailing punctuation in header
Headers should be surrounded by blank lines
## What's next?
Trailing spaces
 
Line length
Trailing spaces
Plans and ideas for next releases are provided in the [future releases](https://github.com/intracom-telecom-sdn/nstat/wiki/Future-releases) page.
Trailing spaces
 
Trailing spaces
-----------------------------------------------------------
Trailing spaces
 
Headers should be surrounded by blank lines
Trailing spaces
## Contact and Support
Trailing spaces
 
Line length
Trailing spaces
For issues regarding NSTAT, please use the [issue tracking](https://github.com/intracom-telecom-sdn/nstat/issues) section.
Trailing spaces
 
Trailing spaces
Line length
For any other questions and feedback, contact us at [nstat-support@intracom-telecom.com](mailto:nstat-support@intracom-telecom.com).