summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYujun Zhang <zhang.yujunz@zte.com.cn>2017-05-31 05:34:16 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-05-31 05:34:16 +0000
commit10e89733d84e6bdcd8427c34ce4452aa69cf5df0 (patch)
tree7a16baaa15f17e576bcbf498f70e0afc86a794a8
parent0f1847e312fca1366b14946ad9815b1e1d96e7ea (diff)
parent5e1a84abafbbb222e2e032af4891a567a86d6687 (diff)
Merge "Update getting started guide"
-rw-r--r--docs/testing/user/userguide/getting-started.rst60
-rw-r--r--docs/testing/user/userguide/index.rst2
2 files changed, 41 insertions, 21 deletions
diff --git a/docs/testing/user/userguide/getting-started.rst b/docs/testing/user/userguide/getting-started.rst
index 8289a9c2..0f60f13f 100644
--- a/docs/testing/user/userguide/getting-started.rst
+++ b/docs/testing/user/userguide/getting-started.rst
@@ -5,10 +5,29 @@
Getting started with QTIP
*************************
-Overview
-========
+.. code-block::
+
+ pip install qtip
+ eval $(ssh-agent)
+
+ qtip create <project_name>
+ cd <project_name>
+
+ qtip setup
+ qtip run
+ qtip teardown
+
+Installation
+============
+
+Refer to `installation and configuration guide`_ for details
+
+.. _installation and configuration guide:../configguide/
-Create a new project to hold the neccessary configurations and test results
+Create
+======
+
+Create a new project to hold the necessary configurations and test results
::
qtip create <project_name>
@@ -29,32 +48,33 @@ The user would be prompted for OPNFV installer, its hostname etc
**OPNFV Scenario [unknown]: os-nosdn-nofeature-ha**
Depends on the OPNFV scenario deployed
-With the framework generated, user should now proceed on to setting up testing environment. In this step, information related to OPNFV cluster would
-be generated, such as getting the IP addresses of the nodes in System Under Test (SUT).
-::
+Setup
+=====
+
+With the project is created, user should now proceed on to setting up testing environment. In this step, ssh connection
+to hosts in SUT will be configured automatically::
cd <project_name>
$ qtip setup
-QTIP uses `ssh-agent` for authentication. It is critical that it started and stopped in the correct way.
-
+Run
+===
-ssh-agent
-=========
+QTIP uses ``ssh-agent`` for authentication of ssh connection to hosts in SUT. It must be started correctly before
+running the tests::
-ssh-agent is used to hold the private keys for RSA, DCA authentication. In order to start the process
-::
+ eval $(ssh-agent)
- $ eval $(ssh-agent)
+Then run test with ``qtip run``
-This would start the agent in background. One must now be able to execute QTIP
-::
+Teardown
+========
- $ qtip run
+Clean up the temporary folder on target hosts.
-However, if QTIP is not working because of `ssh-agent`, one should kill the process as follows
-::
+.. note:: The installed packages for testing won't be uninstalled.
- $ eval $(ssh-agent -k)
+One more thing
+==============
-Then start the agent again as described above.
+You may use ``-v`` for verbose output (``-vvv`` for more, ``-vvvv`` to enable connection debugging)
diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst
index 9b6ab888..e6eaea59 100644
--- a/docs/testing/user/userguide/index.rst
+++ b/docs/testing/user/userguide/index.rst
@@ -12,7 +12,7 @@ QTIP User Guide
:maxdepth: 2
overview.rst
+ getting-started.rst
cli.rst
api.rst
compute.rst
- getting-started.rst