DOCS-84

ONOSFW contribution to the Colorado user guide

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

diff --git a/docs/Colorado/configguide/config-for-installer.rst b/docs/Colorado/configguide/config-for-installer.rst
index fe4f83d..d5c327f 100644 (file)
--- a/docs/Colorado/configguide/config-for-installer.rst
+++ b/docs/Colorado/configguide/config-for-installer.rst
@@ -1,5 +1,5 @@
 ===========================================================================================================
-OPNFV config guide instructions for the Brahmaputra release of OPNFV when using installers to deploy onosfw
+OPNFV config guide instructions for the Colorado release of OPNFV when using installers to deploy onosfw
 ===========================================================================================================
 
 .. contents:: Table of Contents
@@ -66,7 +66,7 @@ Config Documentation for onos with apex
 
    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.5 The Colorado Apex RPM.
 
    1.6 16 GB of RAM for a bare metal deployment, 56 GB of RAM for a VM deployment.
 
@@ -79,7 +79,7 @@ Config Documentation for onos with apex
    below is the directory::
 
       ├── build
-      │   ├── instack.sh   # add onos build steps
+      │   ├── overcloud-onos.sh   # add onos build steps
       │   ├── opnfv-tripleo-heat-templates.patch   # add onos deployment scripts
       │   
       ├── ci
@@ -93,7 +93,7 @@ Config Documentation for onos with apex
 
    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
+   3.3 Execute sudo opnfv-deploy --virtual [ --no-ha ] -d /etc/opnfv-apex/deploy_settings.yaml -n /etc/opnfv-apex/network_settings.yaml
 
 4. Baremetal deployment
 
@@ -103,7 +103,7 @@ Config Documentation for onos with apex
 
    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
+   4.4 Execute sudo opnfv-deploy -d /etc/opnfv-apex/deploy_settings.yaml -i /etc/apex-opnfv/inventory.yaml -n /etc/opnfv-apex/network_settings.yaml
 
 5. Detail of apex installation `Apex Installation`_.
 
@@ -278,7 +278,7 @@ Config Documentation for onos with JOID
 
    1.5、Deploy OPNFV:
       For liberty openstack, ONOS SDN, HA mode
-     $ ./deploy.sh -o liberty -s onos -t ha
+     $ ./deploy.sh -o mitaka -s onos -t ha -f sfc -d trusty
 
 2、Bare Metal Deployment
 
@@ -300,7 +300,7 @@ Config Documentation for onos with JOID
    2.5、Deploy OPNFV:
 
       For liberty openstack, ONOS SDN, HA mode in intel pod5
-      $ ./deploy.sh -o liberty -s onos -t ha -l intelpod5
+      $ ./deploy.sh -o liberty -s onos -t ha -f sfc -d trusty -l intelpod5
 
 3、How to add onos into joid
 
@@ -312,11 +312,14 @@ create a dir onos as below::
    │   ├── 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
+   ├── openstack.sh  # create ext-net
+   ├── config_tpl/bundle_tpl
+   │   ├── onos.yaml # set onos config option
+   │   ├── subordinate.yaml # set openvswitch-onos config option
    └── README  # description
 
 Revision: _sha1_
 
-:Author: Henry(jiangrui1@huawei.com)
+:Author: Lucius(lukai1@huawei.com)
 
 Build date: |today|

diff --git a/docs/Colorado/configguide/index.rst b/docs/Colorado/configguide/index.rst
index c00c155..be05670 100644 (file)
--- a/docs/Colorado/configguide/index.rst
+++ b/docs/Colorado/configguide/index.rst
@@ -1,5 +1,5 @@
 *********************************************
-OPNFV(Brahmaputra) ONOSFW config instructions
+OPNFV(Colorado) ONOSFW config instructions
 *********************************************
 
 .. toctree::

diff --git a/docs/Colorado/design/index.rst b/docs/Colorado/design/index.rst
index 5a0b7d9..e312308 100644 (file)
--- a/docs/Colorado/design/index.rst
+++ b/docs/Colorado/design/index.rst
@@ -1,5 +1,5 @@
 *********************************************
-OPNFV(Brahmaputra) ONOSFW design instructions
+OPNFV(Colorado) ONOSFW design instructions
 *********************************************
 
 .. toctree::

diff --git a/docs/Colorado/release/onos-release.rst b/docs/Colorado/release/onos-release.rst
index da81984..540dd59 100644 (file)
--- a/docs/Colorado/release/onos-release.rst
+++ b/docs/Colorado/release/onos-release.rst
@@ -1,5 +1,5 @@
 =========================================
-OPNFV Brahmaputra release note for onosfw
+OPNFV Colorado release note for onosfw
 =========================================
 
 .. contents:: Table of Contents
@@ -14,7 +14,11 @@ This document describes the release note of onosfw project, including upstream p
 License
 =======
 
-OPNFV Brahmaputra release note for onosfw Docs
+<<<<<<< HEAD:docs/Colorado/release/onos-release.rst
+OPNFV Colorado release note for onosfw Docs
+=======
+OPNFV Colorado release note for onosfw Docs
+>>>>>>> 061216d... DOCS-84:docs/Colorado/release/onos-release.rst
 (c) by Lucius (HUAWEI)
 
 OPNFV Colorado release note for onosfw Docs

diff --git a/docs/Colorado/scenario description/scenario-description.rst b/docs/Colorado/scenario description/scenario-description.rst
index fc76eb3..e94dd89 100644 (file)
--- a/docs/Colorado/scenario description/scenario-description.rst
+++ b/docs/Colorado/scenario description/scenario-description.rst
@@ -1,5 +1,5 @@
 =========================================
-OPNFV Brahmaputra release note for onosfw
+OPNFV Colorado release note for onosfw
 =========================================
 
 .. contents:: Table of Contents
@@ -14,7 +14,11 @@ This document describes the testing scenario of onosfw project, including ONOS b
 License
 =======
 
-OPNFV Brahmaputra release note for onosfw Docs
+<<<<<<< HEAD:docs/Colorado/scenario description/scenario-description.rst
+OPNFV Colorado release note for onosfw Docs
+=======
+OPNFV Colorado release note for onosfw Docs
+>>>>>>> 061216d... DOCS-84:docs/Colorado/scenario description/scenario-description.rst
 (c) by Lucius (HUAWEI)
 
 OPNFV Colorado release note for onosfw Docs
@@ -29,7 +33,7 @@ Version history
 | **Date**   | **Ver.** | **Author** | **Comment**      |
 |            |          |            |                  |
 +------------+----------+------------+------------------+
-| 2016-02-14 | 0.0.1    | Henry      | First draft      |
+| 2016-08-11 | 0.0.1    | Lucius     | First draft      |
 |            |          | (HUAWEI)   |                  |
 +------------+----------+------------+------------------+
 

diff --git a/docs/Colorado/userguide/onosfw-userguide.rst b/docs/Colorado/userguide/onosfw-userguide.rst
index b220cc7..90864d0 100644 (file)
--- a/docs/Colorado/userguide/onosfw-userguide.rst
+++ b/docs/Colorado/userguide/onosfw-userguide.rst
@@ -29,14 +29,8 @@ 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)   |                  |
+| 2016-01-21 | 1.0.0    | Lucius     | Rewritten for    |
+|            |          | (HUAWEI)   | ONOSFW C release |
 +------------+----------+------------+------------------+
 
 Introduction