Refactoring of VolumeSettings to extend VolumeConfig

[snaps.git] / docs / how-to-use / LibraryUsage.rst

diff --git a/docs/how-to-use/LibraryUsage.rst b/docs/how-to-use/LibraryUsage.rst
index b5cff12..fc22a3d 100644 (file)
--- a/docs/how-to-use/LibraryUsage.rst
+++ b/docs/how-to-use/LibraryUsage.rst
@@ -363,7 +363,7 @@ Create Router
 
 -  Router - snaps.openstack.create\_router.OpenStackRouter
 
-   -  snaps.openstack.create\_router.RouterSettings
+   -  snaps.openstack.router.RouterConfig
 
       -  name - the router name (required)
       -  project\_name - the name of the project (optional - can only be
@@ -407,9 +407,10 @@ Create Router
 
 .. code:: python
 
-    from snaps.openstack.create_router import RouterSettings, OpenStackRouter
+    from snaps.config.router import RouterConfig
+    from snaps.openstack.create_router import OpenStackRouter
 
-    router_settings = RouterSettings(name='router-name', external_gateway='external')
+    router_settings = RouterConfig(name='router-name', external_gateway='external')
     router_creator = OpenStackRouter(os_creds, router_settings)
     router_creator.create()
 
@@ -424,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)
@@ -432,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()
 
@@ -449,19 +451,20 @@ Create Volume Type
 
 -  Volume Type - snaps.openstack.create\_volume\_type.OpenStackVolumeType
 
-   -  snaps.openstack.create\_volume\_type.VolumeTypeSettings
+   -  snaps.config.volume\_type.VolumeTypeConfig
 
       -  name - the volume type's name (required)
       -  description - the volume type's description (optional)
-      -  encryption - instance or config for VolumeTypeEncryptionSettings (optional)
+      -  encryption - instance or config for VolumeTypeEncryptionConfig (optional)
       -  qos\_spec\_name - name of the QoS Spec to associate (optional)
-      -  public - instance or config for VolumeTypeEncryptionSettings (optional)
+      -  public - instance or config for VolumeTypeEncryptionConfig (optional)
 
 .. code:: python
 
-    from snaps.openstack.create_volume_type import VolumeTypeSettings, OpenStackVolumeType
+    from snaps.config.volume_type import VolumeTypeConfig
+    from snaps.openstack.create_volume_type import OpenStackVolumeType
 
-    vol_type_settings = VolumeTypeSettings(name='stack-name')
+    vol_type_settings = VolumeTypeConfig(name='stack-name')
     vol_type_creator = OpenStackHeatStack(os_creds, vol_type_settings)
     vol_type_creator.create()
 
@@ -476,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)
@@ -490,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()
 
@@ -507,7 +511,7 @@ Create Heat Stack
 
 -  Heat Stack - snaps.openstack.create\_stack.OpenStackHeatStack
 
-   -  snaps.openstack.create\_stack.StackSettings
+   -  snaps.config.stack.StackConfig
 
       -  name - the stack's name (required)
       -  template - the heat template in dict() format (required when
@@ -519,9 +523,10 @@ Create Heat Stack
 
 .. code:: python
 
-    from snaps.openstack.create_stack import StackSettings, OpenStackHeatStack
+    from snaps.config.stack import StackConfig
+    from snaps.openstack.create_stack import OpenStackHeatStack
 
-    stack_settings = StackSettings(name='stack-name', template_path='/tmp/template.yaml')
+    stack_settings = StackConfig(name='stack-name', template_path='/tmp/template.yaml')
     stack_creator = OpenStackHeatStack(os_creds, stack_settings)
     stack_creator.create()