493 lines
16 KiB
Python
493 lines
16 KiB
Python
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
#
|
|
|
|
"""Volume V2 Volume action implementations"""
|
|
|
|
import copy
|
|
import logging
|
|
|
|
from osc_lib.cli import parseractions
|
|
from osc_lib.command import command
|
|
from osc_lib import exceptions
|
|
from osc_lib import utils
|
|
import six
|
|
|
|
from openstackclient.i18n import _
|
|
from openstackclient.identity import common as identity_common
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class CreateVolume(command.ShowOne):
|
|
"""Create new volume"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(CreateVolume, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
"name",
|
|
metavar="<name>",
|
|
help=_("Volume name"),
|
|
)
|
|
parser.add_argument(
|
|
"--size",
|
|
metavar="<size>",
|
|
type=int,
|
|
required=True,
|
|
help=_("Volume size in GB"),
|
|
)
|
|
parser.add_argument(
|
|
"--type",
|
|
metavar="<volume-type>",
|
|
help=_("Set the type of volume"),
|
|
)
|
|
parser.add_argument(
|
|
"--image",
|
|
metavar="<image>",
|
|
help=_("Use <image> as source of volume (name or ID)"),
|
|
)
|
|
parser.add_argument(
|
|
"--snapshot",
|
|
metavar="<snapshot>",
|
|
help=_("Use <snapshot> as source of volume (name or ID)"),
|
|
)
|
|
parser.add_argument(
|
|
"--source",
|
|
metavar="<volume>",
|
|
help=_("Volume to clone (name or ID)"),
|
|
)
|
|
parser.add_argument(
|
|
"--description",
|
|
metavar="<description>",
|
|
help=_("Volume description"),
|
|
)
|
|
parser.add_argument(
|
|
'--user',
|
|
metavar='<user>',
|
|
help=_('Specify an alternate user (name or ID)'),
|
|
)
|
|
parser.add_argument(
|
|
'--project',
|
|
metavar='<project>',
|
|
help=_('Specify an alternate project (name or ID)'),
|
|
)
|
|
parser.add_argument(
|
|
"--availability-zone",
|
|
metavar="<availability-zone>",
|
|
help=_("Create volume in <availability-zone>"),
|
|
)
|
|
parser.add_argument(
|
|
"--property",
|
|
metavar="<key=value>",
|
|
action=parseractions.KeyValueAction,
|
|
help=_("Set a property to this volume "
|
|
"(repeat option to set multiple properties)"),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
identity_client = self.app.client_manager.identity
|
|
volume_client = self.app.client_manager.volume
|
|
image_client = self.app.client_manager.image
|
|
|
|
source_volume = None
|
|
if parsed_args.source:
|
|
source_volume = utils.find_resource(
|
|
volume_client.volumes,
|
|
parsed_args.source).id
|
|
|
|
image = None
|
|
if parsed_args.image:
|
|
image = utils.find_resource(
|
|
image_client.images,
|
|
parsed_args.image).id
|
|
|
|
snapshot = None
|
|
if parsed_args.snapshot:
|
|
snapshot = utils.find_resource(
|
|
volume_client.volume_snapshots,
|
|
parsed_args.snapshot).id
|
|
|
|
project = None
|
|
if parsed_args.project:
|
|
project = utils.find_resource(
|
|
identity_client.projects,
|
|
parsed_args.project).id
|
|
|
|
user = None
|
|
if parsed_args.user:
|
|
user = utils.find_resource(
|
|
identity_client.users,
|
|
parsed_args.user).id
|
|
|
|
volume = volume_client.volumes.create(
|
|
size=parsed_args.size,
|
|
snapshot_id=snapshot,
|
|
name=parsed_args.name,
|
|
description=parsed_args.description,
|
|
volume_type=parsed_args.type,
|
|
user_id=user,
|
|
project_id=project,
|
|
availability_zone=parsed_args.availability_zone,
|
|
metadata=parsed_args.property,
|
|
imageRef=image,
|
|
source_volid=source_volume
|
|
)
|
|
# Remove key links from being displayed
|
|
volume._info.update(
|
|
{
|
|
'properties': utils.format_dict(volume._info.pop('metadata')),
|
|
'type': volume._info.pop('volume_type')
|
|
}
|
|
)
|
|
volume._info.pop("links", None)
|
|
return zip(*sorted(six.iteritems(volume._info)))
|
|
|
|
|
|
class DeleteVolume(command.Command):
|
|
"""Delete volume(s)"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(DeleteVolume, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
"volumes",
|
|
metavar="<volume>",
|
|
nargs="+",
|
|
help=_("Volume(s) to delete (name or ID)")
|
|
)
|
|
group = parser.add_mutually_exclusive_group()
|
|
group.add_argument(
|
|
"--force",
|
|
action="store_true",
|
|
help=_("Attempt forced removal of volume(s), regardless of state "
|
|
"(defaults to False)")
|
|
)
|
|
group.add_argument(
|
|
"--purge",
|
|
action="store_true",
|
|
help=_("Remove any snapshots along with volume(s) "
|
|
"(defaults to False)")
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
result = 0
|
|
|
|
for i in parsed_args.volumes:
|
|
try:
|
|
volume_obj = utils.find_resource(
|
|
volume_client.volumes, i)
|
|
if parsed_args.force:
|
|
volume_client.volumes.force_delete(volume_obj.id)
|
|
else:
|
|
volume_client.volumes.delete(volume_obj.id,
|
|
cascade=parsed_args.purge)
|
|
except Exception as e:
|
|
result += 1
|
|
LOG.error(_("Failed to delete volume with "
|
|
"name or ID '%(volume)s': %(e)s"),
|
|
{'volume': i, 'e': e})
|
|
|
|
if result > 0:
|
|
total = len(parsed_args.volumes)
|
|
msg = (_("%(result)s of %(total)s volumes failed "
|
|
"to delete.") % {'result': result, 'total': total})
|
|
raise exceptions.CommandError(msg)
|
|
|
|
|
|
class ListVolume(command.Lister):
|
|
"""List volumes"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(ListVolume, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'--project',
|
|
metavar='<project>',
|
|
help=_('Filter results by project (name or ID) (admin only)')
|
|
)
|
|
identity_common.add_project_domain_option_to_parser(parser)
|
|
parser.add_argument(
|
|
'--user',
|
|
metavar='<user>',
|
|
help=_('Filter results by user (name or ID) (admin only)')
|
|
)
|
|
identity_common.add_user_domain_option_to_parser(parser)
|
|
parser.add_argument(
|
|
'--name',
|
|
metavar='<name>',
|
|
help=_('Filter results by volume name'),
|
|
)
|
|
parser.add_argument(
|
|
'--status',
|
|
metavar='<status>',
|
|
help=_('Filter results by status'),
|
|
)
|
|
parser.add_argument(
|
|
'--all-projects',
|
|
action='store_true',
|
|
default=False,
|
|
help=_('Include all projects (admin only)'),
|
|
)
|
|
parser.add_argument(
|
|
'--long',
|
|
action='store_true',
|
|
default=False,
|
|
help=_('List additional fields in output'),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
|
|
volume_client = self.app.client_manager.volume
|
|
compute_client = self.app.client_manager.compute
|
|
identity_client = self.app.client_manager.identity
|
|
|
|
def _format_attach(attachments):
|
|
"""Return a formatted string of a volume's attached instances
|
|
|
|
:param attachments: a volume.attachments field
|
|
:rtype: a string of formatted instances
|
|
"""
|
|
|
|
msg = ''
|
|
for attachment in attachments:
|
|
server = attachment['server_id']
|
|
if server in server_cache:
|
|
server = server_cache[server].name
|
|
device = attachment['device']
|
|
msg += 'Attached to %s on %s ' % (server, device)
|
|
return msg
|
|
|
|
if parsed_args.long:
|
|
columns = [
|
|
'ID',
|
|
'Name',
|
|
'Status',
|
|
'Size',
|
|
'Volume Type',
|
|
'Bootable',
|
|
'Attachments',
|
|
'Metadata',
|
|
]
|
|
column_headers = copy.deepcopy(columns)
|
|
column_headers[1] = 'Display Name'
|
|
column_headers[4] = 'Type'
|
|
column_headers[6] = 'Attached to'
|
|
column_headers[7] = 'Properties'
|
|
else:
|
|
columns = [
|
|
'ID',
|
|
'Name',
|
|
'Status',
|
|
'Size',
|
|
'Attachments',
|
|
]
|
|
column_headers = copy.deepcopy(columns)
|
|
column_headers[1] = 'Display Name'
|
|
column_headers[4] = 'Attached to'
|
|
|
|
# Cache the server list
|
|
server_cache = {}
|
|
try:
|
|
for s in compute_client.servers.list():
|
|
server_cache[s.id] = s
|
|
except Exception:
|
|
# Just forget it if there's any trouble
|
|
pass
|
|
|
|
project_id = None
|
|
if parsed_args.project:
|
|
project_id = identity_common.find_project(
|
|
identity_client,
|
|
parsed_args.project,
|
|
parsed_args.project_domain)
|
|
|
|
user_id = None
|
|
if parsed_args.user:
|
|
user_id = identity_common.find_user(identity_client,
|
|
parsed_args.user,
|
|
parsed_args.user_domain)
|
|
|
|
search_opts = {
|
|
'all_tenants': parsed_args.all_projects,
|
|
'project_id': project_id,
|
|
'user_id': user_id,
|
|
'display_name': parsed_args.name,
|
|
'status': parsed_args.status,
|
|
}
|
|
|
|
data = volume_client.volumes.list(search_opts=search_opts)
|
|
|
|
return (column_headers,
|
|
(utils.get_item_properties(
|
|
s, columns,
|
|
formatters={'Metadata': utils.format_dict,
|
|
'Attachments': _format_attach},
|
|
) for s in data))
|
|
|
|
|
|
class SetVolume(command.Command):
|
|
"""Set volume properties"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(SetVolume, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'volume',
|
|
metavar='<volume>',
|
|
help=_('Volume to modify (name or ID)'),
|
|
)
|
|
parser.add_argument(
|
|
'--name',
|
|
metavar='<name>',
|
|
help=_('New volume name'),
|
|
)
|
|
parser.add_argument(
|
|
'--size',
|
|
metavar='<size>',
|
|
type=int,
|
|
help=_('Extend volume size in GB'),
|
|
)
|
|
parser.add_argument(
|
|
'--description',
|
|
metavar='<description>',
|
|
help=_('New volume description'),
|
|
)
|
|
parser.add_argument(
|
|
'--property',
|
|
metavar='<key=value>',
|
|
action=parseractions.KeyValueAction,
|
|
help=_('Set a property on this volume '
|
|
'(repeat option to set multiple properties)'),
|
|
)
|
|
parser.add_argument(
|
|
'--image-property',
|
|
metavar='<key=value>',
|
|
action=parseractions.KeyValueAction,
|
|
help=_('Set an image property on this volume '
|
|
'(repeat option to set multiple image properties)'),
|
|
)
|
|
parser.add_argument(
|
|
"--state",
|
|
metavar="<state>",
|
|
choices=['available', 'error', 'creating', 'deleting',
|
|
'in-use', 'attaching', 'detaching', 'error_deleting',
|
|
'maintenance'],
|
|
help=_('New volume state ("available", "error", "creating", '
|
|
'"deleting", "in-use", "attaching", "detaching", '
|
|
'"error_deleting" or "maintenance")'),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
|
|
|
|
if parsed_args.size:
|
|
if volume.status != 'available':
|
|
LOG.error(_("Volume is in %s state, it must be available "
|
|
"before size can be extended"), volume.status)
|
|
return
|
|
if parsed_args.size <= volume.size:
|
|
LOG.error(_("New size must be greater than %s GB"),
|
|
volume.size)
|
|
return
|
|
volume_client.volumes.extend(volume.id, parsed_args.size)
|
|
|
|
if parsed_args.property:
|
|
volume_client.volumes.set_metadata(volume.id, parsed_args.property)
|
|
if parsed_args.image_property:
|
|
volume_client.volumes.set_image_metadata(
|
|
volume.id, parsed_args.image_property)
|
|
if parsed_args.state:
|
|
volume_client.volumes.reset_state(volume.id, parsed_args.state)
|
|
|
|
kwargs = {}
|
|
if parsed_args.name:
|
|
kwargs['display_name'] = parsed_args.name
|
|
if parsed_args.description:
|
|
kwargs['display_description'] = parsed_args.description
|
|
if kwargs:
|
|
volume_client.volumes.update(volume.id, **kwargs)
|
|
|
|
|
|
class ShowVolume(command.ShowOne):
|
|
"""Display volume details"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(ShowVolume, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'volume',
|
|
metavar="<volume-id>",
|
|
help=_("Volume to display (name or ID)")
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
|
|
|
|
# Special mapping for columns to make the output easier to read:
|
|
# 'metadata' --> 'properties'
|
|
# 'volume_type' --> 'type'
|
|
volume._info.update(
|
|
{
|
|
'properties': utils.format_dict(volume._info.pop('metadata')),
|
|
'type': volume._info.pop('volume_type'),
|
|
},
|
|
)
|
|
|
|
# Remove key links from being displayed
|
|
volume._info.pop("links", None)
|
|
return zip(*sorted(six.iteritems(volume._info)))
|
|
|
|
|
|
class UnsetVolume(command.Command):
|
|
"""Unset volume properties"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(UnsetVolume, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'volume',
|
|
metavar='<volume>',
|
|
help=_('Volume to modify (name or ID)'),
|
|
)
|
|
parser.add_argument(
|
|
'--property',
|
|
metavar='<key>',
|
|
action='append',
|
|
help=_('Remove a property from volume '
|
|
'(repeat option to remove multiple properties)'),
|
|
)
|
|
parser.add_argument(
|
|
'--image-property',
|
|
metavar='<key>',
|
|
action='append',
|
|
help=_('Remove an image property from volume '
|
|
'(repeat option to remove multiple image properties)'),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
volume = utils.find_resource(
|
|
volume_client.volumes, parsed_args.volume)
|
|
|
|
if parsed_args.property:
|
|
volume_client.volumes.delete_metadata(
|
|
volume.id, parsed_args.property)
|
|
if parsed_args.image_property:
|
|
volume_client.volumes.delete_image_metadata(
|
|
volume.id, parsed_args.image_property)
|