summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rwxr-xr-xdocs/scenarios/os-nosdn-fdio-noha/FDS-nosdn-overview.png (renamed from docs/userguide/FDS-nosdn-overview.png)bin88294 -> 88294 bytes
-rw-r--r--docs/scenarios/os-nosdn-fdio-noha/index.rst18
-rwxr-xr-xdocs/scenarios/os-nosdn-fdio-noha/scenario.description.rst (renamed from docs/userguide/scenario-apex-os-nosdn-fdio-noha.rst)33
-rwxr-xr-xdocs/scenarios/os-odl_l2-fdio-noha/FDS-L3-tenant-connectivity.png (renamed from docs/userguide/FDS-L3-tenant-connectivity.png)bin50947 -> 50947 bytes
-rwxr-xr-xdocs/scenarios/os-odl_l2-fdio-noha/FDS-basic-callflow.jpg (renamed from docs/userguide/FDS-basic-callflow.jpg)bin148454 -> 148454 bytes
-rwxr-xr-xdocs/scenarios/os-odl_l2-fdio-noha/FDS-odl_l2-overview.png (renamed from docs/userguide/FDS-odl_l2-overview.png)bin90635 -> 90635 bytes
-rw-r--r--docs/scenarios/os-odl_l2-fdio-noha/index.rst18
-rwxr-xr-xdocs/scenarios/os-odl_l2-fdio-noha/scenario.description.rst (renamed from docs/userguide/scenario-apex-os-odl_l2-fdio-noha.rst)67
-rwxr-xr-xdocs/scenarios/os-odl_l3-fdio-noha/FDS-L3-DVR-example.png (renamed from docs/userguide/FDS-L3-DVR-example.png)bin299709 -> 299709 bytes
-rwxr-xr-xdocs/scenarios/os-odl_l3-fdio-noha/FDS-basic-callflow.jpgbin0 -> 148454 bytes
-rwxr-xr-xdocs/scenarios/os-odl_l3-fdio-noha/FDS-odl_l3-overview.png (renamed from docs/userguide/FDS-odl_l3-overview.png)bin89119 -> 89119 bytes
-rw-r--r--docs/scenarios/os-odl_l3-fdio-noha/index.rst18
-rwxr-xr-xdocs/scenarios/os-odl_l3-fdio-noha/scenario.description.rst (renamed from docs/userguide/scenario-apex-os-odl_l3-fdio-noha.rst)60
-rw-r--r--docs/userguide/index.rst16
14 files changed, 187 insertions, 43 deletions
diff --git a/docs/userguide/FDS-nosdn-overview.png b/docs/scenarios/os-nosdn-fdio-noha/FDS-nosdn-overview.png
index 0692374..0692374 100755
--- a/docs/userguide/FDS-nosdn-overview.png
+++ b/docs/scenarios/os-nosdn-fdio-noha/FDS-nosdn-overview.png
Binary files differ
diff --git a/docs/scenarios/os-nosdn-fdio-noha/index.rst b/docs/scenarios/os-nosdn-fdio-noha/index.rst
new file mode 100644
index 0000000..3a5bb20
--- /dev/null
+++ b/docs/scenarios/os-nosdn-fdio-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
+
+
+**********************************************************************
+Fast Data Stacks Scenario: os-nosdn-fdio-noha Overview and Description
+**********************************************************************
+
+Scenario: "OpenStack - FD.io" (apex-os-nosdn-fdio-noha)
+is a scenario developed as part of the FastDataStacks
+OPNFV project.
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ scenario.description.rst
diff --git a/docs/userguide/scenario-apex-os-nosdn-fdio-noha.rst b/docs/scenarios/os-nosdn-fdio-noha/scenario.description.rst
index b863aee..e4e17b2 100755
--- a/docs/userguide/scenario-apex-os-nosdn-fdio-noha.rst
+++ b/docs/scenarios/os-nosdn-fdio-noha/scenario.description.rst
@@ -15,11 +15,20 @@ are:
- Openstack (in non-HA configuration)
- FD.io/VPP virtual forwarder for tenant networking
-Scenario Overview
-==================
+Introduction
+============
-Basics
-------
+NFV and virtualized high performance applications, such as video processing,
+require a "fast data stack" solution that provides both carrier grade
+forwarding performance, scalability and open extensibility.
+
+A key component of any NFV solution is the virtual forwarder, which needs to be
+a feature rich, high performance, highly scale virtual switch-router. It needs
+to leverage hardware accelerators when available and run in user space. In
+addition, it should be modular and easily extensible. The Vector Packet
+Processor (VPP) supplied by the FD.io project meets these needs, in that
+it offers a highly scalable, high performance and easily extensible
+software forwarder that entirely runs in user space.
The "Openstack - FD.io/VPP" scenario provides the capability to realize a set
of use-cases relevant to the deployment of NFV nodes instantiated by means of
@@ -106,5 +115,17 @@ File "deploy_settings.yaml" choose opendaylight as controller with version
vpn: false
vpp: true
-Notes and known issues
-======================
+Limitations, Issues and Workarounds
+===================================
+
+There are no known issues.
+
+References
+==========
+
+
+ * FastDataStacks OPNFV project wiki: https://wiki.opnfv.org/display/fds
+ * Fast Data (FD.io): https://fd.io/
+ * FD.io Vector Packet Processor (VPP): https://wiki.fd.io/view/VPP
+ * ML2 VPP mechanisms driver: https://github.com/naveenjoy/networking-vpp/
+ * OPNFV Colorado release - more information: http://www.opnfv.org/colorado
diff --git a/docs/userguide/FDS-L3-tenant-connectivity.png b/docs/scenarios/os-odl_l2-fdio-noha/FDS-L3-tenant-connectivity.png
index 9de77e5..9de77e5 100755
--- a/docs/userguide/FDS-L3-tenant-connectivity.png
+++ b/docs/scenarios/os-odl_l2-fdio-noha/FDS-L3-tenant-connectivity.png
Binary files differ
diff --git a/docs/userguide/FDS-basic-callflow.jpg b/docs/scenarios/os-odl_l2-fdio-noha/FDS-basic-callflow.jpg
index 96464f8..96464f8 100755
--- a/docs/userguide/FDS-basic-callflow.jpg
+++ b/docs/scenarios/os-odl_l2-fdio-noha/FDS-basic-callflow.jpg
Binary files differ
diff --git a/docs/userguide/FDS-odl_l2-overview.png b/docs/scenarios/os-odl_l2-fdio-noha/FDS-odl_l2-overview.png
index 2755099..2755099 100755
--- a/docs/userguide/FDS-odl_l2-overview.png
+++ b/docs/scenarios/os-odl_l2-fdio-noha/FDS-odl_l2-overview.png
Binary files differ
diff --git a/docs/scenarios/os-odl_l2-fdio-noha/index.rst b/docs/scenarios/os-odl_l2-fdio-noha/index.rst
new file mode 100644
index 0000000..cd8f2d8
--- /dev/null
+++ b/docs/scenarios/os-odl_l2-fdio-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
+
+
+***********************************************************************
+Fast Data Stacks Scenario: os-odl_l2-fdio-noha Overview and Description
+***********************************************************************
+
+Scenario: "OpenStack - Opendaylight (L2) - FD.io" (apex-os-odl_l2-fdio-noha)
+is a scenario developed as part of the FastDataStacks
+OPNFV project.
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ scenario.description.rst
diff --git a/docs/userguide/scenario-apex-os-odl_l2-fdio-noha.rst b/docs/scenarios/os-odl_l2-fdio-noha/scenario.description.rst
index 39c6b47..c164b6b 100755
--- a/docs/userguide/scenario-apex-os-odl_l2-fdio-noha.rst
+++ b/docs/scenarios/os-odl_l2-fdio-noha/scenario.description.rst
@@ -13,14 +13,42 @@ FastDataStacks OPNFV project. The main components of the
- APEX (TripleO) installer (please also see APEX installer documentation)
- Openstack (in non-HA configuration)
- - OpenDaylight controller controlling layer 2 networking
+ - OpenDaylight controller (non-clustered) controlling layer 2 networking
- FD.io/VPP virtual forwarder for tenant networking
-Scenario Overview
-==================
-
-Basics
-------
+Introduction
+============
+
+NFV and virtualized high performance applications, such as video processing,
+require a "fast data stack" solution that provides both carrier grade
+forwarding performance, scalability and open extensibility, along with
+functionality for realizing application policies and controlling a complex
+network topology.
+
+A solution stack is only as good as its foundation. Key foundational assets for
+NFV infrastructure are
+ * The virtual forwarder: The virtual forwarder needs to be a feature rich,
+ high performance, highly scale virtual switch-router. It needs to leverage
+ hardware accelerators when available and run in user space.
+ In addition, it should be modular and easily extensible.
+ * Forwarder diversity: A solution stack should support a variety of
+ forwarders, hardware forwarders (physical switches and routers)
+ as well as software forwarders. This way virtual and physical
+ forwarding domains can be seamlessly glued together.
+ * Policy driven connectivity: Connectivity should respect and
+ reflect different business
+
+In order to meet the desired qualities of an NFV infrastructure, the
+following components were chosen for the "Openstack - OpenDaylight
+ - FD.io/VPP" scenario:
+ * FD.io Vector Packet Processor (VPP) - a highly scalable,
+ high performance, extensible virtual forwarder
+ * OpenDaylight Controller - an extensible controller platform which
+ offers the ability to separate business logic from networking
+ constructs, supports a diverse set of network devices
+ (virtual and physical) via the "group based policy (GBP)"
+ component, and can be clustered to achieve a highly available
+ deployment.
The "Openstack - OpenDaylight - FD.io/VPP" scenario provides the capability to
realize a set of use-cases relevant to the deployment of NFV nodes instantiated
@@ -46,7 +74,7 @@ servers:
as a network controller
* 2 or more Computehosts
-.. image:: FDS-ODL_L2-overview.png
+.. image:: FDS-odl_l2-overview.png
Tenant networking leverages FD.io/VPP. Open VSwitch (OVS) is used for all other
connectivity, in particular the connectivity to public networking / the
@@ -78,8 +106,8 @@ Main features of the "apex-os-odl_l2-fdio-noha" scenario:
and security groups.
* Manual and automatic (via DHCP) addressing on tenant networks
-Software components of the scenario
----------------------------------------
+Scenario components and composition
+===================================
The apex-os-odl_l2-fdio-noha scenario combines components from three key open
source projects: OpenStack, OpenDaylight, and Fast Data (FD.io). The key
@@ -166,7 +194,9 @@ store.
**Virtual Bridge Domain (VBD) Store and Manager**: The virtual bridge domain
manager is responsible for configuring the VxLAN overlay tunnel infrastructure
to arrive at a desired bridged topology between multiple (VPP) compute nodes.
-VDB configures VXLAN tunnels always into a full-mesh with split-horizon group forwarding applied on any domain facing tunnel interface (i.e. forwarding behavior will be that used for VPLS).
+VDB configures VXLAN tunnels always into a full-mesh with split-horizon group
+forwarding applied on any domain facing tunnel interface (i.e. forwarding
+behavior will be that used for VPLS).
**NETCONF Mount Point Service & Connector**: Collectively referred to as
Netconf Services, provide the NETCONF interface for accessing VPP configuration
@@ -216,5 +246,18 @@ File "deploy_settings.yaml" choose opendaylight as controller with version
vpn: false
vpp: true
-Notes and known issues
-======================
+Limitations, Issues and Workarounds
+===================================
+
+There are no known issues.
+
+References
+==========
+
+
+ * FastDataStacks OPNFV project wiki: https://wiki.opnfv.org/display/fds
+ * Fast Data (FD.io): https://fd.io/
+ * FD.io Vector Packet Processor (VPP): https://wiki.fd.io/view/VPP
+ * OpenDaylight Controller: https://www.opendaylight.org/
+ * OPNFV Colorado release - more information: http://www.opnfv.org/colorado
+
diff --git a/docs/userguide/FDS-L3-DVR-example.png b/docs/scenarios/os-odl_l3-fdio-noha/FDS-L3-DVR-example.png
index 18932c3..18932c3 100755
--- a/docs/userguide/FDS-L3-DVR-example.png
+++ b/docs/scenarios/os-odl_l3-fdio-noha/FDS-L3-DVR-example.png
Binary files differ
diff --git a/docs/scenarios/os-odl_l3-fdio-noha/FDS-basic-callflow.jpg b/docs/scenarios/os-odl_l3-fdio-noha/FDS-basic-callflow.jpg
new file mode 100755
index 0000000..96464f8
--- /dev/null
+++ b/docs/scenarios/os-odl_l3-fdio-noha/FDS-basic-callflow.jpg
Binary files differ
diff --git a/docs/userguide/FDS-odl_l3-overview.png b/docs/scenarios/os-odl_l3-fdio-noha/FDS-odl_l3-overview.png
index 5b90c93..5b90c93 100755
--- a/docs/userguide/FDS-odl_l3-overview.png
+++ b/docs/scenarios/os-odl_l3-fdio-noha/FDS-odl_l3-overview.png
Binary files differ
diff --git a/docs/scenarios/os-odl_l3-fdio-noha/index.rst b/docs/scenarios/os-odl_l3-fdio-noha/index.rst
new file mode 100644
index 0000000..7ae4f83
--- /dev/null
+++ b/docs/scenarios/os-odl_l3-fdio-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
+
+
+***********************************************************************
+Fast Data Stacks Scenario: os-odl_l3-fdio-noha Overview and Description
+***********************************************************************
+
+Scenario: "OpenStack - Opendaylight (L3) - FD.io" (apex-os-odl_l3-fdio-noha)
+is a scenario developed as part of the FastDataStacks
+OPNFV project.
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ scenario.description.rst
diff --git a/docs/userguide/scenario-apex-os-odl_l3-fdio-noha.rst b/docs/scenarios/os-odl_l3-fdio-noha/scenario.description.rst
index cc95fd9..bf32eb6 100755
--- a/docs/userguide/scenario-apex-os-odl_l3-fdio-noha.rst
+++ b/docs/scenarios/os-odl_l3-fdio-noha/scenario.description.rst
@@ -13,14 +13,44 @@ FastDataStacks OPNFV project. The main components of the
- APEX (TripleO) installer (please also see APEX installer documentation)
- Openstack (in non-HA configuration)
- - OpenDaylight controller controlling layer 2 and layer 3 networking
+ - OpenDaylight controller (non-clustered)
+ controlling layer 2 and layer 3 networking
- FD.io/VPP virtual forwarder for tenant networking
-Scenario Overview
-==================
+Introduction
+============
+
+NFV and virtualized high performance applications, such as video processing,
+require a "fast data stack" solution that provides both carrier grade
+forwarding performance, scalability and open extensibility, along with
+functionality for realizing application policies and controlling a complex
+network topology.
+
+A solution stack is only as good as its foundation. Key foundational assets for
+NFV infrastructure are
+ * The virtual forwarder: The virtual forwarder needs to be a feature rich,
+ high performance, highly scale virtual switch-router. It needs to leverage
+ hardware accelerators when available and run in user space.
+ In addition, it should be modular and easily extensible.
+ * Forwarder diversity: A solution stack should support a variety of
+ forwarders, hardware forwarders (physical switches and routers)
+ as well as software forwarders. This way virtual and physical
+ forwarding domains can be seamlessly glued together.
+ * Policy driven connectivity: Connectivity should respect and
+ reflect different business
+
+In order to meet the desired qualities of an NFV infrastructure, the
+following components were chosen for the "Openstack - OpenDaylight
+ - FD.io/VPP" scenario:
+ * FD.io Vector Packet Processor (VPP) - a highly scalable,
+ high performance, extensible virtual forwarder
+ * OpenDaylight Controller - an extensible controller platform which
+ offers the ability to separate business logic from networking
+ constructs, supports a diverse set of network devices
+ (virtual and physical) via the "group based policy (GBP)"
+ component, and can be clustered to achieve a highly available
+ deployment.
-Basics
-------
The "Openstack - OpenDaylight - FD.io/VPP" scenario provides the capability to
realize a set of use-cases relevant to the deployment of NFV nodes instantiated
@@ -75,8 +105,8 @@ Main features of the "apex-os-odl_l3-fdio-noha" scenario:
floating IP addresses (i.e. NAT) are implemented by the FD.io/VPP forwarder
* Manual and automatic (via DHCP) addressing on tenant networks
-Software components of the scenario
----------------------------------------
+Scenario components and composition
+===================================
The apex-os-odl_l3-fdio-noha scenario combines components from three key open
source projects: OpenStack, OpenDaylight, and Fast Data (FD.io). The key
@@ -217,5 +247,17 @@ File "deploy_settings.yaml": Choose Opendaylight as controller with version
vpn: false
vpp: true
-Notes and known issues
-======================
+Limitations, Issues and Workarounds
+===================================
+
+There are no known issues.
+
+References
+==========
+
+
+ * FastDataStacks OPNFV project wiki: https://wiki.opnfv.org/display/fds
+ * Fast Data (FD.io): https://fd.io/
+ * FD.io Vector Packet Processor (VPP): https://wiki.fd.io/view/VPP
+ * OpenDaylight Controller: https://www.opendaylight.org/
+ * OPNFV Colorado release - more information: http://www.opnfv.org/colorado
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
deleted file mode 100644
index 54f12ba..0000000
--- a/docs/userguide/index.rst
+++ /dev/null
@@ -1,16 +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
-
-
-**************************
-Fast Data Stacks Scenarios
-**************************
-
-.. toctree::
- :numbered:
- :maxdepth: 2
-
- scenario-apex-os-nosdn-fdio-noha.rst
- scenario-apex-os-odl_l2-fdio-noha.rst
- scenario-apex-os-odl_l3-fdio-noha.rst