docs/development/scenario/scenariomatrix.rst

   1 Scenarios are implemented as deployable compositions through integration with an installation tool.
   2 OPNFV supports multiple installation tools and for any given release not all tools will support all
   3 scenarios. While our target is to establish parity across the installation tools to ensure they
   4 can provide all scenarios, the practical challenge of achieving that goal for any given feature and
   5 release results in some disparity.
   6
   7 Brahmaputra scenario overeview
   8 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   9
  10 The following table provides an overview of the installation tools and available scenario's
  11 in the Brahmaputra release of OPNFV.
  12
  13 .. image:: ../images/brahmaputrascenariomatrix.jpg
  14    :alt: OPNFV Brahmaputra Scenario Matrix
  15
  16 Scenario status is indicated by a weather pattern icon. All scenarios listed with
  17 a weather pattern are possible to deploy and run in your environment or a Pharos lab,
  18 however they may have known limitations or issues as indicated by the icon.
  19
  20 Weather pattern icon legend:
  21
  22 +---------------------------------------------+----------------------------------------------------------+
  23 | Weather Icon                                | Scenario Status                                          |
  24 +=============================================+==========================================================+
  25 | .. image:: ../images/weather-clear.jpg      | Stable, no known issues                                  |
  26 +---------------------------------------------+----------------------------------------------------------+
  27 | .. image:: ../images/weather-few-clouds.jpg | Stable, documented limitations                           |
  28 +---------------------------------------------+----------------------------------------------------------+
  29 | .. image:: ../images/weather-overcast.jpg   | Deployable, stability or feature limitations             |
  30 +---------------------------------------------+----------------------------------------------------------+
  31 | .. image:: ../images/weather-dash.jpg       | Not deployed with this installer                         |
  32 +---------------------------------------------+----------------------------------------------------------+
  33
  34 Scenarios that are not yet in a state of "Stable, no known issues" will continue to be stabilised
  35 and updates will be made on the stable/brahmaputra branch. While we intend that all Brahmaputra
  36 scenarios should be stable it is worth checking regularly to see the current status.  Due to
  37 our dependency on upstream communities and code some issues may not be resolved prior to the C release.
  38
  39 Scenario Naming
  40 ^^^^^^^^^^^^^^^
  41
  42 In OPNFV scenarios are identified by short scenario names, these names follow a scheme that
  43 identifies the key components and behaviours of the scenario. The rules for scenario naming are as follows:
  44
  45   os-[controller]-[feature]-[mode]-[option]
  46
  47 Details of the fields are
  48   * os: mandatory
  49
  50     * Refers to the platform type used
  51     * possible value: os (OpenStack)
  52
  53 * [controller]: mandatory
  54
  55     * Refers to the SDN controller integrated in the platform
  56     * example values: nosdn, ocl, odl, onos
  57
  58   * [feature]: mandatory
  59
  60     * Refers to the feature projects supported by the scenario
  61     * example values: nofeature, kvm, ovs, sfc
  62
  63   * [mode]: mandatory
  64
  65     * Refers to the deployment type, which may include for instance high availability
  66     * possible values: ha, noha
  67
  68   * [option]: optional
  69
  70     * Used for the scenarios those do not fit into naming scheme.
  71     * The optional field in the short scenario name should not be included if there is no optional scenario.
  72
  73 Some examples of supported scenario names are:
  74
  75   * os-nosdn-kvm-noha
  76
  77     * This is an OpenStack based deployment using neutron including the OPNFV enhanced KVM hypervisor
  78
  79   * os-onos-nofeature-ha
  80
  81     * This is an OpenStack deployment in high availability mode including ONOS as the SDN controller
  82
  83   * os-odl_l2-sfc
  84
  85     * This is an OpenStack deployment using OpenDaylight and OVS enabled with SFC features
  86
  87 Installing your scenario
  88 ^^^^^^^^^^^^^^^^^^^^^^^^
  89
  90 There are two main methods of deploying your target scenario, one method is to follow this guide which will
  91 walk you through the process of deploying to your hardware using scripts or ISO images, the other method is
  92 to set up a Jenkins slave and connect your infrastructure to the OPNFV Jenkins master.
  93
  94 For the purposes of evaluation and development a number of Brahmaputra scenarios are able to be deployed
  95 virtually to mitigate the requirements on physical infrastructure. Details and instructions on performing
  96 virtual deployments can be found in the installer specific installation instructions.
  97
  98 To set up a Jenkins slave for automated deployment to your lab, refer to the `Jenkins slave connect guide.
  99 <http://artifacts.opnfv.org/brahmaputra.1.0/docs/opnfv-jenkins-slave-connection.brahmaputra.1.0.html>`_
 100