summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorspisarski <s.pisarski@cablelabs.com>2017-11-16 18:26:13 -0700
committerspisarski <s.pisarski@cablelabs.com>2017-11-20 07:32:31 -0700
commitf9d332f6c67f5e0cb70c1570499996926ffbdf5c (patch)
tree8923eb58594217b45599761280e9659935b48713 /docs
parent4cad4f7d1f53189900f9024fa5478e98a64d3760 (diff)
Refactoring of FlavorSettings to extend FlavorConfig
FlavorSettings and glance_utils have a runtime cyclical dependency. This patch reduces this dependency and deprecates the FlavorSettings class. JIRA: SNAPS-216 Change-Id: Ie9532fcbe16377d4ab608bdacd1982c3c6628fe9 Signed-off-by: spisarski <s.pisarski@cablelabs.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/how-to-use/LibraryUsage.rst7
-rw-r--r--docs/how-to-use/UnitTests.rst12
2 files changed, 13 insertions, 6 deletions
diff --git a/docs/how-to-use/LibraryUsage.rst b/docs/how-to-use/LibraryUsage.rst
index a842be0..c6b40a1 100644
--- a/docs/how-to-use/LibraryUsage.rst
+++ b/docs/how-to-use/LibraryUsage.rst
@@ -138,7 +138,7 @@ Create Flavor
-------------
- FlavorĀ - snaps.openstack.create\_flavor.OpenStackFlavor
- - snaps.openstack.create\_flavor.FlavorSettings
+ - snaps.config.flavor.FlavorConfig
- name - the flavor name (required)
- flavor\_id - the flavor's string ID (default='auto')
@@ -155,8 +155,9 @@ Create Flavor
.. code:: python
- from snaps.openstack.create_flavor import FlavorSettings, OpenStackFlavor
- flavor_settings = FlavorSettings(name='flavor-name', ram=4, disk=10, vcpus=2)
+ from snaps.config.flavor import FlavorConfig
+ from snaps.openstack.create_flavor import OpenStackFlavor
+ flavor_settings = FlavorConfig(name='flavor-name', ram=4, disk=10, vcpus=2)
flavor_creator = OpenStackFlavor(os_creds, flavor_settings)
flavor_creator.create()
diff --git a/docs/how-to-use/UnitTests.rst b/docs/how-to-use/UnitTests.rst
index e6b95ab..398a08e 100644
--- a/docs/how-to-use/UnitTests.rst
+++ b/docs/how-to-use/UnitTests.rst
@@ -78,11 +78,17 @@ ImageDomainObjectTests
Ensures that all required members are included when constructing a
Image domain object
+FlavorConfigUnitTests
+---------------------
+
+Ensures that all required members are included when constructing a
+FlavorConfig object
+
FlavorSettingsUnitTests
-----------------------
Ensures that all required members are included when constructing a
-FlavorSettings object
+deprecated FlavorSettings object
FlavorDomainObjectTests
-----------------------
@@ -310,6 +316,6 @@ snaps.domain.VolumeType object to a
snaps.openstack.create_volume.VolumeSettings object
-Ensures that the settings_utils.py#create_flavor_settings() function properly
+Ensures that the settings_utils.py#create_flavor_config() function properly
maps a snaps.domain.Flavor object correctly to a
-snaps.openstack.create_flavor.FlavorSettings object \ No newline at end of file
+snaps.config.flavor.FlavorConfig object \ No newline at end of file