x
/
neutron-classifier
Code Issues Proposed changes

Update README.rst 

This patch includes an updated README version.

Changes include:
 - update of description paragraph
 - addition of feature
 - addition of background on the subject column

Change-Id: Id95c90e63dc74aeaba4d4d6b59dd79646020cad1
This commit is contained in:
Sara Nierodzik 2019-08-09 14:48:41 +00:00
parent 1603f200d7
commit 8a18025b1e
1 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.rst
View File

@ -2,18 +2,32 @@
neutron-classifier
===============================
Common database model for services that classify packets
This project provides a common API plugin for services to classify traffic in
Neutron as well as an agent extension implementation to distribute these classifications.
Please feel here a long description which must be at least 3 lines wrapped on
80 cols, so that distribution package maintainers can use it in their packages.
Note that this is a hard requirement.
The neutron-classifier provides a common API for all neutron services to deliver
a consistent interface for tenants to define specific traffic classifications.
The usage of the agent extension aids in the propagation of classifications to the
backend. The project rose from the need to create a plugin that is common to all
projects in order to prevent duplicates or varied versions of traffic classification work.
The currently supported classification types include ethernet, ipv4, IPv6, IPv4, tcp, udp.
In order to group those types and provide a common relation, classification groups are used.
Any feedback from users is welcome. The features as well as the API may evolve
based on that feedback.
* Free software: Apache license
* Documentation: https://wiki.openstack.org/wiki/Neutron/CommonClassificationFramework
* Source: https://git.openstack.org/cgit/openstack/neutron-classifier
* Documentation: https://specs.openstack.org/openstack/neutron-specs/specs/pike/common-classification-framework.html
* Wiki: https://wiki.openstack.org/wiki/Neutron/CommonClassificationFramework
* Source: https://opendev.org/x/neutron-classifier/
* Bugs: https://bugs.launchpad.net/neutron
Features
--------
* Flexible classification of network traffic
* TODO
Background on the Subject of Common Classification Frameworks
-------------------------------------------------------------
* Original Neutron RFE: https://bugs.launchpad.net/neutron/+bug/1476527
* Traffic Classification in Neutron QoS: https://bugs.launchpad.net/neutron/+bug/1527671