Expose volume & snapshot commands (Block Storage)

kamaki/cli/commands/blockstorage.py

+# Copyright 2014 GRNET S.A. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or
+# without modification, are permitted provided that the following
+# conditions are met:
+#
+#   1. Redistributions of source code must retain the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer.
+#
+#   2. Redistributions in binary form must reproduce the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer in the documentation and/or other materials
+#      provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
+# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# The views and conclusions contained in the software and
+# documentation are those of the authors and should not be
+# interpreted as representing official policies, either expressed
+# or implied, of GRNET S.A.command
+
+from kamaki.cli import command
+from kamaki.cli.command_tree import CommandTree
+from kamaki.cli.commands import (
+    _command_init, errors, addLogSettings, _optional_json)
+from kamaki.clients.cyclades import CycladesBlockStorageClient
+from kamaki.cli import argument
+
+
+volume_cmds = CommandTree('volume', 'Block Storage API volume commands')
+snapshot_cmds = CommandTree('snapshot', 'Block Storage API snapshot commands')
+namespaces = [volume_cmds, snapshot_cmds]
+_commands = namespaces
+
+
+class _BlockStorageInit(_command_init):
+    @errors.generic.all
+    @addLogSettings
+    def _run(self):
+        self.client = self.get_client(CycladesBlockStorageClient, 'volume')
+
+    def main(self):
+        self._run()
+
+
+@command(volume_cmds)
+class volume_list(_BlockStorageInit, _optional_json):
+    """List volumes"""
+
+    arguments = dict(
+        detail=argument.FlagArgument(
+            'show detailed output', ('-l', '--details')),
+    )
+
+    @errors.generic.all
+    def _run(self):
+        self._print(self.client.list_volumes(detail=self['detail']))
+
+    def main(self):
+        super(self.__class__, self)._run()
+        self._run()
+
+
+@command(volume_cmds)
+class volume_info(_BlockStorageInit, _optional_json):
+    """Get details about a volume"""
+
+    @errors.generic.all
+    def _run(self, volume_id):
+        self._print(
+            self.client.get_volume_details(volume_id), self.print_dict)
+
+    def main(self, volume_id):
+        super(self.__class__, self)._run()
+        self._run(volume_id=volume_id)
+
+
+@command(volume_cmds)
+class volume_create(_BlockStorageInit, _optional_json):
+    """Create a new volume"""
+
+    arguments = dict(
+        size=argument.IntArgument('Volume size in GB', '--size'),
+        server_id=argument.ValueArgument(
+            'The server for the new volume', '--server-id'),
+        name=argument.ValueArgument('Display name', '--name'),
+        # src_volume_id=argument.ValueArgument(
+        #     'Associate another volume to the new volume',
+        #     '--source-volume-id'),
+        description=argument.ValueArgument(
+            'Volume description', '--description'),
+        snapshot_id=argument.ValueArgument(
+            'Associate a snapshot to the new volume', '--snapshot-id'),
+        image_id=argument.ValueArgument(
+            'Associate an image to the new volume', '--image-id'),
+        volume_type=argument.ValueArgument('Volume type', '--volume-type'),
+        metadata=argument.KeyValueArgument(
+            'Metadata of key=value form (can be repeated)', '--metadata'),
+        project_id=argument.ValueArgument(
+            'Assign volume to a project', '--project-id'),
+    )
+    required = ('size', 'server_id', 'name')
+
+    @errors.generic.all
+    def _run(self, size, server_id, name):
+        self._print(
+            self.client.create_volume(
+                size, server_id, name,
+                # source_volid=self['src_volume_id'],
+                display_description=self['description'],
+                snapshot_id=self['snapshot_id'],
+                imageRef=self['image_id'],
+                volume_type=self['volume_type'],
+                metadata=self['metadata'],
+                project=self['project_id']),
+            self.print_dict)
+
+    def main(self):
+        super(self.__class__, self)._run()
+        self._run(
+            size=self['size'], server_id=self['server_id'], name=self['name'])
+
+
+@command(volume_cmds)
+class volume_modify(_BlockStorageInit, _optional_json):
+    """Modify a volumes' properties"""
+
+    arguments = dict(
+        name=argument.ValueArgument('Rename', '--name'),
+        description=argument.ValueArgument('New description', '--description'),
+        delete_on_termination=argument.BooleanArgument(
+            'Delete on termination', '--delete-on-termination'))
+    required = ['name', 'description', 'delete_on_termination']
+
+    @errors.generic.all
+    def _run(self, volume_id):
+        self._print(
+            self.client.update_volume(
+                volume_id,
+                display_name=self['name'],
+                display_description=self['description'],
+                delete_on_termination=self['delete_on_termination']),
+            self.print_dict)
+
+    def main(self, volume_id):
+        super(self.__class__, self)._run()
+        self._run(volume_id)
+
+
+@command(volume_cmds)
+class volume_reassign(_BlockStorageInit):
+    """Reassign volume to a different project"""
+
+    arguments = dict(
+        project_id=argument.ValueArgument('Project to assign', '--project-id'),
+    )
+    required = ('project_id', )
+
+    @errors.generic.all
+    def _run(self, volume_id, project_id):
+        self.client.reassign_volume(volume_id, project_id)
+
+    def main(self, volume_id):
+        super(self.__class__, self)._run()
+        self._run(volume_id=volume_id, project_id=self['project_id'])
+
+
+@command(volume_cmds)
+class volume_delete(_BlockStorageInit):
+    """Delete a volume"""
+
+    @errors.generic.all
+    def _run(self, volume_id):
+        self.client.delete_volume(volume_id)
+
+    def main(self, volume_id):
+        super(self.__class__, self)._run()
+        self._run(volume_id=volume_id)
+
+
+@command(volume_cmds)
+class volume_types(_BlockStorageInit, _optional_json):
+    """List volume types"""
+
+    @errors.generic.all
+    def _run(self):
+        self._print(self.client.list_volume_types())
+
+    def main(self):
+        super(self.__class__, self)._run()
+        self._run()
+
+
+@command(volume_cmds)
+class volume_type(_BlockStorageInit, _optional_json):
+    """Get volume type details"""
+
+    @errors.generic.all
+    def _run(self, volume_type_id):
+        self._print(
+            self.client.get_volume_type_details(volume_type_id),
+            self.print_dict)
+
+    def main(self, volume_type_id):
+        super(self.__class__, self)._run()
+        self._run(volume_type_id=volume_type_id)
+
+
+@command(snapshot_cmds)
+class snapshot_list(_BlockStorageInit, _optional_json):
+    """List snapshots"""
+
+    arguments = dict(
+        detail=argument.FlagArgument(
+            'show detailed output', ('-l', '--details')),
+    )
+
+    @errors.generic.all
+    def _run(self):
+        self._print(self.client.list_snapshots(detail=self['detail']))
+
+    def main(self):
+        super(self.__class__, self)._run()
+        self._run()
+
+
+@command(snapshot_cmds)
+class snapshot_info(_BlockStorageInit, _optional_json):
+    """Get details about a snapshot"""
+
+    @errors.generic.all
+    def _run(self, snapshot_id):
+        self._print(
+            self.client.get_snapshot_details(snapshot_id), self.print_dict)
+
+    def main(self, snapshot_id):
+        super(self.__class__, self)._run()
+        self._run(snapshot_id=snapshot_id)
+
+
+@command(snapshot_cmds)
+class snapshot_create(_BlockStorageInit, _optional_json):
+    """Create a new snapshot"""
+
+    arguments = dict(
+        volume_id=argument.ValueArgument(
+            'Volume associated to new snapshot', '--volume-id'),
+        name=argument.ValueArgument('Display name', '--name'),
+        force=argument.BooleanArgument('Switch force flag', '--force'),
+        description=argument.ValueArgument('New description', '--description'),
+    )
+    required = ('volume_id', 'name')
+
+    @errors.generic.all
+    def _run(self, volume_id, name):
+        self._print(
+            self.client.create_snapshot(
+                volume_id, name,
+                force=self['force'], display_description=self['description']),
+            self.print_dict)
+
+    def main(self):
+        super(self.__class__, self)._run()
+        self._run(volume_id=self['volume_id'], name=self['name'])
+
+
+@command(snapshot_cmds)
+class snapshot_modify(_BlockStorageInit, _optional_json):
+    """Modify a snapshots' properties"""
+
+    arguments = dict(
+        name=argument.ValueArgument('Rename', '--name'),
+        description=argument.ValueArgument('New description', '--description'),
+    )
+    required = ['name', 'description']
+
+    @errors.generic.all
+    def _run(self, snapshot_id):
+        self._print(
+            self.client.update_snapshot(
+                snapshot_id,
+                display_name=self['name'],
+                display_description=self['description']),
+            self.print_dict)
+
+    def main(self, snapshot_id):
+        super(self.__class__, self)._run()
+        self._run(snapshot_id=snapshot_id)
+
+
+@command(snapshot_cmds)
+class snapshot_delete(_BlockStorageInit):
+    """Delete a snapshot"""
+
+    @errors.generic.all
+    def _run(self, snapshot_id):
+        self.client.delete_snapshot(snapshot_id)
+
+    def main(self, snapshot_id):
+        super(self.__class__, self)._run()
+        self._run(snapshot_id=snapshot_id)

kamaki/cli/config/__init__.py

@@ -94,6 +94,8 @@ DEFAULTS = {
         'subnet_cli': 'network',
         'port_cli': 'network',
         'ip_cli': 'network',
+        'volume_cli': 'blockstorage',
+        'snapshot_cli': 'blockstorage',
         'image_cli': 'image',
         'imagecompute_cli': 'image',
         'config_cli': 'config',