rearrange existing documentation to fit the new standard layout

- Most user related contents are moved into admin/ directory
  as the main consumers of networking-ovn project are expected
  to be OpenStack operators.
- OVN references in README.rst are moved to a separate file
  for better document structure.

Part of doc-migration work. For more detail, see:
https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
https://etherpad.openstack.org/p/doc-migration-tracking

Change-Id: Ia7785dec8e09daa239c751beb181b2dc6f6c4b34
changes/52/481852/3
Akihiro Motoki 6 years ago
parent c82d77ae4b
commit c8097ca325

@ -1,12 +1,3 @@
========================
Team and repository tags
========================
.. image:: http://governance.openstack.org/badges/networking-ovn.svg
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
=========================================================
networking-ovn - OpenStack Neutron integration with OVN
=========================================================
@ -23,70 +14,8 @@ and OVN.
* IRC: #openstack-neutron-ovn on Freenode.
* Docs: http://docs.openstack.org/developer/networking-ovn/
The original OVN project announcement can be found here:
* http://networkheresy.com/2015/01/13/ovn-bringing-native-virtual-networking-to-ovs/
The OVN architecture is described here:
* http://openvswitch.org/support/dist-docs/ovn-architecture.7.html
Here are two tutorials that help with learning different aspects of OVN:
* http://blog.spinhirne.com/p/blog-series.html#introToOVN
* http://docs.openvswitch.org/en/latest/tutorials/ovn-sandbox/
There is also an in depth tutorial on using OVN with OpenStack:
* http://docs.openvswitch.org/en/latest/tutorials/ovn-openstack/
OVN DB schemas and other man pages:
* http://openvswitch.org/support/dist-docs/ovn-nb.5.html
* http://openvswitch.org/support/dist-docs/ovn-sb.5.html
* http://openvswitch.org/support/dist-docs/ovn-nbctl.8.html
* http://openvswitch.org/support/dist-docs/ovn-sbctl.8.html
* http://openvswitch.org/support/dist-docs/ovn-northd.8.html
* http://openvswitch.org/support/dist-docs/ovn-controller.8.html
* http://openvswitch.org/support/dist-docs/ovn-controller-vtep.8.html
or find a full list of OVS and OVN man pages here:
* http://docs.openvswitch.org/en/latest/ref/
The openvswitch web page includes a list of presentations, some of which are
about OVN:
* http://openvswitch.org/support/
Here are some direct links to past OVN presentations:
* OVN talk at OpenStack Summit in Boston, Spring 2017
* https://www.youtube.com/watch?v=sgc7myiX6ts
* OVN talk at OpenStack Summit in Barcelona, Fall 2016
* https://www.youtube.com/watch?v=q3cJ6ezPnCU
* OVN talk at OpenStack Summit in Austin, Spring 2016
* https://www.youtube.com/watch?v=okralc7LrZo
* OVN Project Update at the OpenStack Summit in Tokyo, Fall 2015
* http://openvswitch.org/support/slides/OVN_Tokyo.pdf
* https://www.youtube.com/watch?v=3IrG2xghJjs
* OVN at OpenStack Summit in Vancouver, Sping 2015
* http://openvswitch.org/support/slides/OVN-Vancouver.pdf
* https://www.youtube.com/watch?v=kEzXTq2fPDg
* OVS Conference 2015
* https://www.youtube.com/watch?v=JLGZOYi_Cqc
These blog resources may also help with testing and understanding OVN:
Team and repository tags
------------------------
* http://networkop.co.uk/blog/2016/11/27/ovn-part1/
* http://networkop.co.uk/blog/2016/12/10/ovn-part2/
* https://blog.russellbryant.net/2016/12/19/comparing-openstack-neutron-ml2ovs-and-ovn-control-plane/
* https://blog.russellbryant.net/2016/11/11/ovn-logical-flows-and-ovn-trace/
* https://blog.russellbryant.net/2016/09/29/ovs-2-6-and-the-first-release-of-ovn/
* http://galsagie.github.io/2015/11/23/ovn-l3-deepdive/
* http://blog.russellbryant.net/2015/10/22/openstack-security-groups-using-ovn-acls/
* http://galsagie.github.io/sdn/openstack/ovs/2015/05/30/ovn-deep-dive/
* http://blog.russellbryant.net/2015/05/14/an-ez-bake-ovn-for-openstack/
* http://galsagie.github.io/sdn/openstack/ovs/2015/04/26/ovn-containers/
* http://blog.russellbryant.net/2015/04/21/ovn-and-openstack-status-2015-04-21/
* http://blog.russellbryant.net/2015/04/08/ovn-and-openstack-integration-development-update/
.. image:: http://governance.openstack.org/badges/networking-ovn.svg
:target: http://governance.openstack.org/reference/tags/index.html

@ -51,4 +51,4 @@ address. When the HA manager detects a failure of the master, the
virtual IP would be moved and the passive replica would become the
new master.
See :doc:`readme` for links to more details on OVN's architecture.
See :doc:`ovn` for links to more details on OVN's architecture.

@ -0,0 +1,14 @@
====================
Administration Guide
====================
.. toctree::
:maxdepth: 1
ovn
features
faq
refarch/refarch
dpdk
containers
troubleshooting

@ -0,0 +1,71 @@
===============
OVN information
===============
The original OVN project announcement can be found here:
* http://networkheresy.com/2015/01/13/ovn-bringing-native-virtual-networking-to-ovs/
The OVN architecture is described here:
* http://openvswitch.org/support/dist-docs/ovn-architecture.7.html
Here are two tutorials that help with learning different aspects of OVN:
* http://blog.spinhirne.com/p/blog-series.html#introToOVN
* http://docs.openvswitch.org/en/latest/tutorials/ovn-sandbox/
There is also an in depth tutorial on using OVN with OpenStack:
* http://docs.openvswitch.org/en/latest/tutorials/ovn-openstack/
OVN DB schemas and other man pages:
* http://openvswitch.org/support/dist-docs/ovn-nb.5.html
* http://openvswitch.org/support/dist-docs/ovn-sb.5.html
* http://openvswitch.org/support/dist-docs/ovn-nbctl.8.html
* http://openvswitch.org/support/dist-docs/ovn-sbctl.8.html
* http://openvswitch.org/support/dist-docs/ovn-northd.8.html
* http://openvswitch.org/support/dist-docs/ovn-controller.8.html
* http://openvswitch.org/support/dist-docs/ovn-controller-vtep.8.html
or find a full list of OVS and OVN man pages here:
* http://docs.openvswitch.org/en/latest/ref/
The openvswitch web page includes a list of presentations, some of which are
about OVN:
* http://openvswitch.org/support/
Here are some direct links to past OVN presentations:
* OVN talk at OpenStack Summit in Boston, Spring 2017
* https://www.youtube.com/watch?v=sgc7myiX6ts
* OVN talk at OpenStack Summit in Barcelona, Fall 2016
* https://www.youtube.com/watch?v=q3cJ6ezPnCU
* OVN talk at OpenStack Summit in Austin, Spring 2016
* https://www.youtube.com/watch?v=okralc7LrZo
* OVN Project Update at the OpenStack Summit in Tokyo, Fall 2015
* http://openvswitch.org/support/slides/OVN_Tokyo.pdf
* https://www.youtube.com/watch?v=3IrG2xghJjs
* OVN at OpenStack Summit in Vancouver, Sping 2015
* http://openvswitch.org/support/slides/OVN-Vancouver.pdf
* https://www.youtube.com/watch?v=kEzXTq2fPDg
* OVS Conference 2015
* https://www.youtube.com/watch?v=JLGZOYi_Cqc
These blog resources may also help with testing and understanding OVN:
* http://networkop.co.uk/blog/2016/11/27/ovn-part1/
* http://networkop.co.uk/blog/2016/12/10/ovn-part2/
* https://blog.russellbryant.net/2016/12/19/comparing-openstack-neutron-ml2ovs-and-ovn-control-plane/
* https://blog.russellbryant.net/2016/11/11/ovn-logical-flows-and-ovn-trace/
* https://blog.russellbryant.net/2016/09/29/ovs-2-6-and-the-first-release-of-ovn/
* http://galsagie.github.io/2015/11/23/ovn-l3-deepdive/
* http://blog.russellbryant.net/2015/10/22/openstack-security-groups-using-ovn-acls/
* http://galsagie.github.io/sdn/openstack/ovs/2015/05/30/ovn-deep-dive/
* http://blog.russellbryant.net/2015/05/14/an-ez-bake-ovn-for-openstack/
* http://galsagie.github.io/sdn/openstack/ovs/2015/04/26/ovn-containers/
* http://blog.russellbryant.net/2015/04/21/ovn-and-openstack-status-2015-04-21/
* http://blog.russellbryant.net/2015/04/08/ovn-and-openstack-integration-development-update/

Before

Width:  |  Height:  |  Size: 142 KiB

After

Width:  |  Height:  |  Size: 142 KiB

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 72 KiB

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

Before

Width:  |  Height:  |  Size: 68 KiB

After

Width:  |  Height:  |  Size: 68 KiB

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

@ -1,4 +1,4 @@
============
Contributing
============
.. include:: ../../CONTRIBUTING.rst
.. include:: ../../../CONTRIBUTING.rst

@ -0,0 +1,11 @@
============
Design Notes
============
.. toctree::
:maxdepth: 1
data_model
native_dhcp
ovn_worker
metadata_api

@ -0,0 +1,10 @@
=========================
Contributor Documentation
=========================
.. toctree::
:maxdepth: 2
contributing
testing
design/index

@ -648,9 +648,11 @@ On the compute nodes, enable it as follows:
Troubleshooting
---------------
If you run into any problems, take a look at our :doc:`troubleshooting` page.
If you run into any problems, take a look at our :doc:`/admin/troubleshooting`
page.
Additional Resources
--------------------
See the documentation and other references linked from the :doc:`readme` page.
See the documentation and other references linked
from the :doc:`/admin/ovn` page.

@ -3,43 +3,21 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to networking-ovn's documentation!
========================================================
.. the main title comes from README.rst
General Information and Other Project References:
.. include:: ../../README.rst
.. toctree::
:maxdepth: 1
readme
features
contributing
faq
refarch/refarch
install
Testing and Usage Information:
.. toctree::
:maxdepth: 1
testing
dpdk
containers
troubleshooting
Design Notes:
Contents
--------
.. toctree::
:maxdepth: 1
:maxdepth: 2
design/data_model
design/native_dhcp
design/ovn_worker
design/metadata_api
admin/index
install/index
contributor/index
Indices and tables
==================
.. rubric:: Indices and tables
* :ref:`genindex`
* :ref:`search`

@ -1,7 +1,7 @@
.. _installation:
Installation
============
Install & Configuration
=======================
The ``networking-ovn`` repository includes integration with DevStack that
enables creation of a simple Open Virtual Network (OVN) development and test

@ -1 +0,0 @@
.. include:: ../../README.rst
Loading…
Cancel
Save