You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
233 lines
8.0 KiB
233 lines
8.0 KiB
# 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 signal |
|
import ssl |
|
import sys |
|
import traceback as traceback_mod |
|
|
|
import eventlet |
|
from eventlet import semaphore |
|
from futurist import periodics |
|
from oslo_config import cfg |
|
from oslo_log import log |
|
from oslo_utils import reflection |
|
|
|
from ironic_inspector.common import ironic as ir_utils |
|
from ironic_inspector.common import rpc |
|
from ironic_inspector import db |
|
from ironic_inspector import main as app |
|
from ironic_inspector import node_cache |
|
from ironic_inspector.plugins import base as plugins_base |
|
from ironic_inspector.pxe_filter import base as pxe_filter |
|
from ironic_inspector import utils |
|
|
|
|
|
LOG = log.getLogger(__name__) |
|
CONF = cfg.CONF |
|
|
|
|
|
class WSGIService(object): |
|
"""Provides ability to launch API from wsgi app.""" |
|
|
|
def __init__(self): |
|
self.app = app.app |
|
self._periodics_worker = None |
|
self._shutting_down = semaphore.Semaphore() |
|
signal.signal(signal.SIGHUP, self._handle_sighup) |
|
signal.signal(signal.SIGTERM, self._handle_sigterm) |
|
|
|
def _init_middleware(self): |
|
"""Initialize WSGI middleware. |
|
|
|
:returns: None |
|
""" |
|
|
|
if CONF.auth_strategy != 'noauth': |
|
utils.add_auth_middleware(self.app) |
|
else: |
|
LOG.warning('Starting unauthenticated, please check' |
|
' configuration') |
|
|
|
# TODO(aarefiev): move to WorkerService once we split service |
|
if CONF.processing.store_data == 'none': |
|
LOG.warning('Introspection data will not be stored. Change ' |
|
'"[processing] store_data" option if this is not ' |
|
'the desired behavior') |
|
elif CONF.processing.store_data == 'swift': |
|
LOG.info('Introspection data will be stored in Swift in the ' |
|
'container %s', CONF.swift.container) |
|
utils.add_cors_middleware(self.app) |
|
|
|
def _create_ssl_context(self): |
|
if not CONF.use_ssl: |
|
return |
|
|
|
MIN_VERSION = (2, 7, 9) |
|
|
|
if sys.version_info < MIN_VERSION: |
|
LOG.warning(('Unable to use SSL in this version of Python: ' |
|
'%(current)s, please ensure your version of Python ' |
|
'is greater than %(min)s to enable this feature.'), |
|
{'current': '.'.join(map(str, sys.version_info[:3])), |
|
'min': '.'.join(map(str, MIN_VERSION))}) |
|
return |
|
|
|
context = ssl.create_default_context(purpose=ssl.Purpose.CLIENT_AUTH) |
|
if CONF.ssl_cert_path and CONF.ssl_key_path: |
|
try: |
|
context.load_cert_chain(CONF.ssl_cert_path, CONF.ssl_key_path) |
|
except IOError as exc: |
|
LOG.warning('Failed to load certificate or key from defined ' |
|
'locations: %(cert)s and %(key)s, will continue ' |
|
'to run with the default settings: %(exc)s', |
|
{'cert': CONF.ssl_cert_path, |
|
'key': CONF.ssl_key_path, |
|
'exc': exc}) |
|
except ssl.SSLError as exc: |
|
LOG.warning('There was a problem with the loaded certificate ' |
|
'and key, will continue to run with the default ' |
|
'settings: %s', exc) |
|
return context |
|
|
|
# TODO(aarefiev): move init code to WorkerService |
|
def _init_host(self): |
|
"""Initialize Worker host |
|
|
|
Init db connection, load and validate processing |
|
hooks, runs periodic tasks. |
|
|
|
:returns None |
|
""" |
|
db.init() |
|
|
|
try: |
|
hooks = plugins_base.validate_processing_hooks() |
|
except Exception as exc: |
|
LOG.critical(str(exc)) |
|
sys.exit(1) |
|
|
|
LOG.info('Enabled processing hooks: %s', [h.name for h in hooks]) |
|
|
|
driver = pxe_filter.driver() |
|
driver.init_filter() |
|
|
|
periodic_clean_up_ = periodics.periodic( |
|
spacing=CONF.clean_up_period |
|
)(periodic_clean_up) |
|
|
|
self._periodics_worker = periodics.PeriodicWorker( |
|
callables=[(driver.get_periodic_sync_task(), None, None), |
|
(periodic_clean_up_, None, None)], |
|
executor_factory=periodics.ExistingExecutor(utils.executor()), |
|
on_failure=self._periodics_watchdog) |
|
utils.executor().submit(self._periodics_worker.start) |
|
|
|
def _periodics_watchdog(self, callable_, activity, spacing, exc_info, |
|
traceback=None): |
|
LOG.exception("The periodic %(callable)s failed with: %(exception)s", { |
|
'exception': ''.join(traceback_mod.format_exception(*exc_info)), |
|
'callable': reflection.get_callable_name(callable_)}) |
|
# NOTE(milan): spawn new thread otherwise waiting would block |
|
eventlet.spawn(self.shutdown, error=str(exc_info[1])) |
|
|
|
def shutdown(self, error=None): |
|
"""Stop serving API, clean up. |
|
|
|
:returns: None |
|
""" |
|
# TODO(aarefiev): move shutdown code to WorkerService |
|
if not self._shutting_down.acquire(blocking=False): |
|
LOG.warning('Attempted to shut down while already shutting down') |
|
return |
|
|
|
LOG.debug('Shutting down') |
|
|
|
self.rpc_server.stop() |
|
|
|
if self._periodics_worker is not None: |
|
try: |
|
self._periodics_worker.stop() |
|
self._periodics_worker.wait() |
|
except Exception as e: |
|
LOG.exception('Service error occurred when stopping ' |
|
'periodic workers. Error: %s', e) |
|
self._periodics_worker = None |
|
|
|
if utils.executor().alive: |
|
utils.executor().shutdown(wait=True) |
|
|
|
pxe_filter.driver().tear_down_filter() |
|
|
|
self._shutting_down.release() |
|
LOG.info('Shut down successfully') |
|
sys.exit(error) |
|
|
|
def run(self): |
|
"""Start serving this service using loaded application. |
|
|
|
:returns: None |
|
""" |
|
app_kwargs = {'host': CONF.listen_address, |
|
'port': CONF.listen_port} |
|
|
|
context = self._create_ssl_context() |
|
if context: |
|
app_kwargs['ssl_context'] = context |
|
|
|
self._init_middleware() |
|
|
|
self._init_host() |
|
|
|
self.rpc_server = rpc.get_server() |
|
self.rpc_server.start() |
|
|
|
try: |
|
self.app.run(**app_kwargs) |
|
except Exception as e: |
|
self.shutdown(error=str(e)) |
|
else: |
|
self.shutdown() |
|
|
|
def _handle_sighup_bg(self, *args): |
|
"""Reload config on SIGHUP.""" |
|
CONF.mutate_config_files() |
|
|
|
def _handle_sighup(self, *args): |
|
eventlet.spawn(self._handle_sighup_bg, *args) |
|
|
|
def _handle_sigterm(self, *args): |
|
# This is a workaround to ensure that shutdown() is done when recieving |
|
# SIGTERM. Raising KeyboardIntrerrupt which won't be caught by any |
|
# 'except Exception' clauses. |
|
raise KeyboardInterrupt |
|
|
|
|
|
def periodic_clean_up(): # pragma: no cover |
|
try: |
|
if node_cache.clean_up(): |
|
pxe_filter.driver().sync(ir_utils.get_client()) |
|
except Exception: |
|
LOG.exception('Periodic clean up of node cache failed') |
|
|
|
try: |
|
sync_with_ironic() |
|
except Exception: |
|
LOG.exception('Periodic sync of node list with ironic failed') |
|
|
|
|
|
def sync_with_ironic(): |
|
ironic = ir_utils.get_client() |
|
# TODO(yuikotakada): pagination |
|
ironic_nodes = ironic.node.list(limit=0) |
|
ironic_node_uuids = {node.uuid for node in ironic_nodes} |
|
node_cache.delete_nodes_not_in_list(ironic_node_uuids)
|
|
|