diff options
Diffstat (limited to 'docs/release/scenarios')
12 files changed, 24 insertions, 303 deletions
diff --git a/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst b/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst index 0aa72ba0..bc6d39b8 100644 --- a/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst +++ b/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst @@ -2,14 +2,14 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) <optionally add copywriters name> -This document provides scenario level details for Euphrates 1.0 of +This document provides scenario level details for Fraser 1.0 of deployment with no SDN controller and no extra features enabled. ============ Introduction ============ -This scenario is used primarily to validate and deploy a Newton OpenStack +This scenario is used primarily to validate and deploy a Pike OpenStack deployment without any NFV features or SDN controller enabled. Scenario components and composition @@ -38,6 +38,6 @@ None References ========== -For more information on the OPNFV Euphrates release, please visit -http://www.opnfv.org/euphrates +For more information on the OPNFV Fraser release, please visit +http://www.opnfv.org/fraser diff --git a/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst b/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst index 6889f7d9..8edd29bd 100644 --- a/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst +++ b/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst @@ -2,14 +2,14 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) <optionally add copywriters name> -This document provides scenario level details for Euphrates 1.0 of +This document provides scenario level details for Fraser 1.0 of deployment with no SDN controller and no extra features enabled. ============ Introduction ============ -This scenario is used primarily to validate and deploy a Newton OpenStack +This scenario is used primarily to validate and deploy a Pike OpenStack deployment without any NFV features or SDN controller enabled. Scenario components and composition @@ -35,6 +35,6 @@ None References ========== -For more information on the OPNFV Euphrates release, please visit -http://www.opnfv.org/euphrates +For more information on the OPNFV Fraser release, please visit +http://www.opnfv.org/fraser diff --git a/docs/release/scenarios/os-nosdn-ovs_dpdk-ha/index.rst b/docs/release/scenarios/os-nosdn-ovs_dpdk-ha/index.rst deleted file mode 100644 index febf16c1..00000000 --- a/docs/release/scenarios/os-nosdn-ovs_dpdk-ha/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _os-nosdn-ovs_dpdk-ha: - -.. 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 Accelerated OVS scenario: os-nosdn-ovs_dpdk-ha Overview and Description -********************************************************************************** - -.. toctree:: - :numbered: - :maxdepth: 4 - - os-nosdn-ovs_dpdk-ha.rst diff --git a/docs/release/scenarios/os-nosdn-ovs_dpdk-ha/os-nosdn-ovs_dpdk-ha.rst b/docs/release/scenarios/os-nosdn-ovs_dpdk-ha/os-nosdn-ovs_dpdk-ha.rst deleted file mode 100644 index 39083850..00000000 --- a/docs/release/scenarios/os-nosdn-ovs_dpdk-ha/os-nosdn-ovs_dpdk-ha.rst +++ /dev/null @@ -1,87 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -This document provides scenario level details for Euphrates 1.0 of -deployment with no SDN controller and DPDK enabled Open vSwitch. - -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. - -Scenario components and composition -=================================== - -This scenario enables high performance data plan acceleration by utilizing -DPDK enabled Open vSwitch (OVS). This allows packet switching to be isolated -to particular hardware resources (CPUs, huge page memory allocation) without -kernel interrupt or context switching on the data plane CPU. - -Tenant networking leverages Open vSwitch accelerated with a fast user space -data path such. OVS with the Linux kernel module data path is used for all -other connectivity, such as connectivity to the external network (i.e. br-ex) -is performed via non-accelerated OVS. - -Scenario Configuration -====================== - -Due to the performance optimization done by this scenario, it is recommended to -set some performance settings in the deploy settings in order to ensure maximum -performance. This is not necessary unless doing a baremetal deployment. Note, -this scenario requires taking the NIC mapped to the tenant network on the -compute node and binding it to DPDK. This means it will no longer be -accessible via the kernel. Ensure the NIC that is mapped to the Compute -Tenant network supports DPDK. - -Make a copy of the deploy settings file, os-nosdn-ovs_dpdk-ha.yaml. Under the -kernel options for Compute, edit as follows: - - hugepagesz: the size of hugepages as an integer, followed by unit M - (megabyte) or G (gigabyte). - - hugepages: number of hugepages of hugepagesz size. Huge page memory will be - used for OVS as well as each nova instance spawned. It is a good idea to - allocate the maximum number possible, while still leaving some non-huge page - memory available to other processes (nova-compute, etc). - - isolcpus: comma-separated list of CPUs to isolate from the kernel. Isolated - CPUs will be used for pinning OVS and libvirtd to. - -Under the performance->Compute->ovs section, edit as follows: - - socket_memory: the amount of huge page memory in MB to allocate to allocate - per socket to OVS as a comma-separated list. It is best to allocate the - memory to the socket which is closest to the PCI-Express bus of the NIC - to be used with OVS DPDK for tenant traffic. - - pmd_cores: comma-separated list of cores to pin to the poll-mode driver in - OVS. OVS DPDK will spawn TX/RX PMD threads to handle forwarding packets. - This setting identifies which cores to pin these threads to. For best - performance, dedicate at least 2 isolated cores on the same NUMA node where - socket_memory was assigned. - - dpdk_cores: comma-separated list of cores to pin OVS lcore threads to. - These threads do validation and control handling and it may not have any - impact on performance to include this setting. - -Under the performance->Compute section. Add a nova subsection and include -the following setting: - - libvirtpin: comma-separated list of CPUs to pin libvirt (nova) instances to. - For best results, set this to be one or more CPUs that are located on the - same NUMA node where OVS socket memory was dedicated. - -Now deploy with the modified deploy settings file. - -Limitations, Issues and Workarounds -=================================== - -* _APEX-415 br-phy dpdk interfaces are not brought up by os-net-config - -References -========== - -For more information on the OPNFV Euphrates release, please visit -http://www.opnfv.org/euphrates diff --git a/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/index.rst b/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/index.rst deleted file mode 100644 index 699f3915..00000000 --- a/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _os-nosdn-ovs_dpdk-noha: - -.. 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 Accelerated OVS scenario: os-nosdn-ovs_dpdk-noha Overview and Description -************************************************************************************ - -.. toctree:: - :numbered: - :maxdepth: 4 - - os-nosdn-ovs_dpdk-noha.rst diff --git a/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/os-nosdn-ovs_dpdk-noha.rst b/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/os-nosdn-ovs_dpdk-noha.rst deleted file mode 100644 index be0f37d3..00000000 --- a/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/os-nosdn-ovs_dpdk-noha.rst +++ /dev/null @@ -1,87 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -This document provides scenario level details for Euphrates 1.0 of -deployment with no SDN controller and DPDK enabled Open vSwitch. - -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. - -Scenario components and composition -=================================== - -This scenario enables high performance data plan acceleration by utilizing -DPDK enabled Open vSwitch (OVS). This allows packet switching to be isolated -to particular hardware resources (CPUs, huge page memory allocation) without -kernel interrupt or context switching on the data plane CPU. - -Tenant networking leverages Open vSwitch accelerated with a fast user space -data path such. OVS with the Linux kernel module data path is used for all -other connectivity, such as connectivity to the external network (i.e. br-ex) -is performed via non-accelerated OVS. - -Scenario Configuration -====================== - -Due to the performance optimization done by this scenario, it is recommended to -set some performance settings in the deploy settings in order to ensure maximum -performance. This is not necessary unless doing a baremetal deployment. Note, -this scenario requires taking the NIC mapped to the tenant network on the -compute node and binding it to DPDK. This means it will no longer be -accessible via the kernel. Ensure the NIC that is mapped to the Compute -Tenant network supports DPDK. - -Make a copy of the deploy settings file, os-nosdn-ovs_dpdk-noha.yaml. Under -the kernel options for Compute, edit as follows: - - hugepagesz: the size of hugepages as an integer, followed by unit M - (megabyte) or G (gigabyte). - - hugepages: number of hugepages of hugepagesz size. Huge page memory will be - used for OVS as well as each nova instance spawned. It is a good idea to - allocate the maximum number possible, while still leaving some non-huge page - memory available to other processes (nova-compute, etc). - - isolcpus: comma-separated list of CPUs to isolate from the kernel. Isolated - CPUs will be used for pinning OVS and libvirtd to. - -Under the performance->Compute->ovs section, edit as follows: - - socket_memory: the amount of huge page memory in MB to allocate to allocate - per socket to OVS as a comma-separated list. It is best to allocate the - memory to the socket which is closest to the PCI-Express bus of the NIC - to be used with OVS DPDK for tenant traffic. - - pmd_cores: comma-separated list of cores to pin to the poll-mode driver in - OVS. OVS DPDK will spawn TX/RX PMD threads to handle forwarding packets. - This setting identifies which cores to pin these threads to. For best - performance, dedicate at least 2 isolated cores on the same NUMA node where - socket_memory was assigned. - - dpdk_cores: comma-separated list of cores to pin OVS lcore threads to. - These threads do validation and control handling and it may not have any - impact on performance to include this setting. - -Under the performance->Compute section. Add a nova subsection and include -the following setting: - - libvirtpin: comma-separated list of CPUs to pin libvirt (nova) instances to. - For best results, set this to be one or more CPUs that are located on the - same NUMA node where OVS socket memory was dedicated. - -Now deploy with the modified deploy settings file. - -Limitations, Issues and Workarounds -=================================== - -* _APEX-415 br-phy dpdk interfaces are not brought up by os-net-config - -References -========== - -For more information on the OPNFV Euphrates release, please visit -http://www.opnfv.org/euphrates diff --git a/docs/release/scenarios/os-nosdn-performance-ha/os-nosdn-performance-ha.rst b/docs/release/scenarios/os-nosdn-performance-ha/os-nosdn-performance-ha.rst index 6437ce1b..beed894e 100644 --- a/docs/release/scenarios/os-nosdn-performance-ha/os-nosdn-performance-ha.rst +++ b/docs/release/scenarios/os-nosdn-performance-ha/os-nosdn-performance-ha.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) <optionally add copywriters name> -This document provides scenario level details for Euphrates 1.0 of +This document provides scenario level details for Fraser 1.0 of deployment with no SDN controller and performance options enabled. ============ @@ -10,7 +10,7 @@ Introduction ============ This scenario is used primarily to demonstrate the performance settings and -capabilities in Apex. This scenario will deploy a Newton OpenStack +capabilities in Apex. This scenario will deploy a Pike OpenStack deployment without any NFV features or SDN controller enabled. Scenario components and composition @@ -49,6 +49,6 @@ Limitations, Issues and Workarounds References ========== -For more information on the OPNFV Euphrates release, please visit -http://www.opnfv.org/euphrates +For more information on the OPNFV Fraser release, please visit +http://www.opnfv.org/fraser diff --git a/docs/release/scenarios/os-odl-csit-noha/index.rst b/docs/release/scenarios/os-odl-csit-noha/index.rst deleted file mode 100644 index 51cf903f..00000000 --- a/docs/release/scenarios/os-odl-csit-noha/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _os-odl-csit-noha: - -.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -========================================= -os-odl-csit-noha overview and description -========================================= - -.. toctree:: - :numbered: - :maxdepth: 4 - - os-odl-csit-noha.rst diff --git a/docs/release/scenarios/os-odl-csit-noha/os-odl-csit-noha.rst b/docs/release/scenarios/os-odl-csit-noha/os-odl-csit-noha.rst deleted file mode 100644 index b75c4355..00000000 --- a/docs/release/scenarios/os-odl-csit-noha/os-odl-csit-noha.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -This document provides scenario level details for Euphrates 1.0 of -deployment with the OpenDaylight SDN controller and only CSIT relevant -features enabled. - -============ -Introduction -============ - -This scenario is used primarily to validate and deploy a minimum Newton -OpenStack + OpenDaylight deployment with only required OpenStack services. - -Scenario components and composition -=================================== - -This scenario is composed of only required OpenStack services enabled by -default, including Nova, Neutron, Glance, and Keystone. OpenDaylight is also -enabled. File storage is used as the backend to Glance. - -The purpose of this file is to deploy a minimum OpenStack setup that will -still be able to exercise OpenDaylight. The use case for this scenario is -to be able to test OpenDaylight quickly in an environment with low -CPU/Memory requirements. - - -Scenario usage overview -======================= - -Simply deploy this scenario by using the os-odl-csit-noha.yaml deploy -settings file. - -Limitations, Issues and Workarounds -=================================== - -* `APEX-112 <https://jira.opnfv.org/browse/APEX-112>`_: - ODL routes local subnet traffic to GW -* `APEX-149 <https://jira.opnfv.org/browse/APEX-149>`_: - OpenFlow rules are populated very slowly -* `APEX-268 <https://jira.opnfv.org/browse/APEX-268>`_: - VMs with multiple floating IPs can only access via first NIC -* `APEX-384 <https://jira.opnfv.org/browse/APEX-384>`_: - Not including odl_version in deploy settings causes error -* `APEX-422 <https://jira.opnfv.org/browse/APEX-422>`_: - First nova instance DHCP request fails - -References -========== - -For more information on the OPNFV Euphrates release, please visit -http://www.opnfv.org/euphrates - diff --git a/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst b/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst index e5561a79..52530cdd 100644 --- a/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst +++ b/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst @@ -2,14 +2,14 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) <optionally add copywriters name> -This document provides scenario level details for Euphrates 1.0 of +This document provides scenario level details for Fraser 1.0 of deployment with the OpenDaylight SDN controller and no extra features enabled. ============ Introduction ============ -This scenario is used primarily to validate and deploy a Newton OpenStack +This scenario is used primarily to validate and deploy a Pike OpenStack deployment with OpenDaylight, and without any NFV features enabled. Scenario components and composition @@ -44,14 +44,12 @@ Limitations, Issues and Workarounds OpenFlow rules are populated very slowly * `APEX-268 <https://jira.opnfv.org/browse/APEX-268>`_: VMs with multiple floating IPs can only access via first NIC -* `APEX-384 <https://jira.opnfv.org/browse/APEX-384>`_: - Not including odl_version in deploy settings causes error * `APEX-422 <https://jira.opnfv.org/browse/APEX-422>`_: First nova instance DHCP request fails References ========== -For more information on the OPNFV Euphrates release, please visit -http://www.opnfv.org/euphrates +For more information on the OPNFV Fraser release, please visit +http://www.opnfv.org/fraser diff --git a/docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst b/docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst index f04e7c02..932ccc85 100644 --- a/docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst +++ b/docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst @@ -2,14 +2,14 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) <optionally add copywriters name> -This document provides scenario level details for Euphrates 1.0 of +This document provides scenario level details for Fraser 1.0 of deployment with the OpenDaylight SDN controller and no extra features enabled. ============ Introduction ============ -This scenario is used primarily to validate and deploy a Newton OpenStack +This scenario is used primarily to validate and deploy a Pike OpenStack deployment with OpenDaylight, and without any NFV features enabled. Scenario components and composition @@ -38,14 +38,12 @@ Limitations, Issues and Workarounds OpenFlow rules are populated very slowly * `APEX-268 <https://jira.opnfv.org/browse/APEX-268>`_: VMs with multiple floating IPs can only access via first NIC -* `APEX-384 <https://jira.opnfv.org/browse/APEX-384>`_: - Not including odl_version in deploy settings causes error * `APEX-422 <https://jira.opnfv.org/browse/APEX-422>`_: First nova instance DHCP request fails References ========== -For more information on the OPNFV Euphrates release, please visit -http://www.opnfv.org/euphrates +For more information on the OPNFV Fraser release, please visit +http://www.opnfv.org/fraser diff --git a/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst b/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst index a838e4b1..1b2da194 100644 --- a/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst +++ b/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst @@ -2,14 +2,14 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) <optionally add copywriters name> -This document provides scenario level details for Euphrates 1.0 of +This document provides scenario level details for Fraser 1.0 of deployment with the OVN SDN controller and no extra features enabled. ============ Introduction ============ -This scenario is used primarily to validate and deploy a Newton OpenStack +This scenario is used primarily to validate and deploy a Pike OpenStack deployment with the OVN SDN controller, and without any NFV features enabled. Scenario components and composition @@ -35,6 +35,6 @@ Limitations, Issues and Workarounds References ========== -For more information on the OPNFV Euphrates release, please visit -http://www.opnfv.org/euphrates +For more information on the OPNFV Fraser release, please visit +http://www.opnfv.org/fraser |