summaryrefslogtreecommitdiffstats
path: root/docs/userguide
diff options
context:
space:
mode:
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/index.rst28
-rw-r--r--docs/userguide/onosfw-userguide.rst90
2 files changed, 118 insertions, 0 deletions
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|