Avoid using include to outside in document
include directive works in Sphinx, but it is not well handled when we see doc/source in github repository browser. Change-Id: Ibebb427f68ea52f1dd38c4d9531d30dda3def07b
This commit is contained in:
Akihiro Motoki
parent
5d2558b1fc
commit
a9b2ac624a
|
|
@ -1,16 +0,0 @@
|
|||
If you would like to contribute to the development of OpenStack,
|
||||
you must follow the steps in this page:
|
||||
|
||||
http://docs.openstack.org/infra/manual/developers.html
|
||||
|
||||
Once those steps have been completed, changes to OpenStack
|
||||
should be submitted for review via the Gerrit tool, following
|
||||
the workflow documented at:
|
||||
|
||||
http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
|
||||
Pull requests submitted through GitHub will be ignored.
|
||||
|
||||
Bugs should be filed on Launchpad, not GitHub:
|
||||
|
||||
https://bugs.launchpad.net/networking-nec
|
||||
|
|
@ -0,0 +1 @@
|
|||
doc/source/contributing.rst
|
||||
|
|
@ -1,50 +0,0 @@
|
|||
===========================================================
|
||||
DevStack plugin for NEC OpenFlow Neutron plugin integration
|
||||
===========================================================
|
||||
|
||||
As a part of vendor plugins/drivers decomposition work in Kilo,
|
||||
NEC plugin decomposition has been done.
|
||||
|
||||
This devstack external plugin installs NEC plugin library
|
||||
so that Neutron NEC OpenFlow plugin can be enabled.
|
||||
|
||||
To use this devstack plugin, add the following to your local.conf::
|
||||
|
||||
enable_plugin networking-nec https://git.openstack.org/stackforge/networking-nec [<branch>]
|
||||
|
||||
When you use stable branches, `branch` needs to be specified to **stable/xxxx**
|
||||
such as **stable/kilo**.
|
||||
|
||||
Examples
|
||||
========
|
||||
|
||||
Minimum sample local.conf::
|
||||
|
||||
[[local|localrc]]
|
||||
disable_service n-net
|
||||
enable_service neutron q-svc q-agt
|
||||
enable_service q-dhcp
|
||||
enable_service q-l3
|
||||
enable_service q-meta
|
||||
enable_service q-lbaas
|
||||
enable_service q-fwaas
|
||||
enable_service q-vpn
|
||||
|
||||
# NEC plugin
|
||||
Q_PLUGIN=nec
|
||||
enable_plugin networking-nec https://git.openstack.org/stackforge/networking-nec
|
||||
|
||||
# Trema Sliceable Switch (the following three lines are required at least)
|
||||
OFC_DRIVER=trema
|
||||
OFC_OFP_PORT=6653
|
||||
enable_plugin trema-devstack-plugin https://github.com/nec-openstack/trema-devstack-plugin
|
||||
|
||||
# ProgrammableFlow controller
|
||||
#OFC_DRIVER=pfc
|
||||
|
||||
References
|
||||
==========
|
||||
|
||||
* `DevStack externally hosted plugins`_
|
||||
|
||||
.. _DevStack externally hosted plugins: http://docs.openstack.org/developer/devstack/plugins.html#externally-hosted-plugins
|
||||
|
|
@ -0,0 +1 @@
|
|||
../doc/source/devstack.rst
|
||||
|
|
@ -1,4 +1,20 @@
|
|||
============
|
||||
Contributing
|
||||
============
|
||||
.. include:: ../../CONTRIBUTING.rst
|
||||
|
||||
If you would like to contribute to the development of OpenStack,
|
||||
you must follow the steps in this page:
|
||||
|
||||
http://docs.openstack.org/infra/manual/developers.html
|
||||
|
||||
Once those steps have been completed, changes to OpenStack
|
||||
should be submitted for review via the Gerrit tool, following
|
||||
the workflow documented at:
|
||||
|
||||
http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
|
||||
Pull requests submitted through GitHub will be ignored.
|
||||
|
||||
Bugs should be filed on Launchpad, not GitHub:
|
||||
|
||||
https://bugs.launchpad.net/networking-nec
|
||||
|
|
|
|||
|
|
@ -1,3 +1,52 @@
|
|||
.. _devstack:
|
||||
|
||||
.. include:: ../../devstack/README.rst
|
||||
===========================================================
|
||||
DevStack plugin for NEC OpenFlow Neutron plugin integration
|
||||
===========================================================
|
||||
|
||||
As a part of vendor plugins/drivers decomposition work in Kilo,
|
||||
NEC plugin decomposition has been done.
|
||||
|
||||
This devstack external plugin installs NEC plugin library
|
||||
so that Neutron NEC OpenFlow plugin can be enabled.
|
||||
|
||||
To use this devstack plugin, add the following to your local.conf::
|
||||
|
||||
enable_plugin networking-nec https://git.openstack.org/stackforge/networking-nec [<branch>]
|
||||
|
||||
When you use stable branches, `branch` needs to be specified to **stable/xxxx**
|
||||
such as **stable/kilo**.
|
||||
|
||||
Examples
|
||||
========
|
||||
|
||||
Minimum sample local.conf::
|
||||
|
||||
[[local|localrc]]
|
||||
disable_service n-net
|
||||
enable_service neutron q-svc q-agt
|
||||
enable_service q-dhcp
|
||||
enable_service q-l3
|
||||
enable_service q-meta
|
||||
enable_service q-lbaas
|
||||
enable_service q-fwaas
|
||||
enable_service q-vpn
|
||||
|
||||
# NEC plugin
|
||||
Q_PLUGIN=nec
|
||||
enable_plugin networking-nec https://git.openstack.org/stackforge/networking-nec
|
||||
|
||||
# Trema Sliceable Switch (the following three lines are required at least)
|
||||
OFC_DRIVER=trema
|
||||
OFC_OFP_PORT=6653
|
||||
enable_plugin trema-devstack-plugin https://github.com/nec-openstack/trema-devstack-plugin
|
||||
|
||||
# ProgrammableFlow controller
|
||||
#OFC_DRIVER=pfc
|
||||
|
||||
References
|
||||
==========
|
||||
|
||||
* `DevStack externally hosted plugins`_
|
||||
|
||||
.. _DevStack externally hosted plugins: http://docs.openstack.org/developer/devstack/plugins.html#externally-hosted-plugins
|
||||
|
|
|
|||
|
|
@ -3,7 +3,27 @@
|
|||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
.. include:: ../../README.rst
|
||||
===================================================
|
||||
Neutron plugins/drivers for NEC networking products
|
||||
===================================================
|
||||
|
||||
``networking-nec`` library provides Neutron plugins/drivers
|
||||
for `NEC SDN`_ networking products` (mainly OpenFlow related at now)
|
||||
and `Trema`_ `Sliceable Switch`_ (reference implementation).
|
||||
|
||||
In 2015.1 release (Kilo development cycle) in OpenStack, Neutron
|
||||
community decided to decompose vendor plugins/drivers from the neutron
|
||||
code repo to address many pain points. NEC OpenFlow Neutron plugin is
|
||||
maintained in a separate module.
|
||||
|
||||
* Documentation: https://wiki.openstack.org/wiki/Neutron/NEC_OpenFlow_Plugin
|
||||
* Source:
|
||||
|
||||
* http://git.openstack.org/cgit/stackforge/networking-nec
|
||||
* https://github.com/stackforge/networking-nec
|
||||
|
||||
* Bugs: http://bugs.launchpad.net/networking-nec
|
||||
* Free software: Apache license
|
||||
|
||||
User Guide
|
||||
----------
|
||||
|
|
@ -17,10 +37,6 @@ User Guide
|
|||
DevStack support <devstack>
|
||||
contributing
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
.. _NEC SDN: http://www.necam.com/SDN/
|
||||
.. _Trema: https://github.com/trema/trema
|
||||
.. _Sliceable Switch: https://github.com/trema/apps/tree/master/sliceable_switch
|
||||
|
|
|
|||
Loading…
Reference in New Issue