436557d5f6
This function is necessary for options discoverability and manual options registration. This first patch adds a config function to every module defining options in marconi. Those functions were registered as entrypoints that will then be loaded by the configuration sample generator. Change-Id: I2c351c14c7e1b104926162336ed3567696c62dfb
122 lines
4.0 KiB
Python
122 lines
4.0 KiB
Python
# Copyright (c) 2013 Rackspace, 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.
|
|
|
|
from oslo.config import cfg
|
|
from stevedore import driver
|
|
|
|
from marconi import common
|
|
from marconi.common import decorators
|
|
from marconi.common import utils
|
|
from marconi.openstack.common.gettextutils import _
|
|
from marconi.openstack.common import log as logging
|
|
from marconi.queues.storage import base
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
_PIPELINE_RESOURCES = ('queue', 'message', 'claim')
|
|
|
|
_PIPELINE_CONFIGS = [
|
|
cfg.ListOpt(resource + '_pipeline', default=[],
|
|
help=_('Pipeline to use for processing {0} operations. '
|
|
'This pipeline will be consumed before calling '
|
|
'the storage driver\'s controller methods, '
|
|
'which will always be appended to this '
|
|
'pipeline.').format(resource))
|
|
for resource in _PIPELINE_RESOURCES
|
|
]
|
|
|
|
_PIPELINE_GROUP = 'storage'
|
|
|
|
|
|
def _config_options():
|
|
return utils.options_iter(_PIPELINE_CONFIGS, _PIPELINE_GROUP)
|
|
|
|
|
|
def _get_storage_pipeline(resource_name, conf):
|
|
"""Constructs and returns a storage resource pipeline.
|
|
|
|
This is a helper function for any service supporting
|
|
pipelines for the storage layer. The function returns
|
|
a pipeline based on the `{resource_name}_pipeline`
|
|
config option.
|
|
|
|
Stages in the pipeline implement controller methods
|
|
that they want to hook. A stage can halt the
|
|
pipeline immediate by returning a value that is
|
|
not None; otherwise, processing will continue
|
|
to the next stage, ending with the actual storage
|
|
controller.
|
|
|
|
:param conf: Configuration instance.
|
|
:type conf: `cfg.ConfigOpts`
|
|
|
|
:returns: A pipeline to use.
|
|
:rtype: `Pipeline`
|
|
"""
|
|
conf.register_opts(_PIPELINE_CONFIGS,
|
|
group=_PIPELINE_GROUP)
|
|
|
|
storage_conf = conf[_PIPELINE_GROUP]
|
|
|
|
pipeline = []
|
|
for ns in storage_conf[resource_name + '_pipeline']:
|
|
try:
|
|
mgr = driver.DriverManager('marconi.queues.storage.stages',
|
|
ns, invoke_on_load=True)
|
|
pipeline.append(mgr.driver)
|
|
except RuntimeError as exc:
|
|
LOG.warning(_(u'Stage %(stage)d could not be imported: %(ex)s'),
|
|
{'stage': ns, 'ex': str(exc)})
|
|
continue
|
|
|
|
return common.Pipeline(pipeline)
|
|
|
|
|
|
class DataDriver(base.DataDriverBase):
|
|
"""Meta-driver for injecting pipelines in front of controllers.
|
|
|
|
:param conf: Configuration from which to load pipeline settings
|
|
:param storage: Storage driver that will service requests as the
|
|
last step in the pipeline
|
|
"""
|
|
|
|
def __init__(self, conf, storage):
|
|
# NOTE(kgriffs): Pass None for cache since it won't ever
|
|
# be referenced.
|
|
super(DataDriver, self).__init__(conf, None)
|
|
self._storage = storage
|
|
|
|
def is_alive(self):
|
|
return self._storage.is_alive()
|
|
|
|
@decorators.lazy_property(write=False)
|
|
def queue_controller(self):
|
|
stages = _get_storage_pipeline('queue', self.conf)
|
|
stages.append(self._storage.queue_controller)
|
|
return stages
|
|
|
|
@decorators.lazy_property(write=False)
|
|
def message_controller(self):
|
|
stages = _get_storage_pipeline('message', self.conf)
|
|
stages.append(self._storage.message_controller)
|
|
return stages
|
|
|
|
@decorators.lazy_property(write=False)
|
|
def claim_controller(self):
|
|
stages = _get_storage_pipeline('claim', self.conf)
|
|
stages.append(self._storage.claim_controller)
|
|
return stages
|