summaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/release-notes.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/release/release-notes/release-notes.rst')
-rw-r--r--docs/release/release-notes/release-notes.rst83
1 files changed, 39 insertions, 44 deletions
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 8611171..0303fb4 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 Euphrates 1.0 of StorPerf.
+This document provides the release notes for Iruya 1.0 of StorPerf.
.. contents::
:depth: 3
@@ -17,7 +17,7 @@ Version history
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| 2017-10-06 | Euphrates 1.0 | Mark Beierl | |
+| 2020-01-10 | Iruya 1.0 | Mark Beierl | |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
@@ -25,9 +25,14 @@ Version history
Important notes
----------------
-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.
+Heat stack support is being sunsetted in StorPerf Iruya. Once Kali is released,
+StorPerf will no longer support the following APIs:
+
+/configurations
+/quota
+
+Additionally, the stack_name parameter will no longer be used. This also means
+that all tests must run using IP addresses.
Summary
--------
@@ -36,10 +41,10 @@ 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 (: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.
+This release provides the ability to use existing servers (virtual or physical)
+as the targets for workload execution. All that is required is the IP address
+and the SSH key or username/password for StorPerf to be able to log in and
+start FIO workloads.
Release Data
-------------
@@ -48,16 +53,16 @@ Release Data
| **Project** | StorPerf |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/commit-ID** | storperf/euphrates.1.0 |
+| **Repo/tag** | opnfv-9.0.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | Euphrates base release |
+| **Release designation** | Iruya.9 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | 2017-10-06 |
+| **Release date** | Jan 10, 2020 |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | OPNFV Euphrates release 1.0 |
+| **Purpose of the delivery** | Regular release |
| | |
+--------------------------------------+--------------------------------------+
@@ -67,39 +72,22 @@ Version change
Module version changes
-----------------------
-No changes to any modules.
+All modules have been upgraded to use python3.
Reason for version
===================
+* Timed release schedule
+
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
-
+* STORPERF-268 Allow user to specify list of IP addresses for StorPerf test
Bug Fixes
----------
-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=11227>`_
+None
Deliverables
=============
@@ -108,24 +96,27 @@ Software
---------
- `StorPerf master image <https://hub.docker.com/r/opnfv/storperf-master/>`_
- (tag: x86_64-euphrates.1.0 or aarch64-euphrates.1.0)
+ (tag: x86_64-opnfv-8.0.0 or aarch64-opnfv-8.0.0)
- `StorPerf swaggerui <https://hub.docker.com/r/opnfv/storperf-swaggerui/>`_
- (tag: x86_64-euphrates.1.0 or aarch64-euphrates.1.0)
+ (tag: x86_64-opnfv-8.0.0 or aarch64-opnfv-8.0.0)
- `StorPerf graphite image <https://hub.docker.com/r/opnfv/storperf-graphite/>`_
- (tag: x86_64-euphrates.1.0 or aarch64-euphrates.1.0)
+ (tag: x86_64-opnfv-8.0.0 or aarch64-opnfv-8.0.0)
- `StorPerf reporting image <https://hub.docker.com/r/opnfv/storperf-reporting/>`_
- (tag: x86_64-euphrates.1.0 or aarch64-euphrates.1.0)
+ (tag: x86_64-opnfv-8.0.0 or aarch64-opnfv-8.0.0)
- `StorPerf Http-Frontend image <https://hub.docker.com/r/opnfv/storperf-httpfrontend/>`_
- (tag: x86_64-euphrates.1.0 or aarch64-euphrates.1.0)
+ (tag: x86_64-opnfv-8.0.0 or aarch64-opnfv-8.0.0)
Documentation
--------------
-- `User Guide <http://docs.opnfv.org/en/latest/submodules/storperf/docs/testing/user/index.html>`_
+- :ref:`User Guide <storperf-userguide>`
+
+Note: The quotas and configurations apis are being sunsetted with the next
+release.
Known Limitations, Issues and Workarounds
------------------------------------------
@@ -140,9 +131,13 @@ Known issues
* 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
+* A bug in the linux kernel can prevent Cinder volumes from attaching to VMs
+ using ARM architecture. Specifying the following properties in Glance for
+ the ARM based image will work around this problem. Note: this will cause
+ the device to show up as a SCSI device and therefore will be /dev/sdb instead
+ of /dev/vdb.
+.. code-block:
+ --property hw_disk_bus=scsi --property hw_scsi_model=virtio-scsi
-Test Result
-===========
-- `OPNFV Test Results DB <http://testresults.opnfv.org/reporting/euphrates/storperf/status-apex.html>`_