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
|
#
# 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 consistency group action implementations"""
import argparse
import logging
from osc_lib.cli import format_columns
from osc_lib.command import command
from osc_lib import exceptions
from osc_lib import utils
from openstackclient.i18n import _
LOG = logging.getLogger(__name__)
def _find_volumes(parsed_args_volumes, volume_client):
result = 0
uuid = ''
for volume in parsed_args_volumes:
try:
volume_id = utils.find_resource(volume_client.volumes, volume).id
uuid += volume_id + ','
except Exception as e:
result += 1
LOG.error(
_(
"Failed to find volume with "
"name or ID '%(volume)s':%(e)s"
)
% {'volume': volume, 'e': e}
)
return result, uuid
class AddVolumeToConsistencyGroup(command.Command):
_description = _("Add volume(s) to consistency group")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'consistency_group',
metavar="<consistency-group>",
help=_('Consistency group to contain <volume> (name or ID)'),
)
parser.add_argument(
'volumes',
metavar='<volume>',
nargs='+',
help=_(
'Volume(s) to add to <consistency-group> (name or ID) '
'(repeat option to add multiple volumes)'
),
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
result, add_uuid = _find_volumes(parsed_args.volumes, volume_client)
if result > 0:
total = len(parsed_args.volumes)
LOG.error(
_("%(result)s of %(total)s volumes failed " "to add.")
% {'result': result, 'total': total}
)
if add_uuid:
add_uuid = add_uuid.rstrip(',')
consistency_group_id = utils.find_resource(
volume_client.consistencygroups, parsed_args.consistency_group
).id
volume_client.consistencygroups.update(
consistency_group_id, add_volumes=add_uuid
)
class CreateConsistencyGroup(command.ShowOne):
_description = _("Create new consistency group.")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
"name",
metavar="<name>",
nargs="?",
help=_("Name of new consistency group (default to None)"),
)
exclusive_group = parser.add_mutually_exclusive_group(required=True)
exclusive_group.add_argument(
"--volume-type",
metavar="<volume-type>",
help=_("Volume type of this consistency group (name or ID)"),
)
exclusive_group.add_argument(
"--source",
metavar="<consistency-group>",
help=_("Existing consistency group (name or ID)"),
)
# NOTE(stephenfin): Legacy alias
exclusive_group.add_argument(
"--consistency-group-source",
metavar="<consistency-group>",
dest='source',
help=argparse.SUPPRESS,
)
exclusive_group.add_argument(
"--snapshot",
metavar="<consistency-group-snapshot>",
help=_("Existing consistency group snapshot (name or ID)"),
)
# NOTE(stephenfin): Legacy alias
exclusive_group.add_argument(
"--consistency-group-snapshot",
metavar="<consistency-group-snapshot>",
dest='snapshot',
help=argparse.SUPPRESS,
)
parser.add_argument(
"--description",
metavar="<description>",
help=_("Description of this consistency group"),
)
parser.add_argument(
"--availability-zone",
metavar="<availability-zone>",
help=_(
"Availability zone for this consistency group "
"(not available if creating consistency group "
"from source)"
),
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
if parsed_args.volume_type:
volume_type_id = utils.find_resource(
volume_client.volume_types, parsed_args.volume_type
).id
consistency_group = volume_client.consistencygroups.create(
volume_type_id,
name=parsed_args.name,
description=parsed_args.description,
availability_zone=parsed_args.availability_zone,
)
else:
if parsed_args.availability_zone:
msg = _(
"'--availability-zone' option will not work "
"if creating consistency group from source"
)
LOG.warning(msg)
consistency_group_id = None
consistency_group_snapshot = None
if parsed_args.source:
consistency_group_id = utils.find_resource(
volume_client.consistencygroups,
parsed_args.source,
).id
elif parsed_args.snapshot:
consistency_group_snapshot = utils.find_resource(
volume_client.cgsnapshots,
parsed_args.snapshot,
).id
consistency_group = (
volume_client.consistencygroups.create_from_src(
consistency_group_snapshot,
consistency_group_id,
name=parsed_args.name,
description=parsed_args.description,
)
)
return zip(*sorted(consistency_group._info.items()))
class DeleteConsistencyGroup(command.Command):
_description = _("Delete consistency group(s).")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'consistency_groups',
metavar='<consistency-group>',
nargs="+",
help=_('Consistency group(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.consistency_groups:
try:
consistency_group_id = utils.find_resource(
volume_client.consistencygroups, i
).id
volume_client.consistencygroups.delete(
consistency_group_id, parsed_args.force
)
except Exception as e:
result += 1
LOG.error(
_(
"Failed to delete consistency group with "
"name or ID '%(consistency_group)s':%(e)s"
)
% {'consistency_group': i, 'e': e}
)
if result > 0:
total = len(parsed_args.consistency_groups)
msg = _(
"%(result)s of %(total)s consistency groups failed "
"to delete."
) % {'result': result, 'total': total}
raise exceptions.CommandError(msg)
class ListConsistencyGroup(command.Lister):
_description = _("List consistency groups.")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'--all-projects',
action="store_true",
help=_(
'Show details for all projects. Admin only. '
'(defaults to False)'
),
)
parser.add_argument(
'--long',
action="store_true",
help=_('List additional fields in output'),
)
return parser
def take_action(self, parsed_args):
if parsed_args.long:
columns = [
'ID',
'Status',
'Availability Zone',
'Name',
'Description',
'Volume Types',
]
else:
columns = ['ID', 'Status', 'Name']
volume_client = self.app.client_manager.volume
consistency_groups = volume_client.consistencygroups.list(
detailed=True,
search_opts={'all_tenants': parsed_args.all_projects},
)
return (
columns,
(
utils.get_item_properties(
s,
columns,
formatters={'Volume Types': format_columns.ListColumn},
)
for s in consistency_groups
),
)
class RemoveVolumeFromConsistencyGroup(command.Command):
_description = _("Remove volume(s) from consistency group")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'consistency_group',
metavar="<consistency-group>",
help=_('Consistency group containing <volume> (name or ID)'),
)
parser.add_argument(
'volumes',
metavar='<volume>',
nargs='+',
help=_(
'Volume(s) to remove from <consistency-group> (name or ID) '
'(repeat option to remove multiple volumes)'
),
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
result, remove_uuid = _find_volumes(parsed_args.volumes, volume_client)
if result > 0:
total = len(parsed_args.volumes)
LOG.error(
_("%(result)s of %(total)s volumes failed " "to remove.")
% {'result': result, 'total': total}
)
if remove_uuid:
remove_uuid = remove_uuid.rstrip(',')
consistency_group_id = utils.find_resource(
volume_client.consistencygroups, parsed_args.consistency_group
).id
volume_client.consistencygroups.update(
consistency_group_id, remove_volumes=remove_uuid
)
class SetConsistencyGroup(command.Command):
_description = _("Set consistency group properties")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'consistency_group',
metavar='<consistency-group>',
help=_('Consistency group to modify (name or ID)'),
)
parser.add_argument(
'--name',
metavar='<name>',
help=_('New consistency group name'),
)
parser.add_argument(
'--description',
metavar='<description>',
help=_('New consistency group description'),
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
kwargs = {}
if parsed_args.name:
kwargs['name'] = parsed_args.name
if parsed_args.description:
kwargs['description'] = parsed_args.description
if kwargs:
consistency_group_id = utils.find_resource(
volume_client.consistencygroups, parsed_args.consistency_group
).id
volume_client.consistencygroups.update(
consistency_group_id, **kwargs
)
class ShowConsistencyGroup(command.ShowOne):
_description = _("Display consistency group details.")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
"consistency_group",
metavar="<consistency-group>",
help=_("Consistency group to display (name or ID)"),
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
consistency_group = utils.find_resource(
volume_client.consistencygroups, parsed_args.consistency_group
)
return zip(*sorted(consistency_group._info.items()))
|