X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fhow-to-use%2FLibraryUsage.rst;h=fc22a3da9698895e39469c9e9237bb8beef95b2b;hb=1d7f4a18cf4a070570beccbb46303f5822840c41;hp=9518c2b0180e3e9ffb8ecb05d6a783a3fa2d0b61;hpb=b5822ef2be374cd6bf53a60a84f1c8449a90b35a;p=snaps.git diff --git a/docs/how-to-use/LibraryUsage.rst b/docs/how-to-use/LibraryUsage.rst index 9518c2b..fc22a3d 100644 --- a/docs/how-to-use/LibraryUsage.rst +++ b/docs/how-to-use/LibraryUsage.rst @@ -79,7 +79,7 @@ Create User ----------- - User - snaps.openstack.create\_user.OpenStackUser - - snaps.openstack.create\_user.UserSettings + - snaps.openstack.user.UserConfig - name - the username (required) - password - the user's password (required) @@ -94,8 +94,9 @@ Create User .. code:: python - from snaps.openstack.create_user import UserSettings, OpenStackUser - user_settings = UserSettings(name='username', password='password') + from snaps.config.user import UserConfig + from snaps.openstack.create_user import OpenStackUser + user_settings = UserConfig(name='username', password='password') user_creator = OpenStackUser(os_creds, user_settings) user_creator.create() @@ -112,7 +113,7 @@ Create Project -------------- - Project - snaps.openstack.create\_project.OpenStackProject - - snaps.openstack.create\_project.ProjectSettings + - snaps.openstack.project.ProjectConfig - name - the project name (required) - domain - the project's domain (default='default') @@ -123,8 +124,9 @@ Create Project .. code:: python - from snaps.openstack.create_project import ProjectSettings, OpenStackProject - project_settings = ProjectSettings(name='username', password='password') + from snaps.openstack.project import ProjectConfig + from snaps.openstack.create_project import OpenStackProject + project_settings = ProjectConfig(name='username', password='password') project_creator = OpenStackProject(os_creds, project_settings) project_creator.create() @@ -138,7 +140,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 +157,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() @@ -170,7 +173,7 @@ Create Image ------------ - Image - snaps.openstack.create\_image.OpenStackImage - - snaps.openstack.create\_image.ImageSettings + - snaps.config.image.ImageConfig - name - the image name (required) - image\_user - the default image user generally used by @@ -193,9 +196,10 @@ Create Image .. code:: python - from snaps.openstack.create_image import ImageSettings, OpenStackImage - image_settings = ImageSettings(name='image-name', image_user='ubuntu', img_format='qcow2', - url='http://uec-images.ubuntu.com/releases/trusty/14.04/ubuntu-14.04-server-cloudimg-amd64-disk1.img') + from snaps.openstack.create_image import OpenStackImage + from snaps.config.image import ImageConfig + image_settings = ImageConfig(name='image-name', image_user='ubuntu', img_format='qcow2', + url='http://uec-images.ubuntu.com/releases/trusty/14.04/ubuntu-14.04-server-cloudimg-amd64-disk1.img') image_creator = OpenStackImage(os_creds, image_settings) image_creator.create() @@ -209,7 +213,7 @@ Create Keypair -------------- - Keypair - snaps.openstack.create\_keypair.OpenStackKeypair - - snaps.openstack.create\_keypair.KeypairSettings + - snaps.openstack.keypair.KeypairConfig - name - the keypair name (required) - public\_filepath - the file location to where the public key is @@ -225,8 +229,9 @@ Create Keypair .. code:: python - from snaps.openstack.create_keypairs import KeypairSettings, OpenStackKeypair - keypair_settings = KeypairSettings(name='kepair-name', private_filepath='/tmp/priv-kp') + from snaps.openstack.keypair.KeypairConfig + from snaps.openstack.create_keypairs import OpenStackKeypair + keypair_settings = KeypairConfig(name='kepair-name', private_filepath='/tmp/priv-kp') keypair_creator = OpenStackKeypair(os_creds, keypair_settings) keypair_creator.create() @@ -358,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 @@ -402,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() @@ -419,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) @@ -427,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() @@ -444,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() @@ -471,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) @@ -485,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() @@ -502,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 @@ -514,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() @@ -571,10 +581,10 @@ Create VM Instance - userdata - the cloud-init script to execute after VM has been started - - image\_settings - see snaps.openstack.create\_image.ImageSettings + - image\_settings - see snaps.config.image.ImageConfig above (required) - keypair\_settings - see - snaps.openstack.create\_keypairs.KeypairSettings above (optional) + snaps.openstack.keypair.KeypairConfig above (optional) .. code:: python