summaryrefslogtreecommitdiffstats
path: root/docs/userguide
diff options
context:
space:
mode:
authorBrady Johnson <brady.allen.johnson@ericsson.com>2017-02-10 13:01:52 +0100
committerBrady Johnson <brady.allen.johnson@ericsson.com>2017-02-10 13:10:36 +0100
commit065fba5bef236f992bd5e4122e635bb21d525af9 (patch)
tree7aa1d737bfeb30b90d9236609f6ba75025636ad7 /docs/userguide
parent773acea6072b38a8b63433ebb53ac86dc522467b (diff)
Migrate docs to the new Danube dir structure
Change-Id: I6bdfd21add4d04f0fee988f83888c1edcc488951 Signed-off-by: Brady Johnson <brady.allen.johnson@ericsson.com>
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/feature.userguide.rst50
-rw-r--r--docs/userguide/index.rst13
2 files changed, 0 insertions, 63 deletions
diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst
deleted file mode 100644
index 6e80a391..00000000
--- a/docs/userguide/feature.userguide.rst
+++ /dev/null
@@ -1,50 +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>
-
-SFC description
-=====================
-.. Describe the specific features and how it is realised in the scenario in a brief manner
-.. to ensure the user understand the context for the user guide instructions to follow.
-
-The OPNFV SFC feature will create service chains, classifiers, and create VMs for Service
-Functions, allowing for client traffic intended to be sent to a server to first traverse
-the provisioned service chain.
-
-The Service Chain creation consists of configuring the OpenDaylight SFC feature. This
-configuration will in-turn configure Service Function Forwarders to route traffic to
-Service Functions. A Service Function Forwarder in the context of OPNFV SFC is the
-"br-int" OVS bridge on an Open Stack compute node.
-
-The classifier(s) consist of configuring the OpenDaylight Netvirt feature. Netvirt is
-a Neutron backend which handles the networking for VMs. Netvirt can also create simple
-classification rules (5-tuples) to send specific traffic to a pre-configured Service
-Chain. A common example of a classification rule would be to send all HTTP traffic
-(tcp port 80) to a pre-configured Service Chain.
-
-Service Function VM creation is performed via a VNF Manager. Currently, OPNFV SFC
-is integrated with OpenStack Tacker, which in addition to being a VNF Manager, also
-orchestrates the SFC configuration. In OPNFV SFC Tacker creates service chains,
-classification rules, creates VMs in OpenStack for Service Functions, and then
-communicates the relevant configuration to OpenDaylight SFC.
-
-SFC capabilities and usage
-================================
-.. Describe the specific capabilities and usage for <XYZ> feature.
-.. Provide enough information that a user will be able to operate the feature on a deployed scenario.
-
-The OPNFV SFC feature can be deployed with either the "os-odl_l2-sfc-ha" or the
-"os-odl_l2-sfc-noha" scenario. SFC usage for both of these scenarios is the same.
-
-As previously mentioned, Tacker is used as a VNF Manager and SFC Orchestrator. All
-the configuration necessary to create working service chains and classifiers can
-be performed using the Tacker command line. Refer to the `Tacker walkthrough <https://github.com/trozet/sfc-random/blob/master/tacker_sfc_apex_walkthrough.txt>`_
-(step 3 and onwards) for more information.
-
-SFC API usage guidelines and example
------------------------------------------------
-.. Describe with examples how to use specific features, provide API examples and details required to
-.. operate the feature on the platform.
-
-Refer to the `Tacker walkthrough <https://github.com/trozet/sfc-random/blob/master/tacker_sfc_apex_walkthrough.txt>`_
-for Tacker usage guidelines and examples.
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
deleted file mode 100644
index 9bfd2433..00000000
--- a/docs/userguide/index.rst
+++ /dev/null
@@ -1,13 +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>
-
-**************
-SFC User Guide
-**************
-
-.. toctree::
- :numbered:
- :maxdepth: 2
-
- feature.userguide.rst