summaryrefslogtreecommitdiffstats
path: root/docs/scenario/featurematrix.rst
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-01-27 09:25:06 +0100
committerChristopher Price <christopher.price@ericsson.com>2016-01-28 12:31:04 +0000
commit00189df66bad2b629bfeda267d540ab10fcd047e (patch)
treee7227f7478a5d244a602d2d1574380f917da85fc /docs/scenario/featurematrix.rst
parent5816766e8a23c6d6dda2730c02d34270c8f7f012 (diff)
Including text and graphic placeholders for the user and config guides. (I like apostrophes'')
This patch contains the introduction and framing text for the user and config guide. Work is required to add the scenario/feature mapping section and information. Change-Id: I71c9fa7cfbac2d0100c743a8855df4a02cc7482c Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
Diffstat (limited to 'docs/scenario/featurematrix.rst')
-rw-r--r--docs/scenario/featurematrix.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/scenario/featurematrix.rst b/docs/scenario/featurematrix.rst
new file mode 100644
index 000000000..5b79028d8
--- /dev/null
+++ b/docs/scenario/featurematrix.rst
@@ -0,0 +1,27 @@
+Each scenario provides a set of platform capabilities and features that it supports. It is
+possible to identify which features are provided by reviewing the scenario name, however
+not all features and capabilities are discernible from the name itself.
+
+Scenario Naming
+^^^^^^^^^^^^^^^
+
+In OPNFV, scenarios are identified by short scenario names. These names follow a scheme that
+identifies the key components and behaviours of the scenario, the rules for scenario naming are as follows:
+
+ os-[controller]-[feature]-[mode]-[option]
+
+For example: *os-nosdn-kvm-noha* provides an OpenStack based deployment using neutron including
+the OPNFV enhanced KVM hypervisor.
+
+The [feature] tag in the scenario name describes the main feature provided by the scenario.
+This scenario may also provide support for advanced fault management features which is not apparent
+in the scenario name. The following section describes the features available in each scenario.
+
+Brahmaputra feature support matrix
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The following table provides an overview of the available scenarios and supported features
+in the Brahmaputra release of OPNFV.
+
+.. image:: ../images/brahmaputrafeaturematrix.jpg
+ :alt: OPNFV Brahmaputra Feature Matrix