From ef2b60ae1bc4214ef695e4afdcf326a740153b46 Mon Sep 17 00:00:00 2001
From: Pete Fotheringham <pete.fotheringham@codethink.co.uk>
Date: Tue, 2 Dec 2014 13:58:13 +0000
Subject: OpenStack write extension documentation

---
 morphlib/exts/openstack.write      | 34 ++--------------------------------
 morphlib/exts/openstack.write.help | 37 +++++++++++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+), 32 deletions(-)
 create mode 100644 morphlib/exts/openstack.write.help

(limited to 'morphlib')

diff --git a/morphlib/exts/openstack.write b/morphlib/exts/openstack.write
index b1941d3c..faf47f54 100755
--- a/morphlib/exts/openstack.write
+++ b/morphlib/exts/openstack.write
@@ -28,40 +28,11 @@ import morphlib.writeexts
 
 class OpenStackWriteExtension(morphlib.writeexts.WriteExtension):
 
-    '''Configure a raw disk image into an OpenStack host.
-
-    The raw disk image is created during Morph's deployment and the
-    image is deployed in OpenStack using python-glanceclient.
-    
-    The location command line argument is the authentification url
-    of the OpenStack server using the following syntax:
- 
-    http://HOST:PORT/VERSION
-
-    where
-
-    * HOST is the host running OpenStack
-    * PORT is the port which is using OpenStack for authentifications.
-    * VERSION is the authentification version of OpenStack (Only v2.0
-      supported)
-
-    This extension needs in the environment the following variables:
- 
-    * OPENSTACK_USER is the username to use in the deployment.
-    * OPENSTACK_TENANT is the project name to use in the deployment.
-    * OPENSTACK_IMAGENAME is the name of the image to create.
-    * OPENSTACK_PASSWORD is the password of the user.
-        
-
-    The extension will connect to OpenStack using python-glanceclient
-    to configure a raw image.
-    
-    '''
 
     def process_args(self, args):
         if len(args) != 2:
             raise cliapp.AppException('Wrong number of command line args')
-        
+
         temp_root, location = args
 
         os_params = self.get_openstack_parameters()
@@ -69,7 +40,7 @@ class OpenStackWriteExtension(morphlib.writeexts.WriteExtension):
         fd, raw_disk = tempfile.mkstemp()
         os.close(fd)
         self.create_local_system(temp_root, raw_disk)
-        self.status(msg='Temporary disk image has been created at %s' 
+        self.status(msg='Temporary disk image has been created at %s'
                     % raw_disk)
 
         self.set_extlinux_root_to_virtio(raw_disk)
@@ -120,4 +91,3 @@ class OpenStackWriteExtension(morphlib.writeexts.WriteExtension):
         self.status(msg='Image configured.')
 
 OpenStackWriteExtension().run()
-
diff --git a/morphlib/exts/openstack.write.help b/morphlib/exts/openstack.write.help
new file mode 100644
index 00000000..579512f5
--- /dev/null
+++ b/morphlib/exts/openstack.write.help
@@ -0,0 +1,37 @@
+help: |
+
+    Deploy a Baserock system as a *new* OpenStack virtual machine.
+    (Use the `ssh-rsync` write extension to deploy upgrades to an *existing*
+    VM)
+
+    Deploys the system to the OpenStack host using python-glanceclient.
+
+    Parameters:
+
+    * location: the authentication url of the OpenStack server using the
+      following syntax:
+
+        http://HOST:PORT/VERSION
+
+        where
+
+        * HOST is the host running OpenStack
+        * PORT is the port which is using OpenStack for authentifications.
+        * VERSION is the authentification version of OpenStack (Only v2.0
+          supported)
+
+    * OPENSTACK_USER=username: the username to use in the `--os-username`
+      argument to `glance`.
+
+    * OPENSTACK_TENANT=tenant: the project name to use in the `--os-tenant-name`
+      argument to `glance`.
+
+    * OPENSTACK_IMAGENAME=imagename: the name of the image to use in the
+      `--name` argument to `glance`.
+
+    * OPENSTACK_PASSWORD=password: the password of the OpenStack user. (We
+      recommend passing this on the command-line, rather than setting an
+      environment variable or storing it in a cluster cluster definition file.)
+
+    (See `morph help deploy` for details of how to pass parameters to write
+    extensions)
-- 
cgit v1.2.1