update onosfw docs

Change-Id: Ia219a0574f54f79639596e4c12d735c3b9c803cc
Signed-off-by: bobzhou <bob.zh@huawei.com>

7 files changed, 370 insertions, 16 deletions

diff --git a/docs/release/configguide/feature.configuration.rst b/docs/release/configguide/feature.configuration.rst
new file mode 100644
index 00000000..c93c1acd
--- /dev/null
+++ b/docs/release/configguide/feature.configuration.rst
@@ -0,0 +1,191 @@
+======================================================
+ONOSFW Installation Guide for the OPNFV Danube Release
+======================================================
+
+.. contents:: Table of Contents
+   :backlinks: none
+
+
+Abstract
+========
+
+This document describes how to use various OPNFV installers to install and configure OPNFV Danube release with ONOS as the SDN controller.
+It also outlines the system resource requirements, dependencies and limitations.
+
+License
+=======
+
+Using Installers to Deploy ONOSFW for OPNFV Danube Release
+(c) by Lucius (HUAWEI)
+
+The Using Installers to Deploy ONOSFW for OPNFV Danube Release document
+is 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-08-11 | 0.0.1    | Lucius     | First draft      |
+|            |          | (HUAWEI)   |                  |
++------------+----------+------------+------------------+
+| 2017-02-15 | 1.0.0    | Bob        | For Danube 1.0   |
+|            |          | (HUAWEI)   |                  |
++------------+----------+------------+------------------+
+
+Introduction
+============
+
+ONOSFW can be deployed on OPNFV Danube Releases using several installers. Each installer has its own system requirements and configuration procedures.
+The following table lists the basic system requirements when installing ONOSFW using each of the supported installers.
+
++-----------------------------------------+-----------------------------------------+
+| Apex                                    | Compass                                 |
++=========================================+=========================================+
+| Virtual  CentOS 7,  ONOS with OpenStack | Virtual  Ubuntu 14, ONOS with OpenStack |
+| neutron-l3-agent being disabled         | neutron-l3-agent being disabled         |
++-----------------------------------------+-----------------------------------------+
+| NA                                      | BM  Ubuntu 14, ONOS with OpenStack      |
+|                                         | neutron-l3-agent being disabled         |
++-----------------------------------------+-----------------------------------------+
+
+Below are the detail configuration procedures for each installer:
+
+Installer Configuration
+=======================
+
+Apex Configuration for ONOS
+---------------------------
+1. Resource Requirements
+
+   1.1 CentOS 7 (from ISO or self-installed).
+
+   1.2 Root access.
+
+   1.3 libvirt virtualization support.
+
+   1.4 minimum 2 networks and maximum 6 networks, multiple NIC and/or VLAN combinations are supported. This is virtualized for a VM deployment.
+
+   1.5 The Danube Apex RPM.
+
+   1.6 16 GB of RAM for a bare metal deployment, 56 GB of RAM for a VM deployment.
+
+2. How to add ONOS into Apex
+
+   2.1  Apex will download two images instack.qcow2 and overcloud-full.qcow2 to build Apex rpm. The instack.qcow2 is used for installation of instack virtual machine.
+   The overcloud-full.qcow2 is used for installation of openstack nodes. The opnfv-tripleo-heat-templates.patch will update tripleo-heat scripts in instack.qcow2.
+   And it will call puppet deployment scripts in overcloud-full.qcow2 to finish deployment. Those two files will be patch up and store into the two images during Apex rpm building process in instack.sh.
+
+   Below is the directory Structure::
+
+      ├── build
+      │   ├── overcloud-onos.sh   # add ONOS build steps
+      │   ├── opnfv-tripleo-heat-templates.patch   # add ONOS deployment scripts
+      │
+      ├── ci
+      │   └── deploy.sh   #add ONOS build steps inside
+
+   2.2 Upload puppet-onos to github for Apex iso/rpm building.
+
+3. Virtual deployment
+
+   3.1 Install jumphost.
+
+   3.3 Execute sudo opnfv-deploy --virtual [ --no-ha ] -d /etc/opnfv-apex/os-onos-nofeature-ha.yaml -n /etc/opnfv-apex/network_settings.yaml
+
+4. Baremetal deployment
+
+   4.1 Install jumphost.
+
+   4.3 Edit /etc/apex-opnfv/inventory.yaml and change mac_address, ipmi_ip, ipmi_user, ipmi_password etc base on your physical server and network.
+
+   4.4 Execute sudo opnfv-deploy -d /etc/opnfv-apex/os-onos-nofeature-ha.yaml -i /etc/apex-opnfv/inventory.yaml -n /etc/opnfv-apex/network_settings.yaml
+
+5. Detail of Apex installation `Apex Installation`_.
+
+.. _Apex Installation : http://artifacts.opnfv.org/apex/docs/installation-instructions/
+
+
+Compass Configuration for ONOS
+------------------------------
+1. Resource Requirements
+
+   1.1 Ubuntu Server 14.04 LTS 64-bit (from ISO or self-installed).
+
+   1.2 Minimum 2GB RAM.
+
+   1.3 Minimum 2 processors.
+
+   1.4 At least 5GB disk space.
+
+   1.5 The ONOS version 1.4.
+
+2. How to add ONOS into compass
+
+   2.1 The ONOS installaion script is added into the compass4nfv project. and the onos will be started when compass calls the onos script. the script is included in the directory of compass4nfv project below::
+
+      commpass4nfv
+         ├── deploy
+         │   ├── adapters
+         │       ├── 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
+
+   3.1 Install jumphost
+
+   3.2 Build ISO image of compass. Execute ./build.sh
+
+   3.3 If onos_nofeature: 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
+
+4. Baremetal deployment
+
+   4.1 Install jumphost
+
+   4.2 Build ISO image of compass. Execute ./build.sh
+
+   4.3 Config the envionment variables
+
+          export WORKSPACE="/home/jenkins/jenkins-slave/workspace/compass-deploy-bare-huawei-us-master"
+
+          export BUILD_DIRECTORY=$WORKSPACE/build_output
+
+          export CONFDIR=$WORKSPACE/deploy/conf/hardware_environment/huawei-pod1
+
+          export ISO_URL=file://$BUILD_DIRECTORY/compass.iso
+
+          export EXTERNAL_NIC=eth0
+
+          export INSTALL_NIC=eth1
+
+          export OS_VERSION=trusty
+
+          export OPENSTACK_VERSION=mitaka
+
+   4.4 Execute cd $WORKSPACE
+
+   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
+
+5. For the details of compass installation `Compass Installation`_.
+
+.. Compass Installation : http://artifacts.opnfv.org/compass4nfv/docs/configguide/installerconfig.html
+
+
+
+Revision: _sha1_
+
+:Author: Lucius(lukai1@huawei.com)
+
+Build date: |today|
diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst
new file mode 100644
index 00000000..3320215c
--- /dev/null
+++ b/docs/release/configguide/index.rst
@@ -0,0 +1,15 @@
+***********************
+Configuration of ONOSFW
+***********************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   feature.configuration.rst
+
+Revision: _sha1_
+
+:Author: Lucius(lukai1@huawei.com)
+
+Build date: |today|
diff --git a/docs/release/index.rst b/docs/release/index.rst
index e3b0bdb2..a680e141 100644
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -6,7 +6,9 @@ ONOSFW Release Notes
    :numbered:
    :maxdepth: 4
 
-   onos-release.rst
+   ./installation/index.rst
+   ./userguide/index.rst
+   ./configguide/index.rst
 
 Revision: _sha1_
 
diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
new file mode 100644
index 00000000..c61125dc
--- /dev/null
+++ b/docs/release/release-notes/index.rst
@@ -0,0 +1,11 @@
+********************
+ONOSFW Release Notes
+********************
+
+.. toctree::
+    :maxdepth: 2
+
+    releasenotes.rst
+
+
+:Author: Bobzhou(bob.zh@huawei.com)
diff --git a/docs/release/onos-release.rst b/docs/release/release-notes/releasenotes.rst
index f30bccb2..5277a2de 100644
--- a/docs/release/onos-release.rst
+++ b/docs/release/release-notes/releasenotes.rst
@@ -1,7 +1,7 @@
 Abstract
 ========
 
-This note describes the Danube 1.0 release status of the ONOSFW project and associated scenarios. 
+This note describes the Danube 1.0 release status of the ONOSFW project and associated scenarios.
 
 License
 =======
@@ -34,32 +34,20 @@ Version history
 Overview
 ========
 
-In Danube, ONOSFW project maintains the support of two scenarios for each of the four installers, Apex, Compass, Fuel, and JOID.
+In Danube, ONOSFW project maintains the support of two scenarios for each of the four installers, Apex and Compass.
 The first major scenario os-onos-nofeature-ha is to update the ONOS version from GlodenEye to Ibis, so that the new ONOS features can be integrated with OPNFV.
-The second major scenario os-onos-sfc-ha is to demonstrate the integration of SFC functionalities provided by the network-sfc in OpenStack \
-and ONOS sfc client library for service function chaining primitives – create, add, remove and modify.
 
 Scenarios Release Status
 ========================
 
 The scenarios are implemented and integrated with supported installers, and tested through OPNFV testing facilities. For Danube 1.0, the supported installer and scenario combinations are:
 
-    fuel-os-onos-nofeature-ha
-
-    fuel-os-onos-sfc-ha
-
-    joid-os-onos-nofeature-ha
-
-    joid-os-onos-sfc-ha
-
     compass-os-onos-nofeature-ha
 
-    compass-os-onos-sfc-ha
+For Danube 2.0, the supported installer and scenario combinations are:
 
     apex-os-onos-nofeature-ha
 
-    apex-on-onos-sfc-ha
-
 Limitations
 ===========
 
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
new file mode 100644
index 00000000..b615993a
--- /dev/null
+++ b/docs/release/userguide/feature.userguide.rst
@@ -0,0 +1,132 @@
+=================
+ONOSFW User Guide
+=================
+
+.. contents:: Table of Contents
+   :backlinks: none
+
+
+Abstract
+========
+
+This user guide describes how to manually setup test environment for testing ONOSFW supported features.
+
+License
+=======
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Lucius (HUAWEI)
+
+Version history
+===============
+
++------------+----------+------------+------------------+
+| **Date**   | **Ver.** | **Author** | **Comment**      |
+|            |          |            |                  |
++------------+----------+------------+------------------+
+| 2016-01-21 | 1.0.0    | Lucius     | Rewritten for    |
+|            |          | (HUAWEI)   | ONOSFW C release |
++------------+----------+------------+------------------+
+| 2017-02-15 | 1.0.1    | Bob        | For Danube 1.0   |
+|            |          | (HUAWEI)   |                  |
++------------+----------+------------+------------------+
+
+Introduction
+============
+
+ONOSFW integrats ONOS SDN controller for OPNFV defined NFVI and VIM framework.
+
+In the Danube releases, all the previously ONOSFW supported features are updated to use Openstack Newton and ONOS Ibis.
+For auto-installation procedures, please refer to the installation document. Herethere is the manual setup instruction.
+
+ONOSFW User Guide Manaully
+==========================
+
+ONOSFW Environment Setup
+------------------------
+ 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-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::
+
+   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 basic networks and instances on openstack dashboard to verify L2/L3 function
+
+Scenario Supported
+------------------
+
+* 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
+
+ONOSFW Demo 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
+
+
+Revision: _sha1_
+
+:Author: Lucius(lukai1@huawei.com)
+
+Build date: |today|
diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst
new file mode 100644
index 00000000..5f7c67bb
--- /dev/null
+++ b/docs/release/userguide/index.rst
@@ -0,0 +1,15 @@
+*****************
+ONOSFW User Guide
+*****************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   feature.userguide.rst
+
+Revision: _sha1_
+
+:Author: Lucius(lukai1@huawei.com)
+
+Build date: |today|