0d9ace6425
This patch acts as a base framework to add the parameters needed for manage volume support. This includes 2 changes: 1. Move get_parser and take_action code to common methods which can be utilized by both v2 and v3 2. Make _check_size_arg as a static method and move it inside CreateVolume class since it's not used by other classes. [2] was initially thought to be a follow up change but since we are implementing changes into the _check_size_arg method for v3, it makes sense to just include it in CreateVolume class to avoid adding a new additional method. Similar changes are done for v2 as well. Change-Id: I9315e457ebd6c5ba4cc67452f92c9dc8c139ee3c
147 lines
4.5 KiB
Python
147 lines
4.5 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 V3 Volume action implementations"""
|
|
|
|
import logging
|
|
|
|
from openstack import utils as sdk_utils
|
|
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 _
|
|
from openstackclient.volume.v2 import volume as volume_v2
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class VolumeSummary(command.ShowOne):
|
|
_description = _("Show a summary of all volumes in this deployment.")
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super().get_parser(prog_name)
|
|
parser.add_argument(
|
|
'--all-projects',
|
|
action='store_true',
|
|
default=False,
|
|
help=_('Include all projects (admin only)'),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.sdk_connection.volume
|
|
|
|
if not sdk_utils.supports_microversion(volume_client, '3.12'):
|
|
msg = _(
|
|
"--os-volume-api-version 3.12 or greater is required to "
|
|
"support the 'volume summary' command"
|
|
)
|
|
raise exceptions.CommandError(msg)
|
|
|
|
columns = [
|
|
'total_count',
|
|
'total_size',
|
|
]
|
|
column_headers = [
|
|
'Total Count',
|
|
'Total Size',
|
|
]
|
|
if sdk_utils.supports_microversion(volume_client, '3.36'):
|
|
columns.append('metadata')
|
|
column_headers.append('Metadata')
|
|
|
|
# set value of 'all_tenants' when using project option
|
|
all_projects = parsed_args.all_projects
|
|
|
|
vol_summary = volume_client.summary(all_projects)
|
|
|
|
return (
|
|
column_headers,
|
|
utils.get_item_properties(
|
|
vol_summary,
|
|
columns,
|
|
formatters={'metadata': format_columns.DictColumn},
|
|
),
|
|
)
|
|
|
|
|
|
class VolumeRevertToSnapshot(command.Command):
|
|
_description = _("Revert a volume to a snapshot.")
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super().get_parser(prog_name)
|
|
parser.add_argument(
|
|
'snapshot',
|
|
metavar="<snapshot>",
|
|
help=_(
|
|
'Name or ID of the snapshot to restore. The snapshot must '
|
|
'be the most recent one known to cinder.'
|
|
),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.sdk_connection.volume
|
|
|
|
if not sdk_utils.supports_microversion(volume_client, '3.40'):
|
|
msg = _(
|
|
"--os-volume-api-version 3.40 or greater is required to "
|
|
"support the 'volume revert snapshot' command"
|
|
)
|
|
raise exceptions.CommandError(msg)
|
|
|
|
snapshot = volume_client.find_snapshot(
|
|
parsed_args.snapshot,
|
|
ignore_missing=False,
|
|
)
|
|
volume = volume_client.find_volume(
|
|
snapshot.volume_id,
|
|
ignore_missing=False,
|
|
)
|
|
|
|
volume_client.revert_volume_to_snapshot(volume, snapshot)
|
|
|
|
|
|
class CreateVolume(volume_v2.CreateVolume):
|
|
_description = _("Create new volume")
|
|
|
|
@staticmethod
|
|
def _check_size_arg(args):
|
|
"""Check whether --size option is required or not.
|
|
|
|
Require size parameter in case if any of the following is not specified:
|
|
* snapshot
|
|
* source volume
|
|
* backup
|
|
* remote source (volume to be managed)
|
|
"""
|
|
|
|
if (
|
|
args.snapshot or args.source or args.backup or args.remote_source
|
|
) is None and args.size is None:
|
|
msg = _(
|
|
"--size is a required option if none of --snapshot, "
|
|
"--backup, --source, or --remote-source are provided."
|
|
)
|
|
raise exceptions.CommandError(msg)
|
|
|
|
def get_parser(self, prog_name):
|
|
parser, _ = self._get_parser(prog_name)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
return self._take_action(parsed_args)
|