please review, updates for release.

Updated scenario matrix for the user guide.
Updated config guide

Change-Id: Ic1e55cacab47521c2428748e00458425c32a11af
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
(cherry picked from commit d4134280f9acbf523454673931155ab4af9b42a0)

diff --git a/build-composite.sh b/build-composite.sh
index 162e0a2..7170490 100755 (executable)
--- a/build-composite.sh
+++ b/build-composite.sh
@@ -35,6 +35,7 @@ get_repo_names() {
     echo "vswitchperf"
     echo "ovsnfv"
     echo "compass4nfv"
+    echo "yardstick"
 }
 
 git_clone() {

diff --git a/docs/configguide/configoptions.rst b/docs/configguide/configoptions.rst
index 720abe2..cb5774a 100644 (file)
--- a/docs/configguide/configoptions.rst
+++ b/docs/configguide/configoptions.rst
@@ -12,7 +12,7 @@ components aimed to solve specific problems for the deployment of VNF's.  A scen
 components such as OpenStack, OpenDaylight, OVS, KVM etc. where each scenario will
 include different source components or configurations.
 
-OPNFV Scenario's
+OPNFV Scenarios
 ================
 
 Each OPNFV scenario provides unique features and capabilities, it is important to understand

diff --git a/docs/configguide/post-install.rst b/docs/configguide/post-install.rst
index 0eca4ba..c7bc27e 100644 (file)
--- a/docs/configguide/post-install.rst
+++ b/docs/configguide/post-install.rst
@@ -17,7 +17,7 @@ based on the tools and test suites available for the installation tool you have
 
 .. toctree::
 
-    postinstall-ipv6
+    postinstall-fuel
 
 .. toctree::
 
@@ -33,6 +33,11 @@ installed in your scenario:
 
     postinstall-copper
 
+.. toctree::
+
+    postinstall-ipv6
+
+
 Additional testing and validation activities
 ============================================
 
@@ -47,3 +52,8 @@ setting up these testing suites:
 .. toctree::
 
     postinstall-vswitchperf
+
+.. toctree::
+
+    postinstall-yardstick
+

diff --git a/docs/configguide/postinstall-fuel.rst b/docs/configguide/postinstall-fuel.rst
new file mode 100644 (file)
index 0000000..877e548
--- /dev/null
+++ b/docs/configguide/postinstall-fuel.rst
@@ -0,0 +1,4 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. include:: ../projects/fuel/configguide/postinstall.rst

diff --git a/docs/configguide/postinstall-yardstick.rst b/docs/configguide/postinstall-yardstick.rst
new file mode 100644 (file)
index 0000000..841b47f
--- /dev/null
+++ b/docs/configguide/postinstall-yardstick.rst
@@ -0,0 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. include:: ../projects/yardstick/userguide/comp-intro.rst
+.. include:: ../projects/yardstick/userguide/03-installation.rst
+

diff --git a/docs/images/brahmaputrafeaturematrix.jpg b/docs/images/brahmaputrafeaturematrix.jpg
index 26d3387..7678fad 100644 (file)
Binary files a/docs/images/brahmaputrafeaturematrix.jpg and b/docs/images/brahmaputrafeaturematrix.jpg differ

diff --git a/docs/images/brahmaputrascenariomatrix.jpg b/docs/images/brahmaputrascenariomatrix.jpg
index d1e6949..84fc87a 100644 (file)
Binary files a/docs/images/brahmaputrascenariomatrix.jpg and b/docs/images/brahmaputrascenariomatrix.jpg differ

diff --git a/docs/images/weather-clear.jpg b/docs/images/weather-clear.jpg
new file mode 100644 (file)
index 0000000..011ad52
Binary files /dev/null and b/docs/images/weather-clear.jpg differ

diff --git a/docs/images/weather-dash.jpg b/docs/images/weather-dash.jpg
new file mode 100644 (file)
index 0000000..3bf98dd
Binary files /dev/null and b/docs/images/weather-dash.jpg differ

diff --git a/docs/images/weather-few-clouds.jpg b/docs/images/weather-few-clouds.jpg
new file mode 100644 (file)
index 0000000..51994ee
Binary files /dev/null and b/docs/images/weather-few-clouds.jpg differ

diff --git a/docs/images/weather-overcast.jpg b/docs/images/weather-overcast.jpg
new file mode 100644 (file)
index 0000000..bdc1e04
Binary files /dev/null and b/docs/images/weather-overcast.jpg differ

diff --git a/docs/scenario/featurematrix.rst b/docs/scenario/featurematrix.rst
index 5b79028..ce8c24b 100644 (file)
--- a/docs/scenario/featurematrix.rst
+++ b/docs/scenario/featurematrix.rst
@@ -2,6 +2,15 @@ Each scenario provides a set of platform capabilities and features that it suppo
 possible to identify which features are provided by reviewing the scenario name, however
 not all features and capabilities are discernible from the name itself.
 
+Brahmaputra feature support matrix
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The following table provides an overview of the available scenarios and supported features
+in the Brahmaputra release of OPNFV.
+
+.. image:: ../images/brahmaputrafeaturematrix.jpg
+   :alt: OPNFV Brahmaputra Feature Matrix
+
 Scenario Naming
 ^^^^^^^^^^^^^^^
 
@@ -17,11 +26,3 @@ The [feature] tag in the scenario name describes the main feature provided by th
 This scenario may also provide support for advanced fault management features which is not apparent
 in the scenario name.  The following section describes the features available in each scenario.
 
-Brahmaputra feature support matrix
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The following table provides an overview of the available scenarios and supported features
-in the Brahmaputra release of OPNFV.
-
-.. image:: ../images/brahmaputrafeaturematrix.jpg
-   :alt: OPNFV Brahmaputra Feature Matrix

diff --git a/docs/scenario/scenariomatrix.rst b/docs/scenario/scenariomatrix.rst
index 1b42e76..64e1150 100644 (file)
--- a/docs/scenario/scenariomatrix.rst
+++ b/docs/scenario/scenariomatrix.rst
@@ -1,6 +1,6 @@
 Scenarios are implemented as deployable compositions through integration with an installation tool.
 OPNFV supports multiple installation tools and for any given release not all tools will support all
-scenarios.  While our target is to establish parity across the installation tools to ensure they
+scenarios. While our target is to establish parity across the installation tools to ensure they
 can provide all scenarios, the practical challenge of achieving that goal for any given feature and
 release results in some disparity.
 
@@ -13,12 +13,34 @@ in the Brahmaputra release of OPNFV.
 .. image:: ../images/brahmaputrascenariomatrix.jpg
    :alt: OPNFV Brahmaputra Scenario Matrix
 
+Scenario status is indicated by a weather pattern icon. All scenarios listed with
+a weather pattern are possible to deploy and run in your environment or a Pharos lab,
+however they may have known limitations or issues as indicated by the icon.
+
+Weather pattern icon legend:
+
++---------------------------------------------+----------------------------------------------------------+
+| Weather Icon                                | Scenario Status                                          |
++=============================================+==========================================================+
+| .. image:: ../images/weather-clear.jpg      | Stable, no known issues                                  |
++---------------------------------------------+----------------------------------------------------------+
+| .. image:: ../images/weather-few-clouds.jpg | Stable, documented limitations                           |
++---------------------------------------------+----------------------------------------------------------+
+| .. image:: ../images/weather-overcast.jpg   | Deployable, stability or feature limitations             |
++---------------------------------------------+----------------------------------------------------------+
+| .. image:: ../images/weather-dash.jpg       | Not deployed with this installer                         |
++---------------------------------------------+----------------------------------------------------------+
+
+Scenarios that are not yet in a state of "Stable, no known issues" will continue to be stabilised
+and updates will be made on the stable/brahmaputra branch. While we intend that all Brahmaputra
+scenarios should be stable it is worth checking regularly to see the current status.  Due to
+our dependency on upstream communities and code some issues may not be resolved prior to the C release.
 
 Scenario Naming
 ^^^^^^^^^^^^^^^
 
 In OPNFV scenarios are identified by short scenario names, these names follow a scheme that
-identifies the key components and behaviours of the scenario.  The rules for scenario naming are as follows:
+identifies the key components and behaviours of the scenario. The rules for scenario naming are as follows:
 
   os-[controller]-[feature]-[mode]-[option]
 
@@ -36,7 +58,7 @@ Details of the fields are
   * [feature]: mandatory
 
     * Refers to the feature projects supported by the scenario
-    * example values: nofeature, kvm, ovs
+    * example values: nofeature, kvm, ovs, sfc
 
   * [mode]: mandatory
 
@@ -54,13 +76,13 @@ Some examples of supported scenario names are:
 
     * This is an OpenStack based deployment using neutron including the OPNFV enhanced KVM hypervisor
 
-  * os-odl_l2-nofeature-ha
+  * os-onos-nofeature-ha
 
-    * This is an OpenStack deployment in high availability mode including OpenDaylight layer2 networking
+    * This is an OpenStack deployment in high availability mode including ONOS as the SDN controller
 
-  * os-onos-kvm_ovs-noha
+  * os-odl_l2-sfc
 
-    * This is an OpenStack deployment using ONOS including OPNFV enhanced KVM and OVS versions
+    * This is an OpenStack deployment using OpenDaylight and OVS enabled with SFC features
 
 Installing your scenario
 ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -70,7 +92,7 @@ walk you through the process of deploying to your hardware using scripts or ISO
 to set up a Jenkins slave and connect your infrastructure to the OPNFV Jenkins master.
 
 For the purposes of evaluation and development a number of Brahmaputra scenarios are able to be deployed
-virtually to mitigate the requirements on physical infrastructure.  Details and instructions on performing
+virtually to mitigate the requirements on physical infrastructure. Details and instructions on performing
 virtual deployments can be found in the installer specific installation instructions.
 
 To set up a Jenkins slave for automated deployment to your lab, refer to the `Jenkins slave connect guide.

diff --git a/docs/userguide/test-usage.rst b/docs/userguide/test-usage.rst
index 1cf6dca..423a306 100644 (file)
--- a/docs/userguide/test-usage.rst
+++ b/docs/userguide/test-usage.rst
@@ -2,17 +2,16 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) Christopher Price (Ericsson AB)
 
-.. deprecated for Brahmaputra
+==================================
+Using the test frameworks in OPNFV
+==================================
 
-.. ==================================
-.. Using the test frameworks in OPNFV
-.. ==================================
+Testing is one of the key activities in OPNFV, validation can include component level testing,
+system testing, automated deployment validation and performance characteristics testing.
 
-.. Testing is one of the key activities in OPNFV, validation can include component level testing,
-.. system testing, automated deployment validation and performance charecteristics testing.
-
-.. The following sections outline how to use the test projects delivering automated
-.. test suites and frameworks in the in the Brahmaputra release of OPNFV.
+The following section outlines how to use the test projects that are delivered on the
+OPNFV platform for the purpose of testing components and VNFs in the context of a
+Brahmaputra deployment.
 
 .. <project>/docs/userguide/testusage.rst files will be imported below by the build script.