Adding general component descriptions and information.

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

diff --git a/build-composite.sh b/build-composite.sh
index a87db0b..2303a5b 100755 (executable)
--- a/build-composite.sh
+++ b/build-composite.sh
@@ -30,6 +30,9 @@ get_repo_names() {
     echo "apex"
     echo "promise"
     echo "copper"
+    echo "doctor"
+    echo "vswitchperf"
+    echo "fastpathmetrics"
 }
 
 git_clone() {

diff --git a/docs/configguide/feature-config.rst b/docs/configguide/feature-config.rst
index 1d06502..992f501 100644 (file)
--- a/docs/configguide/feature-config.rst
+++ b/docs/configguide/feature-config.rst
@@ -10,6 +10,7 @@ The following sections describe the configuration options for specific platform
 Further details for each feature are captured in the referred project documentation.
 
 .. include:: ../projects/copper/configguide/configguide.rst
+.. include:: ../projects/doctor/configguide/configguide.rst
 .. include:: ../projects/ipv6/configguide/featureconfig.rst
 .. include:: ../projects/promise/configguide/featureconfig.rst
 .. include:: ../projects/sdnvpn/configguide/configguide.rst

diff --git a/docs/configguide/post-install.rst b/docs/configguide/post-install.rst
index af50393..741905a 100644 (file)
--- a/docs/configguide/post-install.rst
+++ b/docs/configguide/post-install.rst
@@ -9,15 +9,30 @@ Post Configuration Activities
 Once you have deployed and configured your scenario and features you should validate the
 state of the system using the following guides.
 
+Scenario validation activities
+==============================
+
 The following guides provide information on how to validate the installation of you scenario
 based on the tools and test suites available for the installation tool you have selected:
 
-.. include:: ../projects/functest/configguide/configguide.rst
 .. include:: ../projects/ipv6/configguide/postinstall.rst
 .. include:: ../projects/joid/configguide/postinstall.rst
 
+Feature validation activities
+=============================
+
 The following sections provide information on how to validate the features you have
 installed in your scenario:
- 
+
 .. include:: ../projects/copper/configguide/postinstall.rst
 
+Additional testing and validation activities
+============================================
+
+Many of our testing tools can be manually installed to facilitate targeted testing
+of features and capabilities of your scenario.  The following guides provide instruction on
+setting up these testing suites:
+
+.. include:: ../projects/functest/configguide/configguide.rst
+.. include:: ../projects/vswitchperf/configguide/installation.rst
+

diff --git a/docs/userguide/feature-usage.rst b/docs/userguide/feature-usage.rst
index a90038f..8484a7b 100644 (file)
--- a/docs/userguide/feature-usage.rst
+++ b/docs/userguide/feature-usage.rst
@@ -10,7 +10,8 @@ The following sections of the user guide provide feature specific usage guidelin
 Providing users the necessary information to leveraging the features in the platform,
 some operation in this section may refer back to the guides in the general system usage section.
 
-.. include:: ../projects/promise/userguide/userguide.rst
 .. include:: ../projects/copper/userguide/userguide.rst
+.. include:: ../projects/doctor/userguide/userguide.rst
 .. include:: ../projects/ipv6/userguide/userguide.rst
+.. include:: ../projects/promise/userguide/userguide.rst
 

diff --git a/docs/userguide/general-system.rst b/docs/userguide/general-system.rst
index 08d6f19..055e561 100644 (file)
--- a/docs/userguide/general-system.rst
+++ b/docs/userguide/general-system.rst
@@ -14,7 +14,10 @@ this guide will provide direction ot the relevant documentation made available b
 to better help you navigate the OPNFV deployment.
 
 .. include:: ./openstack.rst
+
+Common SDN components
+---------------------
+
 .. include:: ./opendaylight.rst
 .. include:: ./onos.rst
-.. include:: ./ovs.rst
 

diff --git a/docs/userguide/onos.rst b/docs/userguide/onos.rst
index b39478e..f576d85 100644 (file)
--- a/docs/userguide/onos.rst
+++ b/docs/userguide/onos.rst
@@ -5,11 +5,43 @@
 ONOS User Guide
 ===============
 
-Add ONOS specific user guide information here.
-Needs to include OPNFV default ports and addresses and
-references to upstream documentation applicable for an
-OPNFV deployment.
+ONOS is an SDN controller platform developed and released by the
+`ONOS project <https://www.onosproject.org>`_.
+The ONOS controller is installed and configured in OPNFV as the networking
+component of a variety of OPNFV VNFi scenarios.
 
-From the Jumphost VIP:8282
-karaf/karaf
+ONOS runs within a JVM that is installed in OPNFV within a container and
+integrated with OpenStack.  The ONOS instance can be configured through the
+OpenStack Horizon interface, or accessed directly from the OPNFV Jumphost.  The
+Brahmaputra release of OPNFV integrates the latest
+`ONOS 1.4 (EMU) <https://wiki.onosproject.org/display/ONOS/Download+packages+and+tutorial+VMs>`_
+release version.
 
+ONOS references
+---------------
+
+For an overview of the ONOS controller a good reference is the
+`User Guide <https://wiki.onosproject.org/display/ONOS/User's+Guide>`_.  For more detailed information
+about the EMU version of ONOS, documentation is available on the
+`ONOS download page <https://wiki.onosproject.org/display/ONOS/Download+packages+and+tutorial+VMs>`_.
+
+Connecting to the ONOS instance
+-------------------------------
+
+Once you are familiar with the ONOS controller and it's configuration
+you will want to connect to the ONOS instance from the Jumphost.
+To do this you should open a browser on the JumpHost to the following address
+and enter the username and password:
+
+  http://{Controller-VIP}:8282/index.html>
+  username: karaf
+  password: karaf
+
+Other methods of interacting with and configuring the controller, like the REST API
+and CLI are also available in the Brahmaputra deployment, see the
+`ONOS User Guide <https://wiki.onosproject.org/display/ONOS/User's+Guide>`_
+for more information on using those interfaces.
+
+It is important to be aware that when working directly on the ONOS controller
+the OpenStack instance will not always be aware of the changes you are making to the
+networking controller.  This may result in unrecoverable inconsistencies in your deployment.

diff --git a/docs/userguide/opendaylight.rst b/docs/userguide/opendaylight.rst
index dc04308..7171f0c 100644 (file)
--- a/docs/userguide/opendaylight.rst
+++ b/docs/userguide/opendaylight.rst
@@ -5,11 +5,51 @@
 OpenDaylight User Guide
 =======================
 
-Add opendaylight specific user guide information here.
-Needs to include OPNFV default ports and addresses and
-references to upstream documentation applicable for an
-OPNFV deployment.
+OpenDaylight is an SDN controller platform developed and released by the
+`OpenDaylight project <https://www.opendaylight.org/>`_.
+The OpenDaylight controller is installed and configured in OPNFV as the networking
+component of a variety of OPNFV VNFi scenarios using the neutron ODL device driver
+as an integration point toward OpenStack.
 
-From the Jumphost VIP:8181
-admin/admin
+OpenDaylight runs within a JVM that is installed in OPNFV within a container and
+integrated with OpenStack.  The OpenDaylight instance can be configured through the
+OpenStack Horizon interface, or accessed directly from the OPNFV Jumphost.  The
+Brahmaputra release of OPNFV integrates the latest
+`Lithium stable release <https://www.opendaylight.org/downloads/>`_ or when deploying
+an SFC or SDNVPN scenario will integrate a Beryllium release version.
 
+OpenDaylight references
+-----------------------
+
+For an overview of the OpenDaylight controller a good reference is the
+`Getting Started Guide <http://go.linuxfoundation.org/l/6342/2015-06-28/2l76qt/6342/128122/bk_getting_started_guide_20150629.pdf>`_.  For more detailed information
+about using the platform the `OpenDaylight User Guide <http://go.linuxfoundation.org/l/6342/2015-06-28/2l76qw/6342/128126/bk_user_guide_20150629.pdf>`_
+provides a good feature by feature reference.
+
+It is important when working on your Brahmaputra deployment to be aware of the
+configured state of the OpenDaylight controller in the scenario you have deployed,
+installing an SFC scenario will for instance configure the OpenDaylight controller
+with the required SFC Karaf features in the OpenDaylight controller.  Make sure you
+read the installation and configuration guide carefully to understand the state
+of the deployed system.
+
+Connecting to the OpenDaylight instance
+---------------------------------------
+
+Once you are familiar with the OpenDaylight controller and it's configuration
+you will want to connect to the OpenDaylight instance from the Jumphost.
+To do this you should open a browser on the JumpHost to the following address
+and enter the username and password:
+
+  http://{Controller-VIP}:8181/index.html>
+  username: admin
+  password: admin
+
+Other methods of interacting with and configuring the controller, like the REST API
+and CLI are also available in the Brahmaputra deployment, see the
+`OpenDaylight User Guide <http://go.linuxfoundation.org/l/6342/2015-06-28/2l76qw/6342/128126/bk_user_guide_20150629.pdf>`_
+for more information on using those interfaces.
+
+It is important to be aware that when working directly on the OpenDaylight controller
+the OpenStack instance will not always be aware of the changes you are making to the
+networking controller.  This may result in unrecoverable inconsistencies in your deployment.

diff --git a/docs/userguide/openstack.rst b/docs/userguide/openstack.rst
index 09b482e..0026732 100644 (file)
--- a/docs/userguide/openstack.rst
+++ b/docs/userguide/openstack.rst
@@ -2,14 +2,48 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) Christopher Price (Ericsson AB)
 
-OpenStack User Guide
-====================
+Brahmaputra OpenStack User Guide
+================================
 
-Add openstack specific user guide information here.
-Needs to include OPNFV default ports and addresses and
-references to upstream documentation applicable for an
-OPNFV deployment.
+OpenStack is a cloud operating system developed and released by the
+`OpenStack project <https://www.openstack.org>`_.  OpenStack is used in OPNFV for
+controlling pools of compute, storage, and networking resources in a Pharos
+compliant infrastructure.
 
-From the Jumphost VIP:80
-admin/admin
+OpenStack is used in Brahmaputra to manage tenants (known in OpenStack as projects),
+users, services, images, flavours, and quotas across the Pharos infrastructure.
+The OpenStack interface provides the primary interface for an operational Brahmaputra
+deployment and it is from the "horizon console" that an OPNFV user will perform the
+majority of administrative and operational activities on the deployment.
 
+OpenStack references
+--------------------
+
+The `OpenStack user guide <http://docs.openstack.org/user-guide>`_ provides details
+and descriptions of how to configure and interact with the OpenStack deployment.  This
+guide can be used by lab engineers and operators to tune the OpenStack deployment to
+your liking.
+
+Once you have configured OpenStack to your purposes, or the Brahmaputra deployment meets
+your needs as deployed, an operator, or administrator, will find the best guidance for
+working with OpenStack in the
+`OpenStack administration guide <http://docs.openstack.org/user-guide-admin>`_.
+
+Connecting to the OpenStack instance
+------------------------------------
+
+Once familiar with the basic of working with OpenStack you will want to connect to the
+OpenStack instance via the Horizon Console.  The Horizon console provide a Web based GUI
+that will allow you operate the deployment.
+To do this you should open a browser on the JumpHost to the following address
+and enter the username and password:
+
+
+  http://{Controller-VIP}:80/index.html>
+  username: admin
+  password: admin
+
+Other methods of interacting with and configuring OpenStack,, like the REST API
+and CLI are also available in the Brahmaputra deployment, see the
+`OpenStack administration guide <http://docs.openstack.org/user-guide-admin>`_
+for more information on using those interfaces.

diff --git a/docs/userguide/ovs.rst b/docs/userguide/ovs.rst
deleted file mode 100644 (file)
index 7c6f576..0000000
--- a/docs/userguide/ovs.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Christopher Price (Ericsson AB)
-
-OVS User Guide
-==============
-
-Add OVS specific user guide information here.
-Needs to include OPNFV default ports and addresses and
-references to upstream documentation applicable for an
-OPNFV deployment.

diff --git a/docs/userguide/projects-userguide.rst b/docs/userguide/projects-userguide.rst
deleted file mode 100644 (file)
index e82305b..0000000
--- a/docs/userguide/projects-userguide.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Christopher Price (Ericsson AB)
-
-.. include:: ../projects/promise/userguide/userguide.rst
-

diff --git a/docs/userguide/test-usage.rst b/docs/userguide/test-usage.rst
index f7e92fd..aa2ad96 100644 (file)
--- a/docs/userguide/test-usage.rst
+++ b/docs/userguide/test-usage.rst
@@ -14,4 +14,5 @@ test suites and frameworks in the in the Brahmaputra release of OPNFV.
 
 .. include:: ../projects/functest/userguide/description.rst
 .. include:: ../projects/functest/userguide/runfunctest.rst
+.. include:: ../projects/vswitchperf/userguide/quickstart.rst