From f2f4384563ad6eadabd4ae787bfd5bc54fe7aa45 Mon Sep 17 00:00:00 2001 From: ghanshyam Date: Thu, 9 Aug 2018 07:13:46 +0000 Subject: [PATCH] Deprecate volume api selection config option Tempest volume tests can be run against v2 or v3 API based on config option ``CONF.volume.catalog_type``. If catalog_type is ``volumev2``, then all the volume tests will run against v2 API. If catalog_type is ``volumev3`` which is default in Tempest, then all the volume tests will run against v3 API. That makes below config option unusable in Tempest which used to select the target volume API for volume tests. * ``CONF.volume-feature-enabled.api_v2`` * ``CONF.volume-feature-enabled.api_v3`` This commit deprecate them and marked for removal in future. Change-Id: Ifed9d9e77e37bb846be724a8d2245f130aae02c7 --- ...ction-config-options-b95c5c0ccbf38916.yaml | 19 +++++++++++++++ tempest/config.py | 23 +++++++++++++++++-- 2 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 releasenotes/notes/deprecate-volume-api-selection-config-options-b95c5c0ccbf38916.yaml diff --git a/releasenotes/notes/deprecate-volume-api-selection-config-options-b95c5c0ccbf38916.yaml b/releasenotes/notes/deprecate-volume-api-selection-config-options-b95c5c0ccbf38916.yaml new file mode 100644 index 0000000000..1bea6d0f6d --- /dev/null +++ b/releasenotes/notes/deprecate-volume-api-selection-config-options-b95c5c0ccbf38916.yaml @@ -0,0 +1,19 @@ +--- +deprecations: + - | + The v2 volume API has been deprecated since Pike release. + Volume v3 API is current and Tempest volume tests can + be run against v2 or v3 API based on config option + ``CONF.volume.catalog_type``. If catalog_type is ``volumev2``, then + all the volume tests will run against v2 API. If catalog_type is + ``volumev3`` which is default in Tempest, then all the volume + tests will run against v3 API. + That makes below config options unusable in Tempest which used to + select the target volume API for volume tests. + + * ``CONF.volume-feature-enabled.api_v2`` + * ``CONF.volume-feature-enabled.api_v3`` + + Tempest deprecate the above two config options in Rocky release + and will be removed in future. Alternatively ``CONF.volume.catalog_type`` + can be used to run the Tempest against volume v2 or v3 API. diff --git a/tempest/config.py b/tempest/config.py index cc0ba34d09..0f3fa54352 100644 --- a/tempest/config.py +++ b/tempest/config.py @@ -845,10 +845,29 @@ VolumeFeaturesGroup = [ "removed."), cfg.BoolOpt('api_v2', default=True, - help="Is the v2 volume API enabled"), + help="Is the v2 volume API enabled", + deprecated_for_removal=True, + deprecated_reason="The v2 volume API has been deprecated " + "since Pike release. Now Tempest run all " + "the volume tests against v2 or v3 API " + "based on CONF.volume.catalog_type which " + "makes this config option unusable. If " + "catalog_type is volumev2, then all the " + "volume tests will run against v2 API. " + "Use ``CONF.volume.catalog_type`` to run " + "the Tempest against volume v2 or v3 API"), cfg.BoolOpt('api_v3', default=True, - help="Is the v3 volume API enabled"), + help="Is the v3 volume API enabled", + deprecated_for_removal=True, + deprecated_reason="Tempest run all the volume tests against " + "v2 or v3 API based on " + "CONF.volume.catalog_type which makes this " + "config option unusable. If catalog_type is " + "volumev3 which is default, then all the " + "volume tests will run against v3 API. " + "Use ``CONF.volume.catalog_type`` to run " + "the Tempest against volume v2 or v3 API"), cfg.BoolOpt('extend_attached_volume', default=False, help='Does the cloud support extending the size of a volume '