From 80c6a75dbc3741e44faf376828471febc116b3b9 Mon Sep 17 00:00:00 2001 From: jiangrui Date: Thu, 21 Jan 2016 01:06:32 +0800 Subject: update documents of onosfw Change-Id: I46e023a25d3d768c87930f712b7249f4a8930817 --- docs/configguide/config-for-installer.rst | 38 +++++++++++++ docs/configguide/index.rst | 31 +++++++++++ docs/design/index.rst | 30 +++++++++++ docs/etc/conf.py | 68 +++++++++++------------ docs/how-to-use-docs/index.rst | 3 +- docs/release/index.rst | 30 +++++++++++ docs/userguide/index.rst | 28 ++++++++++ docs/userguide/onosfw-userguide.rst | 90 +++++++++++++++++++++++++++++++ 8 files changed, 282 insertions(+), 36 deletions(-) create mode 100644 docs/configguide/config-for-installer.rst create mode 100644 docs/configguide/index.rst create mode 100644 docs/design/index.rst create mode 100644 docs/release/index.rst create mode 100644 docs/userguide/index.rst create mode 100644 docs/userguide/onosfw-userguide.rst diff --git a/docs/configguide/config-for-installer.rst b/docs/configguide/config-for-installer.rst new file mode 100644 index 00000000..02c1c720 --- /dev/null +++ b/docs/configguide/config-for-installer.rst @@ -0,0 +1,38 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +Config Documentation of onos & apex +=================================== + +Contents: + +Config Documentation of onos & Compass +====================================== + +Contents: + +Config Documentation of onos & Fuel +=================================== + +Contents: + +Config Documentation of onos & JOID +=================================== + +Contents: + + + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst new file mode 100644 index 00000000..1f6a268d --- /dev/null +++ b/docs/configguide/index.rst @@ -0,0 +1,31 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +Example Documentation table of contents +======================================= +ONOSFW need to deploy with several installers and each installer have differernt configs. + +Below is the detail config for them: + +.. toctree:: + :numbered: + :maxdepth: 4 + + config-for-installer.rst + +Indices and tables +================== + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/design/index.rst b/docs/design/index.rst new file mode 100644 index 00000000..36710b32 --- /dev/null +++ b/docs/design/index.rst @@ -0,0 +1,30 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +Example Documentation table of contents +======================================= + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 4 + + documentation-example.rst + +Indices and tables +================== + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/etc/conf.py b/docs/etc/conf.py index 00660351..18deb8b7 100644 --- a/docs/etc/conf.py +++ b/docs/etc/conf.py @@ -1,34 +1,34 @@ -import datetime -import sys -import os - -try: - __import__('imp').find_module('sphinx.ext.numfig') - extensions = ['sphinx.ext.numfig'] -except ImportError: - # 'pip install sphinx_numfig' - extensions = ['sphinx_numfig'] - -# numfig: -number_figures = True -figure_caption_prefix = "Fig." - -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' -html_use_index = False - -pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')] -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False - -latex_elements = { - 'printindex': '', -} - -project = u'OPNFV: Template documentation config' -copyright = u'%s, OPNFV' % datetime.date.today().year -version = u'1.0.0' -release = u'1.0.0' +import datetime +import sys +import os + +try: + __import__('imp').find_module('sphinx.ext.numfig') + extensions = ['sphinx.ext.numfig'] +except ImportError: + # 'pip install sphinx_numfig' + extensions = ['sphinx_numfig'] + +# numfig: +number_figures = True +figure_caption_prefix = "Fig." + +source_suffix = '.rst' +master_doc = 'index' +pygments_style = 'sphinx' +html_use_index = False + +pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')] +pdf_fit_mode = "shrink" +pdf_stylesheets = ['sphinx','kerning','a4'] +#latex_domain_indices = False +#latex_use_modindex = False + +latex_elements = { + 'printindex': '', +} + +project = u'OPNFV: Template documentation config' +copyright = u'%s, OPNFV' % datetime.date.today().year +version = u'1.0.0' +release = u'1.0.0' diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst index 36710b32..3593b2a0 100644 --- a/docs/how-to-use-docs/index.rst +++ b/docs/how-to-use-docs/index.rst @@ -12,7 +12,6 @@ Example Documentation table of contents ======================================= -Contents: .. toctree:: :numbered: @@ -27,4 +26,4 @@ Indices and tables Revision: _sha1_ -Build date: |today| +Build date: |today| \ No newline at end of file diff --git a/docs/release/index.rst b/docs/release/index.rst new file mode 100644 index 00000000..36710b32 --- /dev/null +++ b/docs/release/index.rst @@ -0,0 +1,30 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +Example Documentation table of contents +======================================= + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 4 + + documentation-example.rst + +Indices and tables +================== + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst new file mode 100644 index 00000000..8ada4a2e --- /dev/null +++ b/docs/userguide/index.rst @@ -0,0 +1,28 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +Example Documentation table of contents +======================================= + +.. toctree:: + :numbered: + :maxdepth: 4 + + onosfw-userguide.rst + +Indices and tables +================== + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/userguide/onosfw-userguide.rst b/docs/userguide/onosfw-userguide.rst new file mode 100644 index 00000000..53a1cbb9 --- /dev/null +++ b/docs/userguide/onosfw-userguide.rst @@ -0,0 +1,90 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +ONOSFW User Guide Manaully +========================== + + 1. initialize environment:: + + initialize openstack：delete allthe network, instance and router. + + initialize ovs：delete managerand bridge by the following command： + + ovs-vsctl del-manager + + ovs-vsctl del-br “bridge name” + + 2. restart onos，install feature:: + + feature:install onos-ovsdatabase + + feature:install onos-app-vtn-onosfw + + 3. set the external port name:: + + onos command：externalportname-set –n “external port name” + + 4. create provider network:: + + set manager on compute node and network node: ovs-vsctl set-manager tcp:“onos ip”:6640 + + 5. create external network and subnet on openstack dashboard，then update external gateway mac:: + + externalgateway-update -m “mac address” + + 6. create basic networks and instances on openstack dashboard to verify L2/L3function:: + + * L2 scene: + + * Live Migration + + * With between same node under the same tenant and network wether the vm is conneted + + * With between different nodes under the same tenant and network wether the vm is conneted + + * With between same node under the same tenant and different network wether the vm is not conneted + + * With between different nodes under the same tenant and different network wether the vm is not conneted + + * With between same nodes under the different tenant and different network wether the vm is not conneted + + * With between different nodes under the different tenant and different network wether the vm is not conneted + + * L3 scene: + + * With between same node under the same tenant and network wether the vm is conneted + + * With between different nodes under the same tenant and network wether the vm is conneted + + * With between same node under the same tenant and different network wether the vm is conneted + + * With between different nodes under the same tenant and different network wether the vm is conneted + + * With between same nodes under the different tenant and different network wether the vm is not conneted + + * With between different nodes under the different tenant and different network wether the vm is not conneted + VM can ping external network well + + Video: + + ONOSFW L2 Function Flash video：https://www.youtube.com/watch?v=7bxjWrR4peI + + ONOSFW L2 Function Demo video：https://www.youtube.com/watch?v=qP8nPYhz_Mo + + ONOSFW L3 Function Demo video：https://www.youtube.com/watch?v=R0H-IibpVxw +Indices and tables +================== + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| -- cgit 1.2.3-korg