ff32b51bbf
This adds optional notifications emitted when ironic changes a node's power
state or when ironic detects a change in a node's power state.
These notifications can be consumed by any external service listening to the
message bus to perform functions like tracking node power state changes over
time or automatically responding to anomalous power states.
The event_types of the new notifications are:
* baremetal.node.power_set.{start,end,error}
* baremetal.node.power_state_corrected.success
This also adds a new NodePayload class for notification payloads related
to nodes.
Change-Id: I82702e7f959d666bb02b59d1fc53ab50b519cb74
Closes-Bug: 1526408
533 lines
23 KiB
Python
533 lines
23 KiB
Python
# coding=utf-8
|
|
#
|
|
#
|
|
# 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.
|
|
|
|
from oslo_utils import strutils
|
|
from oslo_utils import uuidutils
|
|
from oslo_versionedobjects import base as object_base
|
|
|
|
from ironic.common import exception
|
|
from ironic.common.i18n import _
|
|
from ironic.conf import CONF
|
|
from ironic.db import api as db_api
|
|
from ironic.objects import base
|
|
from ironic.objects import fields as object_fields
|
|
from ironic.objects import notification
|
|
|
|
REQUIRED_INT_PROPERTIES = ['local_gb', 'cpus', 'memory_mb']
|
|
|
|
|
|
def _default_network_interface():
|
|
network_iface = (CONF.default_network_interface or
|
|
('flat' if CONF.dhcp.dhcp_provider == 'neutron'
|
|
else 'noop'))
|
|
return network_iface
|
|
|
|
|
|
@base.IronicObjectRegistry.register
|
|
class Node(base.IronicObject, object_base.VersionedObjectDictCompat):
|
|
# Version 1.0: Initial version
|
|
# Version 1.1: Added instance_info
|
|
# Version 1.2: Add get() and get_by_id() and make get_by_uuid()
|
|
# only work with a uuid
|
|
# Version 1.3: Add create() and destroy()
|
|
# Version 1.4: Add get_by_instance_uuid()
|
|
# Version 1.5: Add list()
|
|
# Version 1.6: Add reserve() and release()
|
|
# Version 1.7: Add conductor_affinity
|
|
# Version 1.8: Add maintenance_reason
|
|
# Version 1.9: Add driver_internal_info
|
|
# Version 1.10: Add name and get_by_name()
|
|
# Version 1.11: Add clean_step
|
|
# Version 1.12: Add raid_config and target_raid_config
|
|
# Version 1.13: Add touch_provisioning()
|
|
# Version 1.14: Add _validate_property_values() and make create()
|
|
# and save() validate the input of property values.
|
|
# Version 1.15: Add get_by_port_addresses
|
|
# Version 1.16: Add network_interface field
|
|
# Version 1.17: Add resource_class field
|
|
# Version 1.18: Add default setting for network_interface
|
|
VERSION = '1.18'
|
|
|
|
dbapi = db_api.get_instance()
|
|
|
|
fields = {
|
|
'id': object_fields.IntegerField(),
|
|
|
|
'uuid': object_fields.UUIDField(nullable=True),
|
|
'name': object_fields.StringField(nullable=True),
|
|
'chassis_id': object_fields.IntegerField(nullable=True),
|
|
'instance_uuid': object_fields.UUIDField(nullable=True),
|
|
|
|
'driver': object_fields.StringField(nullable=True),
|
|
'driver_info': object_fields.FlexibleDictField(nullable=True),
|
|
'driver_internal_info': object_fields.FlexibleDictField(nullable=True),
|
|
|
|
# A clean step dictionary, indicating the current clean step
|
|
# being executed, or None, indicating cleaning is not in progress
|
|
# or has not yet started.
|
|
'clean_step': object_fields.FlexibleDictField(nullable=True),
|
|
|
|
'raid_config': object_fields.FlexibleDictField(nullable=True),
|
|
'target_raid_config': object_fields.FlexibleDictField(nullable=True),
|
|
|
|
'instance_info': object_fields.FlexibleDictField(nullable=True),
|
|
'properties': object_fields.FlexibleDictField(nullable=True),
|
|
'reservation': object_fields.StringField(nullable=True),
|
|
# a reference to the id of the conductor service, not its hostname,
|
|
# that has most recently performed some action which could require
|
|
# local state to be maintained (eg, built a PXE config)
|
|
'conductor_affinity': object_fields.IntegerField(nullable=True),
|
|
|
|
# One of states.POWER_ON|POWER_OFF|NOSTATE|ERROR
|
|
'power_state': object_fields.StringField(nullable=True),
|
|
|
|
# Set to one of states.POWER_ON|POWER_OFF when a power operation
|
|
# starts, and set to NOSTATE when the operation finishes
|
|
# (successfully or unsuccessfully).
|
|
'target_power_state': object_fields.StringField(nullable=True),
|
|
|
|
'provision_state': object_fields.StringField(nullable=True),
|
|
'provision_updated_at': object_fields.DateTimeField(nullable=True),
|
|
'target_provision_state': object_fields.StringField(nullable=True),
|
|
|
|
'maintenance': object_fields.BooleanField(),
|
|
'maintenance_reason': object_fields.StringField(nullable=True),
|
|
'console_enabled': object_fields.BooleanField(),
|
|
|
|
# Any error from the most recent (last) asynchronous transaction
|
|
# that started but failed to finish.
|
|
'last_error': object_fields.StringField(nullable=True),
|
|
|
|
# Used by nova to relate the node to a flavor
|
|
'resource_class': object_fields.StringField(nullable=True),
|
|
|
|
'inspection_finished_at': object_fields.DateTimeField(nullable=True),
|
|
'inspection_started_at': object_fields.DateTimeField(nullable=True),
|
|
|
|
'extra': object_fields.FlexibleDictField(nullable=True),
|
|
|
|
'network_interface': object_fields.StringFieldThatAcceptsCallable(
|
|
nullable=False, default=_default_network_interface),
|
|
}
|
|
|
|
def _validate_property_values(self, properties):
|
|
"""Check if the input of local_gb, cpus and memory_mb are valid.
|
|
|
|
:param properties: a dict contains the node's information.
|
|
"""
|
|
if not properties:
|
|
return
|
|
invalid_msgs_list = []
|
|
for param in REQUIRED_INT_PROPERTIES:
|
|
value = properties.get(param)
|
|
if value is None:
|
|
continue
|
|
try:
|
|
int_value = int(value)
|
|
assert int_value >= 0
|
|
except (ValueError, AssertionError):
|
|
msg = (('%(param)s=%(value)s') %
|
|
{'param': param, 'value': value})
|
|
invalid_msgs_list.append(msg)
|
|
|
|
if invalid_msgs_list:
|
|
msg = (_('The following properties for node %(node)s '
|
|
'should be non-negative integers, '
|
|
'but provided values are: %(msgs)s') %
|
|
{'node': self.uuid, 'msgs': ', '.join(invalid_msgs_list)})
|
|
raise exception.InvalidParameterValue(msg)
|
|
|
|
# NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
|
|
# methods can be used in the future to replace current explicit RPC calls.
|
|
# Implications of calling new remote procedures should be thought through.
|
|
# @object_base.remotable_classmethod
|
|
@classmethod
|
|
def get(cls, context, node_id):
|
|
"""Find a node based on its id or uuid and return a Node object.
|
|
|
|
:param node_id: the id *or* uuid of a node.
|
|
:returns: a :class:`Node` object.
|
|
"""
|
|
if strutils.is_int_like(node_id):
|
|
return cls.get_by_id(context, node_id)
|
|
elif uuidutils.is_uuid_like(node_id):
|
|
return cls.get_by_uuid(context, node_id)
|
|
else:
|
|
raise exception.InvalidIdentity(identity=node_id)
|
|
|
|
# NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
|
|
# methods can be used in the future to replace current explicit RPC calls.
|
|
# Implications of calling new remote procedures should be thought through.
|
|
# @object_base.remotable_classmethod
|
|
@classmethod
|
|
def get_by_id(cls, context, node_id):
|
|
"""Find a node based on its integer id and return a Node object.
|
|
|
|
:param node_id: the id of a node.
|
|
:returns: a :class:`Node` object.
|
|
"""
|
|
db_node = cls.dbapi.get_node_by_id(node_id)
|
|
node = Node._from_db_object(cls(context), db_node)
|
|
return node
|
|
|
|
# NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
|
|
# methods can be used in the future to replace current explicit RPC calls.
|
|
# Implications of calling new remote procedures should be thought through.
|
|
# @object_base.remotable_classmethod
|
|
@classmethod
|
|
def get_by_uuid(cls, context, uuid):
|
|
"""Find a node based on uuid and return a Node object.
|
|
|
|
:param uuid: the uuid of a node.
|
|
:returns: a :class:`Node` object.
|
|
"""
|
|
db_node = cls.dbapi.get_node_by_uuid(uuid)
|
|
node = Node._from_db_object(cls(context), db_node)
|
|
return node
|
|
|
|
# NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
|
|
# methods can be used in the future to replace current explicit RPC calls.
|
|
# Implications of calling new remote procedures should be thought through.
|
|
# @object_base.remotable_classmethod
|
|
@classmethod
|
|
def get_by_name(cls, context, name):
|
|
"""Find a node based on name and return a Node object.
|
|
|
|
:param name: the logical name of a node.
|
|
:returns: a :class:`Node` object.
|
|
"""
|
|
db_node = cls.dbapi.get_node_by_name(name)
|
|
node = Node._from_db_object(cls(context), db_node)
|
|
return node
|
|
|
|
# NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
|
|
# methods can be used in the future to replace current explicit RPC calls.
|
|
# Implications of calling new remote procedures should be thought through.
|
|
# @object_base.remotable_classmethod
|
|
@classmethod
|
|
def get_by_instance_uuid(cls, context, instance_uuid):
|
|
"""Find a node based on the instance uuid and return a Node object.
|
|
|
|
:param uuid: the uuid of the instance.
|
|
:returns: a :class:`Node` object.
|
|
"""
|
|
db_node = cls.dbapi.get_node_by_instance(instance_uuid)
|
|
node = Node._from_db_object(cls(context), db_node)
|
|
return node
|
|
|
|
# NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
|
|
# methods can be used in the future to replace current explicit RPC calls.
|
|
# Implications of calling new remote procedures should be thought through.
|
|
# @object_base.remotable_classmethod
|
|
@classmethod
|
|
def list(cls, context, limit=None, marker=None, sort_key=None,
|
|
sort_dir=None, filters=None):
|
|
"""Return a list of Node objects.
|
|
|
|
:param context: Security context.
|
|
:param limit: maximum number of resources to return in a single result.
|
|
:param marker: pagination marker for large data sets.
|
|
:param sort_key: column to sort results by.
|
|
:param sort_dir: direction to sort. "asc" or "desc".
|
|
:param filters: Filters to apply.
|
|
:returns: a list of :class:`Node` object.
|
|
|
|
"""
|
|
db_nodes = cls.dbapi.get_node_list(filters=filters, limit=limit,
|
|
marker=marker, sort_key=sort_key,
|
|
sort_dir=sort_dir)
|
|
return [Node._from_db_object(cls(context), obj) for obj in db_nodes]
|
|
|
|
# NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
|
|
# methods can be used in the future to replace current explicit RPC calls.
|
|
# Implications of calling new remote procedures should be thought through.
|
|
# @object_base.remotable_classmethod
|
|
@classmethod
|
|
def reserve(cls, context, tag, node_id):
|
|
"""Get and reserve a node.
|
|
|
|
To prevent other ManagerServices from manipulating the given
|
|
Node while a Task is performed, mark it reserved by this host.
|
|
|
|
:param context: Security context.
|
|
:param tag: A string uniquely identifying the reservation holder.
|
|
:param node_id: A node id or uuid.
|
|
:raises: NodeNotFound if the node is not found.
|
|
:returns: a :class:`Node` object.
|
|
|
|
"""
|
|
db_node = cls.dbapi.reserve_node(tag, node_id)
|
|
node = Node._from_db_object(cls(context), db_node)
|
|
return node
|
|
|
|
# NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
|
|
# methods can be used in the future to replace current explicit RPC calls.
|
|
# Implications of calling new remote procedures should be thought through.
|
|
# @object_base.remotable_classmethod
|
|
@classmethod
|
|
def release(cls, context, tag, node_id):
|
|
"""Release the reservation on a node.
|
|
|
|
:param context: Security context.
|
|
:param tag: A string uniquely identifying the reservation holder.
|
|
:param node_id: A node id or uuid.
|
|
:raises: NodeNotFound if the node is not found.
|
|
|
|
"""
|
|
cls.dbapi.release_node(tag, node_id)
|
|
|
|
# NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
|
|
# methods can be used in the future to replace current explicit RPC calls.
|
|
# Implications of calling new remote procedures should be thought through.
|
|
# @object_base.remotable
|
|
def create(self, context=None):
|
|
"""Create a Node record in the DB.
|
|
|
|
Column-wise updates will be made based on the result of
|
|
self.what_changed(). If target_power_state is provided,
|
|
it will be checked against the in-database copy of the
|
|
node before updates are made.
|
|
|
|
:param context: Security context. NOTE: This should only
|
|
be used internally by the indirection_api.
|
|
Unfortunately, RPC requires context as the first
|
|
argument, even though we don't use it.
|
|
A context should be set when instantiating the
|
|
object, e.g.: Node(context)
|
|
:raises: InvalidParameterValue if some property values are invalid.
|
|
"""
|
|
values = self.obj_get_changes()
|
|
self._validate_property_values(values.get('properties'))
|
|
db_node = self.dbapi.create_node(values)
|
|
self._from_db_object(self, db_node)
|
|
|
|
# NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
|
|
# methods can be used in the future to replace current explicit RPC calls.
|
|
# Implications of calling new remote procedures should be thought through.
|
|
# @object_base.remotable
|
|
def destroy(self, context=None):
|
|
"""Delete the Node from the DB.
|
|
|
|
:param context: Security context. NOTE: This should only
|
|
be used internally by the indirection_api.
|
|
Unfortunately, RPC requires context as the first
|
|
argument, even though we don't use it.
|
|
A context should be set when instantiating the
|
|
object, e.g.: Node(context)
|
|
"""
|
|
self.dbapi.destroy_node(self.uuid)
|
|
self.obj_reset_changes()
|
|
|
|
# NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
|
|
# methods can be used in the future to replace current explicit RPC calls.
|
|
# Implications of calling new remote procedures should be thought through.
|
|
# @object_base.remotable
|
|
def save(self, context=None):
|
|
"""Save updates to this Node.
|
|
|
|
Column-wise updates will be made based on the result of
|
|
self.what_changed(). If target_power_state is provided,
|
|
it will be checked against the in-database copy of the
|
|
node before updates are made.
|
|
|
|
:param context: Security context. NOTE: This should only
|
|
be used internally by the indirection_api.
|
|
Unfortunately, RPC requires context as the first
|
|
argument, even though we don't use it.
|
|
A context should be set when instantiating the
|
|
object, e.g.: Node(context)
|
|
:raises: InvalidParameterValue if some property values are invalid.
|
|
"""
|
|
updates = self.obj_get_changes()
|
|
self._validate_property_values(updates.get('properties'))
|
|
if 'driver' in updates and 'driver_internal_info' not in updates:
|
|
# Clean driver_internal_info when changes driver
|
|
self.driver_internal_info = {}
|
|
updates = self.obj_get_changes()
|
|
self.dbapi.update_node(self.uuid, updates)
|
|
self.obj_reset_changes()
|
|
|
|
# NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
|
|
# methods can be used in the future to replace current explicit RPC calls.
|
|
# Implications of calling new remote procedures should be thought through.
|
|
# @object_base.remotable
|
|
def refresh(self, context=None):
|
|
"""Refresh the object by re-fetching from the DB.
|
|
|
|
:param context: Security context. NOTE: This should only
|
|
be used internally by the indirection_api.
|
|
Unfortunately, RPC requires context as the first
|
|
argument, even though we don't use it.
|
|
A context should be set when instantiating the
|
|
object, e.g.: Node(context)
|
|
"""
|
|
current = self.__class__.get_by_uuid(self._context, self.uuid)
|
|
self.obj_refresh(current)
|
|
|
|
# NOTE(xek): We don't want to enable RPC on this call just yet. Remotable
|
|
# methods can be used in the future to replace current explicit RPC calls.
|
|
# Implications of calling new remote procedures should be thought through.
|
|
# @object_base.remotable
|
|
def touch_provisioning(self, context=None):
|
|
"""Touch the database record to mark the provisioning as alive."""
|
|
self.dbapi.touch_node_provisioning(self.id)
|
|
|
|
@classmethod
|
|
def get_by_port_addresses(cls, context, addresses):
|
|
"""Get a node by associated port addresses.
|
|
|
|
:param context: Security context.
|
|
:param addresses: A list of port addresses.
|
|
:raises: NodeNotFound if the node is not found.
|
|
:returns: a :class:`Node` object.
|
|
"""
|
|
db_node = cls.dbapi.get_node_by_port_addresses(addresses)
|
|
node = Node._from_db_object(cls(context), db_node)
|
|
return node
|
|
|
|
|
|
@base.IronicObjectRegistry.register
|
|
class NodePayload(notification.NotificationPayloadBase):
|
|
"""Base class used for all notification payloads about a Node object."""
|
|
# NOTE: This payload does not include the Node fields "chassis_id",
|
|
# "driver_info", "driver_internal_info", "instance_info", "raid_config",
|
|
# "reservation", or "target_raid_config". These were excluded for reasons
|
|
# including:
|
|
# - increased complexity needed for creating the payload
|
|
# - sensitive information in the fields that shouldn't be exposed to
|
|
# external services
|
|
# - being internal-only or hardware-related fields
|
|
SCHEMA = {
|
|
'clean_step': ('node', 'clean_step'),
|
|
'console_enabled': ('node', 'console_enabled'),
|
|
'created_at': ('node', 'created_at'),
|
|
'driver': ('node', 'driver'),
|
|
'extra': ('node', 'extra'),
|
|
'inspection_finished_at': ('node', 'inspection_finished_at'),
|
|
'inspection_started_at': ('node', 'inspection_started_at'),
|
|
'instance_uuid': ('node', 'instance_uuid'),
|
|
'last_error': ('node', 'last_error'),
|
|
'maintenance': ('node', 'maintenance'),
|
|
'maintenance_reason': ('node', 'maintenance_reason'),
|
|
'name': ('node', 'name'),
|
|
'network_interface': ('node', 'network_interface'),
|
|
'power_state': ('node', 'power_state'),
|
|
'properties': ('node', 'properties'),
|
|
'provision_state': ('node', 'provision_state'),
|
|
'provision_updated_at': ('node', 'provision_updated_at'),
|
|
'resource_class': ('node', 'resource_class'),
|
|
'target_power_state': ('node', 'target_power_state'),
|
|
'target_provision_state': ('node', 'target_provision_state'),
|
|
'updated_at': ('node', 'updated_at'),
|
|
'uuid': ('node', 'uuid')
|
|
}
|
|
# Version 1.0: Initial version, based off of Node version 1.18.
|
|
VERSION = '1.0'
|
|
fields = {
|
|
'clean_step': object_fields.FlexibleDictField(nullable=True),
|
|
'console_enabled': object_fields.BooleanField(),
|
|
'created_at': object_fields.DateTimeField(nullable=True),
|
|
'driver': object_fields.StringField(nullable=True),
|
|
'extra': object_fields.FlexibleDictField(nullable=True),
|
|
'inspection_finished_at': object_fields.DateTimeField(nullable=True),
|
|
'inspection_started_at': object_fields.DateTimeField(nullable=True),
|
|
'instance_uuid': object_fields.UUIDField(nullable=True),
|
|
'last_error': object_fields.StringField(nullable=True),
|
|
'maintenance': object_fields.BooleanField(),
|
|
'maintenance_reason': object_fields.StringField(nullable=True),
|
|
'network_interface': object_fields.StringFieldThatAcceptsCallable(),
|
|
'name': object_fields.StringField(nullable=True),
|
|
'power_state': object_fields.StringField(nullable=True),
|
|
'properties': object_fields.FlexibleDictField(nullable=True),
|
|
'provision_state': object_fields.StringField(nullable=True),
|
|
'provision_updated_at': object_fields.DateTimeField(nullable=True),
|
|
'resource_class': object_fields.StringField(nullable=True),
|
|
'target_power_state': object_fields.StringField(nullable=True),
|
|
'target_provision_state': object_fields.StringField(nullable=True),
|
|
'updated_at': object_fields.DateTimeField(nullable=True),
|
|
'uuid': object_fields.UUIDField()
|
|
}
|
|
|
|
def __init__(self, node, **kwargs):
|
|
super(NodePayload, self).__init__(**kwargs)
|
|
self.populate_schema(node=node)
|
|
|
|
|
|
@base.IronicObjectRegistry.register
|
|
class NodeSetPowerStateNotification(notification.NotificationBase):
|
|
"""Notification emitted when ironic changes a node's power state."""
|
|
# Version 1.0: Initial version
|
|
VERSION = '1.0'
|
|
|
|
fields = {
|
|
'payload': object_fields.ObjectField('NodeSetPowerStatePayload')
|
|
}
|
|
|
|
|
|
@base.IronicObjectRegistry.register
|
|
class NodeSetPowerStatePayload(NodePayload):
|
|
"""Payload schema for when ironic changes a node's power state."""
|
|
# Version 1.0: Initial version
|
|
VERSION = '1.0'
|
|
|
|
fields = {
|
|
# "to_power" indicates the future target_power_state of the node. A
|
|
# separate field from target_power_state is used so that the
|
|
# baremetal.node.power_set.start notification, which is sent before
|
|
# target_power_state is set on the node, has information about what
|
|
# state the conductor will attempt to set on the node.
|
|
'to_power': object_fields.StringField(nullable=True)
|
|
}
|
|
|
|
def __init__(self, node, to_power):
|
|
super(NodeSetPowerStatePayload, self).__init__(
|
|
node, to_power=to_power)
|
|
|
|
|
|
@base.IronicObjectRegistry.register
|
|
class NodeCorrectedPowerStateNotification(notification.NotificationBase):
|
|
"""Notification for when a node's power state is corrected in the database.
|
|
|
|
This notification is emitted when ironic detects that the actual power
|
|
state on a bare metal hardware is different from the power state on an
|
|
ironic node (DB). This notification is emitted after the database is
|
|
updated to reflect this correction.
|
|
"""
|
|
# Version 1.0: Initial version
|
|
VERSION = '1.0'
|
|
|
|
fields = {
|
|
'payload': object_fields.ObjectField('NodeCorrectedPowerStatePayload')
|
|
}
|
|
|
|
|
|
@base.IronicObjectRegistry.register
|
|
class NodeCorrectedPowerStatePayload(NodePayload):
|
|
"""Notification payload schema for when a node's power state is corrected.
|
|
|
|
"from_power" indicates the previous power state on the ironic node
|
|
before the node was updated.
|
|
"""
|
|
# Version 1.0: Initial version
|
|
VERSION = '1.0'
|
|
|
|
fields = {
|
|
'from_power': object_fields.StringField(nullable=True)
|
|
}
|
|
|
|
def __init__(self, node, from_power):
|
|
super(NodeCorrectedPowerStatePayload, self).__init__(
|
|
node, from_power=from_power)
|