DOCS-84

ONOSFW contribution to the Colorado user guide

Change-Id: I0ec627d2e8a02f39a3b9e7a727d92b67396d8b12
Signed-off-by: CNlucius <lukai1@huawei.com>

9 files changed, 102 insertions, 104 deletions

diff --git a/docs/configguide/config-for-installer.rst b/docs/Colorado/configguide/config-for-installer.rst
index 5a8be801..fe4f83d8 100644
--- a/docs/configguide/config-for-installer.rst
+++ b/docs/Colorado/configguide/config-for-installer.rst
@@ -9,17 +9,17 @@ OPNFV config guide instructions for the Brahmaputra release of OPNFV when using
 Abstract
 ========
 
-This document describes how to config the Brahmaputra release of OPNFV when
+This document describes how to config the Colorado release of OPNFV when
 using installers as a deployment tool to deploy onosfw, covering it's limitations, dependencies
 and required system resources.
 
 License
 =======
 
-Brahmaputra release of OPNFV when using installers to deploy onosfw Docs
-(c) by Henry (HUAWEI)
+Colorado release of OPNFV when using installers to deploy onosfw Docs
+(c) by Lucius (HUAWEI)
 
-Brahmaputra release of OPNFV when using installers to deploy onosfw Docs
+Colorado release of OPNFV when using installers to deploy 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/>.
@@ -31,13 +31,7 @@ Version history
 | **Date**   | **Ver.** | **Author** | **Comment**      |
 |            |          |            |                  |
 +------------+----------+------------+------------------+
-| 2016-01-21 | 1.0.0    | Henry      | Rewritten for    |
-|            |          | (HUAWEI)   | ONOSFW B release |
-+------------+----------+------------+------------------+
-| 2016-01-20 | 0.0.2    | Henry      | Minor changes &  |
-|            |          | (HUAWEI)   | formatting       |
-+------------+----------+------------+------------------+
-| 2016-01-19 | 0.0.1    | Henry      | First draft      |
+| 2016-08-11 | 0.0.1    | Lucius     | First draft      |
 |            |          | (HUAWEI)   |                  |
 +------------+----------+------------+------------------+
 
@@ -136,14 +130,14 @@ Config Documentation for onos with Compass
       commpass4nfv
          ├── deploy
          │   ├── adapters
-         │      ├── ansible
-         │         ├── roles # include the sdn script
-         │             ├── onos_cluster # include the onos script
-         │                 ├── files # include the files of jdk and onos driver
-         │                 ├── handlers # include the opertaion of restart onos service
-         │                 ├── tasks # include the task of installing onos
-         │                 ├── templates # include the templates of onos
-         │                 ├── vars # include the var of onos used
+         │       ├── ansible
+         │           ├── openstack_mitaka
+         │               ├── roles # include the sdn script
+         │                 ├── onos_cluster # include the onos script
+         │                     ├── handlers # include the opertaion of restart onos service
+         │                     ├── tasks # include the task of installing onos
+         │                     ├── templates # include the templates of onos
+         │                     ├── vars # include the var of onos used
 
 3. Virtual deployment 
 
@@ -151,7 +145,8 @@ Config Documentation for onos with Compass
 
    3.2 Build iso of compass. Execute ./build.sh
 
-   3.3 Execute ./deploy.sh virtual_cluster_onos
+   3.3 If onos_sfc: Execute ./deploy.sh --dha /home/compass4nfv/deploy/conf/vm_environment/os-onos-nofeature-ha.yml --network /home/compass4nfv/deploy/conf/vm_environment/huawei-virtual1/network_onos.yml --iso-url file:///home/compass4nfv/work/building/compass.iso
+       If onos_nofeature: Execute ./deploy.sh --dha /home/compass4nfv/deploy/conf/vm_environment/os-onos-sfc-ha.yml --network /home/compass4nfv/deploy/conf/vm_environment/huawei-virtual1/network_onos.yml --iso-url file:///home/compass4nfv/work/building/compass.iso
 
 4. Baremetal deployment
 
@@ -165,7 +160,7 @@ Config Documentation for onos with Compass
 
           export BUILD_DIRECTORY=$WORKSPACE/build_output
 
-          export CONFDIR=$WORKSPACE/deploy/conf/hardware_environment/huawei_us_lab/pod1
+          export CONFDIR=$WORKSPACE/deploy/conf/hardware_environment/huawei-pod1
 
           export ISO_URL=file://$BUILD_DIRECTORY/compass.iso
 
@@ -175,11 +170,13 @@ Config Documentation for onos with Compass
 
           export OS_VERSION=trusty
 
-          export OPENSTACK_VERSION=liberty     
+          export OPENSTACK_VERSION=mitaka     
  
    4.4 Execute cd $WORKSPACE
 
-   4.5 Execute ./deploy.sh --dha $CONFDIR/dha.yml --network $CONFDIR/network.yml
+   4.5 If onos_nofeature Execute ./deploy.sh --dha $CONFDIR/os-onos-nofeature-ha.yml --network $CONFDIR/network_onos.yml --iso-url file:///home/compass4nfv/work/building/compass.iso
+
+   4.6 If onos_sfc Execute ./deploy.sh --dha $CONFDIR/os-onos-sfc-ha.yml --network $CONFDIR/network_onos.yml --iso-url file:///home/compass4nfv/work/building/compass.iso
 
 5. Detail of compass installation `Compass Installation`_.
 
@@ -191,34 +188,33 @@ 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.
-   
+
+   1.4 minimum 2 networks and maximum 4 networks, multiple NIC and/or VLAN combinations are supported. 
+
    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.
+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 and SFC.
    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
+      │       ├── sfc-onos-ha_scenario.yaml   # add onos sfc ha configuration
+      │       ├── sfc-onos-noha_scenario.yaml   # add onos sfc 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 
@@ -227,19 +223,19 @@ Config Documentation for onos with Fuel
    
    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-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.
-  
+   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 os-onos-sfc-ha -i file://root/iso/fuel.iso. Fore bare metal deployment, 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 Liberty deployment, use –b Liberty.
-  
+   4.2 git clone git://git.openstack.org/openstack/fuel-plugin-onos. For Mitaka deployment, use –b Mitaka.
+
    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. As a constraint, you need select public_network_assignment in network configuration.
+   4.5 Create a new environment and select onos plugin in settings table. As a constraint, you need to select public_network_assignment in network configuration. In addition, if you want to try SFC feature, select ''SFC feature'.
 
    4.6 Select a node with the role of controller and onos( onos must collocate with a controller).
 
diff --git a/docs/configguide/index.rst b/docs/Colorado/configguide/index.rst
index 38cba669..c00c1554 100644
--- a/docs/configguide/index.rst
+++ b/docs/Colorado/configguide/index.rst
@@ -10,6 +10,6 @@ OPNFV(Brahmaputra) ONOSFW config instructions
 
 Revision: _sha1_
 
-:Author: Henry(jiangrui1@huawei.com)
+:Author: Lucius(lukai1@huawei.com)
 
 Build date: |today|
diff --git a/docs/design/index.rst b/docs/Colorado/design/index.rst
index 82681ddc..5a0b7d93 100644
--- a/docs/design/index.rst
+++ b/docs/Colorado/design/index.rst
@@ -8,6 +8,6 @@ OPNFV(Brahmaputra) ONOSFW design instructions
 
 Revision: _sha1_
 
-:Author: Henry(jiangrui1@huawei.com)
+:Author: Lucius(lukai1@huawei.com)
 
 Build date: |today|
diff --git a/docs/release/index.rst b/docs/Colorado/release/index.rst
index 693f2209..e3b0bdb2 100644
--- a/docs/release/index.rst
+++ b/docs/Colorado/release/index.rst
@@ -10,6 +10,6 @@ ONOSFW Release Notes
 
 Revision: _sha1_
 
-:Author: Henry(jiangrui1@huawei.com)
+:Author: Lucius(lukai1@huawei.com)
 
 Build date: |today|
diff --git a/docs/release/onos-release.rst b/docs/Colorado/release/onos-release.rst
index 26e1d72f..da819842 100644
--- a/docs/release/onos-release.rst
+++ b/docs/Colorado/release/onos-release.rst
@@ -15,9 +15,9 @@ License
 =======
 
 OPNFV Brahmaputra release note for onosfw Docs
-(c) by Henry (HUAWEI)
+(c) by Lucius (HUAWEI)
 
-OPNFV Brahmaputra release note for onosfw Docs
+OPNFV Colorado 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/>.
@@ -29,13 +29,7 @@ Version history
 | **Date**   | **Ver.** | **Author** | **Comment**      |
 |            |          |            |                  |
 +------------+----------+------------+------------------+
-| 2016-01-21 | 1.0.0    | Henry      | Rewritten for    |
-|            |          | (HUAWEI)   | ONOSFW B release |
-+------------+----------+------------+------------------+
-| 2016-01-20 | 0.0.2    | Henry      | Minor changes &  |
-|            |          | (HUAWEI)   | formatting       |
-+------------+----------+------------+------------------+
-| 2016-01-19 | 0.0.1    | Henry      | First draft      |
+| 2016-08-11 | 0.0.1    | Lucius     | First draft      |
 |            |          | (HUAWEI)   |                  |
 +------------+----------+------------+------------------+
 
@@ -52,13 +46,14 @@ ONOSFW Test Scenarios
 +---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
 | 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 For user metadata               | Success                                   | Success                                   | Success                                   | Success                                                    |
+|                                       |                                           |                                           |                                           |                                                           
+| 
 +---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
 | vPing                                 | Success                                   | Success                                   | Success                                   | Success                                                    |
 |                                       |                                           |                                           |                                           |                                                            |
 +---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
-| tempest                               | Success[1]                                | Success[1]                                | Success[1]                                | Success[1]                                                 |
+| tempest                               | Success                                   | Success                                   | Success                                   | Success                                                    |
 |                                       |                                           |                                           |                                           |                                                            |
 +---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
 | VIMS                                  |  NR                                       |  NR                                       |  NR                                       | NR                                                         |
@@ -69,33 +64,11 @@ ONOSFW Test Scenarios
 +---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
 | ONOS                                  | Success                                   | Success                                   | Success                                   | Success                                                    |
 |                                       |                                           |                                           |                                           |                                                            |
-+---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
-
-Secenario 14 ONOS-HA for Virtual:
-
-+---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+
-| 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_SFC                              | Success                                   | Success                                   | Success                                   | Success                                                   
+|
+|                                       |                                           |                                           |                                           |                                                            |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------
 
 ONOS Release
 ============
@@ -103,13 +76,13 @@ ONOS wiki of onosfw : `onosfw proposal in ONOS`_.
 
 .. _onosfw proposal in ONOS: https://wiki.onosproject.org/login.action?os_destination=%2Fdisplay%2FONOS%2FONOS%2BFramework%2B%28ONOSFW%29%2Bfor%2BOPNFV
 
-ONOS Emu code:`ONOS Emu Code`_.
+ONOS Goldeneye code:`ONOS Goldeneye Code`_.
 
-.. _ONOS Emu Code: https://github.com/opennetworkinglab/onos/tree/onos-1.4
+.. _ONOS Goldeneye Code: https://github.com/opennetworkinglab/onos/tree/onos-1.6
 
-ONOS Emu Release Note `ONOS Emu Release Note`_.
+ONOS Goldeneye Release Note `ONOS Goldeneye Release Note`_.
 
-.. _ONOS Emu Release Note: https://wiki.onosproject.org/display/ONOS/Release+Notes+-+Emu+1.4.0
+.. _ONOS Goldeneye Release Note: https://wiki.onosproject.org/display/ONOS/Goldeneye+Release+Notes
 
 The APIs docs exist as a submodule in docs/apis. 
 In order to retrieve them, you must change directories to "apis" and then do a "git pull origin master".
@@ -119,9 +92,9 @@ here is api link: https://github.com/onosfw/apis
 OpenStack Release
 =================
 
-OpenStack Liberty wiki page `OpenStack Liberty wiki`_.
+OpenStack Mitaka wiki page `OpenStack Mitaka wiki`_.
 
-.. _OpenStack Liberty wiki : https://wiki.openstack.org/wiki/Main_Page
+.. _OpenStack Mitaka wiki : https://wiki.openstack.org/wiki/Main_Page
 
 OpenStack Liberty api page `OpenStack Networking Api`_.
 
@@ -130,6 +103,6 @@ OpenStack Liberty api page `OpenStack Networking Api`_.
 
 Revision: _sha1_
 
-:Author: Henry(jiangrui1@huawei.com)
+:Author: Lucius(lukai1@huawei.com)
 
 Build date: |today|
diff --git a/docs/scenario description/index.rst b/docs/Colorado/scenario description/index.rst
index 68c82d17..e39d0220 100644
--- a/docs/scenario description/index.rst
+++ b/docs/Colorado/scenario description/index.rst
@@ -10,6 +10,6 @@ ONOSFW Release Notes
 
 Revision: _sha1_
 
-:Author: Henry(jiangrui1@huawei.com)
+:Author: Lucius(lukai1@huawei.com)
 
 Build date: |today|
diff --git a/docs/scenario description/scenario-description.rst b/docs/Colorado/scenario description/scenario-description.rst
index 264f97fd..fc76eb3f 100644
--- a/docs/scenario description/scenario-description.rst
+++ b/docs/Colorado/scenario description/scenario-description.rst
@@ -15,9 +15,9 @@ License
 =======
 
 OPNFV Brahmaputra release note for onosfw Docs
-(c) by Henry (HUAWEI)
+(c) by Lucius (HUAWEI)
 
-OPNFV Brahmaputra release note for onosfw Docs
+OPNFV Colorado 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/>.
@@ -44,7 +44,7 @@ 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
+.. image::  /etc/ONOS-DVR.png
 
 
 Secenario 14 ONOS-HA :
@@ -87,8 +87,15 @@ Secenario 14 ONOS-HA :
 
       2.3.3. All nicira extension api has been extended
 
+3. SFC feature
+
+   3.1 Infrastructure CURD operation of SFC.
+
+   3.2 traffic through SFC
+
+
 Revision: _sha1_
 
-:Author: Henry(jiangrui1@huawei.com)
+:Author: Lucius(lukai1@huawei.com)
 
 Build date: |today|
diff --git a/docs/userguide/index.rst b/docs/Colorado/userguide/index.rst
index 38247f02..3b7683af 100644
--- a/docs/userguide/index.rst
+++ b/docs/Colorado/userguide/index.rst
@@ -10,6 +10,6 @@ ONOSFW User Guide
 
 Revision: _sha1_
 
-:Author: Henry(jiangrui1@huawei.com)
+:Author: Lucius(lukai1@huawei.com)
 
-Build date: |today|
\ No newline at end of file
+Build date: |today|
diff --git a/docs/userguide/onosfw-userguide.rst b/docs/Colorado/userguide/onosfw-userguide.rst
index 6b9ce7e7..b220cc77 100644
--- a/docs/userguide/onosfw-userguide.rst
+++ b/docs/Colorado/userguide/onosfw-userguide.rst
@@ -15,7 +15,7 @@ License
 =======
 
 ONOSFW User Guide Manaully Docs
-(c) by Henry (HUAWEI)
+(c) by Lucius (HUAWEI)
 
 ONOSFW User Guide Manaully Docs
 are licensed under a Creative Commons Attribution 4.0 International License.
@@ -62,8 +62,18 @@ ONOSFW Environment Setup
 
  2. restart onos，install feature::
 
+   feature:install onos-openflow-base
+
+   feature:install onos-openflow
+
    feature:install onos-ovsdatabase
 
+   feature:install onos-ovsdb-base
+
+   feature:install onos-drivers-ovsdb
+
+   feature:install onos-ovsdb-provider-host
+
    feature:install onos-app-vtn-onosfw
 
  3. set the external port name::
@@ -74,11 +84,9 @@ ONOSFW Environment Setup
 
    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”
+ 5. create basic networks and instances on openstack dashboard to verify L2/L3 function
 
- 6. create basic networks and instances on openstack dashboard to verify L2/L3function
+ 6. create basic scenarios to verify SFC functions.
 
 Scenario Supported
 ------------------
@@ -113,6 +121,18 @@ Scenario Supported
    
    * With between different nodes under the different tenant and different network wether the vm is not conneted
    VM can ping external network well
+
+ * SFC scene:
+
+   * Create 3-4 VNF-nodes service chain, verify with traffic
+
+   * Remove service chain, display service chain info
+
+   * Insert a node(vnf) in the chain, and verify with traffic
+
+   * Remove a node from the chain and verify with traffic
+
+   * Get service chain status
    
 ONOSFW Demo Video
 -----------------
@@ -123,8 +143,10 @@ ONOSFW Demo Video
 
     ONOSFW L3 Function Demo video：https://www.youtube.com/watch?v=R0H-IibpVxw
 
+    ONOSFW SFC Function Demo video: https://www.youtube.com/watch?v=2vWusqd3WJ4
+
 Revision: _sha1_
 
-:Author: Henry(jiangrui1@huawei.com)
+:Author: Lucius(lukai1@huawei.com)
 
 Build date: |today|