From 925f84b6875ba8543f97eaca8664c4ebb9a6bf81 Mon Sep 17 00:00:00 2001 From: Billy O'Mahony Date: Mon, 27 Feb 2017 10:44:25 +0000 Subject: Migrate docs to the new Danube dir structure. Change-Id: If749fa744c29b8a6895d0e420333ce6b6c28ea72 Signed-off-by: Billy O'Mahony --- docs/configguide/featureconfig.rst | 37 --- docs/configguide/index.rst | 14 -- docs/design/index.rst | 13 -- docs/design/specs/High-Priority-Traffic-Path.rst | 257 --------------------- docs/development/design/index.rst | 13 ++ .../design/specs/High-Priority-Traffic-Path.rst | 257 +++++++++++++++++++++ docs/release-notes/index.rst | 11 - docs/release-notes/release-notes.rst | 215 ----------------- docs/release/configguide/featureconfig.rst | 37 +++ docs/release/configguide/index.rst | 14 ++ docs/release/installation | 0 docs/release/release-notes/index.rst | 11 + docs/release/release-notes/release-notes.rst | 215 +++++++++++++++++ docs/release/scenarios/os-nosdn-ovs-noha/index.rst | 18 ++ .../scenarios/os-nosdn-ovs-noha/ovs4nfv.png | Bin 0 -> 49053 bytes .../os-nosdn-ovs-noha/scenario.description.rst | 105 +++++++++ docs/release/scenarios/os-nosdn-ovs/index.rst | 17 ++ .../os-nosdn-ovs/scenario.description.rst | 48 ++++ docs/release/userguide/feature.userguide.rst | 17 ++ docs/release/userguide/index.rst | 24 ++ docs/scenarios/os-nosdn-ovs-noha/index.rst | 18 -- docs/scenarios/os-nosdn-ovs-noha/ovs4nfv.png | Bin 49053 -> 0 bytes .../os-nosdn-ovs-noha/scenario.description.rst | 105 --------- docs/scenarios/os-nosdn-ovs/index.rst | 17 -- .../os-nosdn-ovs/scenario.description.rst | 48 ---- docs/userguide/feature.userguide.rst | 17 -- docs/userguide/index.rst | 24 -- 27 files changed, 776 insertions(+), 776 deletions(-) delete mode 100755 docs/configguide/featureconfig.rst delete mode 100644 docs/configguide/index.rst delete mode 100644 docs/design/index.rst delete mode 100644 docs/design/specs/High-Priority-Traffic-Path.rst create mode 100644 docs/development/design/index.rst create mode 100644 docs/development/design/specs/High-Priority-Traffic-Path.rst delete mode 100644 docs/release-notes/index.rst delete mode 100644 docs/release-notes/release-notes.rst create mode 100755 docs/release/configguide/featureconfig.rst create mode 100644 docs/release/configguide/index.rst create mode 100644 docs/release/installation create mode 100644 docs/release/release-notes/index.rst create mode 100644 docs/release/release-notes/release-notes.rst create mode 100644 docs/release/scenarios/os-nosdn-ovs-noha/index.rst create mode 100644 docs/release/scenarios/os-nosdn-ovs-noha/ovs4nfv.png create mode 100644 docs/release/scenarios/os-nosdn-ovs-noha/scenario.description.rst create mode 100644 docs/release/scenarios/os-nosdn-ovs/index.rst create mode 100644 docs/release/scenarios/os-nosdn-ovs/scenario.description.rst create mode 100644 docs/release/userguide/feature.userguide.rst create mode 100644 docs/release/userguide/index.rst delete mode 100644 docs/scenarios/os-nosdn-ovs-noha/index.rst delete mode 100644 docs/scenarios/os-nosdn-ovs-noha/ovs4nfv.png delete mode 100644 docs/scenarios/os-nosdn-ovs-noha/scenario.description.rst delete mode 100644 docs/scenarios/os-nosdn-ovs/index.rst delete mode 100644 docs/scenarios/os-nosdn-ovs/scenario.description.rst delete mode 100644 docs/userguide/feature.userguide.rst delete mode 100644 docs/userguide/index.rst diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst deleted file mode 100755 index 093f236..0000000 --- a/docs/configguide/featureconfig.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors - -Installing OVSNFV Fuel Plugin -============================= - -* On the Fuel UI, create a new environment. -* Assign nodes as normal. -* In Settings > Compute, ensure KVM is selected which is required to enable DPDK on nodes' interfaces. -* On the compute nodes' interface settings enable DPDK on the interface running the - private network. -* *Do not enable DPDK on the control nodes.* -* In Settings > Other - * Enable "Install Openvswitch with NSH/DPDK" - * Enable "Install DPDK" - * Disable "Install NSH" -* In Nodes, for each compute node: - * Reserve some memory for DPDK hugepages - typically 128-512MB per NUMA node. - * Reserve some memory for Nova hugepages - typically 70-90% of total memory. - * Pin DPDK cores - typically 2. -* Continue with environment configuration and deployment as normal. - - -Upgrading the plugin --------------------- - -From time to time new versions of the plugin may become available. - -The plugin cannot be upgraded if an active environment is using the plugin. - -In order to upgrade the plugin: - -* Copy the updated plugin file to the fuel-master. -* On the Fuel UI, reset the environment. -* On the Fuel CLI "fuel plugins --update " -* On the Fuel UI, re-deploy the environment. diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst deleted file mode 100644 index 70bb4a4..0000000 --- a/docs/configguide/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors - -============================== -OVSNFV Guides and Installation -============================== - -.. toctree:: - :numbered: - :maxdepth: 3 - - featureconfig.rst - diff --git a/docs/design/index.rst b/docs/design/index.rst deleted file mode 100644 index bc371e3..0000000 --- a/docs/design/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors - -============ -OVSNFV Specs -============ - -.. toctree:: - :numbered: - :maxdepth: 3 - - specs/High-Priority-Traffic-Path.rst diff --git a/docs/design/specs/High-Priority-Traffic-Path.rst b/docs/design/specs/High-Priority-Traffic-Path.rst deleted file mode 100644 index f330a9d..0000000 --- a/docs/design/specs/High-Priority-Traffic-Path.rst +++ /dev/null @@ -1,257 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -========================================== -High Priority Traffic Path -========================================== - -https://wiki.opnfv.org/display/ovsnfv/OVSFV+Requirement+-+High+Priority+Traffic+Path - -Problem description -=================== - -A network design may need to adequately accommodate multiple classes of traffic, each -class requiring different levels of service in critical network elements. - -As a concrete example, a network element managed by a service provider may be -handling voice and elastic data traffic. Voice traffic requires that the end-to-end -latency and jitter is bounded to some numerical limit (in msec) accuracy in order to ensure -sufficient quality-of-service (QoS) for the participants in the voice call. -Elastic data traffic does not impose the same demanding requirements on the network -(there will be essentially no requirement on jitter. For example, when downloading a -large file across the Internet, although the bandwidth requirements may be high there -is usually no requirement that the file arrives within a bounded time interval. - -Depending on the scheduling algorithms running on the network element, -frames belonging to the data traffic may get transmitted before frames -belonging to the voice traffic introducing unwanted latency or jitter. -Therefore, in order to ensure deterministic latency and jitter characteristics -end-to-end, each network element through which the voice traffic traverses -must ensure that voice traffic is handled deterministically. - -Hardware switches have typically been designed to ensure certain classes -of traffic can be scheduled ahead of other classes and are also -over-provisioned which further ensures deterministic behavior when -handling high priority traffic. However, software switches (which includes -virtual switches such as Open vSwitch) may require modification in order -to achieve this deterministic behavior. - -Use Cases ---------- - -1. Program classes of service - -The End User specifies a number of classes of service. Each class of service -will be represented by the value of a particular field in a frame. The class -of service determines the priority treatment which flows in the class will -receive, while maintaining a relative level of priority for other classes and -a default level of treatment for the lowest priority class of service. As -such, each class of service will be associated with a priority. The End User -will associate classes of service and priorities to ingress ports with the -expectation that frames that arrive on these ingress ports will get -scheduled following the specified priorities. - -Note: Priority treatment of the classes of service cannot cause any one of -the classes (even the default class) from being transferred at all. In other -words, a strict priority treatment would likely not be successful for serving -all classes eventually, and this is a key consideration. - -2. Forward high priority network traffic - -A remote network element sends traffic to Open vSwitch. The remote network -element, indicates the class of service to which this flow of traffic belongs -to by modifying a pre-determined but arbitrary field in the frame as specified -in Use Case 1. Some examples include the Differentiated Services Code Point -(DSCP) in an IP packet or the Priority Code Point (PCP) in an Ethernet frame. -The relative priority treatment that frames get processed by Open vSwitch can be guaranteed by the -values populated in these fields when the fields are different. If the fields -are the same, ordering is not deterministic. - -For example: Packet A is sent with a DSCP value of 0 and packet B is sent -with a value of 46; 0 has a lower priority than 46. Packet A arrives -before packet B. If Open vSwitch has been configured as such, Packet -B will be transmitted before Packet A. - -Proposed change -=============== - -TBD - -Alternatives ------------- - -TBD - -OVSDB schema impact -------------------- - -TBD - -User interface impact ---------------------- - -TBD - -Security impact ---------------- - -TBD - -Other end user impact ---------------------- - -TBD - -Performance Impact ------------------- - -TBD - -Other deployer impact ---------------------- - -TBD - -Developer impact ----------------- - -TBD - -Implementation -============== - -Assignee(s) ------------ - -Who is leading the writing of the code? Or is this a blueprint where you're -throwing it out there to see who picks it up? - -If more than one person is working on the implementation, please designate the -primary author and contact. - -Primary assignee: - - -Other contributors: - - -Work Items ----------- - -TBD - -Dependencies -============ - -TBD - -Testing -======= - -In order to test how effectively the virtual switch handles high priority traffic -types, the following scheme is suggested.:: - - +---------------------------+ Ingress Traffic Parameters - | | +-------------------------------------------+ - | | - | | Packet Size: The size of the Ethernet frames - | | - | | Tmax: RFC2544 Max. Throughput for traffic of - | PHY0 <-------+ "Packet Size" - | | - | | Total Offered Rate: The offered rate of both - | | traffic classes combined expressed as a % of - | | Tmax - | | - | | Ingress Rates are expressed as a percentage - | | of Total Offered Rate. - | | - | | Class A: - | OVS | Ethernet PCP = 0 (Background) - | (BR0) | Ingress Rate : rate_ingress_a(n) Mfps - | | - | | Class B: - | | Ethernet PCP = 7 (Highest) - | | Ingress Rate : rate_ingress_b(n) Mfps - | | - | | Egress Traffic Measurements - | | +-------------------------------------------+ - | | Class A: - | | Egress Throughput : rate_egress_a(n) Mfps - | | Egress Latency : max_lat_egrees_a(n) ms - | | Egress Jitter : max_jit_egress_a(n) ms - | PHY1 +-------> - | | Class B: - | | Egress Throughput : rate_egress_b(n) Mfps - | | Egress Latency : max_lat_egrees_b(n) ms - +---------------------------+ Egress Jitter : max_jit_egress_b(n) ms - - -Open vSwitch is configured to forward traffic between two ports agnostic to the -traffic type. For example, using the following command: - -ovs-ofctl add-flow br0 in_port=0,actions=output:1 - -The test will be carried out with the functionality to enable high-priority -traffic enabled and disabled in order to guage the change in performance for -both cases. - -Two classes of traffic will be generated by a traffic generator. In the example -above, the classes are differentiated using the Ethernet PCP field. However, -another means for differentiating traffic could be used, depending the -prioritization scheme that is developed. - -Tests should be performed for each combination of: - -* Packet Sizes in (64, 512) -* Total Offered Rate in (80, 120, 150) -* rate_ingress_b(n) / rate_ingress_a(n) in (0.1, 0.2, 0.5) - -For each set, the following metrics should be collected for each traffic -class over a specified time period: - -Egress Throughput (Mfps) -Maximum Egress Latency (ms) -Maximum Egress Jitter (ms) - -Documentation Impact -==================== - -TBD - -References -========== - -Please add any useful references here. You are not required to have any -reference. Moreover, this specification should still make sense when your -references are unavailable. Examples of what you could include are: - -* Links to mailing list or IRC discussions - -- http://lists.opnfv.org/pipermail/opnfv-tech-discuss/2015-December/007193.html -- http://ircbot.wl.linuxfoundation.org/meetings/opnfv-ovsnfv/2016/opnfv-ovsnfv.2016-03-07-13.01.html - -* Links to relevant research, if appropriate - -- https://wiki.opnfv.org/download/attachments/5046510/qos_mechanisms.pdf?version=1&modificationDate=1459187636000&api=v2 - -* Related specifications as appropriate - -* Anything else you feel it is worthwhile to refer to - - -History -======= - -Optional section intended to be used each time the spec -is updated to describe new design, API or any database schema -updated. Useful to let reader understand what's happened along the -time. - -.. list-table:: Revisions - :header-rows: 1 - - * - Release Name - - Description - * - Colorado - - Introduced diff --git a/docs/development/design/index.rst b/docs/development/design/index.rst new file mode 100644 index 0000000..bc371e3 --- /dev/null +++ b/docs/development/design/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors + +============ +OVSNFV Specs +============ + +.. toctree:: + :numbered: + :maxdepth: 3 + + specs/High-Priority-Traffic-Path.rst diff --git a/docs/development/design/specs/High-Priority-Traffic-Path.rst b/docs/development/design/specs/High-Priority-Traffic-Path.rst new file mode 100644 index 0000000..f330a9d --- /dev/null +++ b/docs/development/design/specs/High-Priority-Traffic-Path.rst @@ -0,0 +1,257 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +========================================== +High Priority Traffic Path +========================================== + +https://wiki.opnfv.org/display/ovsnfv/OVSFV+Requirement+-+High+Priority+Traffic+Path + +Problem description +=================== + +A network design may need to adequately accommodate multiple classes of traffic, each +class requiring different levels of service in critical network elements. + +As a concrete example, a network element managed by a service provider may be +handling voice and elastic data traffic. Voice traffic requires that the end-to-end +latency and jitter is bounded to some numerical limit (in msec) accuracy in order to ensure +sufficient quality-of-service (QoS) for the participants in the voice call. +Elastic data traffic does not impose the same demanding requirements on the network +(there will be essentially no requirement on jitter. For example, when downloading a +large file across the Internet, although the bandwidth requirements may be high there +is usually no requirement that the file arrives within a bounded time interval. + +Depending on the scheduling algorithms running on the network element, +frames belonging to the data traffic may get transmitted before frames +belonging to the voice traffic introducing unwanted latency or jitter. +Therefore, in order to ensure deterministic latency and jitter characteristics +end-to-end, each network element through which the voice traffic traverses +must ensure that voice traffic is handled deterministically. + +Hardware switches have typically been designed to ensure certain classes +of traffic can be scheduled ahead of other classes and are also +over-provisioned which further ensures deterministic behavior when +handling high priority traffic. However, software switches (which includes +virtual switches such as Open vSwitch) may require modification in order +to achieve this deterministic behavior. + +Use Cases +--------- + +1. Program classes of service + +The End User specifies a number of classes of service. Each class of service +will be represented by the value of a particular field in a frame. The class +of service determines the priority treatment which flows in the class will +receive, while maintaining a relative level of priority for other classes and +a default level of treatment for the lowest priority class of service. As +such, each class of service will be associated with a priority. The End User +will associate classes of service and priorities to ingress ports with the +expectation that frames that arrive on these ingress ports will get +scheduled following the specified priorities. + +Note: Priority treatment of the classes of service cannot cause any one of +the classes (even the default class) from being transferred at all. In other +words, a strict priority treatment would likely not be successful for serving +all classes eventually, and this is a key consideration. + +2. Forward high priority network traffic + +A remote network element sends traffic to Open vSwitch. The remote network +element, indicates the class of service to which this flow of traffic belongs +to by modifying a pre-determined but arbitrary field in the frame as specified +in Use Case 1. Some examples include the Differentiated Services Code Point +(DSCP) in an IP packet or the Priority Code Point (PCP) in an Ethernet frame. +The relative priority treatment that frames get processed by Open vSwitch can be guaranteed by the +values populated in these fields when the fields are different. If the fields +are the same, ordering is not deterministic. + +For example: Packet A is sent with a DSCP value of 0 and packet B is sent +with a value of 46; 0 has a lower priority than 46. Packet A arrives +before packet B. If Open vSwitch has been configured as such, Packet +B will be transmitted before Packet A. + +Proposed change +=============== + +TBD + +Alternatives +------------ + +TBD + +OVSDB schema impact +------------------- + +TBD + +User interface impact +--------------------- + +TBD + +Security impact +--------------- + +TBD + +Other end user impact +--------------------- + +TBD + +Performance Impact +------------------ + +TBD + +Other deployer impact +--------------------- + +TBD + +Developer impact +---------------- + +TBD + +Implementation +============== + +Assignee(s) +----------- + +Who is leading the writing of the code? Or is this a blueprint where you're +throwing it out there to see who picks it up? + +If more than one person is working on the implementation, please designate the +primary author and contact. + +Primary assignee: + + +Other contributors: + + +Work Items +---------- + +TBD + +Dependencies +============ + +TBD + +Testing +======= + +In order to test how effectively the virtual switch handles high priority traffic +types, the following scheme is suggested.:: + + +---------------------------+ Ingress Traffic Parameters + | | +-------------------------------------------+ + | | + | | Packet Size: The size of the Ethernet frames + | | + | | Tmax: RFC2544 Max. Throughput for traffic of + | PHY0 <-------+ "Packet Size" + | | + | | Total Offered Rate: The offered rate of both + | | traffic classes combined expressed as a % of + | | Tmax + | | + | | Ingress Rates are expressed as a percentage + | | of Total Offered Rate. + | | + | | Class A: + | OVS | Ethernet PCP = 0 (Background) + | (BR0) | Ingress Rate : rate_ingress_a(n) Mfps + | | + | | Class B: + | | Ethernet PCP = 7 (Highest) + | | Ingress Rate : rate_ingress_b(n) Mfps + | | + | | Egress Traffic Measurements + | | +-------------------------------------------+ + | | Class A: + | | Egress Throughput : rate_egress_a(n) Mfps + | | Egress Latency : max_lat_egrees_a(n) ms + | | Egress Jitter : max_jit_egress_a(n) ms + | PHY1 +-------> + | | Class B: + | | Egress Throughput : rate_egress_b(n) Mfps + | | Egress Latency : max_lat_egrees_b(n) ms + +---------------------------+ Egress Jitter : max_jit_egress_b(n) ms + + +Open vSwitch is configured to forward traffic between two ports agnostic to the +traffic type. For example, using the following command: + +ovs-ofctl add-flow br0 in_port=0,actions=output:1 + +The test will be carried out with the functionality to enable high-priority +traffic enabled and disabled in order to guage the change in performance for +both cases. + +Two classes of traffic will be generated by a traffic generator. In the example +above, the classes are differentiated using the Ethernet PCP field. However, +another means for differentiating traffic could be used, depending the +prioritization scheme that is developed. + +Tests should be performed for each combination of: + +* Packet Sizes in (64, 512) +* Total Offered Rate in (80, 120, 150) +* rate_ingress_b(n) / rate_ingress_a(n) in (0.1, 0.2, 0.5) + +For each set, the following metrics should be collected for each traffic +class over a specified time period: + +Egress Throughput (Mfps) +Maximum Egress Latency (ms) +Maximum Egress Jitter (ms) + +Documentation Impact +==================== + +TBD + +References +========== + +Please add any useful references here. You are not required to have any +reference. Moreover, this specification should still make sense when your +references are unavailable. Examples of what you could include are: + +* Links to mailing list or IRC discussions + +- http://lists.opnfv.org/pipermail/opnfv-tech-discuss/2015-December/007193.html +- http://ircbot.wl.linuxfoundation.org/meetings/opnfv-ovsnfv/2016/opnfv-ovsnfv.2016-03-07-13.01.html + +* Links to relevant research, if appropriate + +- https://wiki.opnfv.org/download/attachments/5046510/qos_mechanisms.pdf?version=1&modificationDate=1459187636000&api=v2 + +* Related specifications as appropriate + +* Anything else you feel it is worthwhile to refer to + + +History +======= + +Optional section intended to be used each time the spec +is updated to describe new design, API or any database schema +updated. Useful to let reader understand what's happened along the +time. + +.. list-table:: Revisions + :header-rows: 1 + + * - Release Name + - Description + * - Colorado + - Introduced diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst deleted file mode 100644 index 664306d..0000000 --- a/docs/release-notes/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -************************ -OPNFV OPNFV Release Notes -************************ - -Contents: - -.. toctree:: - :numbered: - :maxdepth: 4 - - release-notes.rst diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst deleted file mode 100644 index 683ce06..0000000 --- a/docs/release-notes/release-notes.rst +++ /dev/null @@ -1,215 +0,0 @@ -============================================================= -OPNFV Release Notes for the Colorado release of OVS for OPNFV -============================================================= - - -.. contents:: Table of Contents - :backlinks: none - - -Abstract -======== - -This document provides the release notes for Colorado release of -OVS for OPNFV. - -Version history -=============== - - -+-------------+-----------+------------------+----------------------+ -| **Date** | **Ver.** | **Authors** | **Comment** | -| | | | | -+-------------+-----------+------------------+----------------------+ - -Summary -======= - -The Colorado release of OVSNFV will provide RPMs for DPDK and OVS with DPDK. -Also for the Colorado release an RPM of an interim release of OVS and the -OVS kernel module with NSH patches. - -- Documentation is built by Jenkins -- .rpm packages are built by Jenkins - -Release Data -============ - -+--------------------------------------+--------------------------------------+ -| **Project** | ovsnfv | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/tag** | ovsnfv/colorado.1.0 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | colorado.1.0 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | 2016-09-14 | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Colorado release | -| | | -+--------------------------------------+--------------------------------------+ - -Version change --------------- - -Module version changes -~~~~~~~~~~~~~~~~~~~~~~ -This is the first tracked version of OVSNFV for the Colorado release. - -- Open vSwitch 2.5.90 - -- DPDK 16.04 - -Unsupported Experimental OVS with NSH -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- **Experimental** Open vSwitch 2.5.90 with NSH -- **Experimental** Open vSwitch 2.5.90 with NSH Kernel Module -- OVS commit7d433ae57ebb90cd68e8fa948a096f619ac4e2d8 - -For more information see: - -- https://github.com/yyang13/ovs_nsh_patches/blob/master/README.md - -Document version changes -~~~~~~~~~~~~~~~~~~~~~~~~ - -This is the first tracked version of Colorado release of OVSNFV -The following documentation is provided with this release: - -- OVSNFV Build instructions of the RPMs for the Colorado release - ver. 1.0.0 - -Feature additions -~~~~~~~~~~~~~~~~~ - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: OVSNFV-1 | Setup OVS/DPDK RPM | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: OVSNFV-27 | A deployment with Apex using | -| | OVS/DPDK passes all relevant | -| | functest tests. | -+--------------------------------------+--------------------------------------+ -| JIRA: OVSNFV-29 | Apex consume ovsnfv generated RPM | -| | | -+--------------------------------------+--------------------------------------+ - -Bug corrections -~~~~~~~~~~~~~~~ - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -+--------------------------------------+--------------------------------------+ - -Deliverables ------------- - -Software deliverables -~~~~~~~~~~~~~~~~~~~~~ -build.sh - Builds the RPM artifacts - -Artifacts produced by OVSNFV -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Artifacts consist of RPMs. Artifacts for this release conist of RPMs. -The RPM file names are all prefixed -with ovs4opnfv-e8acab14- -RPMs are uploaded into the OPNFV artifactory in the opnfv artifactory in the -ovsnfv/colorado directory. - -- DPDK 16.04 - - - ovs4opnfv-e8acab14-dpdk-16.04.0-1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-dpdk-debuginfo-16.04.0-1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-dpdk-devel-16.04.0-1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-dpdk-examples-16.04.0-1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-dpdk-tools-16.04.0-1.el7.centos.x86_64.rpm - -- OVS with DPDK - - - ovs4opnfv-e8acab14-openvswitch-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-openvswitch-debuginfo-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-openvswitch-devel-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-openvswitch-ovn-central-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-openvswitch-ovn-common-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-openvswitch-ovn-docker-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-openvswitch-ovn-host-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-openvswitch-ovn-vtep-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm - -EXPERIMENTAL artifacts produced by OVS for NFV -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-debuginfo-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-devel-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-kmod-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-central-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-common-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-docker-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-host-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm - - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-vtep-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm - - -Documentation deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~ -- RPM build instructions for the Colorado release version 1.0.0 -- OVSNFV Release Notes for the Colorado release version 1.0.0 -- Configuration Guide for OVSNFV -- Supported Scenario Description and Documentation - -Known Limitations, Issues and Workarounds -========================================= - -Known issues ------------- - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -+--------------------------------------+--------------------------------------+ - -Workarounds ------------ -**-** - - -Test Result -=========== - -The Colorado release of OVS/DPDK RPM deployed with the Apex deployment -toolchain has undergone QA test runs with the following results: - -+--------------------------------------+--------------------------------------+ -| **TEST-SUITE** | **Results:** | -| | | -+--------------------------------------+--------------------------------------+ -| **-** | **-** | -+--------------------------------------+--------------------------------------+ - - -References -========== - -For more information on the OPNFV Colorado release, please see: - -http://wiki.opnfv.org/releases/Colorado - -:Author: Thomas F Herbert (therbert@redhat.com) -:Version: 1.0.0 diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst new file mode 100755 index 0000000..093f236 --- /dev/null +++ b/docs/release/configguide/featureconfig.rst @@ -0,0 +1,37 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors + +Installing OVSNFV Fuel Plugin +============================= + +* On the Fuel UI, create a new environment. +* Assign nodes as normal. +* In Settings > Compute, ensure KVM is selected which is required to enable DPDK on nodes' interfaces. +* On the compute nodes' interface settings enable DPDK on the interface running the + private network. +* *Do not enable DPDK on the control nodes.* +* In Settings > Other + * Enable "Install Openvswitch with NSH/DPDK" + * Enable "Install DPDK" + * Disable "Install NSH" +* In Nodes, for each compute node: + * Reserve some memory for DPDK hugepages - typically 128-512MB per NUMA node. + * Reserve some memory for Nova hugepages - typically 70-90% of total memory. + * Pin DPDK cores - typically 2. +* Continue with environment configuration and deployment as normal. + + +Upgrading the plugin +-------------------- + +From time to time new versions of the plugin may become available. + +The plugin cannot be upgraded if an active environment is using the plugin. + +In order to upgrade the plugin: + +* Copy the updated plugin file to the fuel-master. +* On the Fuel UI, reset the environment. +* On the Fuel CLI "fuel plugins --update " +* On the Fuel UI, re-deploy the environment. diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst new file mode 100644 index 0000000..70bb4a4 --- /dev/null +++ b/docs/release/configguide/index.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors + +============================== +OVSNFV Guides and Installation +============================== + +.. toctree:: + :numbered: + :maxdepth: 3 + + featureconfig.rst + diff --git a/docs/release/installation b/docs/release/installation new file mode 100644 index 0000000..e69de29 diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 0000000..664306d --- /dev/null +++ b/docs/release/release-notes/index.rst @@ -0,0 +1,11 @@ +************************ +OPNFV OPNFV Release Notes +************************ + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 4 + + release-notes.rst diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst new file mode 100644 index 0000000..683ce06 --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,215 @@ +============================================================= +OPNFV Release Notes for the Colorado release of OVS for OPNFV +============================================================= + + +.. contents:: Table of Contents + :backlinks: none + + +Abstract +======== + +This document provides the release notes for Colorado release of +OVS for OPNFV. + +Version history +=============== + + ++-------------+-----------+------------------+----------------------+ +| **Date** | **Ver.** | **Authors** | **Comment** | +| | | | | ++-------------+-----------+------------------+----------------------+ + +Summary +======= + +The Colorado release of OVSNFV will provide RPMs for DPDK and OVS with DPDK. +Also for the Colorado release an RPM of an interim release of OVS and the +OVS kernel module with NSH patches. + +- Documentation is built by Jenkins +- .rpm packages are built by Jenkins + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | ovsnfv | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | ovsnfv/colorado.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | colorado.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | 2016-09-14 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | OPNFV Colorado release | +| | | ++--------------------------------------+--------------------------------------+ + +Version change +-------------- + +Module version changes +~~~~~~~~~~~~~~~~~~~~~~ +This is the first tracked version of OVSNFV for the Colorado release. + +- Open vSwitch 2.5.90 + +- DPDK 16.04 + +Unsupported Experimental OVS with NSH +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- **Experimental** Open vSwitch 2.5.90 with NSH +- **Experimental** Open vSwitch 2.5.90 with NSH Kernel Module +- OVS commit7d433ae57ebb90cd68e8fa948a096f619ac4e2d8 + +For more information see: + +- https://github.com/yyang13/ovs_nsh_patches/blob/master/README.md + +Document version changes +~~~~~~~~~~~~~~~~~~~~~~~~ + +This is the first tracked version of Colorado release of OVSNFV +The following documentation is provided with this release: + +- OVSNFV Build instructions of the RPMs for the Colorado release + ver. 1.0.0 + +Feature additions +~~~~~~~~~~~~~~~~~ + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: OVSNFV-1 | Setup OVS/DPDK RPM | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: OVSNFV-27 | A deployment with Apex using | +| | OVS/DPDK passes all relevant | +| | functest tests. | ++--------------------------------------+--------------------------------------+ +| JIRA: OVSNFV-29 | Apex consume ovsnfv generated RPM | +| | | ++--------------------------------------+--------------------------------------+ + +Bug corrections +~~~~~~~~~~~~~~~ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | ++--------------------------------------+--------------------------------------+ + +Deliverables +------------ + +Software deliverables +~~~~~~~~~~~~~~~~~~~~~ +build.sh - Builds the RPM artifacts + +Artifacts produced by OVSNFV +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Artifacts consist of RPMs. Artifacts for this release conist of RPMs. +The RPM file names are all prefixed +with ovs4opnfv-e8acab14- +RPMs are uploaded into the OPNFV artifactory in the opnfv artifactory in the +ovsnfv/colorado directory. + +- DPDK 16.04 + + - ovs4opnfv-e8acab14-dpdk-16.04.0-1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-dpdk-debuginfo-16.04.0-1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-dpdk-devel-16.04.0-1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-dpdk-examples-16.04.0-1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-dpdk-tools-16.04.0-1.el7.centos.x86_64.rpm + +- OVS with DPDK + + - ovs4opnfv-e8acab14-openvswitch-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-openvswitch-debuginfo-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-openvswitch-devel-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-openvswitch-ovn-central-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-openvswitch-ovn-common-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-openvswitch-ovn-docker-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-openvswitch-ovn-host-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-openvswitch-ovn-vtep-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm + +EXPERIMENTAL artifacts produced by OVS for NFV +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-debuginfo-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-devel-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-kmod-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-central-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-common-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-docker-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-host-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm + - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-vtep-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm + + +Documentation deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~ +- RPM build instructions for the Colorado release version 1.0.0 +- OVSNFV Release Notes for the Colorado release version 1.0.0 +- Configuration Guide for OVSNFV +- Supported Scenario Description and Documentation + +Known Limitations, Issues and Workarounds +========================================= + +Known issues +------------ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | ++--------------------------------------+--------------------------------------+ + +Workarounds +----------- +**-** + + +Test Result +=========== + +The Colorado release of OVS/DPDK RPM deployed with the Apex deployment +toolchain has undergone QA test runs with the following results: + ++--------------------------------------+--------------------------------------+ +| **TEST-SUITE** | **Results:** | +| | | ++--------------------------------------+--------------------------------------+ +| **-** | **-** | ++--------------------------------------+--------------------------------------+ + + +References +========== + +For more information on the OPNFV Colorado release, please see: + +http://wiki.opnfv.org/releases/Colorado + +:Author: Thomas F Herbert (therbert@redhat.com) +:Version: 1.0.0 diff --git a/docs/release/scenarios/os-nosdn-ovs-noha/index.rst b/docs/release/scenarios/os-nosdn-ovs-noha/index.rst new file mode 100644 index 0000000..27723c8 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-ovs-noha/index.rst @@ -0,0 +1,18 @@ +.. OPNFV - Open Platform for Network Function Virtualization +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +******************************************************************************* +User Space Accelarated OVS scenario: os-nosdn-ovs-noha Overview and Description +******************************************************************************* + +Scenario: "OpenStack - ovs-nfv" (apex-os-nosdn-ovs-noha) +is a scenario developed as part of the ovsnfv +OPNFV project. + +.. toctree:: + :numbered: + :maxdepth: 2 + + scenario.description.rst diff --git a/docs/release/scenarios/os-nosdn-ovs-noha/ovs4nfv.png b/docs/release/scenarios/os-nosdn-ovs-noha/ovs4nfv.png new file mode 100644 index 0000000..ea9d543 Binary files /dev/null and b/docs/release/scenarios/os-nosdn-ovs-noha/ovs4nfv.png differ diff --git a/docs/release/scenarios/os-nosdn-ovs-noha/scenario.description.rst b/docs/release/scenarios/os-nosdn-ovs-noha/scenario.description.rst new file mode 100644 index 0000000..3027a7e --- /dev/null +++ b/docs/release/scenarios/os-nosdn-ovs-noha/scenario.description.rst @@ -0,0 +1,105 @@ +.. OPNFV - Open Platform for Network Function Virtualization +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. +.. http://creativecommons.org/licenses/by/4.0 + +Scenario: "OpenStack - ovs-nfv" +============================= + +Scenario: apex-os-nosdn-ovs-noha + +"apex-os-ovs-noha" is a scenario developed as part of the OVS for NFV +OPNFV project. The main components of the "apex-os-nosdn-ovs-noha" scenario +are: + + - APEX (TripleO) installer (please also see APEX installer documentation) + - Openstack (in non-HA configuration) + - OVS/DPDK Open vSwitch with DPDK data plane virtual forwarder for tenant networking + +Introduction +============ + +NFV and virtualized high performance applications, such as video processing, +require Open vSwitch to be accelerated with a fast data plane solution that provides both +carrier grade forwarding performance, scalability and open extensibility. + +A key component of any NFV solution is the virtual forwarder, which should consist of +soft switch that includes an accelerated data plane component. For this, any virtual +switch should make use of +hardware accelerators and optimized cache operation to be run in user space. + +The "Openstack - Open vSwitch/DPDK" scenario provides +use-cases for deployment of NFV nodes instantiated by +an Openstack orchestration system on OVS/DPDK enabled compute nodes. + +A deployment of the "apex-os-nosdn-ovs-noha" scenario consists of 3 or more +servers: + + * 1 Jumphost hosting the APEX installer - running the Undercloud + * 1 Controlhost, which runs the Overcloud and Openstack services + * 1 or more Computehosts + +.. image:: ovs4nfv.png + +Tenant networking leverages Open vSwitch accelerated with a fast user space data path such +as DPDK. +Open VSwitch (OVS) with the Linux kernel module data path is used for all other +connectivity, such as connectivity to public networking "the +Internet" (i.e. br-ext) is performed via non-accelerated OVS. + +Features of the scenario +------------------------ + +Main features of the "apex-os-ovs-nosdn-noha" scenario: + + * Automated installation using the APEX installer + * Accelerated tenant networking using OVS/DPDK as the forwarder + +Networking in this scenario using OVS with accelerated User space IO. +--------------------------------------------------------------------- + +The apex-os-nosdn-ovs-noha scenario combines components from three open +source projects: OpenStack, Open vSwitch and DPDK. To make accelerated networking +available for this scenario Open vSwitch is bound via its netdev interface +with DPDK user space accelerated capability. + +Scenario Configuration +====================== + +To enable the "apex-os-nosdn-ovs-noha" scenario check the appropriate settings +in the APEX configuration files. Those are typically found in /etc/opnfv-apex. + +File "deploy_settings.yaml" choose false for sdn controller:: + + global_params: + ha_enabled: false + + deploy_options: + sdn_controller: false + sdn_l3: false + tacker: false + congress: false + sfc: false + vpn: false + +Validated deployment environments +================================= + +The "os-odl_l2-ovs-noha" scenario has been deployed and tested +on the following sets of hardware: + * TBD + + +Limitations, Issues and Workarounds +=================================== + +There are no known issues. + +References +========== + + + * OVS for NFV OPNFV project wiki: https://wiki.opnfv.org/display/ovsnfv + * Open vSwitch: http://openvswitch.org/ + * DPDK: http://dpdk.org + * OPNFV Colorado release - more information: http://www.opnfv.org/colorado diff --git a/docs/release/scenarios/os-nosdn-ovs/index.rst b/docs/release/scenarios/os-nosdn-ovs/index.rst new file mode 100644 index 0000000..145d0ae --- /dev/null +++ b/docs/release/scenarios/os-nosdn-ovs/index.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Intel Corporation + +.. This document will be used to provide a description of the scenario for an end user. +.. You should explain the purpose of the scenario, the types of capabilities provided and +.. the unique components that make up the scenario including how they are used. + +===================================== +os-nosdn-ovs overview and description +===================================== + +.. toctree:: + :maxdepth: 3 + + ./scenario.description.rst + diff --git a/docs/release/scenarios/os-nosdn-ovs/scenario.description.rst b/docs/release/scenarios/os-nosdn-ovs/scenario.description.rst new file mode 100644 index 0000000..04d88a1 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-ovs/scenario.description.rst @@ -0,0 +1,48 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Intel Corporation + +Introduction +============ +For Fuel this scenario installs the latest DPDK-enabled Open vSwitch component, +version - 2.5.90 based on DPDK 16.07. + +For Apex this scenario installs the latest DPDK-enabled Open vSwitch component, +version - 2.5.90 based on DPDK 16.04. + +Scenario components and composition +=================================== +This scenario is currently able to be installed using the Fuel and Apex installers. +For details on how to install the ovsnfv scenarion using these installer tools +please refer to the installation instructions at: + * Fuel installation instruction: http://artifacts.opnfv.org/fuel/colorado/2.0/docs/installation-instruction/index.html + * Apex installation instruction: http://artifacts.opnfv.org/apex/colorado/2.0/docs/installation-instruction/index.html + +.. Above links need to be updated with the eventual release URL's. This will need to be done closer to the +.. release date once the project and docs team have a solution ready and the final version of the installation +.. documents are done. + +Scenario usage overview +======================= +After installation use of the scenario requires no further action by the user. +Traffic on the private network will automatically be processed by the upgraded +DPDK datapath. + +Limitations, Issues and Workarounds +=================================== +The same limitations that apply to using Fuel DPDK-enabled interfaces also apply +when using this scenario. Including: + +* Fuel9 OVS-DPDK support works only for VLAN segmentation. +* Only interfaces running the private network (and no other network) can be + supported so each node needs a separate interface dedicated to the private network. +* The nodes with dpdk enabled interfaces will need to have hugepages + configured and some cores reserved for dpdk. + + +References +========== + +For more information on the OPNFV Colorado release, please visit +http://www.opnfv.org/colorado + diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst new file mode 100644 index 0000000..5741f2d --- /dev/null +++ b/docs/release/userguide/feature.userguide.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Intel Corporation + +OVSNFV description +===================== +Open vSwtich (OVS) is a software switch commonly used in OPNFV deployments. +OVSNFV project supplies a Fuel Plugin to upgrade DPDK enabled Open vSwitch on +an OPNFV to 2.5.90. + + +OVSNFV capabilities and usage +================================ +After installation use of the scenario requires no further action by the user. +Traffic on the private network will automatically be processed by the upgraded +DPDK datapath. + diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst new file mode 100644 index 0000000..1566bf6 --- /dev/null +++ b/docs/release/userguide/index.rst @@ -0,0 +1,24 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Intel Corporation + +================= +OVSNFV user guide +================= + +.. The feature user guide should provide an OPNFV user with enough information to +.. use the features provided by the feature project in the supported scenarios. +.. This guide should walk a user through the usage of the features once a scenario +.. has been deployed and is active according to the installation guide provided +.. by the installer project. + + +.. toctree:: + :maxdepth: 3 + + ./feature.userguide.rst + +.. The feature.userguide.rst file should contain the text for this document +.. additional documents can be added to this directory and added in the right order +.. to this file as a list below. + diff --git a/docs/scenarios/os-nosdn-ovs-noha/index.rst b/docs/scenarios/os-nosdn-ovs-noha/index.rst deleted file mode 100644 index 27723c8..0000000 --- a/docs/scenarios/os-nosdn-ovs-noha/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. OPNFV - Open Platform for Network Function Virtualization -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - - -******************************************************************************* -User Space Accelarated OVS scenario: os-nosdn-ovs-noha Overview and Description -******************************************************************************* - -Scenario: "OpenStack - ovs-nfv" (apex-os-nosdn-ovs-noha) -is a scenario developed as part of the ovsnfv -OPNFV project. - -.. toctree:: - :numbered: - :maxdepth: 2 - - scenario.description.rst diff --git a/docs/scenarios/os-nosdn-ovs-noha/ovs4nfv.png b/docs/scenarios/os-nosdn-ovs-noha/ovs4nfv.png deleted file mode 100644 index ea9d543..0000000 Binary files a/docs/scenarios/os-nosdn-ovs-noha/ovs4nfv.png and /dev/null differ diff --git a/docs/scenarios/os-nosdn-ovs-noha/scenario.description.rst b/docs/scenarios/os-nosdn-ovs-noha/scenario.description.rst deleted file mode 100644 index 3027a7e..0000000 --- a/docs/scenarios/os-nosdn-ovs-noha/scenario.description.rst +++ /dev/null @@ -1,105 +0,0 @@ -.. OPNFV - Open Platform for Network Function Virtualization -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. -.. http://creativecommons.org/licenses/by/4.0 - -Scenario: "OpenStack - ovs-nfv" -============================= - -Scenario: apex-os-nosdn-ovs-noha - -"apex-os-ovs-noha" is a scenario developed as part of the OVS for NFV -OPNFV project. The main components of the "apex-os-nosdn-ovs-noha" scenario -are: - - - APEX (TripleO) installer (please also see APEX installer documentation) - - Openstack (in non-HA configuration) - - OVS/DPDK Open vSwitch with DPDK data plane virtual forwarder for tenant networking - -Introduction -============ - -NFV and virtualized high performance applications, such as video processing, -require Open vSwitch to be accelerated with a fast data plane solution that provides both -carrier grade forwarding performance, scalability and open extensibility. - -A key component of any NFV solution is the virtual forwarder, which should consist of -soft switch that includes an accelerated data plane component. For this, any virtual -switch should make use of -hardware accelerators and optimized cache operation to be run in user space. - -The "Openstack - Open vSwitch/DPDK" scenario provides -use-cases for deployment of NFV nodes instantiated by -an Openstack orchestration system on OVS/DPDK enabled compute nodes. - -A deployment of the "apex-os-nosdn-ovs-noha" scenario consists of 3 or more -servers: - - * 1 Jumphost hosting the APEX installer - running the Undercloud - * 1 Controlhost, which runs the Overcloud and Openstack services - * 1 or more Computehosts - -.. image:: ovs4nfv.png - -Tenant networking leverages Open vSwitch accelerated with a fast user space data path such -as DPDK. -Open VSwitch (OVS) with the Linux kernel module data path is used for all other -connectivity, such as connectivity to public networking "the -Internet" (i.e. br-ext) is performed via non-accelerated OVS. - -Features of the scenario ------------------------- - -Main features of the "apex-os-ovs-nosdn-noha" scenario: - - * Automated installation using the APEX installer - * Accelerated tenant networking using OVS/DPDK as the forwarder - -Networking in this scenario using OVS with accelerated User space IO. ---------------------------------------------------------------------- - -The apex-os-nosdn-ovs-noha scenario combines components from three open -source projects: OpenStack, Open vSwitch and DPDK. To make accelerated networking -available for this scenario Open vSwitch is bound via its netdev interface -with DPDK user space accelerated capability. - -Scenario Configuration -====================== - -To enable the "apex-os-nosdn-ovs-noha" scenario check the appropriate settings -in the APEX configuration files. Those are typically found in /etc/opnfv-apex. - -File "deploy_settings.yaml" choose false for sdn controller:: - - global_params: - ha_enabled: false - - deploy_options: - sdn_controller: false - sdn_l3: false - tacker: false - congress: false - sfc: false - vpn: false - -Validated deployment environments -================================= - -The "os-odl_l2-ovs-noha" scenario has been deployed and tested -on the following sets of hardware: - * TBD - - -Limitations, Issues and Workarounds -=================================== - -There are no known issues. - -References -========== - - - * OVS for NFV OPNFV project wiki: https://wiki.opnfv.org/display/ovsnfv - * Open vSwitch: http://openvswitch.org/ - * DPDK: http://dpdk.org - * OPNFV Colorado release - more information: http://www.opnfv.org/colorado diff --git a/docs/scenarios/os-nosdn-ovs/index.rst b/docs/scenarios/os-nosdn-ovs/index.rst deleted file mode 100644 index 145d0ae..0000000 --- a/docs/scenarios/os-nosdn-ovs/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Intel Corporation - -.. This document will be used to provide a description of the scenario for an end user. -.. You should explain the purpose of the scenario, the types of capabilities provided and -.. the unique components that make up the scenario including how they are used. - -===================================== -os-nosdn-ovs overview and description -===================================== - -.. toctree:: - :maxdepth: 3 - - ./scenario.description.rst - diff --git a/docs/scenarios/os-nosdn-ovs/scenario.description.rst b/docs/scenarios/os-nosdn-ovs/scenario.description.rst deleted file mode 100644 index 04d88a1..0000000 --- a/docs/scenarios/os-nosdn-ovs/scenario.description.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Intel Corporation - -Introduction -============ -For Fuel this scenario installs the latest DPDK-enabled Open vSwitch component, -version - 2.5.90 based on DPDK 16.07. - -For Apex this scenario installs the latest DPDK-enabled Open vSwitch component, -version - 2.5.90 based on DPDK 16.04. - -Scenario components and composition -=================================== -This scenario is currently able to be installed using the Fuel and Apex installers. -For details on how to install the ovsnfv scenarion using these installer tools -please refer to the installation instructions at: - * Fuel installation instruction: http://artifacts.opnfv.org/fuel/colorado/2.0/docs/installation-instruction/index.html - * Apex installation instruction: http://artifacts.opnfv.org/apex/colorado/2.0/docs/installation-instruction/index.html - -.. Above links need to be updated with the eventual release URL's. This will need to be done closer to the -.. release date once the project and docs team have a solution ready and the final version of the installation -.. documents are done. - -Scenario usage overview -======================= -After installation use of the scenario requires no further action by the user. -Traffic on the private network will automatically be processed by the upgraded -DPDK datapath. - -Limitations, Issues and Workarounds -=================================== -The same limitations that apply to using Fuel DPDK-enabled interfaces also apply -when using this scenario. Including: - -* Fuel9 OVS-DPDK support works only for VLAN segmentation. -* Only interfaces running the private network (and no other network) can be - supported so each node needs a separate interface dedicated to the private network. -* The nodes with dpdk enabled interfaces will need to have hugepages - configured and some cores reserved for dpdk. - - -References -========== - -For more information on the OPNFV Colorado release, please visit -http://www.opnfv.org/colorado - diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst deleted file mode 100644 index 5741f2d..0000000 --- a/docs/userguide/feature.userguide.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Intel Corporation - -OVSNFV description -===================== -Open vSwtich (OVS) is a software switch commonly used in OPNFV deployments. -OVSNFV project supplies a Fuel Plugin to upgrade DPDK enabled Open vSwitch on -an OPNFV to 2.5.90. - - -OVSNFV capabilities and usage -================================ -After installation use of the scenario requires no further action by the user. -Traffic on the private network will automatically be processed by the upgraded -DPDK datapath. - diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst deleted file mode 100644 index 1566bf6..0000000 --- a/docs/userguide/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Intel Corporation - -================= -OVSNFV user guide -================= - -.. The feature user guide should provide an OPNFV user with enough information to -.. use the features provided by the feature project in the supported scenarios. -.. This guide should walk a user through the usage of the features once a scenario -.. has been deployed and is active according to the installation guide provided -.. by the installer project. - - -.. toctree:: - :maxdepth: 3 - - ./feature.userguide.rst - -.. The feature.userguide.rst file should contain the text for this document -.. additional documents can be added to this directory and added in the right order -.. to this file as a list below. - -- cgit 1.2.3-korg