# Copyright 2010 United States Government as represented by the
# Administrator of the National Aeronautics and Space Administration.
# 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.
"""Ironic specific exceptions list."""
import collections
from http import client as http_client
import json
from oslo_config import cfg
from oslo_log import log as logging
from oslo_utils import excutils
from ironic.common.i18n import _
LOG = logging.getLogger(__name__)
CONF = cfg.CONF
def _ensure_exception_kwargs_serializable(exc_class_name, kwargs):
"""Ensure that kwargs are serializable
Ensure that all kwargs passed to exception constructor can be passed over
RPC, by trying to convert them to JSON, or, as a last resort, to string.
If it is not possible, unserializable kwargs will be removed, letting the
receiver handle the exception string as it is configured to.
:param exc_class_name: a IronicException class name.
:param kwargs: a dictionary of keyword arguments passed to the exception
constructor.
:returns: a dictionary of serializable keyword arguments.
"""
serializers = [(json.dumps, _('when converting to JSON')),
(str, _('when converting to string'))]
exceptions = collections.defaultdict(list)
serializable_kwargs = {}
for k, v in kwargs.items():
for serializer, msg in serializers:
try:
serializable_kwargs[k] = serializer(v)
exceptions.pop(k, None)
break
except Exception as e:
exceptions[k].append(
'(%(serializer_type)s) %(e_type)s: %(e_contents)s' %
{'serializer_type': msg, 'e_contents': e,
'e_type': e.__class__.__name__})
if exceptions:
LOG.error("One or more arguments passed to the %(exc_class)s "
"constructor as kwargs can not be serialized. The "
"serialized arguments: %(serialized)s. These "
"unserialized kwargs were dropped because of the "
"exceptions encountered during their "
"serialization:\n%(errors)s",
dict(errors=';\n'.join("%s: %s" % (k, '; '.join(v))
for k, v in exceptions.items()),
exc_class=exc_class_name,
serialized=serializable_kwargs))
# We might be able to actually put the following keys' values into
# format string, but there is no guarantee, drop it just in case.
for k in exceptions:
del kwargs[k]
return serializable_kwargs
[docs]
class IronicException(Exception):
"""Base Ironic Exception
To correctly use this class, inherit from it and define
a '_msg_fmt' property. That _msg_fmt will get printf'd
with the keyword arguments provided to the constructor.
If you need to access the message from an exception you should use
str(exc)
"""
_msg_fmt = _("An unknown exception occurred.")
code = 500
headers = {}
safe = False
def __init__(self, message=None, **kwargs):
self.kwargs = _ensure_exception_kwargs_serializable(
self.__class__.__name__, kwargs)
if 'code' not in self.kwargs:
try:
self.kwargs['code'] = self.code
except AttributeError:
pass
else:
self.code = int(kwargs['code'])
if not message:
try:
message = self._msg_fmt % kwargs
except Exception:
with excutils.save_and_reraise_exception() as ctxt:
# kwargs doesn't match a variable in the message
# log the issue and the kwargs
prs = ', '.join('%s=%s' % pair for pair in kwargs.items())
LOG.exception('Exception in string format operation '
'(arguments %s)', prs)
if not CONF.errors.fatal_exception_format_errors:
# at least get the core message out if something
# happened
message = self._msg_fmt
ctxt.reraise = False
super(IronicException, self).__init__(message)
[docs]
class NotAuthorized(IronicException):
_msg_fmt = _("Not authorized.")
code = http_client.FORBIDDEN
[docs]
class OperationNotPermitted(NotAuthorized):
_msg_fmt = _("Operation not permitted.")
[docs]
class Invalid(IronicException):
_msg_fmt = _("Unacceptable parameters.")
code = http_client.BAD_REQUEST
[docs]
class Conflict(IronicException):
_msg_fmt = _('Conflict.')
code = http_client.CONFLICT
[docs]
class TemporaryFailure(IronicException):
_msg_fmt = _("Resource temporarily unavailable, please retry.")
code = http_client.SERVICE_UNAVAILABLE
[docs]
class NotAcceptable(IronicException):
# TODO(tenbrae): We need to set response headers in the API
# for this exception
_msg_fmt = _("Request not acceptable.")
code = http_client.NOT_ACCEPTABLE
[docs]
class InvalidState(Conflict):
_msg_fmt = _("Invalid resource state.")
[docs]
class NodeAlreadyExists(Conflict):
_msg_fmt = _("A node with UUID %(uuid)s already exists.")
[docs]
class MACAlreadyExists(Conflict):
_msg_fmt = _("A port with MAC address %(mac)s already exists.")
[docs]
class ChassisAlreadyExists(Conflict):
_msg_fmt = _("A chassis with UUID %(uuid)s already exists.")
[docs]
class PortAlreadyExists(Conflict):
_msg_fmt = _("A port with UUID %(uuid)s already exists.")
[docs]
class PortDuplicateName(Conflict):
_msg_fmt = _("A port with name %(name)s already exists.")
[docs]
class PortgroupAlreadyExists(Conflict):
_msg_fmt = _("A portgroup with UUID %(uuid)s already exists.")
[docs]
class PortgroupDuplicateName(Conflict):
_msg_fmt = _("A portgroup with name %(name)s already exists.")
[docs]
class PortgroupMACAlreadyExists(Conflict):
_msg_fmt = _("A portgroup with MAC address %(mac)s already exists.")
[docs]
class InstanceAssociated(Conflict):
_msg_fmt = _("Instance %(instance_uuid)s is already associated with a "
"node, it cannot be associated with this other node %(node)s")
[docs]
class DuplicateName(Conflict):
_msg_fmt = _("A node with name %(name)s already exists.")
[docs]
class VolumeConnectorAlreadyExists(Conflict):
_msg_fmt = _("A volume connector with UUID %(uuid)s already exists.")
[docs]
class VolumeConnectorTypeAndIdAlreadyExists(Conflict):
_msg_fmt = _("A volume connector with type %(type)s and connector ID "
"%(connector_id)s already exists.")
[docs]
class NodeInventoryAlreadyExists(Conflict):
_msg_fmt = _("A node inventory with ID %(id)s already exists.")
[docs]
class VifAlreadyAttached(Conflict):
_msg_fmt = _("Unable to attach VIF because VIF %(vif)s is already "
"attached to Ironic %(object_type)s %(object_uuid)s")
[docs]
class NoFreePhysicalPorts(Invalid):
_msg_fmt = _("Unable to attach VIF %(vif)s, not "
"enough free physical ports.")
[docs]
class VifNotAttached(Invalid):
_msg_fmt = _("Unable to detach VIF %(vif)s from node %(node)s "
"because it is not attached to it.")
[docs]
class InvalidUUID(Invalid):
_msg_fmt = _("Expected a UUID but received %(uuid)s.")
[docs]
class InvalidUuidOrName(Invalid):
_msg_fmt = _("Expected a logical name or UUID but received %(name)s.")
[docs]
class InvalidName(Invalid):
_msg_fmt = _("Expected a logical name but received %(name)s.")
[docs]
class InvalidConductorGroup(Invalid):
_msg_fmt = _("Expected a conductor group but received %(group)s.")
[docs]
class InvalidIdentity(Invalid):
_msg_fmt = _("Expected a UUID or int but received %(identity)s.")
[docs]
class InvalidMAC(Invalid):
_msg_fmt = _("Expected a MAC address but received %(mac)s.")
[docs]
class InvalidSwitchID(Invalid):
_msg_fmt = _("Expected a MAC address or OpenFlow datapath ID but "
"received %(switch_id)s.")
[docs]
class InvalidDatapathID(Invalid):
_msg_fmt = _("Expected an OpenFlow datapath ID but received "
"%(datapath_id)s.")
[docs]
class InvalidStateRequested(Invalid):
_msg_fmt = _('The requested action "%(action)s" can not be performed '
'on node "%(node)s" while it is in state "%(state)s".')
[docs]
class PatchError(Invalid):
_msg_fmt = _("Couldn't apply patch '%(patch)s'. Reason: %(reason)s")
[docs]
class InstanceDeployFailure(IronicException):
_msg_fmt = _("Failed to deploy instance: %(reason)s")
[docs]
class ImageUnacceptable(IronicException):
_msg_fmt = _("Image %(image_id)s is unacceptable: %(reason)s")
[docs]
class ImageConvertFailed(IronicException):
_msg_fmt = _("Image %(image_id)s is unacceptable: %(reason)s")
# Cannot be templated as the error syntax varies.
# msg needs to be constructed when raised.
[docs]
class InvalidParameterValue(Invalid):
_msg_fmt = "%(err)s"
[docs]
class MissingParameterValue(InvalidParameterValue):
_msg_fmt = "%(err)s"
[docs]
class Duplicate(IronicException):
_msg_fmt = _("Resource already exists.")
[docs]
class NotFound(IronicException):
_msg_fmt = _("Resource could not be found.")
code = http_client.NOT_FOUND
[docs]
class DHCPLoadError(IronicException):
_msg_fmt = _("Failed to load DHCP provider %(dhcp_provider_name)s, "
"reason: %(reason)s")
# TODO(dtantsur): word "driver" is overused in class names here, and generally
# means stevedore driver, not ironic driver. Rename them in the future.
[docs]
class DriverNotFound(NotFound):
_msg_fmt = _("Could not find the following driver(s) or hardware type(s): "
"%(driver_name)s.")
[docs]
class DriverNotFoundInEntrypoint(DriverNotFound):
_msg_fmt = _("Could not find the following items in the "
"'%(entrypoint)s' entrypoint: %(names)s.")
[docs]
class InterfaceNotFoundInEntrypoint(InvalidParameterValue):
_msg_fmt = _("Could not find the following interface in the "
"'%(entrypoint)s' entrypoint: %(iface)s. Valid interfaces "
"are %(valid)s.")
[docs]
class IncompatibleInterface(InvalidParameterValue):
_msg_fmt = _("%(interface_type)s interface implementation "
"'%(interface_impl)s' is not supported by hardware type "
"%(hardware_type)s.")
[docs]
class NoValidDefaultForInterface(InvalidParameterValue):
# NOTE(rloo): in the line below, there is no blank space after 'For'
# because node_info could be an empty string. If node_info
# is not empty, it should start with a space.
_msg_fmt = _("For%(node_info)s hardware type '%(driver)s', no default "
"value found for %(interface_type)s interface could be "
"determined. Please ensure the interfaces are enabled.")
[docs]
class ImageNotFound(NotFound):
_msg_fmt = _("Image %(image_id)s could not be found.")
[docs]
class NoValidHost(NotFound):
_msg_fmt = _("No valid host was found. Reason: %(reason)s")
[docs]
class InstanceNotFound(NotFound):
_msg_fmt = _("Instance %(instance)s could not be found.")
[docs]
class NodeNotFound(NotFound):
_msg_fmt = _("Node %(node)s could not be found.")
[docs]
class DuplicateNodeOnLookup(NodeNotFound):
pass # Same error message, the difference only matters internally
[docs]
class PortgroupNotFound(NotFound):
_msg_fmt = _("Portgroup %(portgroup)s could not be found.")
[docs]
class PortgroupNotEmpty(Invalid):
_msg_fmt = _("Cannot complete the requested action because portgroup "
"%(portgroup)s contains ports.")
[docs]
class NodeAssociated(InvalidState):
_msg_fmt = _("Node %(node)s is associated with instance %(instance)s.")
[docs]
class PortNotFound(NotFound):
_msg_fmt = _("Port %(port)s could not be found.")
[docs]
class FailedToUpdateDHCPOptOnPort(IronicException):
_msg_fmt = _("Update DHCP options on port: %(port_id)s failed.")
[docs]
class FailedToCleanDHCPOpts(IronicException):
_msg_fmt = _("Clean up DHCP options on node: %(node)s failed.")
[docs]
class FailedToGetIPAddressOnPort(IronicException):
_msg_fmt = _("Retrieve IP address on port: %(port_id)s failed.")
[docs]
class InvalidIPv4Address(IronicException):
_msg_fmt = _("Invalid IPv4 address %(ip_address)s.")
[docs]
class InvalidIPAddress(IronicException):
_msg_fmt = _("Invalid IP address %(ip_address)s.")
[docs]
class FailedToUpdateMacOnPort(IronicException):
_msg_fmt = _("Update MAC address on port: %(port_id)s failed.")
[docs]
class ChassisNotFound(NotFound):
_msg_fmt = _("Chassis %(chassis)s could not be found.")
[docs]
class VolumeConnectorNotFound(NotFound):
_msg_fmt = _("Volume connector %(connector)s could not be found.")
[docs]
class NoDriversLoaded(IronicException):
_msg_fmt = _("Conductor %(conductor)s cannot be started "
"because no hardware types were loaded.")
[docs]
class ConductorNotFound(NotFound):
_msg_fmt = _("Conductor %(conductor)s could not be found.")
[docs]
class ConductorAlreadyRegistered(IronicException):
_msg_fmt = _("Conductor %(conductor)s already registered.")
[docs]
class ConductorHardwareInterfacesAlreadyRegistered(IronicException):
_msg_fmt = _("Duplication detected for hardware_type, interface_type "
"and interface combinations for this conductor while "
"registering the row %(row)s")
[docs]
class PowerStateFailure(InvalidState):
_msg_fmt = _("Failed to set node power state to %(pstate)s.")
[docs]
class ExclusiveLockRequired(NotAuthorized):
_msg_fmt = _("An exclusive lock is required, "
"but the current context has a shared lock.")
[docs]
class NodeMaintenanceFailure(Invalid):
_msg_fmt = _("Failed to toggle maintenance-mode flag "
"for node %(node)s: %(reason)s")
[docs]
class NodeConsoleNotEnabled(Invalid):
_msg_fmt = _("Console access is not enabled on node %(node)s")
[docs]
class NodeInMaintenance(Invalid):
_msg_fmt = _("The %(op)s operation can't be performed on node "
"%(node)s because it's in maintenance mode.")
[docs]
class ChassisNotEmpty(Invalid):
_msg_fmt = _("Cannot complete the requested action because chassis "
"%(chassis)s contains nodes.")
[docs]
class IPMIFailure(IronicException):
_msg_fmt = _("IPMI call failed: %(cmd)s.")
[docs]
class UnsupportedDriverExtension(Invalid):
_msg_fmt = _('Driver %(driver)s does not support %(extension)s '
'(disabled or not implemented).')
[docs]
class GlanceConnectionFailed(IronicException):
_msg_fmt = _("Connection to glance endpoint %(endpoint)s failed: "
"%(reason)s")
[docs]
class ImageNotAuthorized(NotAuthorized):
_msg_fmt = _("Not authorized for image %(image_id)s.")
[docs]
class InvalidImageRef(InvalidParameterValue):
_msg_fmt = _("Invalid image href %(image_href)s.")
[docs]
class ImageRefValidationFailed(IronicException):
_msg_fmt = _("Validation of image href %(image_href)s failed, "
"reason: %(reason)s")
[docs]
class ImageDownloadFailed(IronicException):
_msg_fmt = _("Failed to download image %(image_href)s, reason: %(reason)s")
[docs]
class KeystoneUnauthorized(IronicException):
_msg_fmt = _("Not authorized in Keystone.")
[docs]
class KeystoneFailure(IronicException):
pass
[docs]
class CatalogNotFound(IronicException):
_msg_fmt = _("Service type %(service_type)s with endpoint type "
"%(endpoint_type)s not found in keystone service catalog.")
[docs]
class ServiceUnavailable(IronicException):
_msg_fmt = _("Connection failed")
[docs]
class Forbidden(IronicException):
_msg_fmt = _("Requested OpenStack Baremetal API is forbidden")
# TODO(dtantsur): leave only one variant
BadRequest = Invalid
[docs]
class InvalidEndpoint(IronicException):
_msg_fmt = _("The provided endpoint is invalid")
[docs]
class CommunicationError(IronicException):
_msg_fmt = _("Unable to communicate with the server.")
[docs]
class HTTPForbidden(NotAuthorized):
_msg_fmt = _("Access was denied to the following resource: %(resource)s")
# TODO(dtantsur): leave only one variant
HTTPNotFound = NotFound
[docs]
class ConfigNotFound(IronicException):
_msg_fmt = _("Could not find config at %(path)s")
[docs]
class NodeLocked(Conflict):
_msg_fmt = _("Node %(node)s is locked by host %(host)s, please retry "
"after the current operation is completed.")
[docs]
class NodeNotLocked(Invalid):
_msg_fmt = _("Node %(node)s found not to be locked on release")
[docs]
class NoFreeConductorWorker(TemporaryFailure):
_msg_fmt = _('Requested action cannot be performed due to lack of free '
'conductor workers.')
code = http_client.SERVICE_UNAVAILABLE
[docs]
class VendorPassthruException(IronicException):
pass
[docs]
class ConfigInvalid(IronicException):
_msg_fmt = _("Invalid configuration file. %(error_msg)s")
[docs]
class DriverLoadError(IronicException):
_msg_fmt = _("Driver, hardware type or interface %(driver)s could not be "
"loaded. Reason: %(reason)s.")
[docs]
class DriverOperationError(IronicException):
_msg_fmt = _("Runtime driver %(driver)s failure. Reason: %(reason)s.")
[docs]
class ConsoleError(IronicException):
pass
[docs]
class NoConsolePid(ConsoleError):
_msg_fmt = _("Could not find pid in pid file %(pid_path)s")
[docs]
class ConsoleSubprocessFailed(ConsoleError):
_msg_fmt = _("Console subprocess failed to start. %(error)s")
[docs]
class PasswordFileFailedToCreate(IronicException):
_msg_fmt = _("Failed to create the password file. %(error)s")
[docs]
class IloOperationError(DriverOperationError):
_msg_fmt = _("%(operation)s failed, error: %(error)s")
[docs]
class IloOperationNotSupported(DriverOperationError):
_msg_fmt = _("%(operation)s not supported. error: %(error)s")
[docs]
class DracOperationError(DriverOperationError):
_msg_fmt = _('DRAC operation failed. Reason: %(error)s')
[docs]
class FailedToGetSensorData(IronicException):
_msg_fmt = _("Failed to get sensor data for node %(node)s. "
"Error: %(error)s")
[docs]
class FailedToParseSensorData(IronicException):
_msg_fmt = _("Failed to parse sensor data for node %(node)s. "
"Error: %(error)s")
[docs]
class InsufficientDiskSpace(IronicException):
_msg_fmt = _("Disk volume where '%(path)s' is located doesn't have "
"enough disk space. Required %(required)d MiB, "
"only %(actual)d MiB available space present.")
[docs]
class ImageCreationFailed(IronicException):
_msg_fmt = _('Creating %(image_type)s image failed: %(error)s')
[docs]
class SwiftOperationError(IronicException):
_msg_fmt = _("Swift operation '%(operation)s' failed: %(error)s")
[docs]
class SwiftObjectNotFoundError(SwiftOperationError):
_msg_fmt = _("Swift object %(obj)s from container %(container)s "
"not found. Operation '%(operation)s' failed.")
[docs]
class SNMPFailure(DriverOperationError):
_msg_fmt = _("SNMP operation '%(operation)s' failed: %(error)s")
[docs]
class FileSystemNotSupported(IronicException):
_msg_fmt = _("Failed to create a file system. "
"File system %(fs)s is not supported.")
[docs]
class IRMCOperationError(DriverOperationError):
_msg_fmt = _('iRMC %(operation)s failed. Reason: %(error)s')
[docs]
class IRMCSharedFileSystemNotMounted(DriverOperationError):
_msg_fmt = _("iRMC shared file system '%(share)s' is not mounted.")
[docs]
class HardwareInspectionFailure(IronicException):
_msg_fmt = _("Failed to inspect hardware. Reason: %(error)s")
[docs]
class NodeCleaningFailure(IronicException):
_msg_fmt = _("Failed to clean node %(node)s: %(reason)s")
[docs]
class NodeServicingFailure(IronicException):
_msg_fmt = _("Failed to service node %(node)s: %(reason)s")
[docs]
class PathNotFound(IronicException):
_msg_fmt = _("Path %(dir)s does not exist.")
[docs]
class DirectoryNotWritable(IronicException):
_msg_fmt = _("Directory %(dir)s is not writable.")
[docs]
class ImageUploadFailed(IronicException):
_msg_fmt = _("Failed to upload %(image_name)s image to web server "
"%(web_server)s, reason: %(reason)s")
[docs]
class NodeTagNotFound(IronicException):
_msg_fmt = _("Node %(node_id)s doesn't have a tag '%(tag)s'")
[docs]
class NetworkError(IronicException):
_msg_fmt = _("Network operation failure.")
[docs]
class IncompleteLookup(Invalid):
_msg_fmt = _("At least one of 'addresses' and 'node_uuid' parameters "
"is required")
[docs]
class NotificationSchemaObjectError(IronicException):
_msg_fmt = _("Expected object %(obj)s when populating notification payload"
" but got object %(source)s")
[docs]
class NotificationSchemaKeyError(IronicException):
_msg_fmt = _("Object %(obj)s doesn't have the field \"%(field)s\" "
"required for populating notification schema key "
"\"%(key)s\"")
[docs]
class NotificationPayloadError(IronicException):
_msg_fmt = _("Payload not populated when trying to send notification "
"\"%(class_name)s\"")
[docs]
class StorageError(IronicException):
_msg_fmt = _("Storage operation failure.")
[docs]
class RedfishError(DriverOperationError):
_msg_fmt = _("Redfish exception occurred. Error: %(error)s")
[docs]
class RedfishConnectionError(RedfishError):
_msg_fmt = _("Redfish connection failed for node %(node)s: %(error)s")
[docs]
class PortgroupPhysnetInconsistent(IronicException):
_msg_fmt = _("Port group %(portgroup)s has member ports with inconsistent "
"physical networks (%(physical_networks)s). All ports in a "
"port group must have the same physical network.")
[docs]
class VifInvalidForAttach(Conflict):
_msg_fmt = _("Unable to attach VIF %(vif)s to node %(node)s. Reason: "
"%(reason)s")
[docs]
class AgentAPIError(IronicException):
_msg_fmt = _('Agent API for node %(node)s returned HTTP status code '
'%(status)s with error: %(error)s')
[docs]
class NodeTraitNotFound(NotFound):
_msg_fmt = _("Node %(node_id)s doesn't have a trait '%(trait)s'")
[docs]
class InstanceRescueFailure(IronicException):
_msg_fmt = _('Failed to rescue instance %(instance)s for node '
'%(node)s: %(reason)s')
[docs]
class InstanceUnrescueFailure(IronicException):
_msg_fmt = _('Failed to unrescue instance %(instance)s for node '
'%(node)s: %(reason)s')
[docs]
class BIOSSettingAlreadyExists(Conflict):
_msg_fmt = _('A BIOS setting %(name)s for node %(node)s already exists.')
[docs]
class BIOSSettingNotFound(NotFound):
_msg_fmt = _("Node %(node)s doesn't have a BIOS setting '%(name)s'")
[docs]
class BIOSSettingListNotFound(NotFound):
_msg_fmt = _("Node %(node)s doesn't have BIOS settings '%(names)s'")
[docs]
class DatabaseVersionTooOld(IronicException):
_msg_fmt = _("Database version is too old")
[docs]
class AgentConnectionFailed(IronicException):
_msg_fmt = _("Connection to agent failed: %(reason)s")
[docs]
class AgentCommandTimeout(IronicException):
_msg_fmt = _("Timeout executing command %(command)s on node %(node)s")
[docs]
class NodeProtected(HTTPForbidden):
_msg_fmt = _("Node %(node)s is protected and cannot be undeployed, "
"rebuilt or deleted")
[docs]
class AllocationNotFound(NotFound):
_msg_fmt = _("Allocation %(allocation)s could not be found.")
[docs]
class AllocationDuplicateName(Conflict):
_msg_fmt = _("An allocation with name %(name)s already exists.")
[docs]
class AllocationAlreadyExists(Conflict):
_msg_fmt = _("An allocation with UUID %(uuid)s already exists.")
[docs]
class AllocationFailed(IronicException):
_msg_fmt = _("Failed to process allocation %(uuid)s: %(error)s.")
[docs]
class DeployTemplateDuplicateName(Conflict):
_msg_fmt = _("A deploy template with name %(name)s already exists.")
[docs]
class DeployTemplateAlreadyExists(Conflict):
_msg_fmt = _("A deploy template with UUID %(uuid)s already exists.")
[docs]
class DeployTemplateNotFound(NotFound):
_msg_fmt = _("Deploy template %(template)s could not be found.")
[docs]
class InvalidDeployTemplate(Invalid):
_msg_fmt = _("Deploy template invalid: %(err)s.")
[docs]
class RunbookDuplicateName(Conflict):
_msg_fmt = _("A runbook with name %(name)s already exists.")
[docs]
class RunbookAlreadyExists(Conflict):
_msg_fmt = _("A runbook with UUID %(uuid)s already exists.")
[docs]
class RunbookNotFound(NotFound):
_msg_fmt = _("Runbook %(runbook)s could not be found.")
[docs]
class InvalidRunbook(Invalid):
_msg_fmt = _("Runbook invalid: %(err)s.")
[docs]
class InvalidKickstartTemplate(Invalid):
_msg_fmt = _("The kickstart template is missing required variables")
[docs]
class InvalidKickstartFile(Invalid):
_msg_fmt = _("The kickstart file is not valid.")
[docs]
class ClientSideError(RuntimeError):
def __init__(self, msg=None, status_code=400, faultcode='Client'):
self.msg = msg
self.code = status_code
self.faultcode = faultcode
super(ClientSideError, self).__init__(self.faultstring)
@property
def faultstring(self):
if self.msg is None:
return str(self)
elif isinstance(self.msg, str):
return self.msg
else:
return str(self.msg)
[docs]
class NodeIsRetired(Invalid):
_msg_fmt = _("The %(op)s operation can't be performed on node "
"%(node)s because it is retired.")
[docs]
class NoFreeIPMITerminalPorts(TemporaryFailure):
_msg_fmt = _("Unable to allocate a free port on host %(host)s for IPMI "
"terminal, not enough free ports.")
[docs]
class UnknownArgument(ClientSideError):
def __init__(self, argname, msg=''):
self.argname = argname
super(UnknownArgument, self).__init__(msg)
@property
def faultstring(self):
return _('Unknown argument: "%(argname)s"%(msg)s') % {
'argname': self.argname,
'msg': self.msg and ": " + self.msg or ""
}
[docs]
class UnknownAttribute(ClientSideError):
def __init__(self, fieldname, attributes, msg=''):
self.fieldname = fieldname
self.attributes = attributes
self.msg = msg
super(UnknownAttribute, self).__init__(self.msg)
@property
def faultstring(self):
error = _("Unknown attribute for argument %(argn)s: %(attrs)s")
if len(self.attributes) > 1:
error = _("Unknown attributes for argument %(argn)s: %(attrs)s")
str_attrs = ", ".join(self.attributes)
return error % {'argn': self.fieldname, 'attrs': str_attrs}
[docs]
def add_fieldname(self, name):
"""Add a fieldname to concatenate the full name.
Add a fieldname so that the whole hierarchy is displayed. Successive
calls to this method will prepend ``name`` to the hierarchy of names.
"""
if self.fieldname is not None:
self.fieldname = "{}.{}".format(name, self.fieldname)
else:
self.fieldname = name
super(UnknownAttribute, self).__init__(self.msg)
[docs]
class AgentInProgress(IronicException):
_msg_fmt = _('Node %(node)s command "%(command)s" failed. Agent is '
'presently executing a command. Error %(error)s')
[docs]
class InsufficientMemory(IronicException):
_msg_fmt = _("Available memory at %(free)s, Insufficient as %(required)s "
"is required to proceed at this time.")
[docs]
class NodeHistoryNotFound(NotFound):
_msg_fmt = _("Node history record %(history)s could not be found.")
[docs]
class NodeInventoryNotFound(NotFound):
_msg_fmt = _("Node inventory record for node %(node)s could not be found.")
[docs]
class IncorrectConfiguration(IronicException):
_msg_fmt = _("Supplied configuration is incorrect and must be fixed. "
"Error: %(error)s")
[docs]
class NodeVerifyFailure(IronicException):
_msg_fmt = _("Failed to verify node %(node)s: %(reason)s")
[docs]
class ImageRefIsARedirect(IronicException):
_msg_fmt = _("Received a URL redirect when attempting to evaluate "
"image reference %(image_ref)s pointing to "
"%(redirect_url)s. This may, or may not be recoverable.")
redirect_url = None
def __init__(self, image_ref=None, redirect_url=None, msg=None):
self.redirect_url = redirect_url
# Kwargs are expected by IronicException to convert the message.
super(ImageRefIsARedirect, self).__init__(
message=msg,
image_ref=image_ref,
redirect_url=redirect_url)
[docs]
class ConcurrentActionLimit(TemporaryFailure):
# NOTE(TheJulia): We explicitly don't report the concurrent
# action limit configuration value as a security guard since
# if informed of the limit, an attacker can tailor their attack.
_msg_fmt = _("Unable to process request at this time. "
"The concurrent action limit for %(task_type)s "
"has been reached. Please contact your administrator "
"and try again later.")
[docs]
class SwiftObjectStillExists(IronicException):
_msg_fmt = _("Clean up failed for swift object %(obj)s during deletion"
" of node %(node)s.")
[docs]
class FirmwareComponentAlreadyExists(Conflict):
_msg_fmt = _('A Firmware component %(name)s for node %(node)s'
' already exists.')
[docs]
class FirmwareComponentNotFound(NotFound):
_msg_fmt = _("Node %(node)s doesn't have Firmware component %(name)s")
[docs]
class InvalidNodeInventory(Invalid):
_msg_fmt = _("Inventory for node %(node)s is invalid: %(reason)s")
[docs]
class UnsupportedHardwareFeature(Invalid):
_msg_fmt = _("Node %(node)s hardware does not support feature "
"%(feature)s, which is required based upon the "
"requested configuration.")
[docs]
class BootModeNotAllowed(Invalid):
_msg_fmt = _("'%(mode)s' boot mode is not allowed for %(op)s operation.")
[docs]
class InvalidImage(ImageUnacceptable):
_msg_fmt = _("The requested image is not valid for use.")
[docs]
class ImageChecksumError(InvalidImage):
"""Exception indicating checksum failed to match."""
_msg_fmt = _("The supplied image checksum is invalid or does not match.")
[docs]
class ImageChecksumAlgorithmFailure(InvalidImage):
"""Cannot load the requested or required checksum algorithm."""
_msg_fmt = _("The requested image checksum algorithm cannot be loaded.")
[docs]
class ImageChecksumURLNotSupported(InvalidImage):
"""Exception indicating we cannot support the remote checksum file."""
_msg_fmt = _("Use of remote checksum files is not supported.")
[docs]
class ImageChecksumFileReadFailure(InvalidImage):
"""An OSError was raised when trying to read the file."""
_msg_fmt = _("Failed to read the file from local storage "
"to perform a checksum operation.")
code = http_client.SERVICE_UNAVAILABLE
[docs]
class ParentNodeLocked(Conflict):
_msg_fmt = _("Node %(node)s parent_node %(parent)s is presently locked "
"and we are unable to perform any action on it at this "
"time. Please retry after the current operation is "
"completed.")
[docs]
class ChildNodeLocked(Conflict):
_msg_fmt = _("Node %(node)s child_node %(child)s is presently locked "
"and we are unable to perform any action on it at this "
"time. Please retry after the current operation is "
"completed.")
[docs]
class MetricsNotSupported(IronicException):
_msg_fmt = _("Metrics action is not supported. You may need to "
"adjust the [metrics] section in ironic.conf.")
[docs]
class ServiceLookupFailure(IronicException):
_msg_fmt = _("Cannot find %(service)s service through multicast.")
[docs]
class ServiceRegistrationFailure(IronicException):
_msg_fmt = _("Cannot register %(service)s service: %(error)s")
[docs]
class Unauthorized(IronicException):
code = http_client.UNAUTHORIZED
headers = {'WWW-Authenticate': 'Basic realm="Baremetal API"'}
[docs]
class SecurityProxyNegotiationFailed(IronicException):
_msg_fmt = _("Failed to negotiate security type with server: %(reason)s")
[docs]
class RFBAuthHandshakeFailed(IronicException):
_msg_fmt = _("Failed to complete auth handshake: %(reason)s")
[docs]
class RFBAuthNoAvailableScheme(IronicException):
_msg_fmt = _("No matching auth scheme: allowed types: "
"'%(allowed_types)s', "
"desired types: '%(desired_types)s'")
[docs]
class ConsoleContainerError(IronicException):
_msg_fmt = _("Console container error with provider '%(provider)s', "
"reason: %(reason)s")
[docs]
class ImageHostRateLimitFailure(TemporaryFailure):
_msg_fmt = _("The image registry has indicates the rate limit has been "
"exceeded for url %(image_ref)s. Please try again later or "
"consider using authentication and/or trying again.")
[docs]
class ImageMatchFailure(InvalidImage):
_msg_fmt = _("The requested image lacks the required attributes to "
"identify the file to select.")
[docs]
class OciImageNotSpecific(InvalidImage):
_msg_fmt = _("The requested image (%(image_ref)s) was not specific. "
"Please supply a full URL mapping to the manifest to be "
"utilized for the file download.")
[docs]
class ImageServiceAuthenticationRequired(ImageUnacceptable):
_msg_fmt = _("The requested image %(image_ref)s requires "
"authentication which has not been provided. "
"Unable to proceed.")
[docs]
class InspectionRuleAlreadyExists(Conflict):
"""Rule requested already exists in the database."""
_msg_fmt = _("A rule with UUID %(uuid)s already exists.")
[docs]
class InspectionRuleNotFound(NotFound):
"""The requested rule was not found."""
_msg_fmt = _("Rule %(rule)s could not be found.")
[docs]
class InspectionRuleValidationFailure(IronicException):
"""Inspection rule validation fails during creation or execution."""
_msg_fmt = _("Inspection rule validation failed. Reason: %(reason)s")
[docs]
class InspectionRuleExecutionFailure(HardwareInspectionFailure):
"""Raised when an inspection rule fails during execution."""
_msg_fmt = _("Inspection rule execution failed. Reason: %(reason)s")
[docs]
class RuleActionExecutionFailure(InspectionRuleExecutionFailure):
"""Raised when an inspection rule action fails during execution."""
_msg_fmt = _("Inspection rule action execution failed. "
"Reason: %(reason)s")
[docs]
class RuleConditionCheckFailure(InspectionRuleExecutionFailure):
"""Raised when an inspection rule condition fails during execution."""
_msg_fmt = _("Inspection rule condition check failed. Reason: %(reason)s")
