9a749d3a67
* 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
50 lines
2.0 KiB
ReStructuredText
50 lines
2.0 KiB
ReStructuredText
..
|
|
Copyright 2010-2013 United States Government as represented by the
|
|
Administrator of the National Aeronautics and Space Administration.
|
|
All Rights Reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
Setting Up a Development Environment
|
|
====================================
|
|
|
|
This page describes how to setup a working Python development
|
|
environment that can be used in developing Neutron on Ubuntu, Fedora or
|
|
Mac OS X. These instructions assume you're already familiar with
|
|
Git and Gerrit, which is a code repository mirror and code review toolset
|
|
, however if you aren't please see `this Git tutorial`_ for an introduction
|
|
to using Git and `this wiki page`_ for a tutorial on using Gerrit and Git for
|
|
code contribution to Openstack projects.
|
|
|
|
.. _this Git tutorial: http://git-scm.com/book/en/Getting-Started
|
|
.. _this wiki page: https://wiki.openstack.org/wiki/Gerrit_Workflow
|
|
|
|
Following these instructions will allow you to run the Neutron unit
|
|
tests. If you want to be able to run Neutron in a full OpenStack environment,
|
|
you can use the excellent `DevStack`_ project to do so. There is a wiki page
|
|
that describes `setting up Neutron using DevStack`_.
|
|
|
|
.. _DevStack: https://github.com/openstack-dev/devstack
|
|
.. _setting up Neutron using Devstack: https://wiki.openstack.org/wiki/NeutronDevstack
|
|
|
|
Getting the code
|
|
----------------
|
|
|
|
Grab the code from GitHub::
|
|
|
|
git clone git://git.openstack.org/openstack/neutron.git
|
|
cd neutron
|
|
|
|
|
|
.. include:: ../../../TESTING.rst
|