From 0312f3f6587efd8ebcea6e58d6cfd06ddd223853 Mon Sep 17 00:00:00 2001 From: Zhijiang Hu Date: Fri, 16 Mar 2018 10:28:51 +0800 Subject: Add scenarios docs Change-Id: Ice02ae39569fe2efb1fbd3544afa1e5dd47d5e1d Signed-off-by: Zhijiang Hu --- .../scenarios/os-nosdn-nofeature-ha/index.rst | 15 ++++++ .../os-nosdn-nofeature-ha.rst | 41 +++++++++++++++ .../scenarios/os-nosdn-ovs_dpdk-noha/index.rst | 16 ++++++ .../os-nosdn-ovs_dpdk-noha.rst | 58 ++++++++++++++++++++++ .../scenarios/os-odl-nofeature-ha/index.rst | 15 ++++++ .../os-odl-nofeature-ha/os-odl-nofeature-ha.rst | 41 +++++++++++++++ 6 files changed, 186 insertions(+) create mode 100644 docs/release/scenarios/os-nosdn-nofeature-ha/index.rst create mode 100644 docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst create mode 100644 docs/release/scenarios/os-nosdn-ovs_dpdk-noha/index.rst create mode 100644 docs/release/scenarios/os-nosdn-ovs_dpdk-noha/os-nosdn-ovs_dpdk-noha.rst create mode 100644 docs/release/scenarios/os-odl-nofeature-ha/index.rst create mode 100644 docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst diff --git a/docs/release/scenarios/os-nosdn-nofeature-ha/index.rst b/docs/release/scenarios/os-nosdn-nofeature-ha/index.rst new file mode 100644 index 00000000..1902f8d9 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-nofeature-ha/index.rst @@ -0,0 +1,15 @@ +.. _os-nosdn-nofeature-ha: + +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + +============================================== +os-nosdn-nofeature-ha overview and description +============================================== + +.. toctree:: + :numbered: + :maxdepth: 4 + + os-nosdn-nofeature-ha.rst 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 new file mode 100644 index 00000000..e315d367 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst @@ -0,0 +1,41 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +This document provides scenario level details for Fraser 1.0 of +deployment with no SDN controller and no extra features enabled by using +Daisy installer. + +============ +Introduction +============ + +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 +=================================== + +This scenario is composed of common OpenStack services enabled by default, +including Nova, Neutron, Glance, Cinder, Keystone, Horizon. Ceph is used as +the backend storage to Cinder, Glance and Nova on all deployed nodes. + +All services are in HA, meaning that there are multiple cloned instances of +each service, and they are balanced by HA Proxy using a Virtual IP Address +per service. VIP is elected by using keepalived. + +Scenario usage overview +======================= + +Simply deploy this scenario by using the '-s os-nosdn-nofeature-ha' +parameter among others when calling ./ci/deploy/deploy.sh. + +Limitations, Issues and Workarounds +=================================== + +None + +References +========== + +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-noha/index.rst b/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/index.rst new file mode 100644 index 00000000..699f3915 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/index.rst @@ -0,0 +1,16 @@ +.. _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 new file mode 100644 index 00000000..002e1181 --- /dev/null +++ b/docs/release/scenarios/os-nosdn-ovs_dpdk-noha/os-nosdn-ovs_dpdk-noha.rst @@ -0,0 +1,58 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +This document provides scenario level details for Fraser 1.0 of +deployment with no SDN controller and DPDK enabled Open vSwitch by using +Daisy installer. + +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. + +Both tenant tunnel and external physnet1 leverage Open vSwitch accelerated +with a fast user space data path, while other network planes are 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 and external network +on the compute node and binding them to DPDK. This means it will no longer be +accessible via the kernel. Ensure the NIC supports DPDK. + +40 huge pages of 1G size are allocaled on each compute and network node for DPDK +and VMs by default and currently this can not be re-configured by using +configure files. + +For each compute and network node, One CPU core of each NUMA is dedicatedly +allocated for DPDK by default and currently this can not be re-configured by using +configure files. + +Deploy this scenario by using the '-s os-nosdn-ovs_dpdk-noha' parameter among +others when calling ./ci/deploy/deploy.sh. + +References +========== + +For more information on the OPNFV Fraser release, please visit +http://www.opnfv.org/fraser diff --git a/docs/release/scenarios/os-odl-nofeature-ha/index.rst b/docs/release/scenarios/os-odl-nofeature-ha/index.rst new file mode 100644 index 00000000..4c6a443f --- /dev/null +++ b/docs/release/scenarios/os-odl-nofeature-ha/index.rst @@ -0,0 +1,15 @@ +.. _os-odl-nofeature-ha: + +.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + +============================================ +os-odl-nofeature-ha overview and description +============================================ + +.. toctree:: + :numbered: + :maxdepth: 4 + + os-odl-nofeature-ha.rst 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 new file mode 100644 index 00000000..32d53931 --- /dev/null +++ b/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst @@ -0,0 +1,41 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +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 Pike OpenStack +deployment with OpenDaylight, and without any NFV features enabled. + +Scenario components and composition +=================================== + +This scenario is composed of common OpenStack services enabled by default, +including Nova, Neutron, Glance, Cinder, Keystone, Horizon. Ceph is used as +the backend storage to Cinder, Glance and Nova on all deployed nodes. + +All services are in HA, meaning that there are multiple cloned instances of +each service, and they are balanced by HA Proxy using a Virtual IP Address +per service. VIP is elected by using keepalived. + +OpenDaylight is also enabled in HA, and forms a cluster. Neutron +communicates with a Virtual IP Address for OpenDaylight which is load +balanced across the OpenDaylight cluster. Every Open vSwitch node is +connected to every OpenDaylight for High Availability, thus it is the +OpenDaylight controllers responsbility to elect a master. + +Scenario usage overview +======================= + +Simply deploy this scenario by using the '-s os-odl-nofeature-ha' +parameter among others when calling ./ci/deploy/deploy.sh. + +References +========== + +For more information on the OPNFV Fraser release, please visit +http://www.opnfv.org/fraser -- cgit 1.2.3-korg