Merge "Updated results info for os-odl_l2-fdio-noha"
[functest.git] / docs / userguide / introduction.rst
index 8624bee..3e993a9 100644 (file)
@@ -58,7 +58,11 @@ Features and VNF (Virtual Network Functions).
 |             |               |                | See the Rally documents `[3]`_.  |
 +-------------+---------------+----------------+----------------------------------+
 | Controllers | sdn_suites    | odl            | Opendaylight Test suite          |
-|             |               |                | TODO: Find a document reference! |
+|             |               |                | Limited test suite to check the  |
+|             |               |                | basic neutron (Layer 2)          |
+|             |               |                | operations mainly based on       |
+|             |               |                | upstream testcases. See below    |
+|             |               |                | for details                      |
 |             |               +----------------+----------------------------------+
 |             |               | onos           | Test suite of ONOS L2 and L3     |
 |             |               |                | functions.                       |
@@ -77,11 +81,13 @@ Features and VNF (Virtual Network Functions).
 |             |               |                | details.                         |
 |             |               +----------------+----------------------------------+
 |             |               | Doctor         | Doctor platform, as of Colorado  |
-|             |               |                | release, provides the two        |
+|             |               |                | release, provides the three      |
 |             |               |                | features:                        |
 |             |               |                | * Immediate Notification         |
 |             |               |                | * Consistent resource state      |
-|             |               |                | awareness (compute). See the     |
+|             |               |                | awareness for compute host down  |
+|             |               |                | * Valid compute host status      |
+|             |               |                | given to VM owner                |
 |             |               |                | See `Doctor User Guide`_ for     |
 |             |               |                | details                          |
 |             |               +----------------+----------------------------------+
@@ -96,8 +102,39 @@ Features and VNF (Virtual Network Functions).
 |             |               |                | security scan. (Currently        |
 |             |               |                | available only for the Apex      |
 |             |               |                | installer environment)           |
-|             |               |                | TODO: Add document link from     |
-|             |               |                | Luke Hinds; when received.       |
+|             |               +----------------+----------------------------------+
+|             |               | onos-sfc       | SFC testing for onos scenarios   |
+|             |               |                | TODO See for details             |
+|             |               +----------------+----------------------------------+
+|             |               | odl-sfc        | SFC testing for odl scenarios    |
+|             |               |                | TODO See for details             |
+|             |               +----------------+----------------------------------+
+|             |               | domino         | Domino provides TOSCA template   |
+|             |               |                | distribution service for network |
+|             |               |                | service and VNF descriptors      |
+|             |               |                | among MANO components e.g.,      |
+|             |               |                | NFVO, VNFM, VIM, SDN-C, etc.,    |
+|             |               |                | as well as OSS/BSS functions.    |
+|             |               |                | See `Domino User Guide`_ for     |
+|             |               |                | details                          |
+|             |               +----------------+----------------------------------+
+|             |               | Copper         | Copper develops OPNFV platform   |
+|             |               |                | support for policy management,   |
+|             |               |                | using open source projects such  |
+|             |               |                | as OpenStack Congress, focused   |
+|             |               |                | on helping ensure that virtual   |
+|             |               |                | infrastructure and the apps that |
+|             |               |                | execute on it comply with the    |
+|             |               |                | configuration policy intent of   |
+|             |               |                | service providers, developers,   |
+|             |               |                | and end users. See more detail   |
+|             |               |                | in the `Copper User Guide`_.     |
+|             |               +----------------+----------------------------------+
+|             |               | multisites     | Multisites                       |
+|             |               |                | TODO See for details             |
+|             |               +----------------+----------------------------------+
+|             |               | moon           | Security management system       |
+|             |               |                | TODO See for details             |
 +-------------+---------------+----------------+----------------------------------+
 | VNF         | vnf           | vims           | Example of a real VNF deployment |
 |             |               |                | to show the NFV capabilities of  |
@@ -105,7 +142,16 @@ Features and VNF (Virtual Network Functions).
 |             |               |                | Subsytem is a typical Telco test |
 |             |               |                | case, referenced by ETSI.        |
 |             |               |                | It provides a fully functional   |
-|             |               |                | VoIP System,                     |
+|             |               |                | VoIP System                      |
++             +---------------+----------------+----------------------------------+
+|             |               | parser         | Parser is an integration project |
+|             |               |                | which aims to provide            |
+|             |               |                | placement/deployment templates   |
+|             |               |                | translation for OPNFV platform,  |
+|             |               |                | including TOSCA -> HOT, POLICY ->|
+|             |               |                | TOSCA and YANG -> TOSCA.         |
+|             |               |                | See `Parser User Guide`_ for     |
+|             |               |                | details                          |
 +-------------+---------------+----------------+----------------------------------+
 
 
@@ -129,8 +175,8 @@ are integrated from upstream communities or other OPNFV projects. For example,
 OpenStack integration test suite and Functest is in charge of the selection,
 integration and automation of those tests that fit suitably to OPNFV.
 
-The Tempest test suite has been customized but no new test cases have been
-created in OPNFV Functest.
+The Tempest test suite is the default OpenStack smoke test suite but no new test
+cases have been created in OPNFV Functest.
 
 The results produced by the tests run from CI are pushed and collected into a
 NoSQL database. The goal is to populate the database with results from different
@@ -158,24 +204,25 @@ offers a lot of potential combinations:
 Most of the tests are runnable by any combination, but some tests might have
 restrictions imposed by the utilized installers or due to the available
 deployed features. The system uses the environment variables (INSTALLER_IP and
-DEPLOY_SCENARIO) to automatically determine the valid test cases; for each given
+DEPLOY_SCENARIO) to automatically determine the valid test cases, for each given
 environment.
 
 In the Colorado OPNFV System release a convenience Functest CLI utility is also
 introduced to simplify setting up the Functest evironment, management of the
 OpenStack environment (e.g. resource clean-up) and for executing tests.
 The Functest CLI organised the testcase into logical Tiers, which contain in
-turn one or more testcases. The CLI allow execution of a single specified
+turn one or more testcases. The CLI allows execution of a single specified
 testcase, all test cases in a specified Tier, or the special case of execution
 of **ALL** testcases. The Functest CLI is introduced in more detail in the
 section `Executing the functest suites`_ of this document.
 
 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
-.. _`Doctor User Guide`: http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/userguide/featureusage-doctor.html
-.. _`Promise User Guide`: http://artifacts.opnfv.org/promise/brahmaputra/docs/userguide/index.html
+.. _`Copper User Guide`: http://artifacts.opnfv.org/copper/colorado/docs/userguide/index.html
+.. _`Doctor User Guide`: http://artifacts.opnfv.org/doctor/colorado/userguide/index.html
+.. _`Promise User Guide`: http://artifacts.opnfv.org/promise/colorado/docs/userguide/index.html
 .. _`ONOSFW User Guide`: http://artifacts.opnfv.org/onosfw/brahmaputra/docs/userguide/index.html
 .. _`SDNVPN User Guide`: http://artifacts.opnfv.org/sdnvpn/brahmaputra/docs/userguide/featureusage.html
-.. _`Functest Dashboard`: http://testresults.opnfv.org/dashboard/
-
-
+.. _`Domino User Guide`: http://artifacts.opnfv.org/domino/docs/userguide/index.html
+.. _`Parser User Guide`: http://artifacts.opnfv.org/parser/docs/userguide/index.html
+.. _`Functest Dashboard`: http://testresults.opnfv.org/kibana_dashboards/