aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTaseer Ahmed <taseer94@gmail.com>2017-05-18 16:43:58 +0500
committerTaseer Ahmed <taseer94@gmail.com>2017-05-25 08:35:26 +0500
commitbdf3742587870f2ee6f4d78463cea6950491cca0 (patch)
tree02a5e9220ddb23acac668176220d44982727b253 /docs
parent73b0a82bdff1c53846c8cd99475ba3a58b0fdca4 (diff)
Update documentation.
- Breifly describe architecture - Describe launch/kill ssh-agent Change-Id: I9e4226c3de8935894564044e0ab8a723753ed9b3 Signed-off-by: Taseer Ahmed <taseer94@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/testing/user/userguide/getting-started.rst60
-rw-r--r--docs/testing/user/userguide/index.rst1
2 files changed, 61 insertions, 0 deletions
diff --git a/docs/testing/user/userguide/getting-started.rst b/docs/testing/user/userguide/getting-started.rst
new file mode 100644
index 00000000..8289a9c2
--- /dev/null
+++ b/docs/testing/user/userguide/getting-started.rst
@@ -0,0 +1,60 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+*************************
+Getting started with QTIP
+*************************
+
+Overview
+========
+
+Create a new project to hold the neccessary configurations and test results
+::
+
+ qtip create <project_name>
+
+The user would be prompted for OPNFV installer, its hostname etc
+::
+
+ **Pod Name [unknown]: zte-pod1**
+ User's choice to name OPNFV Pod
+
+ **OPNFV Installer [manual]: fuel**
+ QTIP currently supports fuel and apex only
+
+ **Installer Hostname [dummy-host]: master**
+ The hostname for the fuel or apex installer node. The same hostname can be added to **~/.ssh/config** file of current user,
+ if there are problems resolving the hostname via interactive input.
+
+ **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).
+::
+
+ cd <project_name>
+ $ qtip setup
+
+QTIP uses `ssh-agent` for authentication. It is critical that it started and stopped in the correct way.
+
+
+ssh-agent
+=========
+
+ssh-agent is used to hold the private keys for RSA, DCA authentication. In order to start the process
+::
+
+ $ eval $(ssh-agent)
+
+This would start the agent in background. One must now be able to execute QTIP
+::
+
+ $ qtip run
+
+However, if QTIP is not working because of `ssh-agent`, one should kill the process as follows
+::
+
+ $ eval $(ssh-agent -k)
+
+Then start the agent again as described above.
diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst
index d0d555f8..9b6ab888 100644
--- a/docs/testing/user/userguide/index.rst
+++ b/docs/testing/user/userguide/index.rst
@@ -15,3 +15,4 @@ QTIP User Guide
cli.rst
api.rst
compute.rst
+ getting-started.rst