# 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.
"""Inspection implementation for the conductor."""
from oslo_log import log
from oslo_utils import excutils
from ironic.common import exception
from ironic.common.i18n import _
from ironic.common import states
from ironic.conductor import task_manager
from ironic.conductor import utils
from ironic.drivers.modules import inspect_utils
LOG = log.getLogger(__name__)
[docs]
@task_manager.require_exclusive_lock
def inspect_hardware(task):
"""Initiates inspection.
:param task: a TaskManager instance with an exclusive lock
on its node.
:raises: HardwareInspectionFailure if driver doesn't
return the state as states.MANAGEABLE, states.INSPECTWAIT.
"""
node = task.node
def handle_failure(e, log_func=LOG.error):
utils.node_history_record(task.node, event=e,
event_type=states.INTROSPECTION,
error=True, user=task.context.user_id)
task.process_event('fail')
log_func("Failed to inspect node %(node)s: %(err)s",
{'node': node.uuid, 'err': e})
# Inspection cannot start in fast-track mode, wipe token and URL.
utils.wipe_token_and_url(task)
try:
new_state = task.driver.inspect.inspect_hardware(task)
except exception.IronicException as e:
with excutils.save_and_reraise_exception():
error = str(e)
handle_failure(error)
except Exception as e:
error = (_('Unexpected exception of type %(type)s: %(msg)s') %
{'type': type(e).__name__, 'msg': e})
handle_failure(error, log_func=LOG.exception)
raise exception.HardwareInspectionFailure(error=error)
if new_state == states.MANAGEABLE:
task.process_event('done')
LOG.info('Successfully inspected node %(node)s',
{'node': node.uuid})
elif new_state == states.INSPECTWAIT:
task.process_event('wait')
LOG.info('Successfully started introspection on node %(node)s',
{'node': node.uuid})
else:
error = (_("During inspection, driver returned unexpected "
"state %(state)s") % {'state': new_state})
handle_failure(error)
raise exception.HardwareInspectionFailure(error=error)
[docs]
@task_manager.require_exclusive_lock
def abort_inspection(task):
"""Abort inspection for the node."""
node = task.node
try:
task.driver.inspect.abort(task)
except exception.UnsupportedDriverExtension:
with excutils.save_and_reraise_exception():
LOG.error('Inspect interface "%(intf)s" does not support abort '
'operation for node %(node)s',
{'intf': node.inspect_interface, 'node': node.uuid})
except Exception as e:
with excutils.save_and_reraise_exception():
LOG.exception('Error when aborting inspection of node %(node)s',
{'node': node.uuid})
error = _('Failed to abort inspection: %s') % e
utils.node_history_record(task.node, event=error,
event_type=states.INTROSPECTION,
error=True,
user=task.context.user_id)
node.save()
error = _('Inspection was aborted by request.')
utils.node_history_record(task.node, event=error,
event_type=states.INTROSPECTION,
error=True,
user=task.context.user_id)
utils.wipe_token_and_url(task)
task.process_event('abort')
LOG.info('Successfully aborted inspection of node %(node)s',
{'node': node.uuid})
[docs]
@task_manager.require_exclusive_lock
def continue_inspection(task, inventory, plugin_data):
"""Continue inspection for the node."""
node = task.node
LOG.debug('Inventory for node %(node)s: %(data)s',
{'node': node.uuid, 'data': inventory})
plugin_data = plugin_data or {}
try:
result = task.driver.inspect.continue_inspection(
task, inventory, plugin_data)
if result == states.INSPECTWAIT:
if task.node.provision_state == states.INSPECTING:
task.process_event('wait')
LOG.debug('Waiting for inspection data to be processed '
'asynchronously for node %s', node.uuid)
return
# NOTE(dtantsur): logs can be huge and are stored separately
plugin_data.pop('logs', None)
# NOTE(dtantsur): this is done *after* processing to allow
# modifications, especially to plugin_data.
inspect_utils.store_inspection_data(
node, inventory, plugin_data, context=task.context)
except exception.UnsupportedDriverExtension:
with excutils.save_and_reraise_exception():
intf_name = task.driver.inspect.__class__.__name__
LOG.error('Inspect interface %(intf)s does not '
'support processing inspection data for node %(node)s',
{'intf': intf_name, 'node': node.uuid})
except Exception as e:
with excutils.save_and_reraise_exception():
LOG.exception('Error when processing inspection data for '
'node %(node)s', {'node': node.uuid})
error = _('Failed to finish inspection: %s') % e
utils.node_history_record(task.node, event=error,
event_type=states.INTROSPECTION,
error=True)
if node.provision_state != states.ENROLL:
task.process_event('fail')
if node.provision_state != states.ENROLL:
task.process_event('done')
LOG.info('Successfully finished inspection of node %s', node.uuid)
else:
LOG.info('Successfully finished auto-discovery of node %s', node.uuid)
