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