diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Brahmaputra/configguide/config-for-installer.rst | 38 | ||||
| -rw-r--r-- | docs/Brahmaputra/release/onos-release.rst | 9 | ||||
| -rw-r--r-- | docs/Brahmaputra/scenario description/scenario-description.rst | 9 | ||||
| -rw-r--r-- | docs/Brahmaputra/userguide/index.rst | 2 | ||||
| -rw-r--r-- | docs/Brahmaputra/userguide/onosfw-userguide.rst | 21 | ||||
| -rw-r--r-- | docs/installationprocedure/feature.configuration.rst | 329 | ||||
| -rw-r--r-- | docs/release/configguide/feature.configuration.rst | 191 | ||||
| -rw-r--r-- | docs/release/configguide/index.rst (renamed from docs/installationprocedure/index.rst) | 0 | ||||
| -rw-r--r-- | docs/release/index.rst | 4 | ||||
| -rw-r--r-- | docs/release/release-notes/index.rst | 11 | ||||
| -rw-r--r-- | docs/release/release-notes/releasenotes.rst (renamed from docs/release/onos-release.rst) | 18 | ||||
| -rw-r--r-- | docs/release/userguide/feature.userguide.rst (renamed from docs/userguide/feature.userguide.rst) | 19 | ||||
| -rw-r--r-- | docs/release/userguide/index.rst (renamed from docs/userguide/index.rst) | 0 | ||||
| -rw-r--r-- | docs/scenarios/os-onos-nofeature-sfc/scenario-description.rst | 5 |
14 files changed, 259 insertions, 397 deletions
diff --git a/docs/Brahmaputra/configguide/config-for-installer.rst b/docs/Brahmaputra/configguide/config-for-installer.rst index a41acbbc..89f2e0c3 100644 --- a/docs/Brahmaputra/configguide/config-for-installer.rst +++ b/docs/Brahmaputra/configguide/config-for-installer.rst @@ -87,13 +87,13 @@ Config Documentation for onos with apex ├── 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. Virtual deployment 3.1 Install jumphost. @@ -114,10 +114,10 @@ Config Documentation for onos with apex 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. Pyhsical Requirement for install ONOS 1.1 Ubuntu Server 14.04 LTS 64-bit (from ISO or self-installed). @@ -145,7 +145,7 @@ Config Documentation for onos with Compass │ ├── templates # include the templates of onos │ ├── vars # include the var of onos used -3. Virtual deployment +3. Virtual deployment 3.1 Install jumphost @@ -175,8 +175,8 @@ Config Documentation for onos with Compass export OS_VERSION=trusty - export OPENSTACK_VERSION=liberty - + export OPENSTACK_VERSION=liberty + 4.4 Execute cd $WORKSPACE 4.5 Execute ./deploy.sh --dha $CONFDIR/dha.yml --network $CONFDIR/network.yml @@ -196,7 +196,7 @@ Config Documentation for onos with Fuel 1.3 libvirt virtualization support. - 1.4 minimum 2 networks and maximum 4 networks, multiple NIC and/or VLAN combinations are supported. + 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 @@ -207,11 +207,11 @@ Config Documentation for onos with Fuel below is the directory:: ├── build - │ ├──f_isoroot + │ ├──f_isoroot │ ├── f_onosfwpluginbuild # add onos build url - │ + │ ├── deploy - │ ├──scenario + │ ├──scenario │ ├── ha-onos_scenario.yaml # add onos ha configuration │ ├── noha-onos_scenario.yaml # add onos noha configuration ├── ci @@ -219,21 +219,25 @@ Config Documentation for onos with Fuel 2.2 Upload fuel-plugin-onos to git for fuel iso/rpm building. -3. Automatic deployment +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. + 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. + + For 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.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.3 fpb --build fuel-plugin-onos 4.4 Move onos*.rpm in to master and fuel plugins –install onos*.rpm. @@ -253,7 +257,7 @@ Config Documentation for onos with Fuel Fuel iso: http://build.opnfv.org/artifacts/ - Fuel-plugin-onos: http://git.openstack.org/cgit/openstack/fuel-plugin-onos/ + Fuel-plugin-onos: http://git.openstack.org/cgit/openstack/fuel-plugin-onos/ Config Documentation for onos with JOID diff --git a/docs/Brahmaputra/release/onos-release.rst b/docs/Brahmaputra/release/onos-release.rst index 2037781f..d5455c57 100644 --- a/docs/Brahmaputra/release/onos-release.rst +++ b/docs/Brahmaputra/release/onos-release.rst @@ -42,7 +42,10 @@ Version history 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 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. @@ -110,9 +113,9 @@ 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. +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". +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 diff --git a/docs/Brahmaputra/scenario description/scenario-description.rst b/docs/Brahmaputra/scenario description/scenario-description.rst index cd8ae7ba..4ed86b34 100644 --- a/docs/Brahmaputra/scenario description/scenario-description.rst +++ b/docs/Brahmaputra/scenario description/scenario-description.rst @@ -36,7 +36,10 @@ Version history 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 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. @@ -67,7 +70,7 @@ Secenario 14 ONOS-HA : 2.1.3 Related flow rule deleted when VM is deleted is OK - + 2.2 L3 south - north function @@ -77,7 +80,7 @@ Secenario 14 ONOS-HA : 2.2.3. VM hot migration is supported - + 2.3 Improvements diff --git a/docs/Brahmaputra/userguide/index.rst b/docs/Brahmaputra/userguide/index.rst index 38247f02..40b61c78 100644 --- a/docs/Brahmaputra/userguide/index.rst +++ b/docs/Brahmaputra/userguide/index.rst @@ -12,4 +12,4 @@ Revision: _sha1_ :Author: Henry(jiangrui1@huawei.com) -Build date: |today|
\ No newline at end of file +Build date: |today| diff --git a/docs/Brahmaputra/userguide/onosfw-userguide.rst b/docs/Brahmaputra/userguide/onosfw-userguide.rst index 6b9ce7e7..248bc641 100644 --- a/docs/Brahmaputra/userguide/onosfw-userguide.rst +++ b/docs/Brahmaputra/userguide/onosfw-userguide.rst @@ -42,7 +42,10 @@ Version history 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 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 @@ -92,11 +95,11 @@ Scenario Supported * 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: @@ -104,16 +107,16 @@ Scenario Supported * 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 ----------------- diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst deleted file mode 100644 index d4d9266b..00000000 --- a/docs/installationprocedure/feature.configuration.rst +++ /dev/null @@ -1,329 +0,0 @@ -=========================================================================================================== -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 | 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 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_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 - - 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 - - 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. For the details of compass installation `Compass Installation`_. - -.. Compass Installation : http://artifacts.opnfv.org/compass4nfv/docs/configguide/installerconfig.html - - -Fuel Configuration for ONOS ---------------------------- -1. Resource 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 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 and SFC. - 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 - │ ├── 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 - - 3.1 Install jumphost and download fuel.iso with ONOS plugin. - - 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 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 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 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). - - 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/ - - -JOID Configuration for ONOS ---------------------------- - -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 mitaka openstack, ONOS SDN, HA mode - $ ./deploy.sh -o mitaka -s onos -t ha -f sfc -d trusty - -2、Bare Metal Deployment - - 2.1、Pre Requisite: - - 1. have a single node install with Ubuntu OS 14.04 LTS - - 2. Minimum four nodes are needed and they should be preconfigured and integrated with JOID, please refer to 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 mitaka openstack, ONOS SDN, HA mode in intel pod5 - $ ./deploy.sh -o mitaka -s onos -t ha -f sfc -d trusty -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 - ├── 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: Lucius(lukai1@huawei.com) - -Build date: |today| 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/installationprocedure/index.rst b/docs/release/configguide/index.rst index 3320215c..3320215c 100644 --- a/docs/installationprocedure/index.rst +++ b/docs/release/configguide/index.rst 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/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst index 4f0564ff..b615993a 100644 --- a/docs/userguide/feature.userguide.rst +++ b/docs/release/userguide/feature.userguide.rst @@ -37,8 +37,8 @@ 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. +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 ========================== @@ -81,8 +81,6 @@ ONOSFW Environment Setup 5. create basic networks and instances on openstack dashboard to verify L2/L3 function - 6. create basic scenarios to verify SFC functions. - Scenario Supported ------------------ @@ -117,18 +115,6 @@ 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 ----------------- @@ -138,7 +124,6 @@ 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_ diff --git a/docs/userguide/index.rst b/docs/release/userguide/index.rst index 5f7c67bb..5f7c67bb 100644 --- a/docs/userguide/index.rst +++ b/docs/release/userguide/index.rst diff --git a/docs/scenarios/os-onos-nofeature-sfc/scenario-description.rst b/docs/scenarios/os-onos-nofeature-sfc/scenario-description.rst index 1d415c01..d0dfee54 100644 --- a/docs/scenarios/os-onos-nofeature-sfc/scenario-description.rst +++ b/docs/scenarios/os-onos-nofeature-sfc/scenario-description.rst @@ -34,8 +34,9 @@ Version history Introduction ============ -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. +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. |