39c5eb9e3f
Backup commands are used only in volume service now, but "backup" is too generic, users may not know the commands are used for volume from the commands name. By seeing the command name, users can only see the "backup" but do not know which object the backup commands work for. It may confuse users. I think rename "backup" to "volume backup" can depict resource relation and will be helpful for users to know the commands clearly. So add new commands ``volume backup create/delete/ list/show/restore`` to replace the old commands ``backup create/delete/list/show/restore``. And also deprecate old commands. Change-Id: I4f844d9bc48573eb4d17288ce6b8a90cea00d16a Implements: bp backup-snapshot-renamed-for-volume-resource Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com>
319 lines
10 KiB
Python
319 lines
10 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 Backup action implementations"""
|
|
|
|
import copy
|
|
import logging
|
|
|
|
from osc_lib.command import command
|
|
from osc_lib import exceptions
|
|
from osc_lib import utils
|
|
import six
|
|
|
|
from openstackclient.i18n import _
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class CreateVolumeBackup(command.ShowOne):
|
|
"""Create new volume backup"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(CreateVolumeBackup, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
"volume",
|
|
metavar="<volume>",
|
|
help=_("Volume to backup (name or ID)")
|
|
)
|
|
parser.add_argument(
|
|
"--name",
|
|
metavar="<name>",
|
|
help=_("Name of the backup")
|
|
)
|
|
parser.add_argument(
|
|
"--description",
|
|
metavar="<description>",
|
|
help=_("Description of the backup")
|
|
)
|
|
parser.add_argument(
|
|
"--container",
|
|
metavar="<container>",
|
|
help=_("Optional backup container name")
|
|
)
|
|
parser.add_argument(
|
|
"--snapshot",
|
|
metavar="<snapshot>",
|
|
help=_("Snapshot to backup (name or ID)")
|
|
)
|
|
parser.add_argument(
|
|
'--force',
|
|
action='store_true',
|
|
default=False,
|
|
help=_("Allow to back up an in-use volume")
|
|
)
|
|
parser.add_argument(
|
|
'--incremental',
|
|
action='store_true',
|
|
default=False,
|
|
help=_("Perform an incremental backup")
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
volume_id = utils.find_resource(
|
|
volume_client.volumes, parsed_args.volume).id
|
|
snapshot_id = None
|
|
if parsed_args.snapshot:
|
|
snapshot_id = utils.find_resource(
|
|
volume_client.volume_snapshots, parsed_args.snapshot).id
|
|
backup = volume_client.backups.create(
|
|
volume_id,
|
|
container=parsed_args.container,
|
|
name=parsed_args.name,
|
|
description=parsed_args.description,
|
|
force=parsed_args.force,
|
|
incremental=parsed_args.incremental,
|
|
snapshot_id=snapshot_id,
|
|
)
|
|
backup._info.pop("links", None)
|
|
return zip(*sorted(six.iteritems(backup._info)))
|
|
|
|
|
|
class CreateBackup(CreateVolumeBackup):
|
|
"""Create new backup"""
|
|
|
|
# TODO(Huanxuan Ao): Remove this class and ``backup create`` command
|
|
# two cycles after Newton.
|
|
|
|
# This notifies cliff to not display the help for this command
|
|
deprecated = True
|
|
|
|
log = logging.getLogger('deprecated')
|
|
|
|
def take_action(self, parsed_args):
|
|
self.log.warning(_('This command has been deprecated. '
|
|
'Please use "volume backup create" instead.'))
|
|
return super(CreateBackup, self).take_action(parsed_args)
|
|
|
|
|
|
class DeleteVolumeBackup(command.Command):
|
|
"""Delete volume backup(s)"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(DeleteVolumeBackup, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
"backups",
|
|
metavar="<backup>",
|
|
nargs="+",
|
|
help=_("Backup(s) to delete (name or ID)")
|
|
)
|
|
parser.add_argument(
|
|
'--force',
|
|
action='store_true',
|
|
default=False,
|
|
help=_("Allow delete in state other than error or available")
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
result = 0
|
|
|
|
for i in parsed_args.backups:
|
|
try:
|
|
backup_id = utils.find_resource(
|
|
volume_client.backups, i).id
|
|
volume_client.backups.delete(backup_id, parsed_args.force)
|
|
except Exception as e:
|
|
result += 1
|
|
LOG.error(_("Failed to delete backup with "
|
|
"name or ID '%(backup)s': %(e)s")
|
|
% {'backup': i, 'e': e})
|
|
|
|
if result > 0:
|
|
total = len(parsed_args.backups)
|
|
msg = (_("%(result)s of %(total)s backups failed "
|
|
"to delete.") % {'result': result, 'total': total})
|
|
raise exceptions.CommandError(msg)
|
|
|
|
|
|
class DeleteBackup(DeleteVolumeBackup):
|
|
"""Delete backup(s)"""
|
|
|
|
# TODO(Huanxuan Ao): Remove this class and ``backup delete`` command
|
|
# two cycles after Newton.
|
|
|
|
# This notifies cliff to not display the help for this command
|
|
deprecated = True
|
|
|
|
log = logging.getLogger('deprecated')
|
|
|
|
def take_action(self, parsed_args):
|
|
self.log.warning(_('This command has been deprecated. '
|
|
'Please use "volume backup delete" instead.'))
|
|
return super(DeleteBackup, self).take_action(parsed_args)
|
|
|
|
|
|
class ListVolumeBackup(command.Lister):
|
|
"""List volume backups"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(ListVolumeBackup, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
"--long",
|
|
action="store_true",
|
|
default=False,
|
|
help=_("List additional fields in output")
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
|
|
def _format_volume_id(volume_id):
|
|
"""Return a volume name if available
|
|
|
|
:param volume_id: a volume ID
|
|
:rtype: either the volume ID or name
|
|
"""
|
|
|
|
volume = volume_id
|
|
if volume_id in volume_cache.keys():
|
|
volume = volume_cache[volume_id].name
|
|
return volume
|
|
|
|
if parsed_args.long:
|
|
columns = ['ID', 'Name', 'Description', 'Status', 'Size',
|
|
'Availability Zone', 'Volume ID', 'Container']
|
|
column_headers = copy.deepcopy(columns)
|
|
column_headers[6] = 'Volume'
|
|
else:
|
|
columns = ['ID', 'Name', 'Description', 'Status', 'Size']
|
|
column_headers = columns
|
|
|
|
# Cache the volume list
|
|
volume_cache = {}
|
|
try:
|
|
for s in self.app.client_manager.volume.volumes.list():
|
|
volume_cache[s.id] = s
|
|
except Exception:
|
|
# Just forget it if there's any trouble
|
|
pass
|
|
|
|
data = self.app.client_manager.volume.backups.list()
|
|
|
|
return (column_headers,
|
|
(utils.get_item_properties(
|
|
s, columns,
|
|
formatters={'Volume ID': _format_volume_id},
|
|
) for s in data))
|
|
|
|
|
|
class ListBackup(ListVolumeBackup):
|
|
"""List backups"""
|
|
|
|
# TODO(Huanxuan Ao): Remove this class and ``backup list`` command
|
|
# two cycles after Newton.
|
|
|
|
# This notifies cliff to not display the help for this command
|
|
deprecated = True
|
|
|
|
log = logging.getLogger('deprecated')
|
|
|
|
def take_action(self, parsed_args):
|
|
self.log.warning(_('This command has been deprecated. '
|
|
'Please use "volume backup list" instead.'))
|
|
return super(ListBackup, self).take_action(parsed_args)
|
|
|
|
|
|
class RestoreVolumeBackup(command.ShowOne):
|
|
"""Restore volume backup"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(RestoreVolumeBackup, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
"backup",
|
|
metavar="<backup>",
|
|
help=_("Backup to restore (name or ID)")
|
|
)
|
|
parser.add_argument(
|
|
"volume",
|
|
metavar="<volume>",
|
|
help=_("Volume to restore to (name or ID)")
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
backup = utils.find_resource(volume_client.backups, parsed_args.backup)
|
|
destination_volume = utils.find_resource(volume_client.volumes,
|
|
parsed_args.volume)
|
|
return volume_client.restores.restore(backup.id, destination_volume.id)
|
|
|
|
|
|
class RestoreBackup(RestoreVolumeBackup):
|
|
"""Restore backup"""
|
|
|
|
# TODO(Huanxuan Ao): Remove this class and ``backup restore`` command
|
|
# two cycles after Newton.
|
|
|
|
# This notifies cliff to not display the help for this command
|
|
deprecated = True
|
|
|
|
log = logging.getLogger('deprecated')
|
|
|
|
def take_action(self, parsed_args):
|
|
self.log.warning(_('This command has been deprecated. '
|
|
'Please use "volume backup restore" instead.'))
|
|
return super(RestoreBackup, self).take_action(parsed_args)
|
|
|
|
|
|
class ShowVolumeBackup(command.ShowOne):
|
|
"""Display volume backup details"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(ShowVolumeBackup, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
"backup",
|
|
metavar="<backup>",
|
|
help=_("Backup to display (name or ID)")
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
backup = utils.find_resource(volume_client.backups,
|
|
parsed_args.backup)
|
|
backup._info.pop("links", None)
|
|
return zip(*sorted(six.iteritems(backup._info)))
|
|
|
|
|
|
class ShowBackup(ShowVolumeBackup):
|
|
"""Display backup details"""
|
|
|
|
# TODO(Huanxuan Ao): Remove this class and ``backup show`` command
|
|
# two cycles after Newton.
|
|
|
|
# This notifies cliff to not display the help for this command
|
|
deprecated = True
|
|
|
|
log = logging.getLogger('deprecated')
|
|
|
|
def take_action(self, parsed_args):
|
|
self.log.warning(_('This command has been deprecated. '
|
|
'Please use "volume backup show" instead.'))
|
|
return super(ShowBackup, self).take_action(parsed_args)
|