initial version

modifyed conf.py

Change-Id: I16e451e5519f30cf52ee6b399338092a33728401
Signed-off-by: Andrew Sergeev <asergeev@advaoptical.com>

10 files changed, 283 insertions, 1 deletions

diff --git a/docs/etc/conf.py b/docs/etc/conf.py
index 0066035..ea550c3 100644
--- a/docs/etc/conf.py
+++ b/docs/etc/conf.py
@@ -17,6 +17,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 pygments_style = 'sphinx'
 html_use_index = False
+html_theme = 'sphinx_rtd_theme'
 
 pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')]
 pdf_fit_mode = "shrink"
@@ -28,7 +29,7 @@ latex_elements = {
     'printindex': '',
 }
 
-project = u'OPNFV: Template documentation config'
+project = u'ENFV: Edge NFV requirements project'
 copyright = u'%s, OPNFV' % datetime.date.today().year
 version = u'1.0.0'
 release = u'1.0.0'
diff --git a/docs/requirements/01-intro.rst b/docs/requirements/01-intro.rst
new file mode 100644
index 0000000..a60217b
--- /dev/null
+++ b/docs/requirements/01-intro.rst
@@ -0,0 +1,24 @@
+Introduction
+============
+
+The purpose of this Requirements Project is to articulate the capabilities 
+and behaviours needed in Edge NFV platforms, and how they interact with 
+centralized NFVI and MANO components of NFV solutions.
+
+
+Problem description
+-------------------
+
+Edge NFVI location has certain specific requirements related to:
+
+1. Appropriate Tunneling for User Traffic across WAN (Ethernet, IP/MPLS) links
+#. Appropriate Tunneling for Management Traffic across WAN links
+#. Including reachability requirements to the compute platform (‘eth0’ resilience)
+#. Extending Multi-DC management to address many small "DC" locations
+#. Monitoring Capabilities required for a remote Compute Node
+#. Squaring Bare Metal with remote survivability and whether IaaS is more appropriate for remote locations
+
+
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/requirements/02-use_cases.rst b/docs/requirements/02-use_cases.rst
new file mode 100644
index 0000000..9ed0381
--- /dev/null
+++ b/docs/requirements/02-use_cases.rst
@@ -0,0 +1,35 @@
+Use cases and scenarios
+=======================
+
+There are several use cases related to Edge NFV: 
+
+1. Isolated vE-CPE. 
+    [vE-CPE]_ is related to most popupar NFV use case where NFVI compute node is 
+    located at customer premises. Typical applications are virtual Firewall and Virtual BGP router; 
+    in simplest case two virtual appliances are hosted at the same CPE compute node.
+
+#. Distributed VE-CPE. 
+    It is the same as above but at least one virtual appliance is 
+    hosted on another compute node, presumably in DC.
+
+#. Residential GW. 
+    Similar to Isolated vE-CPE, the major difference is scale. Typical VNFs are "WAN fault monitoring", 
+    "Performance monitoring". Ratio between deplyed vE-CPE 
+    and Residential GW might reach 1:100 or even 1:1000, thus VNF management overhead must be minimized. 
+    For instance, self-termination after predefined activity period seems preferable over 
+    explicit VNF removing via management system.
+
+#. Distributed Base station. 
+    TBD. What is the difference for it?
+
+#. Network connectivity. 
+    In most cases CPE is connected to Metro Ethernet [#f1]_ .
+
+
+
+.. [#f1] In all above use cases management traffic is coming inband with tenant traffic. 
+
+
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/requirements/03-architecture.rst b/docs/requirements/03-architecture.rst
new file mode 100644
index 0000000..3af5667
--- /dev/null
+++ b/docs/requirements/03-architecture.rst
@@ -0,0 +1,27 @@
+High level architecture and general features
+============================================
+
+Functional overview
+-------------------
+
+Functional overview is here.
+
+Architecture Overview
+---------------------
+
+Architecture overview is here.
+
+General Features and Requirements
+---------------------------------
+
+This is main part.
+
+High level northbound interface specification
+---------------------------------------------
+
+What is northbound here? VIM controller?
+
+
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/requirements/04-gaps.rst b/docs/requirements/04-gaps.rst
new file mode 100644
index 0000000..6c1bbfb
--- /dev/null
+++ b/docs/requirements/04-gaps.rst
@@ -0,0 +1,64 @@
+Gap analysis in upstream projects
+=================================
+
+Network  related gaps
+---------------------
+
+1. Terminology.
+    Consider to keep upstream/downstream terminology for the traffic leaving/coming to Edge NFV. This gives
+    unambiquies names 'uplink/downlink' or 'access/network' for CPE interfaces. Inside DC this traffic is 
+    calles east-west and no special meaning for interfaces on compute/network node.
+  
+2. Uplink interface capacity. 
+    In most cases those are 1GE as opposite to DC where 10/40G interfaces are prevaling. As result 
+    1GE interfaces are not part of CI.
+
+3. Tunneling technology: 
+    a. Case isolated NFVI - 802.1ad S-VLAN or MPLS.
+    #. Case distributed NFVI - VXLAN or NVGRE over 802.1ad.
+        * VXLAN and NVGRE tunnels don't support OAM check.
+    #. All above tunneling technology don't support integrity check.
+    #. All above tunneling technology don't support payload enryption (optional).
+
+4. Management traffic: 
+    a. Management traffic should come inband with tenant traffic.  
+    b. Management traffic shoud be easiliy come trough firewalls, i.e. single IP/port woudl be ideal 
+       (compare with OpenStack bunch of protocols [firewall]_).
+    c. Management connection might be disrupted for a long period of time; once provisioned Edge NFV device 
+       must keep its functionaly with no respect of management connection state. 
+
+5. Resiliency: 
+    a. Network resiliency is based on dual-homing, service path shall be forked in that case. A VM presumable shall
+       be able to select active virtual link for data forwarding
+    #. SLA assurance for tenant virtual link - mandatory   
+    #. Fault propagation towards VM is mandatory. 
+
+          
+Hypervisor gaps
+---------------
+
+#. Monitoring Capabilities required for a remote Compute Node; Hypervisor shall provide extended monitoring of 
+   VM and its resource usage.
+   
+OpenStack gaps
+--------------
+
+Later shoudl be per specific component? (nova, neutron...)
+
+  OpenStack Nova
+
+  1. Management system should support dozen of thousands individual hosts.
+     Currently each Edge Host is allocated in individual zone, is this approach scalable?
+  2. Host is explicitly selected effectively bypassing NOVA scheduler
+
+Deployment gaps
+---------------
+1. Only traffic interfaces are exposed (e.g. no eth0, no USB); SW deployment is different from DC.
+#. Linux shell shall not be exposed; linux CLI shall be replaced presumable by REST.
+#. Kernel and Hypervisor are hardened. Only OpenStack agents might be added during deployment.
+#. AMT or IPMI shall not be used for SW deployment.
+
+Revision: _sha1_
+
+
+Build date: |today|
diff --git a/docs/requirements/05-implementation.rst b/docs/requirements/05-implementation.rst
new file mode 100644
index 0000000..3dc88bd
--- /dev/null
+++ b/docs/requirements/05-implementation.rst
@@ -0,0 +1,40 @@
+Detailed implementation plan
+============================
+
+TBD
+
+Functional Blocks
+-----------------
+
+TBD
+
+Sequence
+--------
+
+TBD.
+
+Implementation plan for OPNFV Release XYZ
+-----------------------------------------
+
+TBD.
+
+Information elements
+--------------------
+
+TBD.
+
+Detailed northbound interface specification
+-------------------------------------------
+
+TBD.
+
+
+Blueprints
+----------
+
+TBD
+
+
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/requirements/06-summary.rst b/docs/requirements/06-summary.rst
new file mode 100644
index 0000000..a8c7477
--- /dev/null
+++ b/docs/requirements/06-summary.rst
@@ -0,0 +1,9 @@
+Summary and conclusion
+======================
+
+TBD
+
+
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/requirements/99-references.rst b/docs/requirements/99-references.rst
new file mode 100644
index 0000000..5548c45
--- /dev/null
+++ b/docs/requirements/99-references.rst
@@ -0,0 +1,17 @@
+References and bibliography
+===========================
+
+.. [OPSK] OpenStack, [Online]. Available at https://www.openstack.org/
+.. [ENFV] ETSI NFV, [Online]. Available at
+          http://www.etsi.org/technologies-clusters/technologies/nfv
+.. [vE-CPE] ETSI NFV Use Cases, [Online]. Available at
+          http://www.etsi.org/deliver/etsi_gs/nfv/001_099/001/01.01.01_60/gs_nfv001v010101p.pdf
+.. [security] IETF, [Online]. Available at
+          https://tools.ietf.org/html/draft-ietf-nvo3-security-requirements-06
+
+.. [firewall] OpenStack FW, [Online]. Available at
+          http://docs.openstack.org/juno/config-reference/content/firewalls-default-ports.html
+
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/requirements/glossary.rst b/docs/requirements/glossary.rst
new file mode 100644
index 0000000..b9a4163
--- /dev/null
+++ b/docs/requirements/glossary.rst
@@ -0,0 +1,28 @@
+Glossary
+============
+
+**Definition of terms**
+
+Different SDOs and communities use different terminology related to
+NFV/Cloud/SDN. This list tries to define an OPNFV terminology,
+mapping/translating the OPNFV terms to terminology used in other contexts.
+
+
+.. glossary::
+
+    CPE
+        Customer Premices Equipment
+    DC
+        Data Center
+    NFV
+        Network Function Virtualization
+
+    NFVI
+        Network Function Virtualization Infrastructure
+
+    vE-CPE
+        Virtual Enterprise-Customer Premises Equipment
+        
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/requirements/index.rst b/docs/requirements/index.rst
new file mode 100644
index 0000000..2389aa2
--- /dev/null
+++ b/docs/requirements/index.rst
@@ -0,0 +1,37 @@
+.. ENFV documentation master file, created by
+   sphinx-quickstart on Tue Nov 03 15:32:31 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. image:: ../etc/opnfv-logo.png
+  :height: 40
+  :width: 200
+  :alt: OPNFV
+  :align: left
+
+Welcome to ENFV's documentation!
+================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 4
+
+   01-intro.rst
+   02-use_cases.rst
+   03-architecture.rst
+   04-gaps.rst
+   05-implementation.rst
+   06-summary.rst
+   99-references.rst
+   glossary.rst
+
+Indices and tables
+==================
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|
+