diff options
| author |   spisarski <s.pisarski@cablelabs.com> | 2017-11-17 14:54:46 -0700 |
|---|---|---|
| committer | spisarski <s.pisarski@cablelabs.com> | 2017-11-20 10:36:28 -0700 |
| commit | 1d7f4a18cf4a070570beccbb46303f5822840c41 (patch) | |
| tree | a17c6b16bfc508a34b3c5a6e5bca2843efdb4ac2 /docs | |
| parent | 3c387ae1c18c4a80a752c3e5a2409f4a602b9e20 (diff) | |
Refactoring of VolumeSettings to extend VolumeConfig
VolumeSettings and cinder_utils have a runtime cyclical
dependency. This patch reduces this dependency and
deprecates the VolumeSettings class.
JIRA: SNAPS-227
Change-Id: I3f93702ff836af365c811d44bfd0e59b76c3f1f5
Signed-off-by: spisarski <s.pisarski@cablelabs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/how-to-use/LibraryUsage.rst | 7 | ||||
| -rw-r--r-- | docs/how-to-use/UnitTests.rst | 14 |
2 files changed, 14 insertions, 7 deletions
diff --git a/docs/how-to-use/LibraryUsage.rst b/docs/how-to-use/LibraryUsage.rst index 8e2a330..fc22a3d 100644 --- a/docs/how-to-use/LibraryUsage.rst +++ b/docs/how-to-use/LibraryUsage.rst @@ -479,7 +479,7 @@ Create Volume - Volume - snaps.openstack.create\_volume.OpenStackVolume - - snaps.openstack.create\_volume.VolumeSettings + - snaps.config.volume.VolumeConfig - name - the volume type's name (required) - description - the volume type's description (optional) @@ -493,9 +493,10 @@ Create Volume .. code:: python - from snaps.openstack.create\_volume import VolumeSettings, OpenStackVolume + from snaps.config.volume import VolumeConfig + from snaps.openstack.create\_volume import OpenStackVolume - vol_settings = VolumeSettings(name='stack-name') + vol_settings = VolumeConfig(name='stack-name') vol_creator = OpenStackVolume(os_creds, vol_settings) vol_creator.create() diff --git a/docs/how-to-use/UnitTests.rst b/docs/how-to-use/UnitTests.rst index 74404fa..044503e 100644 --- a/docs/how-to-use/UnitTests.rst +++ b/docs/how-to-use/UnitTests.rst @@ -264,11 +264,17 @@ OutputDomainObjectTests Ensures that all required members are included when constructing a Output domain object (for Heat) +VolumeConfigUnitTests +--------------------- + +Ensures that all required members are included when constructing a +VolumeConfig object + VolumeSettingsUnitTests ----------------------- Ensures that all required members are included when constructing a -VolumeSettings object +deprecated VolumeSettings object VolumeDomainObjectTests ----------------------- @@ -351,11 +357,11 @@ VmInst domain object SettingsUtilsUnitTests ---------------------- -Ensures that the settings_utils.py#create_volume_settings() function properly +Ensures that the settings_utils.py#create_volume_config() function properly maps a snaps.domain.Volume object correctly to a -snaps.openstack.create_volume.VolumeSettings object as well as a +snaps.config.volume.VolumeConfig object as well as a snaps.domain.VolumeType object to a -snaps.openstack.create_volume.VolumeSettings object +snaps.config.volume.VolumeConfig object Ensures that the settings_utils.py#create_flavor_config() function properly |