Update release notes

Updates release notes for Euphrates
* Changes in Sections
* Tags not specified so used euphrates.1.0
* Add details of logs' availability

Change-Id: I6fe021a85aed03d033d34fb83b489ca24dc5950f
JIRA: STORPERF-211
Signed-off-by: Shrenik <shrenik.jain@research.iiit.ac.in>

1 files changed, 61 insertions, 27 deletions

diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 1aea8de..8611171 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -2,7 +2,7 @@
 .. http://creativecommons.org/licenses/by/4.0
 
 
-This document provides the release notes for Danube 3.0 of StorPerf.
+This document provides the release notes for Euphrates 1.0 of StorPerf.
 
 .. contents::
    :depth: 3
@@ -10,7 +10,7 @@ This document provides the release notes for Danube 3.0 of StorPerf.
 
 
 Version history
----------------
+===============
 
 
 +--------------------+--------------------+--------------------+--------------------+
@@ -23,24 +23,26 @@ Version history
 
 
 Important notes
-===============
-This is the last release where StorPerf is delivered as a single container.  Moving
-forward, StorPerf must be run using docker-compose.
+----------------
+
+This is the release where StorPerf is not delivered as a single container but
+is delivered as a series of networked containers. StorPerf must be run using
+docker-compose.
 
 Summary
-=======
+--------
 
 StorPerf is a standalone framework that uses OpenStack to measure Cinder volume
 performance.  If desired, it can push results to the OPNFV Test Results DB, or
 the embedded Graphite web interface can be used to perform ad hoc queries.
 
 This release changes to docker-compose framework and adds the StorPerf
-reporting module.  It also marks a change from microsecond (us) to nano-second
-precision for all reported latencies.  This is denoted by a change from
-lat.mean to lat_ns.mean for read and write metrics.
+reporting module.  It also marks a change from microsecond (:math:`\mu`\s) to
+nano-second (ns) precision for all reported latencies.  This is denoted by a change
+from lat.mean to lat_ns.mean for read and write metrics.
 
 Release Data
-============
+-------------
 
 +--------------------------------------+--------------------------------------+
 | **Project**                          | StorPerf                             |
@@ -49,7 +51,7 @@ Release Data
 | **Repo/commit-ID**                   | storperf/euphrates.1.0               |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | Danube base release                  |
+| **Release designation**              | Euphrates base release               |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 | **Release date**                     | 2017-10-06                           |
@@ -60,55 +62,87 @@ Release Data
 +--------------------------------------+--------------------------------------+
 
 Version change
---------------
+===============
 
 Module version changes
-^^^^^^^^^^^^^^^^^^^^^^
+-----------------------
 
 No changes to any modules.
 
 Reason for version
-------------------
+===================
 
 Features additions
-^^^^^^^^^^^^^^^^^^
+-------------------
 
 * STORPERF-125 - StorPerf container decomposition
 * STORPERF-141 - Create a series of graphs to support SNIA targers
+* STORPERF-94 - Logs can now be viewed via the API. One has the choice to either view the complete length of logs,
+  or limit himself to just a few lines.
+* STORPERF-193 - Support for ARM: StorPerf images for ARM and x86_64
+  are published on docker hub with the architecture in the image tag.
+* STORPERF-174 - Container base switched to Alpine
+* STORPERF-92 - Allow flavor to be set in stack create
+* STORPERF-178 - Add ability to specify availability zone
+* STORPERF-175 - Support for different agent OS, such as Cirros
+
 
 Bug Fixes
-^^^^^^^^^
+----------
 
-The following minor bugs have been fixed
+The following minor bugs have been fixed:
 
+* STORPERF-56 - Cannot delete stack if create failed
+* STORPERF-180 - No details if stack create failed
+* STORPERF-186 - Duplicate entries for _warm_up with status query
+* STORPERF-197 - FIO 2.2.10 hangs when statically built
+* STORPERF-216 - Incorrect key names posted to testresults DB
 
-See JIRA for full `change log <https://jira.opnfv.org/jira/secure/ReleaseNote.jspa?projectId=11002&version=10714>`_
+
+See JIRA for full `change log <https://jira.opnfv.org/jira/secure/ReleaseNote.jspa?projectId=11002&version=11227>`_
 
 Deliverables
-------------
+=============
 
 Software
-^^^^^^^^
+---------
+
+- `StorPerf master image <https://hub.docker.com/r/opnfv/storperf-master/>`_
+  (tag: x86_64-euphrates.1.0  or aarch64-euphrates.1.0)
 
-- `StorPerf Docker image <https://hub.docker.com/r/opnfv/storperf/tags>`_ (tag: danube.3.0)
+- `StorPerf swaggerui <https://hub.docker.com/r/opnfv/storperf-swaggerui/>`_
+  (tag: x86_64-euphrates.1.0  or aarch64-euphrates.1.0)
+
+- `StorPerf graphite image <https://hub.docker.com/r/opnfv/storperf-graphite/>`_
+  (tag: x86_64-euphrates.1.0  or aarch64-euphrates.1.0)
+
+- `StorPerf reporting image <https://hub.docker.com/r/opnfv/storperf-reporting/>`_
+  (tag: x86_64-euphrates.1.0  or aarch64-euphrates.1.0)
+
+- `StorPerf Http-Frontend image <https://hub.docker.com/r/opnfv/storperf-httpfrontend/>`_
+  (tag: x86_64-euphrates.1.0  or aarch64-euphrates.1.0)
 
 Documentation
-^^^^^^^^^^^^^
+--------------
 
 - `User Guide <http://docs.opnfv.org/en/latest/submodules/storperf/docs/testing/user/index.html>`_
 
 Known Limitations, Issues and Workarounds
-=========================================
+------------------------------------------
 
 Limitations
------------
+============
+
 
-* Does not work with a target OS that requires authentication instead of using init-cloud for generating the ssh key.
 
 Known issues
-------------
-* STORPERF-56 - Cannot delete stack if create failed
+=============
+
+* Cirros target VMs do not always mount Cinder volumes on first boot.  Sometimes
+  a reboot of the VM is required to properly attach the Cinder volume to /dev/vdb
+
 
 Test Result
 ===========
 
+- `OPNFV Test Results DB <http://testresults.opnfv.org/reporting/euphrates/storperf/status-apex.html>`_