Final edits.
[opnfvdocs.git] / docs / scenario / featurematrix.rst
1 Each scenario provides a set of platform capabilities and features that it supports.  It is
2 possible to identify which features are provided by reviewing the scenario name, however
3 not all features and capabilities are discernible from the name itself.
4
5 Brahmaputra feature support matrix
6 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7
8 The following table provides an overview of the available scenarios and supported features
9 in the Brahmaputra release of OPNFV.
10
11 .. image:: ../images/brahmaputrafeaturematrix.jpg
12    :alt: OPNFV Brahmaputra Feature Matrix
13
14 The table above provides an overview of which scenarios will support certain feature capabilities.
15 The table does not indicate if the feature or scenario has limitations. Refer to the
16 `Configuration Guide <http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/configguide/configoptions.html#opnfv-scenarios>`_
17 for details on the state of each scenario and further information.
18
19 Feature development in the Brahmaputra release often consisted of the development of specific
20 requirements and the further integration and validation of those requirements.  This results in some
21 features only being supported on the platform when a specific scenario, providing the
22 capabilities necessary to run the feature, is deployed.
23
24 Scenario Naming
25 ^^^^^^^^^^^^^^^
26
27 In OPNFV, scenarios are identified by short scenario names.  These names follow a scheme that
28 identifies the key components and behaviours of the scenario, the rules for scenario naming are as follows:
29
30   os-[controller]-[feature]-[mode]-[option]
31
32 For example: *os-nosdn-kvm-noha* provides an OpenStack based deployment using neutron including
33 the OPNFV enhanced KVM hypervisor.
34
35 The [feature] tag in the scenario name describes the main feature provided by the scenario.
36 This scenario may also provide support for features, such as advanced fault management, which are
37 not apparent in the scenario name.
38 The following section describes the features available in each scenario.
39