summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTim Rozet <trozet@redhat.com>2016-08-15 16:51:55 -0400
committerTim Rozet <trozet@redhat.com>2016-08-15 16:51:55 -0400
commita144613b53bebb5579fb31c545adce680caf35e2 (patch)
tree350159c472da3c14ec56b476f1b8fc2d9c9cd016 /docs
parent14bad841d9b2480becb16923f055b71356f5dfe3 (diff)
Adds supported scenarios to docs
Change-Id: Iaf451cd0c6b2bc847e1fffb8e99dc9d3d3abfe91 Signed-off-by: Tim Rozet <trozet@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/installation-instructions/architecture.rst53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/installation-instructions/architecture.rst b/docs/installation-instructions/architecture.rst
index bf2f9db4..c63da27c 100644
--- a/docs/installation-instructions/architecture.rst
+++ b/docs/installation-instructions/architecture.rst
@@ -22,3 +22,56 @@ of the Apex RPM.
The overcloud is OPNFV. Configuration will be passed into undercloud and
the undercloud will use OpenStack's orchestration component, named Heat, to
execute a deployment that will provision the target OPNFV nodes.
+
+OPNFV Scenario Architecture
+===========================
+
+OPNFV distinguishes different types of SDN controllers, deployment options, and
+features into "scenarios". These scenarios are universal across all OPNFV
+installers, although some may or may not be supported by each installer.
+
+The standard naming convention for a scenario is:
+<VIM platform>-<SDN type>-<feature>-<ha/noha>
+
+The only supported VIM type is "OS" (OpenStack), while SDN types can be any
+supported SDN controller. "feature" includes things like ovs_dpdk, sfc, etc.
+"ha" or "noha" determines if the deployment will be highly available. If "ha"
+is used at least 3 control nodes are required.
+
+OPNFV Scenarios in Apex
+=======================
+
+Apex provides pre-built scenario files in /etc/opnfv-apex which a user can
+select from to deploy the desired scenario. Simply pass the desired file to
+the installer as a (-d) deploy setting. Read further in the Apex documentation
+to learn more about invoking the deploy command. Below is quick reference
+matrix for OPNFV scenarios supported in Apex. Please refer to the respective
+OPNFV Docs documentation for each scenario in order to see a full scenario
+description. The following scenarios correspond to a supported <Scenario>.yaml
+deploy settings file:
+
++-------------------------+------------+-----------------+
+| **Scenario** | **Owner** | **Known Issues**|
++-------------------------+------------+-----------------+
+| os-nosdn-nofeature-ha | Apex | |
++-------------------------+------------+-----------------+
+| os-nosdn-nofeature-noha | Apex | |
++-------------------------+------------+-----------------+
+| os-nosdn-ovs-noha | OVS for NFV| |
++-------------------------+------------+-----------------+
+| os-nosdn-fdio-noha | FDS | |
++-------------------------+------------+-----------------+
+| os-odl_l2-nofeature-ha | Apex | |
++-------------------------+------------+-----------------+
+| os-odl_l3-nofeature-ha | Apex | APEX-112 |
++-------------------------+------------+-----------------+
+| os-odl_l2-sfc-noha | SFC | |
++-------------------------+------------+-----------------+
+| os-odl_l2-bgpvpn-noha | SDNVPN | |
++-------------------------+------------+-----------------+
+| os-odl_l2-fdio-noha | FDS | |
++-------------------------+------------+-----------------+
+| os-onos-nofeature-ha | ONOSFW | |
++-------------------------+------------+-----------------+
+| os-onos-sfc-ha | ONOSFW | |
++-------------------------+------------+-----------------+