summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use
diff options
context:
space:
mode:
authorspisarski <s.pisarski@cablelabs.com>2017-11-17 13:11:09 -0700
committerspisarski <s.pisarski@cablelabs.com>2017-11-20 09:50:55 -0700
commit6dd10aa17c12bac0c3c185b15a444a5437563c14 (patch)
treebe09480cfc492d8d82986b154ae401dcaf69f034 /docs/how-to-use
parent0812d4eca28734872a5565afe9288e002721794b (diff)
Refactoring of QoSSettings to extend QoSConfig
QoSSettings and cinder_utils have a runtime cyclical dependency. This patch reduces this dependency and deprecates the QoSSettings class. JIRA: SNAPS-222 Change-Id: I6385717b78db413c496b15b8c4b76ffabe9797c1 Signed-off-by: spisarski <s.pisarski@cablelabs.com>
Diffstat (limited to 'docs/how-to-use')
-rw-r--r--docs/how-to-use/LibraryUsage.rst7
-rw-r--r--docs/how-to-use/UnitTests.rst8
2 files changed, 11 insertions, 4 deletions
diff --git a/docs/how-to-use/LibraryUsage.rst b/docs/how-to-use/LibraryUsage.rst
index 7c82387..d7f3177 100644
--- a/docs/how-to-use/LibraryUsage.rst
+++ b/docs/how-to-use/LibraryUsage.rst
@@ -425,7 +425,7 @@ Create QoS Spec
- Volume Type - snaps.openstack.create\_qos.OpenStackQoS
- - snaps.openstack.create\_qos.QoSSettings
+ - snaps.openstack.qos.QoSConfig
- name - the volume type's name (required)
- consumer - the qos's consumer type of the enum type Consumer (required)
@@ -433,9 +433,10 @@ Create QoS Spec
.. code:: python
- from snaps.openstack.create_qos import QoSSettings, OpenStackQoS
+ from snaps.openstack.qos import QoSConfig
+ from snaps.openstack.create_qos import OpenStackQoS
- qos_settings = QoSSettings(name='stack-name', consumer=Consumer.front-end)
+ qos_settings = QoSConfig(name='stack-name', consumer=Consumer.front-end)
qos_creator = OpenStackQoS(os_creds, vol_type_settings)
qos_creator.create()
diff --git a/docs/how-to-use/UnitTests.rst b/docs/how-to-use/UnitTests.rst
index f46d9ee..bc5515b 100644
--- a/docs/how-to-use/UnitTests.rst
+++ b/docs/how-to-use/UnitTests.rst
@@ -294,11 +294,17 @@ VolumeTypeEncryptionObjectTests
Ensures that all required members are included when constructing a
VolumeTypeEncryption domain object (for Cinder)
+QoSConfigUnitTests
+------------------
+
+Ensures that all required members are included when constructing a
+QoSConfig object
+
QoSSettingsUnitTests
--------------------
Ensures that all required members are included when constructing a
-QoSSettings object
+deprecated QoSSettings object
QoSSpecDomainObjectTests
------------------------