summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorakhilbatra898 <akhil.batra@research.iiit.ac.in>2017-09-15 22:33:29 +0530
committerYujun Zhang <zhang.yujunz@zte.com.cn>2017-09-22 00:59:06 +0000
commit6a67e65307ab58748228c9cc83f2cc0a452ed8ee (patch)
tree7a6e45497ebb364b02207c56cb0af2e962bdc122
parent3d3a0daa625c17d20f746c056930a00e6278a2f8 (diff)
Add user and config guide for web portal
Change-Id: I3acb8710d2f71265b40092f3f1917a133a063577 Signed-off-by: akhilbatra898 <akhil.batra@research.iiit.ac.in> (cherry picked from commit 872329e68475f573295ac497eb648a21dc1e526b)
-rw-r--r--docs/testing/user/configguide/index.rst1
-rw-r--r--docs/testing/user/configguide/web.rst74
-rw-r--r--docs/testing/user/userguide/index.rst1
-rw-r--r--docs/testing/user/userguide/web.rst70
4 files changed, 146 insertions, 0 deletions
diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst
index 43c32cab..ce733666 100644
--- a/docs/testing/user/configguide/index.rst
+++ b/docs/testing/user/configguide/index.rst
@@ -12,3 +12,4 @@ QTIP Installation & Configuration
:maxdepth: 2
./configuration.rst
+ ./web.rst
diff --git a/docs/testing/user/configguide/web.rst b/docs/testing/user/configguide/web.rst
new file mode 100644
index 00000000..83365abe
--- /dev/null
+++ b/docs/testing/user/configguide/web.rst
@@ -0,0 +1,74 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+***************************************
+Web Portal installation & configuration
+***************************************
+
+Web Portal for Benchmarking is developed on python `Django`_ Framework. Right now the installation
+is need to be done from source.
+
+
+
+Clone QTIP Repo
+===============
+
+::
+
+ git clone https://github.com/opnfv/qtip.git
+
+
+Setup database and Initialize user data
+=======================================
+
+CD into `web` directory.
+------------------------
+
+::
+
+ cd qtip/qtip/web
+
+
+Setup migrations
+----------------
+
+::
+
+ python manage.py makemigrations
+
+
+In usual case migrations will be already available with source. Console willll notify you
+of the same.
+
+Run migrations
+--------------
+
+::
+
+ python manage.py migrate
+
+
+Create superuser
+----------------
+::
+
+ python manage.py createsuperuser
+
+
+Console will prompt for adding new web admin. Enter new credentials.
+
+
+
+Collecting Static Dependencies
+------------------------------
+::
+
+ python manage.py importstatic
+
+
+This will import js and css dependencies for UI in static directory. Now the web application is
+ready to run.
+
+
+.. _Django: https://docs.djangoproject.com/en/1.11/
diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst
index e6eaea59..8cbb43c2 100644
--- a/docs/testing/user/userguide/index.rst
+++ b/docs/testing/user/userguide/index.rst
@@ -15,4 +15,5 @@ QTIP User Guide
getting-started.rst
cli.rst
api.rst
+ web.rst
compute.rst
diff --git a/docs/testing/user/userguide/web.rst b/docs/testing/user/userguide/web.rst
new file mode 100644
index 00000000..79f180d9
--- /dev/null
+++ b/docs/testing/user/userguide/web.rst
@@ -0,0 +1,70 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+**********************
+Web Portal User Manual
+**********************
+
+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.
+QTIP benchmarking tasks are built upon `Ansible`_ playbooks and roles.
+QTIP web portal is a platform to expose QTIP as a benchmarking service hosted on a central host.
+
+
+Running
+=======
+
+After setting up the web portal as instructed in config guide, cd into the `web` directory.
+
+and run.
+
+::
+
+ python manage.py runserver 0.0.0.0
+
+
+You can access the portal by logging onto `<host>:8000/bench/login/`
+
+If you want to use port 80, you may need sudo permission.
+
+::
+
+ sudo python manage.py runserver 0.0.0.0:80
+
+To Deploy on `wsgi`_, Use the Django `deployment tutorial`_
+
+
+Features
+========
+
+After logging in You'll be redirect to QTIP-Web Dashboard. You'll see following menus on left.
+
+ * Repos
+ * Run Benchmarks
+ * Tasks
+
+Repo
+----
+
+ Repos are links to qtip `workspaces`_. This menu list all the aded repos. Links to new repos
+ can be added here.
+
+Run Benchmarks
+--------------
+
+ To run a benchmark, select the corresponding repo and run. QTIP Benchmarking service will clone
+ the workspace and run the benchmarks. Inventories used are predefined in the workspace repo in the `/hosts/` config file.
+
+Tasks
+-----
+
+ All running or completed benchmark jobs can be seen in Tasks menu with their status.
+
+
+*New users can be added by Admin on the Django Admin app by logging into `/admin/'.*
+
+.. _Ansible: https://www.ansible.com/
+.. _wsgi: https://wsgi.readthedocs.io/en/latest/what.html
+.. _deployment tutorial: https://docs.djangoproject.com/en/1.11/howto/deployment/wsgi/
+.. _workspaces: https://github.com/opnfv/qtip/blob/master/docs/testing/developer/devguide/ansible.rst#create-workspace