diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 4 | ||||
| -rw-r--r-- | docs/how-to-use-docs/index.rst | 3 | ||||
| -rw-r--r-- | docs/installationprocedure/feature.configuration.rst | 43 | ||||
| -rw-r--r-- | docs/release/onos-release.rst | 112 | ||||
| -rw-r--r-- | docs/scenarios/os-onos-nofeature-sfc/scenario-description.rst | 9 | ||||
| -rw-r--r-- | docs/userguide/feature.userguide.rst | 22 |
6 files changed, 79 insertions, 114 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst index afcf7581..1d1ca6d8 100644 --- a/docs/how-to-use-docs/documentation-example.rst +++ b/docs/how-to-use-docs/documentation-example.rst @@ -1,5 +1,5 @@ .. two dots create a comment. please leave this logo at the top of each of your rst files. -.. image:: ../etc/opnfv-logo.png +.. image:: ../etc/opnfv-logo.png :height: 40 :width: 200 :alt: OPNFV @@ -59,7 +59,7 @@ For verify jobs a link to the documentation will show up as a comment in gerrit * Merge jobs -Once you are happy with the look of your documentation you can submit the patchset the merge job will +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 diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst index 3593b2a0..956d80a8 100644 --- a/docs/how-to-use-docs/index.rst +++ b/docs/how-to-use-docs/index.rst @@ -26,4 +26,5 @@ Indices and tables Revision: _sha1_ -Build date: |today|
\ No newline at end of file +Build date: |today| + diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst index 129fd33b..42d4e064 100644 --- a/docs/installationprocedure/feature.configuration.rst +++ b/docs/installationprocedure/feature.configuration.rst @@ -81,13 +81,13 @@ Config Documentation for ONOS with Apex ├── 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. Virtual deployment 3.1 Install jumphost. @@ -108,10 +108,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 Requirements for install ONOS +1. Pyhsical Requirements for install ONOS 1.1 Ubuntu Server 14.04 LTS 64-bit (from ISO or self-installed). @@ -139,14 +139,18 @@ 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 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 + 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 @@ -170,8 +174,8 @@ Config Documentation for ONOS with Compass export OS_VERSION=trusty - export OPENSTACK_VERSION=mitaka - + 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 @@ -193,7 +197,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 600G disk at least for no-ha virtual deployment @@ -202,11 +206,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 │ ├── sfc-onos-ha_scenario.yaml # add ONOS sfc ha configuration @@ -216,21 +220,22 @@ 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 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. + 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.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.3 fpb --build fuel-plugin-onos 4.4 Move onos*.rpm in to master and fuel plugins –install onos*.rpm. @@ -250,7 +255,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/release/onos-release.rst b/docs/release/onos-release.rst index dd45dbdc..a1154cda 100644 --- a/docs/release/onos-release.rst +++ b/docs/release/onos-release.rst @@ -1,11 +1,3 @@ -========================================= -OPNFV Colorado release note for onosfw -========================================= - - contents:: Table of Contents - :backlinks: none - - Abstract ======== @@ -32,113 +24,83 @@ Version history | 2016-08-11 | 0.0.1 | Lucius | First draft | | | | (HUAWEI) | | +------------+----------+------------+------------------+ +| 2016-09-21 | 1.0.0 | Lucius | For Colorado 1.0 | +| | | (HUAWEI) | | ++------------+----------+------------+------------------+ -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. 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. - - -ONOSFW Test Scenarios -===================== - -+---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+ -| FuncTest Usecase \ Installers | Apex | Compass | Fuel | JOID | -+=======================================+===========================================+===========================================+===========================================+============================================================+ -| vPing For user metadata | Success | Success | Success | Success | -| | | | | -| -+---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------+ -| 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_SFC | Success | Success | Success | Success -| -| | | | | | -+---------------------------------------+-------------------------------------------+-------------------------------------------+-------------------------------------------+------------------------------------------------------------ +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. +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 Colorado 1.0, the supported installer and scenario combinations are: fuel-os-onos-nofeature-ha fuel-os-onos-sfc-ha - jois-os-onos-nofeature-ha + joid-os-onos-nofeature-ha joid-os-onos-sfc-ha compass-os-onos-nofeature-ha -For Colorado 2.0 the following installer/scenario combinations will be supported: + compass-os-onos-sfc-ha - apex-os-onos-nofeature-ha +For Colorado 2.0 the following installer/scenario combinations will be supported: - apex-on-onos-sfc-ha + apex-os-onos-nofeature-ha - compass-os-onos-sfc-ha + apex-on-onos-sfc-ha Limitations =========== -The GlodenEye release of ONOS does not support the following test cases: - - tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_reboot_server_hard - - tempest.scenario.test_network_basic_ops.TestNetworkBasicOps.test_network_basic_ops - - tempest.scenario.test_server_basic_ops.TestServerBasicOps.test_server_basic_ops + tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_reboot_server_hard - tempest.scenario.test_volume_boot_pattern.TestVolumeBootPattern.test_volume_boot_pattern + tempest.scenario.test_network_basic_ops.TestNetworkBasicOps.test_network_basic_ops - tempest.scenario.test_volume_boot_pattern.TestVolumeBootPatternV2.test_volume_boot_pattern + tempest.scenario.test_server_basic_ops.TestServerBasicOps.test_server_basic_ops + tempest.scenario.test_volume_boot_pattern.TestVolumeBootPattern.test_volume_boot_pattern -Upstream Projects -================= + tempest.scenario.test_volume_boot_pattern.TestVolumeBootPatternV2.test_volume_boot_pattern -ONOS Release -============ -ONOS wiki of onosfw : `onosfw proposal in ONOS`_. +Upstream Requirement _ONOS Release +================================== +_ONOS wiki of onosfw - _onosfw proposal in ONOS: https://wiki.onosproject.org/login.action?os_destination=%2Fdisplay%2FONOS%2FONOS%2BFramework%2B%28ONOSFW%29%2Bfor%2BOPNFV + https://wiki.onosproject.org/login.action?os_destination=%2Fdisplay%2FONOS%2FONOS%2BFramework%2B%28ONOSFW%29%2Bfor%2BOPNFV -ONOS Goldeneye code:`ONOS Goldeneye Code`_. +_ONOS Goldeneye code - _ONOS Goldeneye Code: https://github.com/opennetworkinglab/onos/tree/onos-1.6 + https://github.com/opennetworkinglab/onos/tree/onos-1.6 -ONOS Goldeneye Release Note `ONOS Goldeneye Release Note`_. +ONOS Goldeneye Release Note - _ONOS Goldeneye Release Note: https://wiki.onosproject.org/display/ONOS/Goldeneye+Release+Notes + https://wiki.onosproject.org/display/ONOS/Goldeneye+Release+Notes -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 -================= +Upstream Requirement _OpenStack Release +======================================= -OpenStack Mitaka wiki page `OpenStack Mitaka wiki`_. +_OpenStack Mitaka wiki page - _OpenStack Mitaka wiki : https://wiki.openstack.org/wiki/Main_Page + https://wiki.openstack.org/wiki/Main_Page -OpenStack Liberty api page `OpenStack Networking Api`_. +_OpenStack Liberty api page - _OpenStack Networking Api : http://developer.openstack.org/api-ref-networking-v2-ext.html + https://developer.rackspace.com/docs/cloud-networks/v2/api-reference/#api-reference 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 4e2e2724..b509cde3 100644 --- a/docs/scenarios/os-onos-nofeature-sfc/scenario-description.rst +++ b/docs/scenarios/os-onos-nofeature-sfc/scenario-description.rst @@ -31,8 +31,9 @@ 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. -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. +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 Test Scenarios @@ -63,8 +64,6 @@ Secenario 14 ONOS-HA : 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 @@ -73,8 +72,6 @@ Secenario 14 ONOS-HA : 2.2.3. VM hot migration is supported - - 2.3 Improvements 2.3.1 Add p2any vxlan config to ovs is OK diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst index 26943f2d..68c1a17e 100644 --- a/docs/userguide/feature.userguide.rst +++ b/docs/userguide/feature.userguide.rst @@ -32,9 +32,9 @@ 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. -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 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 User Guide Manaully ========================== @@ -91,11 +91,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: @@ -103,13 +103,13 @@ 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 @@ -124,7 +124,7 @@ Scenario Supported * Remove a node from the chain and verify with traffic * Get service chain status - + ONOSFW Demo Video ----------------- |