210 lines
7.6 KiB
Python
210 lines
7.6 KiB
Python
# 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.
|
|
|
|
"""
|
|
Modules required to work with ironic_inspector:
|
|
https://pypi.python.org/pypi/ironic-inspector
|
|
"""
|
|
|
|
import eventlet
|
|
from futurist import periodics
|
|
from oslo_log import log as logging
|
|
from oslo_utils import importutils
|
|
|
|
from ironic.common import exception
|
|
from ironic.common.i18n import _
|
|
from ironic.common import keystone
|
|
from ironic.common import states
|
|
from ironic.conductor import task_manager
|
|
from ironic.conf import CONF
|
|
from ironic.drivers import base
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
client = importutils.try_import('ironic_inspector_client')
|
|
|
|
|
|
INSPECTOR_API_VERSION = (1, 0)
|
|
|
|
_INSPECTOR_SESSION = None
|
|
|
|
|
|
def _get_inspector_session(**kwargs):
|
|
global _INSPECTOR_SESSION
|
|
if not _INSPECTOR_SESSION:
|
|
_INSPECTOR_SESSION = keystone.get_session('inspector', **kwargs)
|
|
return _INSPECTOR_SESSION
|
|
|
|
|
|
def _get_client(context):
|
|
"""Helper to get inspector client instance."""
|
|
# NOTE(pas-ha) remove in Rocky
|
|
if CONF.auth_strategy != 'keystone':
|
|
CONF.set_override('auth_type', 'none', group='inspector')
|
|
service_auth = keystone.get_auth('inspector')
|
|
session = _get_inspector_session(auth=service_auth)
|
|
adapter_params = {}
|
|
if CONF.inspector.service_url and not CONF.inspector.endpoint_override:
|
|
adapter_params['endpoint_override'] = CONF.inspector.service_url
|
|
adapter = keystone.get_adapter('inspector', session=session,
|
|
**adapter_params)
|
|
inspector_url = adapter.get_endpoint()
|
|
# TODO(pas-ha) investigate possibility of passing user context here,
|
|
# similar to what neutron/glance-related code does
|
|
# NOTE(pas-ha) ironic-inspector-client has no Adaper-based
|
|
# SessionClient, so we'll resolve inspector API form adapter loaded
|
|
# form config options
|
|
# TODO(pas-ha) rewrite when inspectorclient is based on ksa Adapter,
|
|
# also add global_request_id to the call
|
|
return client.ClientV1(api_version=INSPECTOR_API_VERSION,
|
|
session=session,
|
|
inspector_url=inspector_url)
|
|
|
|
|
|
class Inspector(base.InspectInterface):
|
|
"""In-band inspection via ironic-inspector project."""
|
|
|
|
@classmethod
|
|
def create_if_enabled(cls, driver_name):
|
|
"""Create instance of Inspector if it's enabled.
|
|
|
|
Reports log warning with given driver_name if it's not.
|
|
|
|
:return: Inspector instance or None
|
|
"""
|
|
if CONF.inspector.enabled:
|
|
return cls()
|
|
else:
|
|
LOG.info("Inspection via ironic-inspector is disabled in "
|
|
"configuration for driver %s. To enable, change "
|
|
"[inspector] enabled = True.", driver_name)
|
|
|
|
def __init__(self):
|
|
if not client:
|
|
raise exception.DriverLoadError(
|
|
_('python-ironic-inspector-client Python module not found'))
|
|
|
|
def get_properties(self):
|
|
"""Return the properties of the interface.
|
|
|
|
:returns: dictionary of <property name>:<property description> entries.
|
|
"""
|
|
return {} # no properties
|
|
|
|
def validate(self, task):
|
|
"""Validate the driver-specific inspection information.
|
|
|
|
If invalid, raises an exception; otherwise returns None.
|
|
|
|
:param task: a task from TaskManager.
|
|
"""
|
|
# NOTE(deva): this is not callable if inspector is disabled
|
|
# so don't raise an exception -- just pass.
|
|
pass
|
|
|
|
def inspect_hardware(self, task):
|
|
"""Inspect hardware to obtain the hardware properties.
|
|
|
|
This particular implementation only starts inspection using
|
|
ironic-inspector. Results will be checked in a periodic task.
|
|
|
|
:param task: a task from TaskManager.
|
|
:returns: states.INSPECTING
|
|
"""
|
|
LOG.debug('Starting inspection for node %(uuid)s using '
|
|
'ironic-inspector', {'uuid': task.node.uuid})
|
|
|
|
# NOTE(dtantsur): we're spawning a short-living green thread so that
|
|
# we can release a lock as soon as possible and allow ironic-inspector
|
|
# to operate on a node.
|
|
eventlet.spawn_n(_start_inspection, task.node.uuid, task.context)
|
|
return states.INSPECTING
|
|
|
|
@periodics.periodic(spacing=CONF.inspector.status_check_period)
|
|
def _periodic_check_result(self, manager, context):
|
|
"""Periodic task checking results of inspection."""
|
|
filters = {'provision_state': states.INSPECTING}
|
|
node_iter = manager.iter_nodes(filters=filters)
|
|
|
|
for node_uuid, driver in node_iter:
|
|
try:
|
|
lock_purpose = 'checking hardware inspection status'
|
|
with task_manager.acquire(context, node_uuid,
|
|
shared=True,
|
|
purpose=lock_purpose) as task:
|
|
_check_status(task)
|
|
except (exception.NodeLocked, exception.NodeNotFound):
|
|
continue
|
|
|
|
|
|
def _start_inspection(node_uuid, context):
|
|
"""Call to inspector to start inspection."""
|
|
try:
|
|
_get_client(context).introspect(node_uuid)
|
|
except Exception as exc:
|
|
LOG.exception('Exception during contacting ironic-inspector '
|
|
'for inspection of node %(node)s: %(err)s',
|
|
{'node': node_uuid, 'err': exc})
|
|
# NOTE(dtantsur): if acquire fails our last option is to rely on
|
|
# timeout
|
|
lock_purpose = 'recording hardware inspection error'
|
|
with task_manager.acquire(context, node_uuid,
|
|
purpose=lock_purpose) as task:
|
|
task.node.last_error = _('Failed to start inspection: %s') % exc
|
|
task.process_event('fail')
|
|
else:
|
|
LOG.info('Node %s was sent to inspection to ironic-inspector',
|
|
node_uuid)
|
|
|
|
|
|
def _check_status(task):
|
|
"""Check inspection status for node given by a task."""
|
|
node = task.node
|
|
if node.provision_state != states.INSPECTING:
|
|
return
|
|
if not isinstance(task.driver.inspect, Inspector):
|
|
return
|
|
|
|
LOG.debug('Calling to inspector to check status of node %s',
|
|
task.node.uuid)
|
|
|
|
try:
|
|
status = _get_client(task.context).get_status(node.uuid)
|
|
except Exception:
|
|
# NOTE(dtantsur): get_status should not normally raise
|
|
# let's assume it's a transient failure and retry later
|
|
LOG.exception('Unexpected exception while getting '
|
|
'inspection status for node %s, will retry later',
|
|
node.uuid)
|
|
return
|
|
|
|
error = status.get('error')
|
|
finished = status.get('finished')
|
|
if not error and not finished:
|
|
return
|
|
|
|
# If the inspection has finished or failed, we need to update the node, so
|
|
# upgrade our lock to an exclusive one.
|
|
task.upgrade_lock()
|
|
node = task.node
|
|
|
|
if error:
|
|
LOG.error('Inspection failed for node %(uuid)s with error: %(err)s',
|
|
{'uuid': node.uuid, 'err': error})
|
|
node.last_error = (_('ironic-inspector inspection failed: %s')
|
|
% error)
|
|
task.process_event('fail')
|
|
elif finished:
|
|
LOG.info('Inspection finished successfully for node %s', node.uuid)
|
|
task.process_event('done')
|