200 lines
7.6 KiB
Python
200 lines
7.6 KiB
Python
# Copyright 2016 EMC Corporation
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
|
|
"""The volumes snapshots V3 API."""
|
|
|
|
import ast
|
|
from http import HTTPStatus
|
|
|
|
from oslo_log import log as logging
|
|
from oslo_utils import strutils
|
|
from webob import exc
|
|
|
|
from cinder.api import api_utils
|
|
from cinder.api import common
|
|
from cinder.api import microversions as mv
|
|
from cinder.api.openstack import wsgi
|
|
from cinder.api.schemas import snapshots as snapshot
|
|
from cinder.api.v2 import snapshots as snapshots_v2
|
|
from cinder.api.v3.views import snapshots as snapshot_views
|
|
from cinder.api import validation
|
|
from cinder import utils
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
SNAPSHOT_IN_USE_FLAG_MSG = (
|
|
f"Since microversion {mv.SNAPSHOT_IN_USE} the 'force' flag is "
|
|
"invalid for this request. For backward compatability, however, when "
|
|
"the 'force' flag is passed with a value evaluating to True, it is "
|
|
"silently ignored.")
|
|
|
|
|
|
class SnapshotsController(snapshots_v2.SnapshotsController):
|
|
"""The Snapshots API controller for the OpenStack API."""
|
|
|
|
_view_builder_class = snapshot_views.ViewBuilder
|
|
|
|
def _get_snapshot_filter_options(self):
|
|
"""returns tuple of valid filter options"""
|
|
|
|
return 'status', 'volume_id', 'name', 'metadata'
|
|
|
|
def _format_snapshot_filter_options(self, search_opts):
|
|
"""Convert valid filter options to correct expected format"""
|
|
|
|
# Get the dict object out of queried metadata
|
|
# convert metadata query value from string to dict
|
|
if 'metadata' in search_opts.keys():
|
|
try:
|
|
search_opts['metadata'] = ast.literal_eval(
|
|
search_opts['metadata'])
|
|
except (ValueError, SyntaxError):
|
|
LOG.debug('Could not evaluate value %s, assuming string',
|
|
search_opts['metadata'])
|
|
|
|
if 'use_quota' in search_opts:
|
|
search_opts['use_quota'] = utils.get_bool_param('use_quota',
|
|
search_opts)
|
|
|
|
MV_ADDED_FILTERS = (
|
|
(mv.get_prior_version(mv.SNAPSHOT_LIST_METADATA_FILTER), 'metadata'),
|
|
# REST API receives consumes_quota, but process_general_filtering
|
|
# transforms it into use_quota
|
|
(mv.get_prior_version(mv.USE_QUOTA), 'use_quota'),
|
|
)
|
|
|
|
@common.process_general_filtering('snapshot')
|
|
def _process_snapshot_filtering(self, context=None, filters=None,
|
|
req_version=None):
|
|
"""Formats allowed filters"""
|
|
for version, field in self.MV_ADDED_FILTERS:
|
|
if req_version.matches(None, version):
|
|
filters.pop(field, None)
|
|
|
|
# Filter out invalid options
|
|
allowed_search_options = self._get_snapshot_filter_options()
|
|
|
|
api_utils.remove_invalid_filter_options(context, filters,
|
|
allowed_search_options)
|
|
|
|
def _items(self, req, is_detail=True):
|
|
"""Returns a list of snapshots, transformed through view builder."""
|
|
context = req.environ['cinder.context']
|
|
# Pop out non search_opts and create local variables
|
|
search_opts = req.GET.copy()
|
|
sort_keys, sort_dirs = common.get_sort_params(search_opts)
|
|
marker, limit, offset = common.get_pagination_params(search_opts)
|
|
|
|
req_version = req.api_version_request
|
|
show_count = False
|
|
if req_version.matches(
|
|
mv.SUPPORT_COUNT_INFO) and 'with_count' in search_opts:
|
|
show_count = utils.get_bool_param('with_count', search_opts)
|
|
search_opts.pop('with_count')
|
|
|
|
# process filters
|
|
self._process_snapshot_filtering(context=context,
|
|
filters=search_opts,
|
|
req_version=req_version)
|
|
# process snapshot filters to appropriate formats if required
|
|
self._format_snapshot_filter_options(search_opts)
|
|
|
|
req_version = req.api_version_request
|
|
if req_version.matches(mv.SNAPSHOT_SORT, None) and 'name' in sort_keys:
|
|
sort_keys[sort_keys.index('name')] = 'display_name'
|
|
|
|
# NOTE(thingee): v3 API allows name instead of display_name
|
|
if 'name' in search_opts:
|
|
search_opts['display_name'] = search_opts.pop('name')
|
|
|
|
snapshots = self.volume_api.get_all_snapshots(
|
|
context,
|
|
search_opts=search_opts.copy(),
|
|
marker=marker,
|
|
limit=limit,
|
|
sort_keys=sort_keys,
|
|
sort_dirs=sort_dirs,
|
|
offset=offset)
|
|
total_count = None
|
|
if show_count:
|
|
total_count = self.volume_api.calculate_resource_count(
|
|
context, 'snapshot', search_opts)
|
|
|
|
req.cache_db_snapshots(snapshots.objects)
|
|
|
|
if is_detail:
|
|
snapshots = self._view_builder.detail_list(req, snapshots.objects,
|
|
total_count)
|
|
else:
|
|
snapshots = self._view_builder.summary_list(req, snapshots.objects,
|
|
total_count)
|
|
return snapshots
|
|
|
|
@wsgi.response(HTTPStatus.ACCEPTED)
|
|
@validation.schema(snapshot.create)
|
|
def create(self, req, body):
|
|
"""Creates a new snapshot."""
|
|
kwargs = {}
|
|
context = req.environ['cinder.context']
|
|
snapshot = body['snapshot']
|
|
kwargs['metadata'] = snapshot.get('metadata', None)
|
|
volume_id = snapshot['volume_id']
|
|
volume = self.volume_api.get(context, volume_id)
|
|
req_version = req.api_version_request
|
|
force_flag = snapshot.get('force')
|
|
force = False
|
|
if force_flag is not None:
|
|
# note: this won't raise because it passed schema validation
|
|
force = strutils.bool_from_string(force_flag, strict=True)
|
|
|
|
if req_version.matches(mv.SNAPSHOT_IN_USE):
|
|
# strictly speaking, the 'force' flag is invalid for
|
|
# mv.SNAPSHOT_IN_USE, but we silently ignore a True
|
|
# value for backward compatibility
|
|
if force is False:
|
|
raise exc.HTTPBadRequest(
|
|
explanation=SNAPSHOT_IN_USE_FLAG_MSG)
|
|
|
|
LOG.info("Create snapshot from volume %s", volume_id)
|
|
|
|
self.validate_name_and_description(snapshot, check_length=False)
|
|
if 'name' in snapshot:
|
|
snapshot['display_name'] = snapshot.pop('name')
|
|
|
|
if force:
|
|
new_snapshot = self.volume_api.create_snapshot_force(
|
|
context,
|
|
volume,
|
|
snapshot.get('display_name'),
|
|
snapshot.get('description'),
|
|
**kwargs)
|
|
else:
|
|
if req_version.matches(mv.SNAPSHOT_IN_USE):
|
|
kwargs['allow_in_use'] = True
|
|
|
|
new_snapshot = self.volume_api.create_snapshot(
|
|
context,
|
|
volume,
|
|
snapshot.get('display_name'),
|
|
snapshot.get('description'),
|
|
**kwargs)
|
|
req.cache_db_snapshot(new_snapshot)
|
|
|
|
return self._view_builder.detail(req, new_snapshot)
|
|
|
|
|
|
def create_resource(ext_mgr):
|
|
return wsgi.Resource(SnapshotsController(ext_mgr))
|