c0b3d73189
Adding a constraints middleware that allows different constraints for a Swift-on-File storage policy. Currently, Swift allows only one set of object naming and metadata rules per cluster. As new storage policies are implemented, it is possible that different storage back-ends have different set of rules on how objects should be created for that specific storage system. Swift-on-File has different rules as objects name are mapped to a POSIX filesystem directory structure. For example: no names with double slashes or ending with slashes are allowed. At first a solution was proposed to include a generic patch in the upstream swift code, but after discussing with the Swift community it became clear that it would be better to have a global set of constraints that covers the whole cluster and if a specific storage policy has specific constraints than it should have its own middleware. Link to patch for reference: https://review.openstack.org/#/c/113325/ Change-Id: I323ead5d98bf5c087930ccf446d3e8d83075e584 Signed-off-by: Thiago da Silva <thiago@redhat.com>
105 lines
3.9 KiB
Python
105 lines
3.9 KiB
Python
# Copyright (c) 2012-2014 Red Hat, 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.
|
|
|
|
"""
|
|
The ``sof_constraints`` middleware should be added to the pipeline in your
|
|
``/etc/swift/proxy-server.conf`` file, and a mapping of storage policies
|
|
using the swiftonfile object server should be listed in the 'policies'
|
|
variable in the filter section.
|
|
|
|
The swiftonfile constraints contains additional checks to make sure object
|
|
names conform with POSIX filesystems file and directory naming limitations
|
|
|
|
For example::
|
|
|
|
[pipeline:main]
|
|
pipeline = catch_errors sof_constraints cache proxy-server
|
|
|
|
[filter:sof_constraints]
|
|
use = egg:swift#sof_constraints
|
|
policies=swiftonfile,gold
|
|
"""
|
|
|
|
from urllib import unquote
|
|
from swift.common.utils import get_logger
|
|
from swift.common.swob import Request, HTTPBadRequest
|
|
from swift.proxy.controllers.base import get_container_info
|
|
from swift.common.storage_policy import POLICIES
|
|
from swiftonfile.swift.common import constraints
|
|
from swiftonfile.swift.common.constraints import check_object_creation \
|
|
as sof_check_object_creation
|
|
|
|
|
|
class CheckConstraintsMiddleware(object):
|
|
|
|
def __init__(self, app, conf):
|
|
self.app = app
|
|
self.logger = get_logger(conf, log_route='constraints')
|
|
self.swift_dir = conf.get('swift_dir', '/etc/swift')
|
|
self.policies = conf.get('policies', '')
|
|
|
|
def __call__(self, env, start_response):
|
|
request = Request(env)
|
|
|
|
if request.method == 'PUT':
|
|
try:
|
|
version, account, container, obj = \
|
|
request.split_path(1, 4, True)
|
|
except ValueError:
|
|
return self.app(env, start_response)
|
|
|
|
# check container creation request
|
|
if account and container and not obj:
|
|
policy_name = request.headers.get('X-Storage-Policy', '')
|
|
default_policy = POLICIES.default.name
|
|
if (policy_name in self.policies) or \
|
|
(policy_name == '' and default_policy in self.policies):
|
|
|
|
container = unquote(container)
|
|
if len(container) > constraints. \
|
|
SOF_MAX_CONTAINER_NAME_LENGTH:
|
|
resp = HTTPBadRequest(request=request)
|
|
resp.body = \
|
|
'Container name length of %d longer than %d' % \
|
|
(len(container),
|
|
constraints.SOF_MAX_CONTAINER_NAME_LENGTH)
|
|
return resp(env, start_response)
|
|
elif account and container and obj:
|
|
# check object creation request
|
|
obj = unquote(obj)
|
|
|
|
container_info = get_container_info(
|
|
env, self.app)
|
|
policy = POLICIES.get_by_index(
|
|
container_info['storage_policy'])
|
|
|
|
if policy.name in self.policies:
|
|
error_response = sof_check_object_creation(request, obj)
|
|
if error_response:
|
|
self.logger.warn("returning error: %s", error_response)
|
|
return error_response(env, start_response)
|
|
|
|
return self.app(env, start_response)
|
|
|
|
|
|
def filter_factory(global_conf, **local_conf):
|
|
conf = global_conf.copy()
|
|
conf.update(local_conf)
|
|
|
|
def check_constraints_filter(app):
|
|
return CheckConstraintsMiddleware(app, conf)
|
|
|
|
return check_constraints_filter
|