summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Brahmaputra/docs/configguide/config-for-installer.rst324
-rw-r--r--docs/Brahmaputra/docs/configguide/index.rst15
-rw-r--r--docs/Brahmaputra/docs/design/index.rst13
-rw-r--r--docs/Brahmaputra/docs/etc/ONOS-DVR.pngbin0 -> 102296 bytes
-rw-r--r--docs/Brahmaputra/docs/etc/conf.py34
-rw-r--r--docs/Brahmaputra/docs/etc/opnfv-logo.pngbin0 -> 2829 bytes
-rw-r--r--docs/Brahmaputra/docs/release/index.rst15
-rw-r--r--docs/Brahmaputra/docs/release/onos-release.rst134
-rw-r--r--docs/Brahmaputra/docs/scenario description/index.rst15
-rw-r--r--docs/Brahmaputra/docs/scenario description/scenario-description.rst94
-rw-r--r--docs/Brahmaputra/docs/userguide/index.rst15
-rw-r--r--docs/Brahmaputra/docs/userguide/onosfw-userguide.rst130
-rw-r--r--docs/Brahmaputra/how-to-use-docs/documentation-example.rst86
-rw-r--r--docs/Brahmaputra/how-to-use-docs/index.rst29
14 files changed, 904 insertions, 0 deletions
diff --git a/docs/Brahmaputra/docs/configguide/config-for-installer.rst b/docs/Brahmaputra/docs/configguide/config-for-installer.rst
new file mode 100644
index 00000000..a41acbbc
--- /dev/null
+++ b/docs/Brahmaputra/docs/configguide/config-for-installer.rst
@@ -0,0 +1,324 @@
+===========================================================================================================
+OPNFV config guide instructions for the Brahmaputra release of OPNFV when using installers to deploy onosfw
+===========================================================================================================
+
+.. contents:: Table of Contents
+ :backlinks: none
+
+
+Abstract
+========
+
+This document describes how to config the Brahmaputra 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)
+
+Brahmaputra 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/>.
+
+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 |
+| | | (HUAWEI) | |
++------------+----------+------------+------------------+
+
+Introduction
+============
+
+ONOSFW need to deploy with several installers and each installer have differernt configs. Here is the scenarios ONOSFW need to supported
+
++-----------------------------------------+-----------------------------------------+-----------------------------------------+-----------------------------------------+
+| Apex | Compass | Fuel | JOID |
++=========================================+=========================================+=========================================+=========================================+
+| Virtual CentOS 7, ONOS with OpenStack | Virtual Ubuntu 14, ONOS with OpenStack | Virtual Ubuntu 14, ONOS with OpenStack | Virtual Ubuntu 14, ONOS with OpenStack |
+| neutron-l3-agent being disabled | neutron-l3-agent being disabled | neutron-l3-agent being disabled | neutron-l3-agent being disabled |
++-----------------------------------------+-----------------------------------------+-----------------------------------------+-----------------------------------------+
+| NA | BM Ubuntu 14, ONOS with OpenStack | NA | NA |
+| | neutron-l3-agent being disabled | | |
++-----------------------------------------+-----------------------------------------+-----------------------------------------+-----------------------------------------+
+Below is the detail config for them:
+
+Config for Installers
+=====================
+
+Config Documentation for onos with apex
+---------------------------------------
+1. Pyhsical Requirement
+
+ 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 Bramaputra 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 when 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::
+
+ ├── build
+ │ ├── instack.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.2 Edit /etc/opnfv-apex/deploy_settings.yaml and change opendaylight into onos.
+
+ 3.3 Execute sudo opnfv-deploy --virtual [ --no-ha ] -d /etc/opnfv-apex/deploy_settings.yaml
+
+4. Baremetal deployment
+
+ 4.1 Install jumphost.
+
+ 4.2 Edit /etc/opnfv-apex/deploy_settings.yaml and change opendaylight into onos.
+
+ 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/deploy_settings.yaml -i /etc/apex-opnfv/inventory.yaml
+
+5. Detail of apex installation `Apex Installation`_.
+
+.. _Apex Installation : http://artifacts.opnfv.org/apex/docs/installation-instructions/
+
+Config Documentation for onos with Compass
+------------------------------------------
+1. Pyhsical Requirement for install ONOS
+
+ 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 script that install onos service is added into the compass4nfv project. and the onos will be started when compass called the onos script. the script is included in the directory of compass4nfv project below::
+
+ 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
+
+3. Virtual deployment
+
+ 3.1 Install jumphost
+
+ 3.2 Build iso of compass. Execute ./build.sh
+
+ 3.3 Execute ./deploy.sh virtual_cluster_onos
+
+4. Baremetal deployment
+
+ 4.1 Install jumphost
+
+ 4.2 Build iso 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_us_lab/pod1
+
+ export ISO_URL=file://$BUILD_DIRECTORY/compass.iso
+
+ export EXTERNAL_NIC=eth0
+
+ export INSTALL_NIC=eth1
+
+ export OS_VERSION=trusty
+
+ export OPENSTACK_VERSION=liberty
+
+ 4.4 Execute cd $WORKSPACE
+
+ 4.5 Execute ./deploy.sh --dha $CONFDIR/dha.yml --network $CONFDIR/network.yml
+
+5. Detail of compass installation `Compass Installation`_.
+
+.. Compass Installation : http://artifacts.opnfv.org/compass4nfv/docs/configguide/installerconfig.html
+
+
+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
+
+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
+ │ ├──f_isoroot
+ │ ├── f_onosfwpluginbuild # add onos build url
+ │
+ ├── deploy
+ │ ├──scenario
+ │ ├── 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.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.
+
+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.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.6 Select a node with the role of controller and onos( onos must collocate with a controller).
+
+ 4.7 Deploy changes.
+
+5. Related url for fuel and onos.
+
+ Fuel: https://wiki.openstack.org/wiki/Fuel
+
+ Fuel plugin: https://wiki.openstack.org/wiki/Fuel/Plugins
+
+ Fuel codes: https://gerrit.opnfv.org/gerrit/fuel
+
+ Fuel iso: http://build.opnfv.org/artifacts/
+
+ Fuel-plugin-onos: http://git.openstack.org/cgit/openstack/fuel-plugin-onos/
+
+
+Config Documentation for onos with JOID
+---------------------------------------
+
+1、Virtual Machine Deployment
+
+ 1.1、 Hardware Requirement:
+ OS: Ubuntu Trusty 14.04 LTS
+
+ Memory: 48 GB +
+
+ CPU: 24 cores +
+
+ Hard disk: 1T
+
+ 1.2、Get the joid code from gerrit https://gerrit.opnfv.org/gerrit/p/joid.git
+
+ 1.3、Suggest to create a user ubuntu and use this user, if not,you should edit the file：joid/ci/maas/default/deployment.yaml. Find Virsh power settings and change ubuntu to your own user name.
+
+ 1.4、Deploy Maas
+ $ cd joid/ci/
+ $ ./02-maasdeploy.sh
+
+ 1.5、Deploy OPNFV:
+ For liberty openstack, ONOS SDN, HA mode
+ $ ./deploy.sh -o liberty -s onos -t ha
+
+2、Bare Metal Deployment
+
+ 2.1、Pre Requisite:
+
+ 1. have a single node install with Ubuntu OS 14.04 LTS
+
+ 2. Minimum four nodes exist and should have been preconfigured and integrated with JOID please have look into this wiki page https://wiki.opnfv.org/joid/get_started
+
+ 2.2、Get the joid code from gerrit : https://gerrit.opnfv.org/gerrit/p/joid.git
+
+ 2.3、Suggest to create a user ubuntu and use this user, if not,you should edit the file：joid/ci/maas/default/deployment.yaml.
+ Find Virsh power settings and change ubuntu to your own user name.
+
+ 2.4、Deploy MAAS:
+
+ $ ./02-maasdeploy.sh <lab and pod name i.e. intelpod5>
+
+ 2.5、Deploy OPNFV:
+
+ For liberty openstack, ONOS SDN, HA mode in intel pod5
+ $ ./deploy.sh -o liberty -s onos -t ha -l intelpod5
+
+3、How to add onos into joid
+
+create a dir onos as below::
+
+ --onos
+ ├── 01-deploybundle.sh # deploy bundle define
+ ├── juju-deployer
+ │ ├── ovs-onos-ha.yaml # openstack type ha feature define
+ │ ├── ovs-onos-nonha.yaml # openstack type nosha feature define
+ │ ├── ovs-onos-tip.yaml # openstack type tip feature define
+ ├── juju_test_prepare.sh # create ext-net and update gw_mac
+ └── README # description
+
+Revision: _sha1_
+
+:Author: Henry(jiangrui1@huawei.com)
+
+Build date: |today|
diff --git a/docs/Brahmaputra/docs/configguide/index.rst b/docs/Brahmaputra/docs/configguide/index.rst
new file mode 100644
index 00000000..38cba669
--- /dev/null
+++ b/docs/Brahmaputra/docs/configguide/index.rst
@@ -0,0 +1,15 @@
+*********************************************
+OPNFV(Brahmaputra) ONOSFW config instructions
+*********************************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 4
+
+ config-for-installer.rst
+
+Revision: _sha1_
+
+:Author: Henry(jiangrui1@huawei.com)
+
+Build date: |today|
diff --git a/docs/Brahmaputra/docs/design/index.rst b/docs/Brahmaputra/docs/design/index.rst
new file mode 100644
index 00000000..82681ddc
--- /dev/null
+++ b/docs/Brahmaputra/docs/design/index.rst
@@ -0,0 +1,13 @@
+*********************************************
+OPNFV(Brahmaputra) ONOSFW design instructions
+*********************************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 4
+
+Revision: _sha1_
+
+:Author: Henry(jiangrui1@huawei.com)
+
+Build date: |today|
diff --git a/docs/Brahmaputra/docs/etc/ONOS-DVR.png b/docs/Brahmaputra/docs/etc/ONOS-DVR.png
new file mode 100644
index 00000000..0c11358d
--- /dev/null
+++ b/docs/Brahmaputra/docs/etc/ONOS-DVR.png
Binary files differ
diff --git a/docs/Brahmaputra/docs/etc/conf.py b/docs/Brahmaputra/docs/etc/conf.py
new file mode 100644
index 00000000..00660351
--- /dev/null
+++ b/docs/Brahmaputra/docs/etc/conf.py
@@ -0,0 +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'
diff --git a/docs/Brahmaputra/docs/etc/opnfv-logo.png b/docs/Brahmaputra/docs/etc/opnfv-logo.png
new file mode 100644
index 00000000..1519503e
--- /dev/null
+++ b/docs/Brahmaputra/docs/etc/opnfv-logo.png
Binary files differ
diff --git a/docs/Brahmaputra/docs/release/index.rst b/docs/Brahmaputra/docs/release/index.rst
new file mode 100644
index 00000000..693f2209
--- /dev/null
+++ b/docs/Brahmaputra/docs/release/index.rst
@@ -0,0 +1,15 @@
+********************
+ONOSFW Release Notes
+********************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 4
+
+ onos-release.rst
+
+Revision: _sha1_
+
+:Author: Henry(jiangrui1@huawei.com)
+
+Build date: |today|
diff --git a/docs/Brahmaputra/docs/release/onos-release.rst b/docs/Brahmaputra/docs/release/onos-release.rst
new file mode 100644
index 00000000..2037781f
--- /dev/null
+++ b/docs/Brahmaputra/docs/release/onos-release.rst
@@ -0,0 +1,134 @@
+=========================================
+OPNFV Brahmaputra release note for onosfw
+=========================================
+
+.. contents:: Table of Contents
+ :backlinks: none
+
+
+Abstract
+========
+
+This document describes the release note of onosfw project, including upstream project ONOS and OpenStack
+
+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-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 |
+| | | (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
+=====================
+
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
+| 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 | Success | Success | Success |
+| | | | | |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+
+| 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 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 | Success | Success | Success |
+| | | | | |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+
+| VIMS | NR | NR | NR | NR |
+| | | | | |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+
+| RALLY | Success | Success | Success | Success |
+| | | | | |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+
+| ONOS | Success | Success | Success | Success |
+| | | | | |
++---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+
+
+
+ONOS Release
+============
+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 Emu Code: https://github.com/opennetworkinglab/onos/tree/onos-1.4
+
+ONOS Emu Release Note `ONOS Emu Release Note`_.
+
+.. _ONOS Emu Release Note: https://wiki.onosproject.org/display/ONOS/Release+Notes+-+Emu+1.4.0
+
+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".
+This will pull down all relevant API documents related to the source components in this release".
+here is api link: https://github.com/onosfw/apis
+
+OpenStack Release
+=================
+
+OpenStack Liberty wiki page `OpenStack Liberty wiki`_.
+
+.. _OpenStack Liberty wiki : https://wiki.openstack.org/wiki/Main_Page
+
+OpenStack Liberty api page `OpenStack Networking Api`_.
+
+.. _OpenStack Networking Api : http://developer.openstack.org/api-ref-networking-v2-ext.html
+
+
+Revision: _sha1_
+
+:Author: Henry(jiangrui1@huawei.com)
+
+Build date: |today|
diff --git a/docs/Brahmaputra/docs/scenario description/index.rst b/docs/Brahmaputra/docs/scenario description/index.rst
new file mode 100644
index 00000000..68c82d17
--- /dev/null
+++ b/docs/Brahmaputra/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/Brahmaputra/docs/scenario description/scenario-description.rst b/docs/Brahmaputra/docs/scenario description/scenario-description.rst
new file mode 100644
index 00000000..264f97fd
--- /dev/null
+++ b/docs/Brahmaputra/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|
diff --git a/docs/Brahmaputra/docs/userguide/index.rst b/docs/Brahmaputra/docs/userguide/index.rst
new file mode 100644
index 00000000..38247f02
--- /dev/null
+++ b/docs/Brahmaputra/docs/userguide/index.rst
@@ -0,0 +1,15 @@
+*****************
+ONOSFW User Guide
+*****************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 4
+
+ onosfw-userguide.rst
+
+Revision: _sha1_
+
+:Author: Henry(jiangrui1@huawei.com)
+
+Build date: |today| \ No newline at end of file
diff --git a/docs/Brahmaputra/docs/userguide/onosfw-userguide.rst b/docs/Brahmaputra/docs/userguide/onosfw-userguide.rst
new file mode 100644
index 00000000..6b9ce7e7
--- /dev/null
+++ b/docs/Brahmaputra/docs/userguide/onosfw-userguide.rst
@@ -0,0 +1,130 @@
+==========================
+ONOSFW User Guide Manaully
+==========================
+
+.. contents:: Table of Contents
+ :backlinks: none
+
+
+Abstract
+========
+
+This document describes the user guide instruction for onosfw project, including env setup and test case.
+
+License
+=======
+
+ONOSFW User Guide Manaully Docs
+(c) by Henry (HUAWEI)
+
+ONOSFW User Guide Manaully 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-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 |
+| | | (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 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-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
+
+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: Henry(jiangrui1@huawei.com)
+
+Build date: |today|
diff --git a/docs/Brahmaputra/how-to-use-docs/documentation-example.rst b/docs/Brahmaputra/how-to-use-docs/documentation-example.rst
new file mode 100644
index 00000000..afcf7581
--- /dev/null
+++ b/docs/Brahmaputra/how-to-use-docs/documentation-example.rst
@@ -0,0 +1,86 @@
+.. two dots create a comment. please leave this logo at the top of each of your rst files.
+.. image:: ../etc/opnfv-logo.png
+ :height: 40
+ :width: 200
+ :alt: OPNFV
+ :align: left
+.. these two pipes are to seperate the logo from the first title
+|
+|
+How to create documentation for your OPNFV project
+==================================================
+
+this is the directory structure of the docs/ directory that can be found in the root of your project directory
+
+.. code-block:: bash
+
+ ./etc
+ ./etc/opnfv-logo.png
+ ./etc/conf.py
+ ./how-to-use-docs
+ ./how-to-use-docs/documentation-example.rst
+ ./how-to-use-docs/index.rst
+
+To create your own documentation, Create any number of directories (depending on your need) and place in each of them an index.rst.
+This index file must refence your other rst files.
+
+* Here is an example index.rst
+
+.. code-block:: bash
+
+ Example Documentation table of contents
+ =======================================
+
+ Contents:
+
+ .. toctree::
+ :numbered:
+ :maxdepth: 4
+
+ documentation-example.rst
+
+ Indices and tables
+ ==================
+
+ * :ref:`search`
+
+ Revision: _sha1_
+
+ Build date: |today|
+
+
+The Sphinx Build
+================
+
+When you push documentation changes to gerrit a jenkins job will create html documentation.
+
+* Verify Jobs
+For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result.
+
+* Merge jobs
+
+Once you are happy with the look of your documentation you can submit the patchset the merge job will
+copy the output of each documentation directory to http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html
+
+Here are some quick examples of how to use rst markup
+
+This is a headline::
+
+ here is some code, note that it is indented
+
+links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/
+
+* Bulleted Items
+
+ **this will be bold**
+
+.. code-block:: bash
+
+ echo "Heres is a code block with bash syntax highlighting"
+
+
+Leave these at the bottom of each of your documents they are used internally
+
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/Brahmaputra/how-to-use-docs/index.rst b/docs/Brahmaputra/how-to-use-docs/index.rst
new file mode 100644
index 00000000..3593b2a0
--- /dev/null
+++ b/docs/Brahmaputra/how-to-use-docs/index.rst
@@ -0,0 +1,29 @@
+.. 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
+
+ documentation-example.rst
+
+Indices and tables
+==================
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today| \ No newline at end of file