aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorblsaws <blsaws@hotmail.com>2015-11-10 14:17:22 -0800
committerblsaws <blsaws@hotmail.com>2015-11-10 14:31:51 -0800
commit51f1c01d34888b48694e3c4ea67f707706532310 (patch)
tree2ec8f1354b906431bc45ca2a1d76f544fc736442
parentdc75170d734debbe8a5de88cc71b52c3e53fd45e (diff)
Correct structure
Add docs folder Update HTML theme Remove example docs JIRA: SFC-3 Change-Id: If0158796aee5f020f3bb4403b8a67952f9e6bb26 Signed-off-by: blsaws <blsaws@hotmail.com>
-rw-r--r--INFO (renamed from VnfMgrSim/INFO)0
-rw-r--r--LICENSE (renamed from VnfMgrSim/LICENSE)0
-rw-r--r--NAME/__init__.py (renamed from VnfMgrSim/NAME/__init__.py)0
-rw-r--r--README (renamed from VnfMgrSim/README)0
-rw-r--r--docs/design/architecture.rst4
-rw-r--r--docs/design/definitions.rst59
-rw-r--r--docs/design/index.rst32
-rw-r--r--docs/design/introduction.rst23
-rw-r--r--docs/design/requirements.rst4
-rw-r--r--docs/design/usecases.rst4
-rw-r--r--docs/etc/conf.py35
-rw-r--r--docs/etc/opnfv-logo.pngbin0 -> 2829 bytes
-rw-r--r--setup.py (renamed from VnfMgrSim/setup.py)0
-rw-r--r--tests/NAME_tests.py (renamed from VnfMgrSim/tests/NAME_tests.py)0
-rw-r--r--tests/__init__.py (renamed from VnfMgrSim/tests/__init__.py)0
-rwxr-xr-xvnfmgr/vnfmgr_main.py (renamed from VnfMgrSim/vnfmgr/vnfmgr_main.py)0
-rw-r--r--vnfmgr/vnfmgr_odl/__init__.py (renamed from VnfMgrSim/vnfmgr/vnfmgr_odl/__init__.py)0
-rwxr-xr-xvnfmgr/vnfmgr_odl/sample_config/RestConf-RSP-HttpPost.json (renamed from VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-RSP-HttpPost.json)0
-rwxr-xr-xvnfmgr/vnfmgr_odl/sample_config/RestConf-SFCs-HttpPut.json (renamed from VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFCs-HttpPut.json)0
-rwxr-xr-xvnfmgr/vnfmgr_odl/sample_config/RestConf-SFFs-HttpPut.json (renamed from VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFFs-HttpPut.json)0
-rwxr-xr-xvnfmgr/vnfmgr_odl/sample_config/RestConf-SFPs-HttpPut.json (renamed from VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFPs-HttpPut.json)0
-rwxr-xr-xvnfmgr/vnfmgr_odl/sample_config/RestConf-SFs-HttpPut.json (renamed from VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFs-HttpPut.json)0
-rwxr-xr-xvnfmgr/vnfmgr_odl/vnfmgr_odl.py (renamed from VnfMgrSim/vnfmgr/vnfmgr_odl/vnfmgr_odl.py)0
-rw-r--r--vnfmgr/vnfmgr_os/__init__.py (renamed from VnfMgrSim/vnfmgr/vnfmgr_os/__init__.py)0
-rwxr-xr-xvnfmgr/vnfmgr_os/vnfmgr_os.py (renamed from VnfMgrSim/vnfmgr/vnfmgr_os/vnfmgr_os.py)0
25 files changed, 161 insertions, 0 deletions
diff --git a/VnfMgrSim/INFO b/INFO
index 76298d3..76298d3 100644
--- a/VnfMgrSim/INFO
+++ b/INFO
diff --git a/VnfMgrSim/LICENSE b/LICENSE
index eab0924..eab0924 100644
--- a/VnfMgrSim/LICENSE
+++ b/LICENSE
diff --git a/VnfMgrSim/NAME/__init__.py b/NAME/__init__.py
index e69de29..e69de29 100644
--- a/VnfMgrSim/NAME/__init__.py
+++ b/NAME/__init__.py
diff --git a/VnfMgrSim/README b/README
index 04d252a..04d252a 100644
--- a/VnfMgrSim/README
+++ b/README
diff --git a/docs/design/architecture.rst b/docs/design/architecture.rst
new file mode 100644
index 0000000..24be167
--- /dev/null
+++ b/docs/design/architecture.rst
@@ -0,0 +1,4 @@
+Architecture
+============
+
+This section will describe the architectural approach to incorporating SFC into the OPNFV platform. \ No newline at end of file
diff --git a/docs/design/definitions.rst b/docs/design/definitions.rst
new file mode 100644
index 0000000..effaf0e
--- /dev/null
+++ b/docs/design/definitions.rst
@@ -0,0 +1,59 @@
+Definitions
+===========
+
+Definitions of most terms used here are provided in the `IETF SFC Architecture draft <https://datatracker.ietf.org/doc/draft-ietf-sfc-architecture/>`_. Additional terms specific to the OPNFV SFC project are defined below.
+
+.. list-table:: Definitions
+ :widths: 15 85
+ :header-rows: 1
+
+ * - Term
+ - Meaning
+
+ * - ...
+ - ...
+
+Abbreviations
+=============
+.. list-table:: Abbreviations
+ :widths: 15 85
+ :header-rows: 1
+
+ * - Abbreviation
+ - Term
+
+ * - NS
+ - Network Service
+
+ * - NFVO
+ - Network Function Virtualization Orchestrator
+
+ * - NF
+ - Network Function
+
+ * - RSP
+ - Rendered Service Path
+
+ * - SF
+ - Service Function
+
+ * - SFC
+ - Service Function Chain(ing)
+
+ * - SFF
+ - Service Function Forwarder
+
+ * - SFP
+ - Service Function Path
+
+ * - VNF
+ - Virtual Network Function
+
+ * - VNFM
+ - Virtual Network Function Manager
+
+ * - VNF-FG
+ - Virtual Network Function Forwarding Graph
+
+ * - VIM
+ - Virtual Infrastructure Manager
diff --git a/docs/design/index.rst b/docs/design/index.rst
new file mode 100644
index 0000000..c878b87
--- /dev/null
+++ b/docs/design/index.rst
@@ -0,0 +1,32 @@
+.. OPNFV Service Function Chaining (SFC) documentation
+
+.. image:: ../etc/opnfv-logo.png
+ :height: 40
+ :width: 200
+ :alt: OPNFV
+ :align: left
+|
+|
+Service Function Chaining (SFC)
+===============================
+
+Contents:
+
+.. toctree::
+ :numbered:
+ :maxdepth: 4
+
+ introduction.rst
+ definitions.rst
+ usecases.rst
+ architecture.rst
+ requirements.rst
+
+Indices and tables
+==================
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/design/introduction.rst b/docs/design/introduction.rst
new file mode 100644
index 0000000..746ba05
--- /dev/null
+++ b/docs/design/introduction.rst
@@ -0,0 +1,23 @@
+.. two dots create a comment. please leave this logo at the top of each of your rst files.
+.. image:: ../etc/opnfv-logo.png
+ :height: 40
+ :width: 200
+ :alt: OPNFV
+ :align: left
+.. these two pipes are to seperate the logo from the first title
+|
+|
+Introduction
+============
+
+..
+ This work is licensed under a Creative Commons Attribution 3.0 Unported License.
+
+ http://creativecommons.org/licenses/by/3.0/legalcode
+
+.. NOTE::
+ This is the working documentation for the SFC project.
+
+The `OPNFV Service Function Chaining (SFC) <https://wiki.opnfv.org/sfc>`_ project aims to provide the ability to define an ordered list of a network services (e.g. firewalls, NAT, QoS). These service are then "stitched" together in the network to create a service chain. This project provides the infrastructure to install the upstream ODL SFC implementation project in an NFV environment.
+
+
diff --git a/docs/design/requirements.rst b/docs/design/requirements.rst
new file mode 100644
index 0000000..dbedc6f
--- /dev/null
+++ b/docs/design/requirements.rst
@@ -0,0 +1,4 @@
+Requirements
+============
+
+This section will define requirements for the initial OPNFV SFC implementation, including those requirements driving upstream project enhancements.
diff --git a/docs/design/usecases.rst b/docs/design/usecases.rst
new file mode 100644
index 0000000..9b88698
--- /dev/null
+++ b/docs/design/usecases.rst
@@ -0,0 +1,4 @@
+Use Cases
+=========
+
+This section will outline use cases driving the initial OPNFV SFC implementation. \ No newline at end of file
diff --git a/docs/etc/conf.py b/docs/etc/conf.py
new file mode 100644
index 0000000..9a0c229
--- /dev/null
+++ b/docs/etc/conf.py
@@ -0,0 +1,35 @@
+import datetime
+import sys
+import os
+
+try:
+ __import__('imp').find_module('sphinx.ext.numfig')
+ extensions = ['sphinx.ext.numfig']
+except ImportError:
+ # 'pip install sphinx_numfig'
+ extensions = ['sphinx_numfig']
+
+# numfig:
+number_figures = True
+figure_caption_prefix = "Fig."
+
+source_suffix = '.rst'
+master_doc = 'index'
+pygments_style = 'sphinx'
+html_use_index = False
+html_theme = 'sphinx_rtd_theme'
+
+pdf_documents = [('index', u'SFC', u'SFC Project', u'OPNFV')]
+pdf_fit_mode = "shrink"
+pdf_stylesheets = ['sphinx','kerning','a4']
+#latex_domain_indices = False
+#latex_use_modindex = False
+
+latex_elements = {
+ 'printindex': '',
+}
+
+project = u'OPNFV: Service Function Chaining (SFC)'
+copyright = u'%s, OPNFV' % datetime.date.today().year
+version = u'1.0.0'
+release = u'1.0.0'
diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png
new file mode 100644
index 0000000..1519503
--- /dev/null
+++ b/docs/etc/opnfv-logo.png
Binary files differ
diff --git a/VnfMgrSim/setup.py b/setup.py
index 9ff1699..9ff1699 100644
--- a/VnfMgrSim/setup.py
+++ b/setup.py
diff --git a/VnfMgrSim/tests/NAME_tests.py b/tests/NAME_tests.py
index 9f83104..9f83104 100644
--- a/VnfMgrSim/tests/NAME_tests.py
+++ b/tests/NAME_tests.py
diff --git a/VnfMgrSim/tests/__init__.py b/tests/__init__.py
index e69de29..e69de29 100644
--- a/VnfMgrSim/tests/__init__.py
+++ b/tests/__init__.py
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_main.py b/vnfmgr/vnfmgr_main.py
index b5ab8be..b5ab8be 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_main.py
+++ b/vnfmgr/vnfmgr_main.py
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/__init__.py b/vnfmgr/vnfmgr_odl/__init__.py
index e69de29..e69de29 100644
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/__init__.py
+++ b/vnfmgr/vnfmgr_odl/__init__.py
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-RSP-HttpPost.json b/vnfmgr/vnfmgr_odl/sample_config/RestConf-RSP-HttpPost.json
index 998d1e0..998d1e0 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-RSP-HttpPost.json
+++ b/vnfmgr/vnfmgr_odl/sample_config/RestConf-RSP-HttpPost.json
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFCs-HttpPut.json b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFCs-HttpPut.json
index 3444964..3444964 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFCs-HttpPut.json
+++ b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFCs-HttpPut.json
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFFs-HttpPut.json b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFFs-HttpPut.json
index 191fd54..191fd54 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFFs-HttpPut.json
+++ b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFFs-HttpPut.json
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFPs-HttpPut.json b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFPs-HttpPut.json
index da1f2c4..da1f2c4 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFPs-HttpPut.json
+++ b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFPs-HttpPut.json
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFs-HttpPut.json b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFs-HttpPut.json
index 1ea27e7..1ea27e7 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFs-HttpPut.json
+++ b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFs-HttpPut.json
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/vnfmgr_odl.py b/vnfmgr/vnfmgr_odl/vnfmgr_odl.py
index 4d35aeb..4d35aeb 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/vnfmgr_odl.py
+++ b/vnfmgr/vnfmgr_odl/vnfmgr_odl.py
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_os/__init__.py b/vnfmgr/vnfmgr_os/__init__.py
index e69de29..e69de29 100644
--- a/VnfMgrSim/vnfmgr/vnfmgr_os/__init__.py
+++ b/vnfmgr/vnfmgr_os/__init__.py
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_os/vnfmgr_os.py b/vnfmgr/vnfmgr_os/vnfmgr_os.py
index 0067850..0067850 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_os/vnfmgr_os.py
+++ b/vnfmgr/vnfmgr_os/vnfmgr_os.py