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 Danube scenario overeview
  16 ^^^^^^^^^^^^^^^^^^^^^^^^^
  17
  18 The following table provides an overview of the installation tools and available scenario's
  19 in the Danube 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/danube branch. While we intend that all Danube
  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 the D 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 follows:
  49
  50 .. code:: bash
  51
  52   os-[controller]-[feature]-[mode]-[option]
  53
  54 Details of the fields are
  55
  56   * **[os]:** mandatory
  57
  58     * Refers to the platform type used
  59     * possible value: os (OpenStack)
  60
  61   * **[controller]:** mandatory
  62
  63     * Refers to the SDN controller integrated in the platform
  64     * example values: nosdn, ocl, odl, onos
  65
  66   * **[feature]:** mandatory
  67
  68     * Refers to the feature projects supported by the scenario
  69     * example values: nofeature, kvm, ovs, sfc
  70
  71   * **[mode]:** mandatory
  72
  73     * Refers to the deployment type, which may include for instance high availability
  74     * possible values: ha, noha
  75
  76   * **[option]:** optional
  77
  78     * Used for the scenarios those do not fit into naming scheme.
  79     * The optional field in the short scenario name should not be included if there is no optional scenario.
  80
  81 Some examples of supported scenario names are:
  82
  83   * **os-nosdn-kvm-noha**
  84
  85     * This is an OpenStack based deployment using neutron including the OPNFV enhanced KVM hypervisor
  86
  87   * **os-onos-nofeature-ha**
  88
  89     * This is an OpenStack deployment in high availability mode including ONOS as the SDN controller
  90
  91   * **os-odl_l2-sfc**
  92
  93     * This is an OpenStack deployment using OpenDaylight and OVS enabled with SFC features
  94
  95   * **os-nosdn-kvm_nfv_ovs_dpdk-ha**
  96
  97     * This is an Openstack deployment with high availability using OVS, DPDK including the OPNFV enhanced KVM hypervisor
  98     * This deployment has ``3-Contoller and 2-Compute nodes``
  99
 100   * **os-nosdn-kvm_nfv_ovs_dpdk-noha**
 101
 102     * This is an Openstack deployment without high availability using OVS, DPDK including the OPNFV enhanced KVM hypervisor
 103     * This deployment has ``1-Contoller and 3-Compute nodes``
 104
 105   * **os-nosdn-kvm_nfv_ovs_dpdk_bar-ha**
 106
 107     * This is an Openstack deployment with high availability using OVS, DPDK including the OPNFV enhanced KVM hypervisor
 108       and Barometer
 109     * This deployment has ``3-Contoller and 2-Compute nodes``
 110
 111   * **os-nosdn-kvm_nfv_ovs_dpdk_bar-noha**
 112
 113     * This is an Openstack deployment without high availability using OVS, DPDK including the OPNFV enhanced KVM hypervisor
 114       and Barometer
 115     * This deployment has ``1-Contoller and 3-Compute nodes``
 116
 117 Installing your scenario
 118 ^^^^^^^^^^^^^^^^^^^^^^^^
 119
 120 There are two main methods of deploying your target scenario, one method is to follow this guide which will
 121 walk you through the process of deploying to your hardware using scripts or ISO images, the other method is
 122 to set up a Jenkins slave and connect your infrastructure to the OPNFV Jenkins master.
 123
 124 For the purposes of evaluation and development a number of Danube scenarios are able to be deployed
 125 virtually to mitigate the requirements on physical infrastructure. Details and instructions on performing
 126 virtual deployments can be found in the installer specific installation instructions.
 127
 128 To set up a Jenkins slave for automated deployment to your lab, refer to the `Jenkins slave connect guide.
 129 <http://artifacts.opnfv.org/brahmaputra.1.0/docs/opnfv-jenkins-slave-connection.brahmaputra.1.0.html>`_