docs/configurationguide/scenariomatrix.rst

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