159 lines
4.9 KiB
Python
159 lines
4.9 KiB
Python
# Copyright 2011 OpenStack Foundation
|
|
# 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.
|
|
|
|
"""
|
|
Routines for configuring Glare
|
|
"""
|
|
|
|
import logging
|
|
import logging.config
|
|
import logging.handlers
|
|
import os
|
|
|
|
from oslo_config import cfg
|
|
from oslo_policy import policy
|
|
from paste import deploy
|
|
|
|
from glare.i18n import _
|
|
|
|
paste_deploy_opts = [
|
|
cfg.StrOpt('flavor',
|
|
help=_('Partial name of a pipeline in your paste configuration '
|
|
'file with the service name removed. For example, if '
|
|
'your paste section name is '
|
|
'[pipeline:glare-keystone] use the value '
|
|
'"keystone"')),
|
|
cfg.StrOpt('config_file',
|
|
help=_('Name of the paste configuration file.')),
|
|
]
|
|
|
|
common_opts = [
|
|
cfg.StrOpt('digest_algorithm',
|
|
default='sha256',
|
|
help=_("""
|
|
Digest algorithm to use for digital signature.
|
|
|
|
Provide a string value representing the digest algorithm to
|
|
use for generating digital signatures. By default, ``sha256``
|
|
is used.
|
|
|
|
To get a list of the available algorithms supported by the version
|
|
of OpenSSL on your platform, run the command:
|
|
``openssl list-message-digest-algorithms``.
|
|
Examples are 'sha1', 'sha256', and 'sha512'.
|
|
|
|
Possible values:
|
|
* An OpenSSL message digest algorithm identifier
|
|
|
|
Relation options:
|
|
* None
|
|
|
|
""")),
|
|
]
|
|
|
|
CONF = cfg.CONF
|
|
CONF.register_opts(paste_deploy_opts, group='paste_deploy')
|
|
CONF.register_opts(common_opts)
|
|
policy.Enforcer(CONF)
|
|
|
|
|
|
def parse_args(args=None, usage=None, default_config_files=None):
|
|
CONF(args=args,
|
|
project='glare',
|
|
usage=usage,
|
|
default_config_files=default_config_files)
|
|
|
|
|
|
def _get_deployment_flavor(flavor=None):
|
|
"""
|
|
Retrieve the paste_deploy.flavor config item, formatted appropriately
|
|
for appending to the application name.
|
|
|
|
:param flavor: if specified, use this setting rather than the
|
|
paste_deploy.flavor configuration setting
|
|
"""
|
|
if not flavor:
|
|
flavor = CONF.paste_deploy.flavor
|
|
return '' if not flavor else ('-' + flavor)
|
|
|
|
|
|
def _get_paste_config_path():
|
|
paste_suffix = '-paste.ini'
|
|
conf_suffix = '.conf'
|
|
if CONF.config_file:
|
|
# Assume paste config is in a paste.ini file corresponding
|
|
# to the last config file
|
|
path = CONF.config_file[-1].replace(conf_suffix, paste_suffix)
|
|
else:
|
|
path = CONF.prog + paste_suffix
|
|
return CONF.find_file(os.path.basename(path))
|
|
|
|
|
|
def _get_deployment_config_file():
|
|
"""
|
|
Retrieve the deployment_config_file config item, formatted as an
|
|
absolute pathname.
|
|
"""
|
|
path = CONF.paste_deploy.config_file
|
|
if not path:
|
|
path = _get_paste_config_path()
|
|
if not path:
|
|
msg = _("Unable to locate paste config file for %s.") % CONF.prog
|
|
raise RuntimeError(msg)
|
|
return os.path.abspath(path)
|
|
|
|
|
|
def load_paste_app(app_name, flavor=None, conf_file=None):
|
|
"""
|
|
Builds and returns a WSGI app from a paste config file.
|
|
|
|
We assume the last config file specified in the supplied ConfigOpts
|
|
object is the paste config file, if conf_file is None.
|
|
|
|
:param app_name: name of the application to load
|
|
:param flavor: name of the variant of the application to load
|
|
:param conf_file: path to the paste config file
|
|
|
|
:raises: RuntimeError when config file cannot be located or application
|
|
cannot be loaded from config file
|
|
"""
|
|
# append the deployment flavor to the application name,
|
|
# in order to identify the appropriate paste pipeline
|
|
app_name += _get_deployment_flavor(flavor)
|
|
|
|
if not conf_file:
|
|
conf_file = _get_deployment_config_file()
|
|
|
|
logger = logging.getLogger(__name__)
|
|
try:
|
|
logger.debug("Loading %(app_name)s from %(conf_file)s",
|
|
{'conf_file': conf_file, 'app_name': app_name})
|
|
|
|
app = deploy.loadapp("config:%s" % conf_file, name=app_name)
|
|
|
|
# Log the options used when starting if we're in debug mode...
|
|
if CONF.debug:
|
|
CONF.log_opt_values(logger, logging.DEBUG)
|
|
|
|
return app
|
|
except (LookupError, ImportError) as e:
|
|
msg = (_("Unable to load %(app_name)s from "
|
|
"configuration file %(conf_file)s."
|
|
"\nGot: %(e)r") % {'app_name': app_name,
|
|
'conf_file': conf_file,
|
|
'e': e})
|
|
logger.error(msg)
|
|
raise RuntimeError(msg)
|