OpenStack Networking (Neutron)
Go to file
Sean M. Collins 72398f1f69 Developer documentation
* Turns TESTING into a rst file, that we include in the developer
  documentation, for instructions on how to run the unit tests.
* Link to a Vagrant project that sets up Neutron inside a VM.
* Adds a section for how to debug with Nose
* Add new section for Neutron Internals
* Neutron L2 Agent documentation - currently only OVS
* Make the Security Group API extension an example of how an API
  extension is implemented

Implements bp developer-documentation

Change-Id: I9b452abc9da3b1a41ae65cff727967de0eab12fe
2014-02-26 11:03:46 -05:00
bin Use oslo.rootwrap library instead of local copy 2014-02-07 10:58:27 +01:00
doc Developer documentation 2014-02-26 11:03:46 -05:00
etc Merge "Replace binding:capabilities with binding:vif_details" 2014-02-24 14:57:27 +00:00
neutron Merge "Replace binding:capabilities with binding:vif_details" 2014-02-24 14:57:27 +00:00
quantum Re-assign quantum.api module as last operation 2013-07-15 22:51:28 +02:00
tools Merge "Corrects broken format strings in check_i18n.py" 2014-01-07 14:11:59 +00:00
.coveragerc fix some missing change from quantum to neutron 2013-07-08 12:11:04 +08:00
.gitignore Updates .gitignore 2013-11-28 23:18:03 +08:00
.gitreview Rename quantum to neutron in .gitreview. 2013-07-06 12:25:09 -04:00
.mailmap mailmap: update .mailmap 2014-02-10 15:48:48 +09:00
.pylintrc Rename Quantum to Neutron 2013-07-06 15:02:43 -04:00
.testr.conf Add an explicit tox job for functional tests 2014-02-05 17:11:52 +00:00
HACKING.rst Cleanup HACKING.rst 2013-11-11 10:32:34 -08:00
LICENSE Adding Apache Version 2.0 license file. This is the official license agreement under which Quantum code is available to 2011-08-08 12:31:04 -07:00
MANIFEST.in Rename Quantum to Neutron 2013-07-06 15:02:43 -04:00
README.rst Rename Quantum to Neutron 2013-07-06 15:02:43 -04:00
TESTING.rst Developer documentation 2014-02-26 11:03:46 -05:00
babel.cfg Use babel to generate translation file 2013-01-24 00:20:32 +08:00
openstack-common.conf Merge "Remove dependent module py3kcompat" 2014-02-23 06:30:59 +00:00
requirements.txt Sync minimum requirements 2014-02-20 18:56:38 -05:00
run_tests.sh Merge "Don't document non-existing flag '--hide-elapsed'" 2014-02-22 04:05:04 +00:00
setup.cfg Merge "Copy cache package from oslo-incubator" 2014-02-21 12:38:22 +00:00
setup.py Updated from global requirements 2013-10-01 16:13:29 +00:00
test-requirements.txt Updated from global requirements 2014-02-23 09:26:34 +00:00
tox.ini Merge "Add an explicit tox job for functional tests" 2014-02-11 08:03:05 +00:00

README.rst

# -- Welcome!

You have come across a cloud computing network fabric controller. It has identified itself as "Neutron." It aims to tame your (cloud) networking!

# -- External Resources:

The homepage for Neutron is: http://launchpad.net/neutron . Use this site for asking for help, and filing bugs. Code is available on github at <http://github.com/openstack/neutron>.

The latest and most in-depth documentation on how to use Neutron is available at: <http://docs.openstack.org>. This includes:

Neutron Administrator Guide http://docs.openstack.org/trunk/openstack-network/admin/content/

Neutron API Reference: http://docs.openstack.org/api/openstack-network/2.0/content/

The start of some developer documentation is available at: http://wiki.openstack.org/NeutronDevelopment

For help using or hacking on Neutron, you can send mail to <mailto:openstack-dev@lists.openstack.org>.