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
This commit is contained in:
ghanshyam 2018-08-09 07:13:46 +00:00 committed by Ghanshyam Mann
parent 127d2970dc
commit f2f4384563
2 changed files with 40 additions and 2 deletions

View File

@ -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.

View File

@ -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 '