X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=README.rst;h=5cf4fec00babcde3b17284a6c3a9e29f11745201;hb=bb31e6c8221b854041a668ddca438444fe97d212;hp=049a42677b05417ae1f507eb08497f3a931a4d7b;hpb=2d131cd335b35914133d3dd8d1d8f5741fc38eb0;p=yardstick.git

diff --git a/README.rst b/README.rst
index 049a42677..5cf4fec00 100644
--- a/README.rst
+++ b/README.rst
@@ -1,9 +1,15 @@
-=========
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+
 Yardstick
 =========
 
+
 Overview
-========
+--------
 
 Yardstick is a framework to test non functional characteristics of an NFV
 Infrastructure as perceived by an application.
@@ -14,36 +20,14 @@ the target cloud, for example OpenStack Heat.
 Yardstick measures a certain service performance but can also validate the
 service performance to be within a certain level of agreement.
 
-Yardstick is _not_ about testing OpenStack functionality (tempest) or
-benchmarking OpenStack APIs (rally).
-
-Concepts
-========
-
-Benchmark - assess the relative performance of something
-
-Benchmark configuration file - describes a single test case in yaml format
-
-Context
-- The set of cloud resources used by a benchmark (scenario)
-– Is a simplified Heat template (context is converted into a Heat template)
-
-Data
-- Output produced by running a benchmark, written to a file in json format
-
-Runner
-- Logic that determines how the test is run
-– For example number of iterations, input value stepping, duration etc
+For more information on Yardstick project, please visit:
 
-Scenario
-- Type/class of measurement for example Ping, Pktgen, (Iperf, LmBench, ...)
+    https://wiki.opnfv.org/display/yardstick/Yardstick
+    http://artifacts.opnfv.org/yardstick/docs/userguide/index.html#document-01-introduction
 
-SLA
-- Some limit to be verified (specific to scenario), for example max_latency
-– Associated action to automatically take: assert, monitor etc
 
 Architecture
-============
+------------
 
 Yardstick is a command line tool written in python inspired by Rally. Yardstick
 is intended to run on a computer with access and credentials to a cloud. The
@@ -56,32 +40,25 @@ serially or in parallel. Each runner runs in its own subprocess executing
 commands in a VM using SSH. The output of each command is written as json
 records to a file.
 
-Install
-=======
+For more information on Yardstick architecture, please read:
 
-TBD
+    http://artifacts.opnfv.org/yardstick/docs/userguide/index.html#document-03-architecture
 
-Run
-===
 
-TBD
+Installation
+------------
 
-Custom Image
-============
+Yardstick supports installation on Ubuntu 14.04, OpenSUSE Leap 42.2, 42.3 and
+Tumbleweed or via a Docker image.
 
-pktgen test requires a ubuntu server cloud image
-TBD
+To learn how to install Yardstick, consult the documentation available online
+at:
 
-Development Environment
-=======================
+    http://artifacts.opnfv.org/yardstick/docs/userguide/index.html#document-09-installation
 
-Example setup known to work for development and test:
-- Development environment: Ubuntu14.04, eclipse, virtual environment
-- Cloud: Mirantis OpenStack 6.0 deployed using Virtualbox
 
-Create a virtual environment:
-$ sudo apt-get install python-virtualenv
-$ virtualenv ~/yardstick_venv
-$ source ~/yardstick_venv/bin/activate
-$ python setup.py develop
+Developers
+----------
+For information on how to contribute to Yardstick, please visit:
 
+    https://wiki.opnfv.org/display/yardstick/Get+started+as+a+Yardstick+developer