629eb33c4d
Supporting "--no-property" option will apply user a convenient way to clean all properties of volume qos in a short command. The patch adds "--no-property" option in "volume qos set" command and update related test cases and docs. Change-Id: I1fb5b4f0a923bbf557a3af3f63809bde9e84ffd4
381 lines
12 KiB
Python
381 lines
12 KiB
Python
# Copyright 2015 iWeb Technologies Inc.
|
|
#
|
|
# 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 QoS action implementations"""
|
|
|
|
import logging
|
|
|
|
from osc_lib.cli import format_columns
|
|
from osc_lib.cli import parseractions
|
|
from osc_lib.command import command
|
|
from osc_lib import exceptions
|
|
from osc_lib import utils
|
|
|
|
from openstackclient.i18n import _
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class AssociateQos(command.Command):
|
|
_description = _("Associate a QoS specification to a volume type")
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(AssociateQos, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'qos_spec',
|
|
metavar='<qos-spec>',
|
|
help=_('QoS specification to modify (name or ID)'),
|
|
)
|
|
parser.add_argument(
|
|
'volume_type',
|
|
metavar='<volume-type>',
|
|
help=_('Volume type to associate the QoS (name or ID)'),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
qos_spec = utils.find_resource(
|
|
volume_client.qos_specs, parsed_args.qos_spec
|
|
)
|
|
volume_type = utils.find_resource(
|
|
volume_client.volume_types, parsed_args.volume_type
|
|
)
|
|
|
|
volume_client.qos_specs.associate(qos_spec.id, volume_type.id)
|
|
|
|
|
|
class CreateQos(command.ShowOne):
|
|
_description = _("Create new QoS specification")
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(CreateQos, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'name',
|
|
metavar='<name>',
|
|
help=_('New QoS specification name'),
|
|
)
|
|
consumer_choices = ['front-end', 'back-end', 'both']
|
|
parser.add_argument(
|
|
'--consumer',
|
|
metavar='<consumer>',
|
|
choices=consumer_choices,
|
|
default='both',
|
|
help=(
|
|
_(
|
|
'Consumer of the QoS. Valid consumers: %s '
|
|
"(defaults to 'both')"
|
|
)
|
|
% utils.format_list(consumer_choices)
|
|
),
|
|
)
|
|
parser.add_argument(
|
|
'--property',
|
|
metavar='<key=value>',
|
|
action=parseractions.KeyValueAction,
|
|
help=_(
|
|
'Set a QoS specification property '
|
|
'(repeat option to set multiple properties)'
|
|
),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
specs = {}
|
|
specs.update({'consumer': parsed_args.consumer})
|
|
|
|
if parsed_args.property:
|
|
specs.update(parsed_args.property)
|
|
|
|
qos_spec = volume_client.qos_specs.create(parsed_args.name, specs)
|
|
|
|
qos_spec._info.update(
|
|
{
|
|
'properties': format_columns.DictColumn(
|
|
qos_spec._info.pop('specs')
|
|
)
|
|
}
|
|
)
|
|
return zip(*sorted(qos_spec._info.items()))
|
|
|
|
|
|
class DeleteQos(command.Command):
|
|
_description = _("Delete QoS specification")
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(DeleteQos, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'qos_specs',
|
|
metavar='<qos-spec>',
|
|
nargs="+",
|
|
help=_('QoS specification(s) to delete (name or ID)'),
|
|
)
|
|
parser.add_argument(
|
|
'--force',
|
|
action='store_true',
|
|
default=False,
|
|
help=_("Allow to delete in-use QoS specification(s)"),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
result = 0
|
|
|
|
for i in parsed_args.qos_specs:
|
|
try:
|
|
qos_spec = utils.find_resource(volume_client.qos_specs, i)
|
|
volume_client.qos_specs.delete(qos_spec.id, parsed_args.force)
|
|
except Exception as e:
|
|
result += 1
|
|
LOG.error(
|
|
_(
|
|
"Failed to delete QoS specification with "
|
|
"name or ID '%(qos)s': %(e)s"
|
|
)
|
|
% {'qos': i, 'e': e}
|
|
)
|
|
|
|
if result > 0:
|
|
total = len(parsed_args.qos_specs)
|
|
msg = _(
|
|
"%(result)s of %(total)s QoS specifications failed"
|
|
" to delete."
|
|
) % {'result': result, 'total': total}
|
|
raise exceptions.CommandError(msg)
|
|
|
|
|
|
class DisassociateQos(command.Command):
|
|
_description = _("Disassociate a QoS specification from a volume type")
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(DisassociateQos, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'qos_spec',
|
|
metavar='<qos-spec>',
|
|
help=_('QoS specification to modify (name or ID)'),
|
|
)
|
|
volume_type_group = parser.add_mutually_exclusive_group()
|
|
volume_type_group.add_argument(
|
|
'--volume-type',
|
|
metavar='<volume-type>',
|
|
help=_('Volume type to disassociate the QoS from (name or ID)'),
|
|
)
|
|
volume_type_group.add_argument(
|
|
'--all',
|
|
action='store_true',
|
|
default=False,
|
|
help=_('Disassociate the QoS from every volume type'),
|
|
)
|
|
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
qos_spec = utils.find_resource(
|
|
volume_client.qos_specs, parsed_args.qos_spec
|
|
)
|
|
|
|
if parsed_args.volume_type:
|
|
volume_type = utils.find_resource(
|
|
volume_client.volume_types, parsed_args.volume_type
|
|
)
|
|
volume_client.qos_specs.disassociate(qos_spec.id, volume_type.id)
|
|
elif parsed_args.all:
|
|
volume_client.qos_specs.disassociate_all(qos_spec.id)
|
|
|
|
|
|
class ListQos(command.Lister):
|
|
_description = _("List QoS specifications")
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
qos_specs_list = volume_client.qos_specs.list()
|
|
|
|
for qos in qos_specs_list:
|
|
try:
|
|
qos_associations = volume_client.qos_specs.get_associations(
|
|
qos,
|
|
)
|
|
if qos_associations:
|
|
associations = [
|
|
association.name for association in qos_associations
|
|
]
|
|
qos._info.update({'associations': associations})
|
|
except Exception as ex:
|
|
if type(ex).__name__ == 'NotFound':
|
|
qos._info.update({'associations': None})
|
|
else:
|
|
raise
|
|
|
|
display_columns = (
|
|
'ID',
|
|
'Name',
|
|
'Consumer',
|
|
'Associations',
|
|
'Properties',
|
|
)
|
|
|
|
columns = ('ID', 'Name', 'Consumer', 'Associations', 'Specs')
|
|
return (
|
|
display_columns,
|
|
(
|
|
utils.get_dict_properties(
|
|
s._info,
|
|
columns,
|
|
formatters={
|
|
'Specs': format_columns.DictColumn,
|
|
'Associations': format_columns.ListColumn,
|
|
},
|
|
)
|
|
for s in qos_specs_list
|
|
),
|
|
)
|
|
|
|
|
|
class SetQos(command.Command):
|
|
_description = _("Set QoS specification properties")
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(SetQos, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'qos_spec',
|
|
metavar='<qos-spec>',
|
|
help=_('QoS specification to modify (name or ID)'),
|
|
)
|
|
parser.add_argument(
|
|
'--no-property',
|
|
dest='no_property',
|
|
action='store_true',
|
|
help=_(
|
|
'Remove all properties from <qos-spec> '
|
|
'(specify both --no-property and --property to remove the '
|
|
'current properties before setting new properties)'
|
|
),
|
|
)
|
|
parser.add_argument(
|
|
'--property',
|
|
metavar='<key=value>',
|
|
action=parseractions.KeyValueAction,
|
|
help=_(
|
|
'Property to add or modify for this QoS specification '
|
|
'(repeat option to set multiple properties)'
|
|
),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
qos_spec = utils.find_resource(
|
|
volume_client.qos_specs, parsed_args.qos_spec
|
|
)
|
|
|
|
result = 0
|
|
if parsed_args.no_property:
|
|
try:
|
|
key_list = list(qos_spec._info['specs'].keys())
|
|
volume_client.qos_specs.unset_keys(qos_spec.id, key_list)
|
|
except Exception as e:
|
|
LOG.error(_("Failed to clean qos properties: %s"), e)
|
|
result += 1
|
|
|
|
if parsed_args.property:
|
|
try:
|
|
volume_client.qos_specs.set_keys(
|
|
qos_spec.id,
|
|
parsed_args.property,
|
|
)
|
|
except Exception as e:
|
|
LOG.error(_("Failed to set qos property: %s"), e)
|
|
result += 1
|
|
|
|
if result > 0:
|
|
raise exceptions.CommandError(
|
|
_("One or more of the set operations failed")
|
|
)
|
|
|
|
|
|
class ShowQos(command.ShowOne):
|
|
_description = _("Display QoS specification details")
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(ShowQos, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'qos_spec',
|
|
metavar='<qos-spec>',
|
|
help=_('QoS specification to display (name or ID)'),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
qos_spec = utils.find_resource(
|
|
volume_client.qos_specs, parsed_args.qos_spec
|
|
)
|
|
|
|
qos_associations = volume_client.qos_specs.get_associations(qos_spec)
|
|
if qos_associations:
|
|
associations = [
|
|
association.name for association in qos_associations
|
|
]
|
|
qos_spec._info.update(
|
|
{'associations': format_columns.ListColumn(associations)}
|
|
)
|
|
qos_spec._info.update(
|
|
{
|
|
'properties': format_columns.DictColumn(
|
|
qos_spec._info.pop('specs')
|
|
)
|
|
}
|
|
)
|
|
|
|
return zip(*sorted(qos_spec._info.items()))
|
|
|
|
|
|
class UnsetQos(command.Command):
|
|
_description = _("Unset QoS specification properties")
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(UnsetQos, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'qos_spec',
|
|
metavar='<qos-spec>',
|
|
help=_('QoS specification to modify (name or ID)'),
|
|
)
|
|
parser.add_argument(
|
|
'--property',
|
|
metavar='<key>',
|
|
action='append',
|
|
default=[],
|
|
help=_(
|
|
'Property to remove from the QoS specification. '
|
|
'(repeat option to unset multiple properties)'
|
|
),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
qos_spec = utils.find_resource(
|
|
volume_client.qos_specs, parsed_args.qos_spec
|
|
)
|
|
|
|
if parsed_args.property:
|
|
volume_client.qos_specs.unset_keys(
|
|
qos_spec.id, parsed_args.property
|
|
)
|