24 files changed, 132 insertions, 0 deletions
diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
index 5d045388..3864c451 100644
--- a/docs/release/release-notes/index.rst
+++ b/docs/release/release-notes/index.rst
@@ -1,3 +1,5 @@
+.. _qtip-releasenotes:
+
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) 2015 Dell Inc.
diff --git a/docs/development/design/apidocs/index.rst b/docs/testing/developer/design/apidocs/index.rst
index 241a2680..241a2680 100644
--- a/docs/development/design/apidocs/index.rst
+++ b/docs/testing/developer/design/apidocs/index.rst
diff --git a/docs/development/design/apidocs/qtip_restful_api.rst b/docs/testing/developer/design/apidocs/qtip_restful_api.rst
index 06c01292..06c01292 100644
--- a/docs/development/design/apidocs/qtip_restful_api.rst
+++ b/docs/testing/developer/design/apidocs/qtip_restful_api.rst
diff --git a/docs/testing/developer/design/cli.rst b/docs/testing/developer/design/cli.rst
new file mode 100644
index 00000000..72d1fbaf
--- /dev/null
+++ b/docs/testing/developer/design/cli.rst
@@ -0,0 +1,92 @@
+***************************
+QTIP Command Line Interface
+***************************
+
+Abstract
+########
+
+QTIP consists of different tools(metrics) to benchmark the NFVI. These metrics fall under different NFVI
+subsystems(QPI's) such as compute, storage and network. A plan consists of one or more QPI's, depending upon how
+the end user would want to measure performance. CLI is designed to help the user, execute benchmarks and
+view respective scores.
+
+Framework
+=========
+
+QTIP CLI has been created using the Python package `Click`_, Command Line Interface Creation Kit. It has been
+chosen for number of reasons. It presents the user with a very simple yet powerful API to build complex
+applications. One of the most striking features is command nesting.
+
+As explained, QTIP consists of metrics, QPI's and plans. CLI is designed to provide interface to all
+these components. It is responsible for execution, as well as provide listing and details of each individual
+element making up these components.
+
+Design
+======
+
+CLI's entry point extends Click's built in MultiCommand class object. It provides two methods, which are
+overridden to provide custom configurations.
+
+.. code-block:: python
+
+    class QtipCli(click.MultiCommand):
+
+        def list_commands(self, ctx):
+            rv = []
+            for filename in os.listdir(cmd_folder):
+                if filename.endswith('.py') and \
+                    filename.startswith('cmd_'):
+                    rv.append(filename[4:-3])
+            rv.sort()
+            return rv
+
+        def get_command(self, ctx, name):
+            try:
+                if sys.version_info[0] == 2:
+                    name = name.encode('ascii', 'replace')
+                mod = __import__('qtip.cli.commands.cmd_' + name,
+                                 None, None, ['cli'])
+            except ImportError:
+                return
+            return mod.cli
+
+Commands and subcommands will then be loaded by the ``get_command`` method above.
+
+Extending the Framework
+=======================
+
+Framework can be easily extended, as per the users requirements. One such example can be to override the builtin
+configurations with user defined ones. These can be written in a file, loaded via a Click Context and passed
+through to all the commands.
+
+.. code-block:: python
+
+   class Context:
+
+       def __init__():
+
+           self.config = ConfigParser.ConfigParser()
+           self.config.read('path/to/configuration_file')
+
+       def get_paths():
+
+           paths = self.config.get('section', 'path')
+           return paths
+
+The above example loads configuration from user defined paths, which then need to be provided to the actual
+command definitions.
+
+.. code-block:: python
+
+   from qtip.cli.entry import Context
+
+   pass_context = click.make_pass_decorator(Context, ensure=False)
+
+   @cli.command('list', help='List the Plans')
+   @pass_context
+   def list(ctx):
+       plans = Plan.list_all(ctx.paths())
+       table = utils.table('Plans', plans)
+       click.echo(table)
+
+.. _Click: http://click.pocoo.org/5/
diff --git a/docs/development/design/compute_QPI.rst b/docs/testing/developer/design/compute_QPI.rst
index 2e5aa87c..2e5aa87c 100644
--- a/docs/development/design/compute_QPI.rst
+++ b/docs/testing/developer/design/compute_QPI.rst
diff --git a/docs/development/design/dashboard.rst b/docs/testing/developer/design/dashboard.rst
index 60c4720d..60c4720d 100644
--- a/docs/development/design/dashboard.rst
+++ b/docs/testing/developer/design/dashboard.rst
diff --git a/docs/development/design/index.rst b/docs/testing/developer/design/index.rst
index b6dd0c01..b6dd0c01 100644
--- a/docs/development/design/index.rst
+++ b/docs/testing/developer/design/index.rst
diff --git a/docs/development/design/integration_with_yardstick.rst b/docs/testing/developer/design/integration_with_yardstick.rst
index a8298d6f..a8298d6f 100644
--- a/docs/development/design/integration_with_yardstick.rst
+++ b/docs/testing/developer/design/integration_with_yardstick.rst
diff --git a/docs/development/overview/.gitkeep b/docs/testing/developer/overview/.gitkeep
index e69de29b..e69de29b 100644
--- a/docs/development/overview/.gitkeep
+++ b/docs/testing/developer/overview/.gitkeep
diff --git a/docs/development/requirement/.gitkeep b/docs/testing/developer/requirement/.gitkeep
index e69de29b..e69de29b 100644
--- a/docs/development/requirement/.gitkeep
+++ b/docs/testing/developer/requirement/.gitkeep
diff --git a/docs/release/installation/.gitkeep b/docs/testing/user/.gitkeep
index e69de29b..e69de29b 100644
--- a/docs/release/installation/.gitkeep
+++ b/docs/testing/user/.gitkeep
diff --git a/docs/release/configguide/configuration.rst b/docs/testing/user/configguide/configuration.rst
index 78e96492..78e96492 100644
--- a/docs/release/configguide/configuration.rst
+++ b/docs/testing/user/configguide/configuration.rst
diff --git a/docs/release/configguide/index.rst b/docs/testing/user/configguide/index.rst
index d5e05d63..d5e05d63 100644
--- a/docs/release/configguide/index.rst
+++ b/docs/testing/user/configguide/index.rst
diff --git a/docs/release/scenarios/.gitkeep b/docs/testing/user/installation/.gitkeep
index e69de29b..e69de29b 100644
--- a/docs/release/scenarios/.gitkeep
+++ b/docs/testing/user/installation/.gitkeep
diff --git a/docs/testing/user/scenarios/.gitkeep b/docs/testing/user/scenarios/.gitkeep
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/testing/user/scenarios/.gitkeep
diff --git a/docs/release/userguide/_01-compute.rst b/docs/testing/user/userguide/_01-compute.rst
index 56be5488..56be5488 100644
--- a/docs/release/userguide/_01-compute.rst
+++ b/docs/testing/user/userguide/_01-compute.rst
diff --git a/docs/release/userguide/_02-network.rst b/docs/testing/user/userguide/_02-network.rst
index 00fe5b0a..00fe5b0a 100644
--- a/docs/release/userguide/_02-network.rst
+++ b/docs/testing/user/userguide/_02-network.rst
diff --git a/docs/release/userguide/_03-storage.rst b/docs/testing/user/userguide/_03-storage.rst
index b1490432..b1490432 100644
--- a/docs/release/userguide/_03-storage.rst
+++ b/docs/testing/user/userguide/_03-storage.rst
diff --git a/docs/release/userguide/_testcase_description.rst b/docs/testing/user/userguide/_testcase_description.rst
index d60ca949..d60ca949 100644
--- a/docs/release/userguide/_testcase_description.rst
+++ b/docs/testing/user/userguide/_testcase_description.rst
diff --git a/docs/release/userguide/annex.rst b/docs/testing/user/userguide/annex.rst
index e8bf5555..e8bf5555 100644
--- a/docs/release/userguide/annex.rst
+++ b/docs/testing/user/userguide/annex.rst
diff --git a/docs/release/userguide/benchmark-suites.rst b/docs/testing/user/userguide/benchmark-suites.rst
index 84d1c647..84d1c647 100644
--- a/docs/release/userguide/benchmark-suites.rst
+++ b/docs/testing/user/userguide/benchmark-suites.rst
diff --git a/docs/testing/user/userguide/cli.rst b/docs/testing/user/userguide/cli.rst
new file mode 100644
index 00000000..e18a36f9
--- /dev/null
+++ b/docs/testing/user/userguide/cli.rst
@@ -0,0 +1,38 @@
+**************
+QTIP CLI Usage
+**************
+
+QTIP consists of a number of benchmarking tools or metrics, grouped under QPI's. QPI's map to the different
+components of a NFVI ecosystem, such as compute, network and storage. Depending on the type of application,
+a user may group them under plans.
+
+QTIP CLI provides interface to all of the above the components. A help page provides a list of all the commands
+along with a short description.
+::
+
+  qtip [-h|--help]
+
+Typically a complete plan is executed at the
+target environment. QTIP defaults to a number of sample plans. One may be able to list them using
+::
+
+  qtip plan list
+
+One can also be able to view the details about a specific plan.
+::
+
+  qtip plan show <plan_name>
+
+where *plan_name* is one of those listed from the previous command.
+
+To execute a complete plan
+::
+
+  qtip plan run <plan_name>
+
+Similarly, the same commands can be used for the other two components making up the plans, i.e QPI's and metrics.
+
+Debug option helps identify the error by providing a detailed traceback. It can be enabled as
+::
+
+  qtip [-d|--debug] plan run <plan_name>
diff --git a/docs/release/userguide/index.rst b/docs/testing/user/userguide/index.rst
index 4be3e498..4be3e498 100644
--- a/docs/release/userguide/index.rst
+++ b/docs/testing/user/userguide/index.rst
diff --git a/docs/release/userguide/introduction.rst b/docs/testing/user/userguide/introduction.rst
index 3147f0aa..3147f0aa 100644
--- a/docs/release/userguide/introduction.rst
+++ b/docs/testing/user/userguide/introduction.rst