1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
|
#
# 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 v3 Type action implementations"""
import functools
import logging
from cinderclient import api_versions
from cliff import columns as cliff_columns
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 _
from openstackclient.identity import common as identity_common
LOG = logging.getLogger(__name__)
class EncryptionInfoColumn(cliff_columns.FormattableColumn):
"""Formattable column for encryption info column.
Unlike the parent FormattableColumn class, the initializer of the
class takes encryption_data as the second argument.
osc_lib.utils.get_item_properties instantiate cliff FormattableColumn
object with a single parameter "column value", so you need to pass
a partially initialized class like
``functools.partial(EncryptionInfoColumn encryption_data)``.
"""
def __init__(self, value, encryption_data=None):
super().__init__(value)
self._encryption_data = encryption_data or {}
def _get_encryption_info(self):
type_id = self._value
return self._encryption_data.get(type_id)
def human_readable(self):
encryption_info = self._get_encryption_info()
if encryption_info:
return utils.format_dict(encryption_info)
else:
return '-'
def machine_readable(self):
return self._get_encryption_info()
def _create_encryption_type(volume_client, volume_type, parsed_args):
if not parsed_args.encryption_provider:
msg = _(
"'--encryption-provider' should be specified while "
"creating a new encryption type"
)
raise exceptions.CommandError(msg)
# set the default of control location while creating
control_location = 'front-end'
if parsed_args.encryption_control_location:
control_location = parsed_args.encryption_control_location
body = {
'provider': parsed_args.encryption_provider,
'cipher': parsed_args.encryption_cipher,
'key_size': parsed_args.encryption_key_size,
'control_location': control_location,
}
encryption = volume_client.volume_encryption_types.create(
volume_type, body
)
return encryption
def _set_encryption_type(volume_client, volume_type, parsed_args):
# update the existing encryption type
body = {}
for attr in ['provider', 'cipher', 'key_size', 'control_location']:
info = getattr(parsed_args, 'encryption_' + attr, None)
if info is not None:
body[attr] = info
try:
volume_client.volume_encryption_types.update(volume_type, body)
except Exception as e:
if type(e).__name__ == 'NotFound':
# create new encryption type
LOG.warning(
_(
"No existing encryption type found, creating "
"new encryption type for this volume type ..."
)
)
_create_encryption_type(volume_client, volume_type, parsed_args)
class CreateVolumeType(command.ShowOne):
_description = _("Create new volume type")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
"name",
metavar="<name>",
help=_("Volume type name"),
)
parser.add_argument(
"--description",
metavar="<description>",
help=_("Volume type description"),
)
public_group = parser.add_mutually_exclusive_group()
public_group.add_argument(
"--public",
action="store_true",
dest="is_public",
default=None,
help=_("Volume type is accessible to the public"),
)
public_group.add_argument(
"--private",
action="store_false",
dest="is_public",
default=None,
help=_("Volume type is not accessible to the public"),
)
parser.add_argument(
'--property',
metavar='<key=value>',
action=parseractions.KeyValueAction,
dest='properties',
help=_(
'Set a property on this volume type '
'(repeat option to set multiple properties)'
),
)
parser.add_argument(
'--multiattach',
action='store_true',
default=False,
help=_(
"Enable multi-attach for this volume type "
"(this is an alias for '--property multiattach=<is> True') "
"(requires driver support)"
),
)
parser.add_argument(
'--cacheable',
action='store_true',
default=False,
help=_(
"Enable caching for this volume type "
"(this is an alias for '--property cacheable=<is> True') "
"(requires driver support)"
),
)
parser.add_argument(
'--replicated',
action='store_true',
default=False,
help=_(
"Enabled replication for this volume type "
"(this is an alias for '--property replication_enabled=<is> True') "
"(requires driver support)"
),
)
parser.add_argument(
'--availability-zone',
action='append',
dest='availability_zones',
help=_(
"Set an availability zone for this volume type "
"(this is an alias for '--property RESKEY:availability_zones:<az>') "
"(repeat option to set multiple availability zones)"
),
)
parser.add_argument(
'--project',
metavar='<project>',
help=_(
"Allow <project> to access private type (name or ID) "
"(must be used with --private option)"
),
)
identity_common.add_project_domain_option_to_parser(parser)
# TODO(Huanxuan Ao): Add choices for each "--encryption-*" option.
parser.add_argument(
'--encryption-provider',
metavar='<provider>',
help=_(
'Set the encryption provider format for '
'this volume type (e.g "luks" or "plain") (admin only) '
'(this option is required when setting encryption type '
'of a volume; consider using other encryption options '
'such as: "--encryption-cipher", "--encryption-key-size" '
'and "--encryption-control-location")'
),
)
parser.add_argument(
'--encryption-cipher',
metavar='<cipher>',
help=_(
'Set the encryption algorithm or mode for this '
'volume type (e.g "aes-xts-plain64") (admin only)'
),
)
parser.add_argument(
'--encryption-key-size',
metavar='<key-size>',
type=int,
help=_(
'Set the size of the encryption key of this '
'volume type (e.g "128" or "256") (admin only)'
),
)
parser.add_argument(
'--encryption-control-location',
metavar='<control-location>',
choices=['front-end', 'back-end'],
help=_(
'Set the notional service where the encryption is '
'performed ("front-end" or "back-end") (admin only) '
'(The default value for this option is "front-end" '
'when setting encryption type of a volume. Consider '
'using other encryption options such as: '
'"--encryption-cipher", "--encryption-key-size" and '
'"--encryption-provider")'
),
)
return parser
def take_action(self, parsed_args):
identity_client = self.app.client_manager.identity
volume_client = self.app.client_manager.volume
if parsed_args.project and parsed_args.is_public is not False:
msg = _("--project is only allowed with --private")
raise exceptions.CommandError(msg)
kwargs = {}
if parsed_args.is_public is not None:
kwargs['is_public'] = parsed_args.is_public
volume_type = volume_client.volume_types.create(
parsed_args.name,
description=parsed_args.description,
**kwargs,
)
volume_type._info.pop('extra_specs')
if parsed_args.project:
try:
project_id = identity_common.find_project(
identity_client,
parsed_args.project,
parsed_args.project_domain,
).id
volume_client.volume_type_access.add_project_access(
volume_type.id, project_id
)
except Exception as e:
msg = _(
"Failed to add project %(project)s access to "
"type: %(e)s"
)
LOG.error(msg % {'project': parsed_args.project, 'e': e})
properties = {}
if parsed_args.properties:
properties.update(parsed_args.properties)
if parsed_args.multiattach:
properties['multiattach'] = '<is> True'
if parsed_args.cacheable:
properties['cacheable'] = '<is> True'
if parsed_args.replicated:
properties['replication_enabled'] = '<is> True'
if parsed_args.availability_zones:
properties['RESKEY:availability_zones'] = ','.join(
parsed_args.availability_zones
)
if properties:
result = volume_type.set_keys(properties)
volume_type._info.update(
{'properties': format_columns.DictColumn(result)}
)
if (
parsed_args.encryption_provider
or parsed_args.encryption_cipher
or parsed_args.encryption_key_size
or parsed_args.encryption_control_location
):
try:
# create new encryption
encryption = _create_encryption_type(
volume_client, volume_type, parsed_args
)
except Exception as e:
LOG.error(
_(
"Failed to set encryption information for this "
"volume type: %s"
),
e,
)
# add encryption info in result
encryption._info.pop("volume_type_id", None)
volume_type._info.update(
{'encryption': format_columns.DictColumn(encryption._info)}
)
volume_type._info.pop("os-volume-type-access:is_public", None)
return zip(*sorted(volume_type._info.items()))
class DeleteVolumeType(command.Command):
_description = _("Delete volume type(s)")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
"volume_types",
metavar="<volume-type>",
nargs="+",
help=_("Volume type(s) to delete (name or ID)"),
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
result = 0
for volume_type in parsed_args.volume_types:
try:
vol_type = utils.find_resource(
volume_client.volume_types, volume_type
)
volume_client.volume_types.delete(vol_type)
except Exception as e:
result += 1
LOG.error(
_(
"Failed to delete volume type with "
"name or ID '%(volume_type)s': %(e)s"
)
% {'volume_type': volume_type, 'e': e}
)
if result > 0:
total = len(parsed_args.volume_types)
msg = _(
"%(result)s of %(total)s volume types failed " "to delete."
) % {'result': result, 'total': total}
raise exceptions.CommandError(msg)
class ListVolumeType(command.Lister):
_description = _("List volume types")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'--long',
action='store_true',
default=False,
help=_('List additional fields in output'),
)
public_group = parser.add_mutually_exclusive_group()
public_group.add_argument(
"--default",
action='store_true',
default=False,
help=_('List the default volume type'),
)
public_group.add_argument(
"--public",
action="store_true",
dest="is_public",
default=None,
help=_("List only public types"),
)
public_group.add_argument(
"--private",
action="store_false",
dest="is_public",
default=None,
help=_("List only private types (admin only)"),
)
parser.add_argument(
"--encryption-type",
action="store_true",
help=_(
"Display encryption information for each volume type "
"(admin only)"
),
)
parser.add_argument(
'--property',
metavar='<key=value>',
action=parseractions.KeyValueAction,
dest='properties',
help=_(
'Filter by a property on the volume types '
'(repeat option to filter by multiple properties) '
'(admin only except for user-visible extra specs) '
'(supported by --os-volume-api-version 3.52 or above)'
),
)
parser.add_argument(
'--multiattach',
action='store_true',
default=False,
help=_(
"List only volume types with multi-attach enabled "
"(this is an alias for '--property multiattach=<is> True') "
"(supported by --os-volume-api-version 3.52 or above)"
),
)
parser.add_argument(
'--cacheable',
action='store_true',
default=False,
help=_(
"List only volume types with caching enabled "
"(this is an alias for '--property cacheable=<is> True') "
"(admin only) "
"(supported by --os-volume-api-version 3.52 or above)"
),
)
parser.add_argument(
'--replicated',
action='store_true',
default=False,
help=_(
"List only volume types with replication enabled "
"(this is an alias for '--property replication_enabled=<is> True') "
"(supported by --os-volume-api-version 3.52 or above)"
),
)
parser.add_argument(
'--availability-zone',
action='append',
dest='availability_zones',
help=_(
"List only volume types with this availability configured "
"(this is an alias for '--property RESKEY:availability_zones:<az>') "
"(repeat option to filter on multiple availability zones)"
),
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
if parsed_args.long:
columns = [
'ID',
'Name',
'Is Public',
'Description',
'Extra Specs',
]
column_headers = [
'ID',
'Name',
'Is Public',
'Description',
'Properties',
]
else:
columns = ['ID', 'Name', 'Is Public']
column_headers = ['ID', 'Name', 'Is Public']
if parsed_args.default:
data = [volume_client.volume_types.default()]
else:
search_opts = {}
properties = {}
if parsed_args.properties:
properties.update(parsed_args.properties)
if parsed_args.multiattach:
properties['multiattach'] = '<is> True'
if parsed_args.cacheable:
properties['cacheable'] = '<is> True'
if parsed_args.replicated:
properties['replication_enabled'] = '<is> True'
if parsed_args.availability_zones:
properties['RESKEY:availability_zones'] = ','.join(
parsed_args.availability_zones
)
if properties:
if volume_client.api_version < api_versions.APIVersion('3.52'):
msg = _(
"--os-volume-api-version 3.52 or greater is required "
"to use the '--property' option or any of the alias "
"options"
)
raise exceptions.CommandError(msg)
search_opts['extra_specs'] = properties
data = volume_client.volume_types.list(
search_opts=search_opts,
is_public=parsed_args.is_public,
)
formatters = {'Extra Specs': format_columns.DictColumn}
if parsed_args.encryption_type:
encryption = {}
for d in volume_client.volume_encryption_types.list():
volume_type_id = d._info['volume_type_id']
# remove some redundant information
del_key = [
'deleted',
'created_at',
'updated_at',
'deleted_at',
'volume_type_id',
]
for key in del_key:
d._info.pop(key, None)
# save the encryption information with their volume type ID
encryption[volume_type_id] = d._info
# We need to get volume type ID, then show encryption
# information according to the ID, so use "id" to keep
# difference to the real "ID" column.
columns += ['id']
column_headers += ['Encryption']
_EncryptionInfoColumn = functools.partial(
EncryptionInfoColumn, encryption_data=encryption
)
formatters['id'] = _EncryptionInfoColumn
return (
column_headers,
(
utils.get_item_properties(
s,
columns,
formatters=formatters,
)
for s in data
),
)
class SetVolumeType(command.Command):
_description = _("Set volume type properties")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'volume_type',
metavar='<volume-type>',
help=_('Volume type to modify (name or ID)'),
)
parser.add_argument(
'--name',
metavar='<name>',
help=_('Set volume type name'),
)
parser.add_argument(
'--description',
metavar='<description>',
help=_('Set volume type description'),
)
parser.add_argument(
'--property',
metavar='<key=value>',
action=parseractions.KeyValueAction,
dest='properties',
help=_(
'Set a property on this volume type '
'(repeat option to set multiple properties)'
),
)
parser.add_argument(
'--multiattach',
action='store_true',
default=False,
help=_(
"Enable multi-attach for this volume type "
"(this is an alias for '--property multiattach=<is> True') "
"(requires driver support)"
),
)
parser.add_argument(
'--cacheable',
action='store_true',
default=False,
help=_(
"Enable caching for this volume type "
"(this is an alias for '--property cacheable=<is> True') "
"(requires driver support)"
),
)
parser.add_argument(
'--replicated',
action='store_true',
default=False,
help=_(
"Enabled replication for this volume type "
"(this is an alias for '--property replication_enabled=<is> True') "
"(requires driver support)"
),
)
parser.add_argument(
'--availability-zone',
action='append',
dest='availability_zones',
help=_(
"Set an availability zone for this volume type "
"(this is an alias for '--property RESKEY:availability_zones:<az>') "
"(repeat option to set multiple availability zones)"
),
)
parser.add_argument(
'--project',
metavar='<project>',
help=_(
'Set volume type access to project (name or ID) '
'(admin only)'
),
)
public_group = parser.add_mutually_exclusive_group()
public_group.add_argument(
'--public',
action='store_true',
dest='is_public',
default=None,
help=_('Volume type is accessible to the public'),
)
public_group.add_argument(
'--private',
action='store_false',
dest='is_public',
default=None,
help=_("Volume type is not accessible to the public"),
)
identity_common.add_project_domain_option_to_parser(parser)
# TODO(Huanxuan Ao): Add choices for each "--encryption-*" option.
parser.add_argument(
'--encryption-provider',
metavar='<provider>',
help=_(
'Set the encryption provider format for '
'this volume type (e.g "luks" or "plain") (admin only) '
'(This option is required when setting encryption type '
'of a volume for the first time. Consider using other '
'encryption options such as: "--encryption-cipher", '
'"--encryption-key-size" and '
'"--encryption-control-location")'
),
)
parser.add_argument(
'--encryption-cipher',
metavar='<cipher>',
help=_(
'Set the encryption algorithm or mode for this '
'volume type (e.g "aes-xts-plain64") (admin only)'
),
)
parser.add_argument(
'--encryption-key-size',
metavar='<key-size>',
type=int,
help=_(
'Set the size of the encryption key of this '
'volume type (e.g "128" or "256") (admin only)'
),
)
parser.add_argument(
'--encryption-control-location',
metavar='<control-location>',
choices=['front-end', 'back-end'],
help=_(
'Set the notional service where the encryption is '
'performed ("front-end" or "back-end") (admin only) '
'(The default value for this option is "front-end" '
'when setting encryption type of a volume for the '
'first time. Consider using other encryption options '
'such as: "--encryption-cipher", "--encryption-key-size" '
'and "--encryption-provider")'
),
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
identity_client = self.app.client_manager.identity
volume_type = utils.find_resource(
volume_client.volume_types,
parsed_args.volume_type,
)
result = 0
kwargs = {}
if parsed_args.name:
kwargs['name'] = parsed_args.name
if parsed_args.description:
kwargs['description'] = parsed_args.description
if parsed_args.is_public is not None:
kwargs['is_public'] = parsed_args.is_public
if kwargs:
try:
volume_client.volume_types.update(volume_type.id, **kwargs)
except Exception as e:
LOG.error(
_(
"Failed to update volume type name or"
" description: %s"
),
e,
)
result += 1
properties = {}
properties = {}
if parsed_args.properties:
properties.update(parsed_args.properties)
if parsed_args.multiattach:
properties['multiattach'] = '<is> True'
if parsed_args.cacheable:
properties['cacheable'] = '<is> True'
if parsed_args.replicated:
properties['replication_enabled'] = '<is> True'
if parsed_args.availability_zones:
properties['RESKEY:availability_zones'] = ','.join(
parsed_args.availability_zones
)
if properties:
try:
volume_type.set_keys(properties)
except Exception as e:
LOG.error(_("Failed to set volume type properties: %s"), e)
result += 1
if parsed_args.project:
project_info = None
try:
project_info = identity_common.find_project(
identity_client,
parsed_args.project,
parsed_args.project_domain,
)
volume_client.volume_type_access.add_project_access(
volume_type.id, project_info.id
)
except Exception as e:
LOG.error(
_("Failed to set volume type access to " "project: %s"), e
)
result += 1
if (
parsed_args.encryption_provider
or parsed_args.encryption_cipher
or parsed_args.encryption_key_size
or parsed_args.encryption_control_location
):
try:
_set_encryption_type(volume_client, volume_type, parsed_args)
except Exception as e:
LOG.error(
_(
"Failed to set encryption information for this "
"volume type: %s"
),
e,
)
result += 1
if result > 0:
raise exceptions.CommandError(
_("Command Failed: One or more of" " the operations failed")
)
class ShowVolumeType(command.ShowOne):
_description = _("Display volume type details")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
"volume_type",
metavar="<volume-type>",
help=_("Volume type to display (name or ID)"),
)
parser.add_argument(
"--encryption-type",
action="store_true",
help=_(
"Display encryption information of this volume type "
"(admin only)"
),
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
volume_type = utils.find_resource(
volume_client.volume_types, parsed_args.volume_type
)
properties = format_columns.DictColumn(
volume_type._info.pop('extra_specs', {})
)
volume_type._info.update({'properties': properties})
access_project_ids = None
if not volume_type.is_public:
try:
volume_type_access = volume_client.volume_type_access.list(
volume_type.id
)
project_ids = [
utils.get_field(item, 'project_id')
for item in volume_type_access
]
# TODO(Rui Chen): This format list case can be removed after
# patch https://review.opendev.org/#/c/330223/ merged.
access_project_ids = format_columns.ListColumn(project_ids)
except Exception as e:
msg = _(
'Failed to get access project list for volume type '
'%(type)s: %(e)s'
)
LOG.error(msg % {'type': volume_type.id, 'e': e})
volume_type._info.update({'access_project_ids': access_project_ids})
if parsed_args.encryption_type:
# show encryption type information for this volume type
try:
encryption = volume_client.volume_encryption_types.get(
volume_type.id
)
encryption._info.pop("volume_type_id", None)
volume_type._info.update(
{'encryption': format_columns.DictColumn(encryption._info)}
)
except Exception as e:
LOG.error(
_(
"Failed to display the encryption information "
"of this volume type: %s"
),
e,
)
volume_type._info.pop("os-volume-type-access:is_public", None)
return zip(*sorted(volume_type._info.items()))
class UnsetVolumeType(command.Command):
_description = _("Unset volume type properties")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'volume_type',
metavar='<volume-type>',
help=_('Volume type to modify (name or ID)'),
)
parser.add_argument(
'--property',
metavar='<key>',
action='append',
dest='properties',
help=_(
'Remove a property from this volume type '
'(repeat option to remove multiple properties)'
),
)
parser.add_argument(
'--project',
metavar='<project>',
help=_(
'Removes volume type access to project (name or ID) '
'(admin only)'
),
)
identity_common.add_project_domain_option_to_parser(parser)
parser.add_argument(
"--encryption-type",
action="store_true",
help=_(
"Remove the encryption type for this volume type "
"(admin only)"
),
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
identity_client = self.app.client_manager.identity
volume_type = utils.find_resource(
volume_client.volume_types,
parsed_args.volume_type,
)
result = 0
if parsed_args.properties:
try:
volume_type.unset_keys(parsed_args.properties)
except Exception as e:
LOG.error(_("Failed to unset volume type properties: %s"), e)
result += 1
if parsed_args.project:
project_info = None
try:
project_info = identity_common.find_project(
identity_client,
parsed_args.project,
parsed_args.project_domain,
)
volume_client.volume_type_access.remove_project_access(
volume_type.id, project_info.id
)
except Exception as e:
LOG.error(
_(
"Failed to remove volume type access from "
"project: %s"
),
e,
)
result += 1
if parsed_args.encryption_type:
try:
volume_client.volume_encryption_types.delete(volume_type)
except Exception as e:
LOG.error(
_(
"Failed to remove the encryption type for this "
"volume type: %s"
),
e,
)
result += 1
if result > 0:
raise exceptions.CommandError(
_("Command Failed: One or more of" " the operations failed")
)
|