65c2c4418c
This adds a crontab plugin hook to StoryBoard, allowing a plugin developer to run periodic events. Example use cases include: - Summary emails. - Periodic report generation. - Synchronization check points. Plugins are expected to provide their own execution interval and configuration indicator. The management of cron workers is implemented as its own cron plugin as a sample, and unit tests for all components are provided. Change-Id: I3aa466e183f1faede9493123510ee11feb55e7aa
156 lines
4.8 KiB
Python
156 lines
4.8 KiB
Python
# Copyright (c) 2013 Mirantis 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.
|
|
|
|
import os
|
|
|
|
from oslo.config import cfg
|
|
import pecan
|
|
from wsgiref import simple_server
|
|
|
|
from storyboard.api.auth.token_storage import impls as storage_impls
|
|
from storyboard.api.auth.token_storage import storage
|
|
from storyboard.api import config as api_config
|
|
from storyboard.api.middleware.cors_middleware import CORSMiddleware
|
|
from storyboard.api.middleware import token_middleware
|
|
from storyboard.api.middleware import user_id_hook
|
|
from storyboard.api.v1.search import impls as search_engine_impls
|
|
from storyboard.api.v1.search import search_engine
|
|
from storyboard.notifications.notification_hook import NotificationHook
|
|
from storyboard.openstack.common.gettextutils import _ # noqa
|
|
from storyboard.openstack.common import log
|
|
from storyboard.plugin.cron import load_crontab
|
|
from storyboard.plugin.user_preferences import initialize_user_preferences
|
|
|
|
CONF = cfg.CONF
|
|
|
|
LOG = log.getLogger(__name__)
|
|
|
|
API_OPTS = [
|
|
cfg.StrOpt('bind_host',
|
|
default='0.0.0.0',
|
|
help='API host'),
|
|
cfg.IntOpt('bind_port',
|
|
default=8080,
|
|
help='API port'),
|
|
cfg.BoolOpt('enable_notifications',
|
|
default=False,
|
|
help='Enable Notifications')
|
|
]
|
|
CORS_OPTS = [
|
|
cfg.ListOpt('allowed_origins',
|
|
default=None,
|
|
help='List of permitted CORS origins.'),
|
|
cfg.IntOpt('max_age',
|
|
default=3600,
|
|
help='Maximum cache age of CORS preflight requests.')
|
|
]
|
|
CONF.register_opts(API_OPTS)
|
|
CONF.register_opts(CORS_OPTS, 'cors')
|
|
|
|
|
|
def get_pecan_config():
|
|
# Set up the pecan configuration
|
|
filename = api_config.__file__.replace('.pyc', '.py')
|
|
return pecan.configuration.conf_from_file(filename)
|
|
|
|
|
|
def setup_app(pecan_config=None):
|
|
if not pecan_config:
|
|
pecan_config = get_pecan_config()
|
|
|
|
# Setup logging
|
|
cfg.set_defaults(log.log_opts,
|
|
default_log_levels=[
|
|
'storyboard=INFO',
|
|
'storyboard.openstack.common.db=WARN',
|
|
'sqlalchemy=WARN'
|
|
])
|
|
log.setup('storyboard')
|
|
|
|
hooks = [
|
|
user_id_hook.UserIdHook()
|
|
]
|
|
|
|
# Setup token storage
|
|
token_storage_type = CONF.token_storage_type
|
|
storage_cls = storage_impls.STORAGE_IMPLS[token_storage_type]
|
|
storage.set_storage(storage_cls())
|
|
|
|
# Setup search engine
|
|
search_engine_name = CONF.search_engine
|
|
search_engine_cls = search_engine_impls.ENGINE_IMPLS[search_engine_name]
|
|
search_engine.set_engine(search_engine_cls())
|
|
|
|
# Load user preference plugins
|
|
initialize_user_preferences()
|
|
|
|
# Initialize crontab
|
|
load_crontab()
|
|
|
|
# Setup notifier
|
|
if CONF.enable_notifications:
|
|
hooks.append(NotificationHook())
|
|
|
|
app = pecan.make_app(
|
|
pecan_config.app.root,
|
|
debug=CONF.debug,
|
|
hooks=hooks,
|
|
force_canonical=getattr(pecan_config.app, 'force_canonical', True),
|
|
guess_content_type_from_ext=False
|
|
)
|
|
|
|
app = token_middleware.AuthTokenMiddleware(app)
|
|
|
|
# Setup CORS
|
|
if CONF.cors.allowed_origins:
|
|
app = CORSMiddleware(app,
|
|
allowed_origins=CONF.cors.allowed_origins,
|
|
allowed_methods=['GET', 'POST', 'PUT', 'DELETE',
|
|
'OPTIONS'],
|
|
allowed_headers=['origin', 'authorization',
|
|
'accept', 'x-total', 'x-limit',
|
|
'x-marker', 'x-client',
|
|
'content-type'],
|
|
max_age=CONF.cors.max_age)
|
|
|
|
return app
|
|
|
|
|
|
def start():
|
|
CONF(project='storyboard')
|
|
|
|
api_root = setup_app()
|
|
|
|
# Create the WSGI server and start it
|
|
host = cfg.CONF.bind_host
|
|
port = cfg.CONF.bind_port
|
|
|
|
srv = simple_server.make_server(host, port, api_root)
|
|
|
|
LOG.info(_('Starting server in PID %s') % os.getpid())
|
|
LOG.info(_("Configuration:"))
|
|
if host == '0.0.0.0':
|
|
LOG.info(_(
|
|
'serving on 0.0.0.0:%(port)s, view at http://127.0.0.1:%(port)s')
|
|
% ({'port': port}))
|
|
else:
|
|
LOG.info(_("serving on http://%(host)s:%(port)s") % (
|
|
{'host': host, 'port': port}))
|
|
|
|
srv.serve_forever()
|
|
|
|
if __name__ == '__main__':
|
|
start()
|