update docs for onosfwbrahmaputra.1.0stable/brahmaputra

4 files changed, 172 insertions, 55 deletions

diff --git a/docs/configguide/config-for-installer.rst b/docs/configguide/config-for-installer.rst
index a41acbbc..5a8be801 100644
--- a/docs/configguide/config-for-installer.rst
+++ b/docs/configguide/config-for-installer.rst
@@ -191,53 +191,55 @@ Config Documentation for onos with Fuel
 1. Pyhsical Requirement
 
    1.1 Linux , Microsoft or Mac OS.
-
+   
    1.2 Root access or admin access.
-
+   
    1.3 libvirt virtualization support.
-
-   1.4 minimum 2 networks and maximum 4 networks, multiple NIC and/or VLAN combinations are supported. 
-
-   1.5 250G disk at least for no-ha virtual deployment
-
+   
+   1.4 minimum 2 networks and maximum 4 networks.
+   
+   1.5 600G disk at least for no-ha virtual deployment
+   
 2. How to add onos into Fuel
 
    2.1 Fuel  provides an intuitive, GUI-driven experience for deployment and management of OpenStack, related community projects and plug-ins. Onos supplies plug-in to manage network of L2/L3.
 
    below is the directory::
 
-      ├── build
+
+├── build
       │   ├──f_isoroot   
-      │     ├── f_onosfwpluginbuild   # add onos build url
+      │    	├── f_onosfwpluginbuild   # add onos build url
       │   
-      ├── deploy
+├── deploy
       │   ├──scenario   
-      │     ├── ha-onos_scenario.yaml   # add onos ha configuration
+      │    	├── ha-onos_scenario.yaml   # add onos ha configuration
       │       ├── noha-onos_scenario.yaml   # add onos noha configuration
       ├── ci
       │   └── deploy.sh   #add onos scenarion steps inside
 
+
    2.2 Upload fuel-plugin-onos to git for fuel iso/rpm building.
 
 3. Automatic deployment 
 
-   3.1 Install jumphost.
+   3.1 Install jumphost and download fuel.iso with onos plugin.
    
    3.2 git clone https://gerrit.opnfv.org/gerrit/fuel
 
-   3.3 In fuel/ci, exec ./deploy.sh. For virtual deployment, you can use -b file:///fuel/deploy/config -l devel-popeline -p huawei-ch -s no-ha_onos_heat_ceilmeter_scenario_0.0.0.2.yaml -i file://root/iso/fuel.iso. Fore bare metal deployment, change parameters correspondingly and use no-ha_onos scenario_0.0.1.yaml.      
-
+   3.3 In fuel/ci, exec ./deploy.sh. For virtual deployment, you can use -b file:///fuel/deploy/config -l devel-pipeline -p huawei-ch -s os-onos-nofeature-ha -i file://root/iso/fuel.iso. For bare metal deployment, you should modify dha.yaml according to hardware configuration.
+  
 4. Build onos plugin into rpm independently.
 
    4.1 Install fuel plugin builder( detailed steps can be found in https://wiki.openstack.org/wiki/Fuel/Plugin ).  
 
-   4.2 git clone git://git.openstack.org/openstack/fuel-plugin-onos. For Kilo deployment, use –b Kilo.
-
+   4.2 git clone git://git.openstack.org/openstack/fuel-plugin-onos. For Liberty deployment, use –b Liberty.
+  
    4.3 fpb --build fuel-plugin-onos 
 
    4.4 Move onos*.rpm in to master and fuel plugins –install onos*.rpm.
 
-   4.5 Create a new environment and select onos plugin in settings table. If the Public Ethernet is not eth3, please change it with your actual configuration.
+   4.5 Create a new environment and select onos plugin in settings table. As a constraint, you need select public_network_assignment in network configuration.
 
    4.6 Select a node with the role of controller and onos( onos must collocate with a controller).
 
diff --git a/docs/release/onos-release.rst b/docs/release/onos-release.rst
index fb162bf7..26e1d72f 100644
--- a/docs/release/onos-release.rst
+++ b/docs/release/onos-release.rst
@@ -49,47 +49,53 @@ ONOSFW addresses integrating an SDN controller of choice based on a target appli
 ONOSFW Test Scenarios
 =====================
 
-Secenario 14 ONOS-HA for Bare Metal:
-
-+---------------------------------------+------------------------------------------------------------+---------+------------------------------------------------------------+------------------------------------------------------------+
-| FuncTest Usecase    \      Installers | Apex                                                       | Compass | Fuel                                                       | JOID                                                       |
-+=======================================+============================================================+=========+============================================================+============================================================+
-| vPing                                 | Should Fail;                                               | Success | Should Fail;                                               | Should Fail;                                               |
-|                                       | ONOSFW do not support Layer 3 feature in BM deploy in Apex |         | ONOSFW do not support Layer 3 feature in BM deploy in Fuel | ONOSFW do not support Layer 3 feature in BM deploy in JOID |
-+---------------------------------------+------------------------------------------------------------+---------+------------------------------------------------------------+------------------------------------------------------------+
-| ONOS                                  | Should Fail;                                               | Success | Should Fail;                                               | Should Fail;                                               |
-|                                       | ONOSFW do not support Layer 3 feature in BM deploy in Apex |         | ONOSFW do not support Layer 3 feature in BM deploy in Fuel | ONOSFW do not support Layer 3 feature in BM deploy in JOID |
-+---------------------------------------+------------------------------------------------------------+---------+------------------------------------------------------------+------------------------------------------------------------+
-| tempest                               | Should  Fail;                                              | Success | Should Fail;                                               | Should Fail;                                               |
-|                                       | ONOSFW do not support Layer 3 feature in BM deploy in Apex |         | ONOSFW do not support Layer 3 feature in BM deploy in Fuel | ONOSFW do not support Layer 3 feature in BM deploy in JOID |
-+---------------------------------------+------------------------------------------------------------+---------+------------------------------------------------------------+------------------------------------------------------------+
-| VIMS                                  | Should Fail;                                               | Success | Should Fail;                                               | Should Fail;                                               |
-|                                       | ONOSFW do not support Layer 3 feature in BM deploy in Apex |         | ONOSFW do not support Layer 3 feature in BM deploy in Fuel | ONOSFW do not support Layer 3 feature in BM deploy in JOID |
-+---------------------------------------+------------------------------------------------------------+---------+------------------------------------------------------------+------------------------------------------------------------+
-| RALLY                                 | Should Fail;                                               | Success | Should Fail;                                               | Should Fail;                                               |
-|                                       | ONOSFW do not support Layer 3 feature in BM deploy in Apex |         | ONOSFW do not support Layer 3 feature in BM deploy in Fuel | ONOSFW do not support Layer 3 feature in BM deploy in JOID |
-+---------------------------------------+------------------------------------------------------------+---------+------------------------------------------------------------+------------------------------------------------------------+
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
+| FuncTest Usecase    \      Installers | Apex                                      | Compass                                   | Fuel                                      | JOID                                                       |
++=======================================+===========================================+===========================================+===========================================+============================================================+
+| vPing For user metadata               | Should Fail;                              | Should Fail;                              | Should Fail;                              | Should Fail;                                               |
+|                                       | ONOSFW do not support user metadata in BM | ONOSFW do not support user metadata in BM | ONOSFW do not support user metadata in BM | ONOSFW do not support user metadata in BM                  |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
+| vPing                                 | Success                                   | Success                                   | Success                                   | Success                                                    |
+|                                       |                                           |                                           |                                           |                                                            |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
+| tempest                               | Success[1]                                | Success[1]                                | Success[1]                                | Success[1]                                                 |
+|                                       |                                           |                                           |                                           |                                                            |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
+| VIMS                                  |  NR                                       |  NR                                       |  NR                                       | NR                                                         |
+|                                       |                                           |                                           |                                           |                                                            |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
+| RALLY                                 | Success                                   | Success                                   | Success                                   | Success                                                    |
+|                                       |                                           |                                           |                                           |                                                            |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
+| ONOS                                  | Success                                   | Success                                   | Success                                   | Success                                                    |
+|                                       |                                           |                                           |                                           |                                                            |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
 
 Secenario 14 ONOS-HA for Virtual:
 
-+---------------------------------------+---------+---------+---------+---------+
-| FuncTest Usecase    \      Installers | Apex    | Compass | Fuel    | JOID    |
-+=======================================+=========+=========+=========+=========+
-| vPing                                 | Success | Success | Success | Success |
-|                                       |         |         |         |         |
-+---------------------------------------+---------+---------+---------+---------+
-| ONOS                                  | Success | Success | Success | Success |
-|                                       |         |         |         |         |
-+---------------------------------------+---------+---------+---------+---------+
-| tempest                               | Success | Success | Success | Success |
-|                                       |         |         |         |         |
-+---------------------------------------+---------+---------+---------+---------+
-| VIMS                                  | Success | Success | Success | Success |
-|                                       |         |         |         |         |
-+---------------------------------------+---------+---------+---------+---------+
-| RALLY                                 | Success | Success | Success | Success |
-|                                       |         |         |         |         |
-+---------------------------------------+---------+---------+---------+---------+
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+
+| FuncTest Usecase    \      Installers | Apex                                      | Compass                                   | Fuel                                      | JOID                                      |
++=======================================+===========================================+===========================================+===========================================+===========================================+
+| vPing For user metadata               | Should Fail;                              | Should Fail;                              | Should Fail;                              | Should Fail;                              |
+|                                       | ONOSFW do not support user metadata in VM | ONOSFW do not support user metadata in VM | ONOSFW do not support user metadata in VM | ONOSFW do not support user metadata in VM |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+
+| vPing                                 | Success                                   | Success                                   | Success                                   | Success                                   |
+|                                       |                                           |                                           |                                           |                                           |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+
+| tempest                               | Success[1]                                | Success[1]                                | Success[1]                                | Success[1]                                |
+|                                       |                                           |                                           |                                           |                                           |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+
+| VIMS                                  | NR                                        | NR                                        | NR                                        | NR                                        |
+|                                       |                                           |                                           |                                           |                                           |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+
+| RALLY                                 | Success                                   | Success                                   | Success                                   | Success                                   |
+|                                       |                                           |                                           |                                           |                                           |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+
+| ONOS                                  | Success                                   | Success                                   | Success                                   | Success                                   |
+|                                       |                                           |                                           |                                           |                                           |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+
+
+[1] There are 11 failed tests out of 210 which (we think) are related to nova metadata service not supported by onos yet. Some tests need to pass the ssh-key to the instances using that service. However, it passes the success criteria of >=90%; details show in JIRA ticket : https://jira.onosproject.org/browse/ONOS-3997
 
 ONOS Release
 ============
diff --git a/docs/scenario description/index.rst b/docs/scenario description/index.rst
new file mode 100644
index 00000000..68c82d17
--- /dev/null
+++ b/docs/scenario description/index.rst
@@ -0,0 +1,15 @@
+********************
+ONOSFW Release Notes
+********************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   scenario-description.rst
+
+Revision: _sha1_
+
+:Author: Henry(jiangrui1@huawei.com)
+
+Build date: |today|
diff --git a/docs/scenario description/scenario-description.rst b/docs/scenario description/scenario-description.rst
new file mode 100644
index 00000000..264f97fd
--- /dev/null
+++ b/docs/scenario description/scenario-description.rst
@@ -0,0 +1,94 @@
+=========================================
+OPNFV Brahmaputra release note for onosfw
+=========================================
+
+.. contents:: Table of Contents
+   :backlinks: none
+
+
+Abstract
+========
+
+This document describes the testing scenario of onosfw project, including ONOS bare metal and virtual deployment scenario
+
+License
+=======
+
+OPNFV Brahmaputra release note for onosfw Docs
+(c) by Henry (HUAWEI)
+
+OPNFV Brahmaputra release note for onosfw Docs
+are licensed under a Creative Commons Attribution 4.0 International License.
+You should have received a copy of the license along with this.
+If not, see <http://creativecommons.org/licenses/by/4.0/>.
+
+Version history
+===============
+
++------------+----------+------------+------------------+
+| **Date**   | **Ver.** | **Author** | **Comment**      |
+|            |          |            |                  |
++------------+----------+------------+------------------+
+| 2016-02-14 | 0.0.1    | Henry      | First draft      |
+|            |          | (HUAWEI)   |                  |
++------------+----------+------------+------------------+
+
+Introduction
+============
+
+ONOSFW addresses integrating an SDN controller of choice based on a target applications or use cases within the OPNFV defined NFVI and VIM framework. It aims to provide end user and open source community with greater flexibility to build service applications, and to help leverage corresponding open source development efforts and results as well. Furthermore, it will create some common framework elements to address multi tenancy support, integration between the network controller and a DPI engine for context-based flow policies. It will also provide driver integration to support the Neutron ML2 & Router plugin.
+
+
+
+ONOSFW Test Scenarios
+=====================
+For now, Openstack and ODL are using Centralized gateway to reach external network, but for ONOS, we are using DVR mode, which means we make each compute node has the ability to reach external network, just like pic below:
+
+.. image::  ../etc/ONOS-DVR.png
+
+
+Secenario 14 ONOS-HA :
+----------------------
+1. L2 feature
+
+   1.1 Infrastructure network setup; including CURD operation of bridge, interface, controller, port, etc.
+
+   1.2 L2 traffic between different subnets in same network
+
+   1.3 Traffic isolation between different tenants
+
+2. L3 feature
+
+   2.1 L3 east - west function
+
+      2.1.1 Ping between VMs between differernt subnets belong to different tenants is OK
+
+      2.1.2 isolated by different networks belong to differernt tenants is OK
+
+      2.1.3 Related flow rule deleted when VM is deleted is OK
+
+ 
+
+   2.2 L3 south - north function
+
+      2.2.1. Ping external network (such as google) from VM by allocating a floating IP is OK
+
+      2.2.2. Binding an external port to OVS is OK
+
+      2.2.3. VM hot migration is supported
+
+ 
+
+   2.3 Improvements
+
+      2.3.1 Add p2any vxlan config to ovs is OK
+
+      2.3.2. Ovsdb support multiple nodes is OK
+
+      2.3.3. All nicira extension api has been extended
+
+Revision: _sha1_
+
+:Author: Henry(jiangrui1@huawei.com)
+
+Build date: |today|