Bugfix: correct a typo in the yardstick userguide

JIRA: YARDSTICK-374

Also refine the userguide

Change-Id: Iae2af02684ee326abe2a21940e5023b935d4a8da
Signed-off-by: JingLu5 <lvjing5@huawei.com>

1 files changed, 86 insertions, 0 deletions

diff --git a/docs/userguide/10-grafana.rst b/docs/userguide/10-grafana.rst
new file mode 100644
index 000000000..e871a18da
--- /dev/null
+++ b/docs/userguide/10-grafana.rst
@@ -0,0 +1,86 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2016 Huawei Technologies Co.,Ltd and others
+
+=================
+Grafana dashboard
+=================
+
+Abstract
+========
+
+This chapter describes the Yardstick grafana dashboard. The Yardstick grafana
+dashboard can be found here: http://testresults.opnfv.org/grafana/
+
+
+.. image:: images/login.png
+   :width: 800px
+   :alt: Yardstick grafana dashboard
+
+Public access
+=============
+
+Yardstick provids a public account for accessing to the dashboard. The username
+and password are both set to ‘opnfv’.
+
+Testcase dashboard
+==================
+
+For each test case, there is a dedicated dashboard. Shown here is the dashboard
+of TC002.
+
+
+.. image:: images/TC002.png
+   :width: 800px
+   :alt:TC002 dashboard
+
+For each test case dashboard. On the top left, we have a dashboard selection,
+you can switch to different test cases using this pull-down menu.
+
+Underneath, we have a pod and scenario selection.
+All the pods and scenarios that have ever published test data to the Influx DB
+will be shown here.
+
+You can check multiple pods or scenarios.
+
+For each test case, we have a short description and a link to detailed test case information in Yardstick user guide.
+
+Underneath, it is the result presentation section.
+You can use the time period selection on the top right corner to zoom in or zoom out the chart.
+
+Add a dashboard into yardstick grafana
+======================================
+
+Due to security concern, users that using the public opnfv account are not able
+to edit the yardstick grafana directly.It takes a few more steps for a
+non-yardstick user to add a custom dashboard into yardstick grafana.
+
+There are 6 steps to go.
+
+
+.. image:: images/add.png
+   :width: 800px
+   :alt: Add a dashboard into yardstick grafana
+
+
+First, You need to build a local influxdb and grafana, so you can do the work
+locally. You can refer to How to deploy InfluxDB and Grafana locally wiki page
+about how to do this.
+
+Once step one is done, you can fetch the existing grafana dashboard
+configuration file from the yardstick repository and import it to your local
+grafana. After import is done, you grafana dashboard will be ready to use just
+like the community’s dashboard.
+
+The third step is running some test cases to generate test results and
+publishing it to your local influxdb.
+
+Now you have some data to visualize in your dashboard. In the fourth step, it
+is time to create your own dashboard. You can either modify an existing
+dashboard or try to create a new one from scratch.
+
+Either way, once you finish the dashboard, the next step is exporting the
+configuration file and propose a patch into Yardstick. Yardstick team will
+review and merge it into Yardstick repository.
+