Sunset stack support

Adds sunset marker to all stack related calls.

STORPERF-269

Change-Id: I79108104c5bf52d253a52eadf4173e95324ea057
Signed-off-by: Mark Beierl <mbeierl@vmware.com>

3 files changed, 54 insertions, 22 deletions

diff --git a/docker/storperf-master/rest_server.py b/docker/storperf-master/rest_server.py
index 547a0fd..98f1400 100644
--- a/docker/storperf-master/rest_server.py
+++ b/docker/storperf-master/rest_server.py
@@ -17,6 +17,7 @@ from flask_restful import Resource, Api, fields
 from flask_restful_swagger import swagger
 
 from storperf.storperf_master import StorPerfMaster
+import flask
 
 
 class ReverseProxied(object):
@@ -136,7 +137,9 @@ class Configure(Resource):
         self.logger = logging.getLogger(__name__)
 
     @swagger.operation(
-        notes='Fetch the current agent configuration',
+        notes='''Fetch the current agent configuration.
+
+        This API is in sunset until the next OPNFV release.''',
         parameters=[
             {
                 "name": "stack_name",
@@ -154,7 +157,7 @@ class Configure(Resource):
         if stack_name:
             storperf.stack_name = stack_name
 
-        return jsonify({'agent_count': storperf.agent_count,
+        json = jsonify({'agent_count': storperf.agent_count,
                         'agent_flavor': storperf.agent_flavor,
                         'agent_image': storperf.agent_image,
                         'public_network': storperf.public_network,
@@ -167,10 +170,15 @@ class Configure(Resource):
                         'stack_name': storperf.stack_name,
                         'slave_addresses': storperf.slave_addresses,
                         'stack_id': storperf.stack_id})
+        response = flask.make_response(json)
+        response.headers['Sunset'] = "Tue. 31 Mar 2020 23:59:59 GMT"
+        return response
 
     @swagger.operation(
         notes='''Set the current agent configuration and create a stack in
-        the controller.  Returns once the stack create is completed.''',
+        the controller.  Returns once the stack create is completed.
+
+        This API is in sunset until the next OPNFV release.''',
         parameters=[
             {
                 "name": "configuration",
@@ -228,7 +236,9 @@ class Configure(Resource):
             abort(400, str(e))
 
     @swagger.operation(
-        notes='Deletes the agent configuration and the stack',
+        notes='''Deletes the agent configuration and the stack
+
+        This API is in sunset until the next OPNFV release.''',
         parameters=[
             {
                 "name": "stack_name",
@@ -245,7 +255,10 @@ class Configure(Resource):
         if stack_name:
             storperf.stack_name = stack_name
         try:
-            return jsonify({'stack_id': storperf.delete_stack()})
+            json = jsonify({'stack_id': storperf.delete_stack()})
+            response = flask.make_response(json)
+            response.headers['Sunset'] = "Tue. 31 Mar 2020 23:59:59 GMT"
+            return response
         except Exception as e:
             self.logger.exception(e)
             abort(400, str(e))
@@ -354,7 +367,8 @@ for any single test iteration.
 
 "workload":if specified, the workload to run. Defaults to all.
 
-"stack_name": The target stack to use.  Defaults to StorPerfAgentGroup, or
+"stack_name": This field is in sunset until the next OPNVF release.
+The target stack to use.  Defaults to StorPerfAgentGroup, or
 the last stack named.
                 """,
                 "required": True,
@@ -487,7 +501,8 @@ for any single test iteration.
 
 "workloads": A JSON formatted map of workload names and parameters for FIO.
 
-"stack_name": The target stack to use.  Defaults to StorPerfAgentGroup, or
+"stack_name": This field is in sunset until the next OPNFV release.
+The target stack to use.  Defaults to StorPerfAgentGroup, or
 the last stack named.  Explicitly specifying null will bypass all Heat Stack
 operations and go directly against the IP addresses specified.
 
@@ -601,7 +616,8 @@ target is specified, it will default to /dev/vdb
 
 "target": The target device to use.
 
-"stack_name": The target stack to use.  Defaults to StorPerfAgentGroup, or
+"stack_name": This field is in sunset until the next OPNFV release.
+The target stack to use.  Defaults to StorPerfAgentGroup, or
 the last stack named.  Explicitly specifying null will bypass all Heat Stack
 operations and go directly against the IP addresses specified.
 
@@ -716,12 +732,18 @@ class Quota(Resource):
         notes='''Fetch the current Cinder volume quota.  This value limits
         the number of volumes that can be created, and by extension, defines
         the maximum number of agents that can be created for any given test
-        scenario''',
+        scenario
+
+
+        This API is in sunset until the next OPNFV release.''',
         type=QuotaModel.__name__
     )
     def get(self):
-        quota = storperf.volume_quota
-        return jsonify({'quota': quota})
+        quota = []  # storperf.volume_quota
+        # return jsonify({'quota': quota})
+        response = flask.make_response(jsonify({'quota': quota}))
+        response.headers['Sunset'] = "Tue. 31 Mar 2020 23:59:59 GMT"
+        return response
 
 
 def setup_logging(default_path='logging.json',
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 60f0d9d..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 Hunter 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**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 2018-11-09         | Hunter 1.0         | Mark Beierl        |                    |
+| 2020-01-10         | Iruya 1.0          | Mark Beierl        |                    |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
 
@@ -25,8 +25,14 @@ Version history
 Important notes
 ----------------
 
-It is now possible to specify arbitrary IP addresses to StorPerf and not
-require OpenStack or Heat for stack creation.
+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
 --------
@@ -47,16 +53,16 @@ Release Data
 | **Project**                          | StorPerf                             |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | opnfv-8.0.0                          |
+| **Repo/tag**                         | opnfv-9.0.0                          |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | Hunter.8                             |
+| **Release designation**              | Iruya.9                              |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | May 10, 2019                         |
+| **Release date**                     | Jan 10, 2020                         |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          |                                      |
+| **Purpose of the delivery**          | Regular release                      |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
@@ -66,7 +72,7 @@ Version change
 Module version changes
 -----------------------
 
-No changes to any modules.
+All modules have been upgraded to use python3.
 
 Reason for version
 ===================
@@ -76,8 +82,7 @@ Reason for version
 Features additions
 -------------------
 
-* STORPERF-265 Add support for stackless (IP address) runs
-* STORPERF-228 Allow user to specify list of IP addresses for StorPerf test
+* STORPERF-268 Allow user to specify list of IP addresses for StorPerf test
 
 Bug Fixes
 ----------
@@ -110,6 +115,9 @@ Documentation
 
 - :ref:`User Guide <storperf-userguide>`
 
+Note: The quotas and configurations apis are being sunsetted with the next
+release.
+
 Known Limitations, Issues and Workarounds
 ------------------------------------------
 
diff --git a/docs/testing/user/test-usage.rst b/docs/testing/user/test-usage.rst
index 5dfd048..ab59cab 100644
--- a/docs/testing/user/test-usage.rst
+++ b/docs/testing/user/test-usage.rst
@@ -38,6 +38,8 @@ via a Heat Stack, or it can run in stackless mode, where it connects
 directly to the IP addresses supplied, regardless of how the slave
 was created or even if it is an OpenStack VM.
 
+Note: Stack support in StorPerf will be deprecated as of the next release.
+
 Configure The Environment for OpenStack Usage
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~