diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/installationprocedure/feature.configuration.rst | 70 | ||||
| -rw-r--r-- | docs/release/onos-release.rst | 37 | ||||
| -rw-r--r-- | docs/scenarios/os-onos-nofeature-sfc/scenario-description.rst | 14 | ||||
| -rw-r--r-- | docs/userguide/feature.userguide.rst | 14 |
4 files changed, 72 insertions, 63 deletions
diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst index 84192072..d4d9266b 100644 --- a/docs/installationprocedure/feature.configuration.rst +++ b/docs/installationprocedure/feature.configuration.rst @@ -1,5 +1,5 @@ -=========================================================================================================== -OPNFV config guide instructions for the Colorado release of OPNFV when using installers to deploy onosfw +=========================================================================================================== +ONOSFW Installation Guide for the OPNFV Danube Release =========================================================================================================== .. contents:: Table of Contents @@ -9,18 +9,17 @@ OPNFV config guide instructions for the Colorado release of OPNFV when using ins Abstract ======== -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. +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 ======= -Colorado release of OPNFV when using installers to deploy onosfw Docs +Using Installers to Deploy ONOSFW for OPNFV Danube Release (c) by Lucius (HUAWEI) -Colorado release of OPNFV when using installers to deploy onosfw Docs -are licensed under a Creative Commons Attribution 4.0 International License. +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/>. @@ -34,11 +33,14 @@ Version history | 2016-08-11 | 0.0.1 | Lucius | First draft | | | | (HUAWEI) | | +------------+----------+------------+------------------+ +| 2017-02-15 | 1.0.0 | Bob | For Danube 1.0 | +| | | (HUAWEI) | | ++------------+----------+------------+------------------+ Introduction ============ -ONOSFW need to deploy with several installers and each installer have differernt configs. Here is the scenarios ONOSFW need to supported +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 | Fuel | JOID | @@ -49,14 +51,15 @@ ONOSFW need to deploy with several installers and each installer have differernt | NA | BM Ubuntu 14, ONOS with OpenStack | NA | NA | | | neutron-l3-agent being disabled | | | +-----------------------------------------+-----------------------------------------+-----------------------------------------+-----------------------------------------+ -Below is the detail configuration for them: -Config for Installers -===================== +Below are the detail configuration procedures for each installer: + +Installer Configuration +======================= -Config Documentation for ONOS with Apex ---------------------------------------- -1. Pyhsical Requirements +Apex Configuration for ONOS +--------------------------- +1. Resource Requirements 1.1 CentOS 7 (from ISO or self-installed). @@ -66,17 +69,17 @@ 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 Colorado Apex RPM. + 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 when build Apex rpm. The instack.qcow2 is used for installation of instack virtual machine. + 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:: + Below is the directory Structure:: ├── build │ ├── overcloud-onos.sh # add ONOS build steps @@ -91,33 +94,30 @@ Config Documentation for ONOS with Apex 3.1 Install jumphost. - 3.2 Edit /etc/opnfv-apex/deploy_settings.yaml and change ODL into ONOS. - - 3.3 Execute sudo opnfv-deploy --virtual [ --no-ha ] -d /etc/opnfv-apex/deploy_settings.yaml -n /etc/opnfv-apex/network_settings.yaml + 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.2 Edit /etc/opnfv-apex/deploy_settings.yaml and change ODL 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 -n /etc/opnfv-apex/network_settings.yaml + 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/ -Config Documentation for ONOS with Compass ------------------------------------------- -1. Pyhsical Requirements for install ONOS + +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.2 Minimum 2GB RAM. - 1.3 minimum 2 processors. + 1.3 Minimum 2 processors. 1.4 At least 5GB disk space. @@ -125,7 +125,7 @@ Config Documentation for ONOS with Compass 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 calls the onos script. the script is included in the directory of compass4nfv project below:: + 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 @@ -187,9 +187,9 @@ Config Documentation for ONOS with Compass .. Compass Installation : http://artifacts.opnfv.org/compass4nfv/docs/configguide/installerconfig.html -Config Documentation for ONOS with Fuel ---------------------------------------- -1. Pyhsical Requirement +Fuel Configuration for ONOS +--------------------------- +1. Resource Requirement 1.1 Linux , Microsoft or Mac OS. @@ -258,8 +258,8 @@ Config Documentation for ONOS with Fuel Fuel-plugin-onos: http://git.openstack.org/cgit/openstack/fuel-plugin-onos/ -Config Documentation for ONOS with JOID ---------------------------------------- +JOID Configuration for ONOS +--------------------------- 1、Virtual Machine Deployment diff --git a/docs/release/onos-release.rst b/docs/release/onos-release.rst index a1154cda..f30bccb2 100644 --- a/docs/release/onos-release.rst +++ b/docs/release/onos-release.rst @@ -1,16 +1,16 @@ -Abstract +Abstract ======== -This note describes the Colorado 1.0 release status of the ONOSFW project and associated scenarios. It also includes the requirements for upstream projects ONOS and OpenStack. +This note describes the Danube 1.0 release status of the ONOSFW project and associated scenarios. License ======= -OPNFV Colorado release note for onosfw Docs +ONOSFW release note for OPNFV Danube Release (c) by Lucius (HUAWEI) -OPNFV Colorado release note for onosfw Docs -are licensed under a Creative Commons Attribution 4.0 International License. +ONOSFW Release note 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/>. @@ -27,19 +27,22 @@ Version history | 2016-09-21 | 1.0.0 | Lucius | For Colorado 1.0 | | | | (HUAWEI) | | +------------+----------+------------+------------------+ +| 2017-02-15 | 1.0.1 | Bob | | +| | | (HUAWEI) | For Danube 1.0 | ++------------+----------+------------+------------------+ Overview ======== -In Colorado, ONOSFW project has two main scenarios for each of the four installers, Apex, Compass, Fuel, and JOID. -The first major scenario os-onos-nofeature-ha is to update the ONOS version from Emu to GlodenEye, so that the new ONOS features can be integrated with OPNFV applications. +In Danube, ONOSFW project maintains the support of two scenarios for each of the four installers, Apex, Compass, Fuel, and JOID. +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 Colorado 1.0, the supported installer and scenario combinations are: +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 @@ -53,8 +56,6 @@ The scenarios are implemented and integrated with supported installers, and test compass-os-onos-sfc-ha -For Colorado 2.0 the following installer/scenario combinations will be supported: - apex-os-onos-nofeature-ha apex-on-onos-sfc-ha @@ -76,15 +77,15 @@ Upstream Requirement _ONOS Release ================================== _ONOS wiki of onosfw - https://wiki.onosproject.org/login.action?os_destination=%2Fdisplay%2FONOS%2FONOS%2BFramework%2B%28ONOSFW%29%2Bfor%2BOPNFV + https://wiki.onosproject.org/display/ONOS/ONOS+Framework+%28ONOSFW%29+for+OPNFV -_ONOS Goldeneye code +_ONOS Ibis code - https://github.com/opennetworkinglab/onos/tree/onos-1.6 + https://github.com/opennetworkinglab/onos/tree/onos-1.8 -ONOS Goldeneye Release Note +ONOS Ibis Release Note - https://wiki.onosproject.org/display/ONOS/Goldeneye+Release+Notes + https://wiki.onosproject.org/display/ONOS/Ibis+Release+Content 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". @@ -94,13 +95,13 @@ here is api link: https://github.com/onosfw/apis Upstream Requirement _OpenStack Release ======================================= -_OpenStack Mitaka wiki page +_OpenStack Newton wiki page https://wiki.openstack.org/wiki/Main_Page -_OpenStack Liberty api page +_OpenStack Newton api page - https://developer.rackspace.com/docs/cloud-networks/v2/api-reference/#api-reference + https://developer.openstack.org/api-ref/networking/v2/ Revision: _sha1_ diff --git a/docs/scenarios/os-onos-nofeature-sfc/scenario-description.rst b/docs/scenarios/os-onos-nofeature-sfc/scenario-description.rst index b509cde3..1d415c01 100644 --- a/docs/scenarios/os-onos-nofeature-sfc/scenario-description.rst +++ b/docs/scenarios/os-onos-nofeature-sfc/scenario-description.rst @@ -9,7 +9,7 @@ Release notes for onosfw Abstract ======== -This document describes the testing scenario of onosfw project, including ONOS bare metal and virtual deployment scenario +This document describes the currently supported ONOSFW test scenarios for both bare metal and virtual deployments License ======= @@ -27,14 +27,18 @@ Version history | 2016-08-11 | 0.0.1 | Lucius | First draft | | | | (HUAWEI) | | +------------+----------+------------+------------------+ +| 2017-02-15 | 1.0.0 | Bob | For Danube 1.0 | +| | | (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. -In the Colorado release, in addition to the features in the Brahmaputra release, ONOSFW has included more functions in the Goldeneys of ONOS, \ -and added service Function Chaining scenario by integrating the networking-sfc capability of openstack. -Therefore, both features and scenarios configurations are described. +ONOSFW integrates ONOS SDN controller for OPNFV defined NFVI and VIM. ONOSFW scenarios are defined test cases for target applications that ONOS supports. Serveral test scebarios has been implemented and integrated for the previous releases. In the Danube release, those scenarios are maintained for the current versions +of Openstack and ONOS. While no new scenario is implemented in this release, new features in the current ONOS release can still be explored by interested users. +For the complete list of new ONOS features, please refer to ONOS release home page. + +The following is a list of current supported test scenarios. ONOSFW Test Scenarios ===================== diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst index 68c1a17e..4f0564ff 100644 --- a/docs/userguide/feature.userguide.rst +++ b/docs/userguide/feature.userguide.rst @@ -1,4 +1,4 @@ -================= +================= ONOSFW User Guide ================= @@ -9,7 +9,7 @@ ONOSFW User Guide Abstract ======== -This document describes the user guide instruction for onosfw project, including env setup and test case. +This user guide describes how to manually setup test environment for testing ONOSFW supported features. License ======= @@ -28,13 +28,17 @@ Version history | 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 addresses integrating an SDN controller of choice based on a target applications or use cases within the OPNFV defined NFVI and VIM framework. - In the Colorado release, in addition to the features in the Brahmaputra release, ONOSFW has included more functions in the Goldeneys of ONOS, -and added service Function Chaining scenario by integrating the networking-sfc capability of openstack.Therefore, both features and scenarios configurations are described. +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 ========================== |