ironic/ironic/api/controllers/v1/node.py

630 lines
25 KiB
Python

# vim: tabstop=4 shiftwidth=4 softtabstop=4
# Copyright 2013 Hewlett-Packard Development Company, L.P.
# 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.
import datetime
import jsonpatch
from oslo.config import cfg
import pecan
from pecan import rest
import six
import wsme
from wsme import types as wtypes
import wsmeext.pecan as wsme_pecan
from ironic.api.controllers.v1 import base
from ironic.api.controllers.v1 import collection
from ironic.api.controllers.v1 import link
from ironic.api.controllers.v1 import port
from ironic.api.controllers.v1 import types
from ironic.api.controllers.v1 import utils as api_utils
from ironic.common import exception
from ironic.common import states as ir_states
from ironic import objects
from ironic.openstack.common import excutils
from ironic.openstack.common import log
from ironic.openstack.common import strutils
CONF = cfg.CONF
CONF.import_opt('heartbeat_timeout', 'ironic.conductor.manager',
group='conductor')
LOG = log.getLogger(__name__)
class NodePatchType(types.JsonPatchType):
@staticmethod
def internal_attrs():
defaults = types.JsonPatchType.internal_attrs()
return defaults + ['/last_error', '/maintenance', '/power_state',
'/provision_state', '/reservation',
'/target_power_state', '/target_provision_state']
@staticmethod
def mandatory_attrs():
return ['/chassis_uuid', '/driver']
class NodeStates(base.APIBase):
"""API representation of the states of a node."""
power_state = wtypes.text
provision_state = wtypes.text
target_power_state = wtypes.text
target_provision_state = wtypes.text
last_error = wtypes.text
@classmethod
def convert(cls, rpc_node):
attr_list = ['last_error', 'power_state', 'provision_state',
'target_power_state', 'target_provision_state']
states = NodeStates()
for attr in attr_list:
setattr(states, attr, getattr(rpc_node, attr))
return states
class NodeStatesController(rest.RestController):
_custom_actions = {
'power': ['PUT'],
'provision': ['PUT'],
}
@wsme_pecan.wsexpose(NodeStates, types.uuid)
def get(self, node_uuid):
"""List the states of the node.
:param node_uuid: UUID of a node.
"""
# NOTE(lucasagomes): All these state values come from the
# DB. Ironic counts with a periodic task that verify the current
# power states of the nodes and update the DB accordingly.
rpc_node = objects.Node.get_by_uuid(pecan.request.context, node_uuid)
return NodeStates.convert(rpc_node)
@wsme_pecan.wsexpose(NodeStates, types.uuid, wtypes.text, status_code=202)
def power(self, node_uuid, target):
"""Set the power state of the node.
:param node_uuid: UUID of a node.
:param target: The desired power state of the node.
:raises: ClientSideError (HTTP 409) if a power operation is
already in progress.
:raises: InvalidStateRequested (HTTP 400) if the requested target
state is not valid.
"""
# TODO(lucasagomes): Test if it's able to transition to the
# target state from the current one
rpc_node = objects.Node.get_by_uuid(pecan.request.context, node_uuid)
topic = pecan.request.rpcapi.get_topic_for(rpc_node)
if rpc_node.target_power_state is not None:
raise wsme.exc.ClientSideError(_("Power operation for node %s is "
"already in progress.") %
rpc_node['uuid'],
status_code=409)
# Note that there is a race condition. The node state(s) could change
# by the time the RPC call is made and the TaskManager manager gets a
# lock.
if target in [ir_states.POWER_ON,
ir_states.POWER_OFF,
ir_states.REBOOT]:
pecan.request.rpcapi.change_node_power_state(
pecan.request.context, node_uuid, target, topic)
else:
raise exception.InvalidStateRequested(state=target, node=node_uuid)
# FIXME(lucasagomes): Currently WSME doesn't support returning
# the Location header. Once it's implemented we should use the
# Location to point to the /states subresource of the node so
# that clients will know how to track the status of the request
# https://bugs.launchpad.net/wsme/+bug/1233687
return NodeStates.convert(rpc_node)
@wsme_pecan.wsexpose(None, types.uuid, wtypes.text, status_code=202)
def provision(self, node_uuid, target):
"""Asynchronous trigger the provisioning of the node.
This will set the target provision state of the node, and a
background task will begin which actually applies the state
change. This call will return a 202 (Accepted) indicating the
request was accepted and is in progress; the client should
continue to GET the status of this node to observe the status
of the requested action.
:param node_uuid: UUID of a node.
:param target: The desired provision state of the node.
:raises: ClientSideError (HTTP 409) if the node is already being
provisioned.
:raises: ClientSideError (HTTP 400) if the node is already in
the requested state.
:raises: InvalidStateRequested (HTTP 400) if the requested target
state is not valid.
"""
rpc_node = objects.Node.get_by_uuid(pecan.request.context, node_uuid)
topic = pecan.request.rpcapi.get_topic_for(rpc_node)
if rpc_node.target_provision_state is not None:
msg = _('Node %s is already being provisioned.') % rpc_node['uuid']
LOG.exception(msg)
raise wsme.exc.ClientSideError(msg, status_code=409) # Conflict
if target == rpc_node.provision_state:
msg = (_("Node %(node)s is already in the '%(state)s' state.") %
{'node': rpc_node['uuid'], 'state': target})
LOG.exception(msg)
raise wsme.exc.ClientSideError(msg, status_code=400)
# Note that there is a race condition. The node state(s) could change
# by the time the RPC call is made and the TaskManager manager gets a
# lock.
if target == ir_states.ACTIVE:
pecan.request.rpcapi.do_node_deploy(
pecan.request.context, node_uuid, topic)
elif target == ir_states.DELETED:
pecan.request.rpcapi.do_node_tear_down(
pecan.request.context, node_uuid, topic)
else:
raise exception.InvalidStateRequested(state=target, node=node_uuid)
# FIXME(lucasagomes): Currently WSME doesn't support returning
# the Location header. Once it's implemented we should use the
# Location to point to the /states subresource of this node so
# that clients will know how to track the status of the request
# https://bugs.launchpad.net/wsme/+bug/1233687
class Node(base.APIBase):
"""API representation of a bare metal node.
This class enforces type checking and value constraints, and converts
between the internal object model and the API representation of a node.
"""
_chassis_uuid = None
def _get_chassis_uuid(self):
return self._chassis_uuid
def _set_chassis_uuid(self, value):
if value and self._chassis_uuid != value:
try:
chassis = objects.Chassis.get_by_uuid(pecan.request.context,
value)
self._chassis_uuid = chassis.uuid
# NOTE(lucasagomes): Create the chassis_id attribute on-the-fly
# to satisfy the api -> rpc object
# conversion.
self.chassis_id = chassis.id
except exception.ChassisNotFound as e:
# Change error code because 404 (NotFound) is inappropriate
# response for a POST request to create a Port
e.code = 400 # BadRequest
raise e
elif value == wtypes.Unset:
self._chassis_uuid = wtypes.Unset
uuid = types.uuid
"Unique UUID for this node"
instance_uuid = types.uuid
"The UUID of the instance in nova-compute"
power_state = wtypes.text
"Represent the current (not transition) power state of the node"
target_power_state = wtypes.text
"The user modified desired power state of the node."
last_error = wtypes.text
"Any error from the most recent (last) asynchronous transaction that"
"started but failed to finish."
provision_state = wtypes.text
"Represent the current (not transition) provision state of the node"
# TODO(yuriyz): make 'reservation' read-only for users
reservation = wtypes.text
"The hostname of the conductor that holds an exclusive lock on the node."
maintenance = wsme.wsattr(bool, default=False)
"Indicates whether the node is in maintenance mode."
target_provision_state = wtypes.text
"The user modified desired provision state of the node."
driver = wsme.wsattr(wtypes.text, mandatory=True)
"The driver responsible for controlling the node"
driver_info = {wtypes.text: types.MultiType(wtypes.text,
six.integer_types)}
"This node's driver configuration"
extra = {wtypes.text: types.MultiType(wtypes.text, six.integer_types)}
"This node's meta data"
# NOTE: properties should use a class to enforce required properties
# current list: arch, cpus, disk, ram, image
properties = {wtypes.text: types.MultiType(wtypes.text,
six.integer_types)}
"The physical characteristics of this node"
chassis_uuid = wsme.wsproperty(types.uuid, _get_chassis_uuid,
_set_chassis_uuid)
"The UUID of the chassis this node belongs"
links = [link.Link]
"A list containing a self link and associated node links"
ports = [link.Link]
"Links to the collection of ports on this node"
def __init__(self, **kwargs):
self.fields = objects.Node.fields.keys()
for k in self.fields:
setattr(self, k, kwargs.get(k))
# NOTE(lucasagomes): chassis_uuid is not part of objects.Node.fields
# because it's an API-only attribute
self.fields.append('chassis_uuid')
setattr(self, 'chassis_uuid', kwargs.get('chassis_id', None))
@classmethod
def _convert_with_links(cls, node, url, expand=True):
if not expand:
except_list = ['instance_uuid', 'power_state',
'provision_state', 'uuid']
node.unset_fields_except(except_list)
else:
node.ports = [link.Link.make_link('self', url, 'nodes',
node.uuid + "/ports"),
link.Link.make_link('bookmark', url, 'nodes',
node.uuid + "/ports",
bookmark=True)
]
# NOTE(lucasagomes): The numeric ID should not be exposed to
# the user, it's internal only.
node.chassis_id = wtypes.Unset
node.links = [link.Link.make_link('self', url, 'nodes',
node.uuid),
link.Link.make_link('bookmark', url, 'nodes',
node.uuid, bookmark=True)
]
return node
@classmethod
def convert_with_links(cls, rpc_node, expand=True):
node = Node(**rpc_node.as_dict())
return cls._convert_with_links(node, pecan.request.host_url,
expand)
@classmethod
def sample(cls, expand=True):
time = datetime.datetime(2000, 1, 1, 12, 0, 0)
node_uuid = '1be26c0b-03f2-4d2e-ae87-c02d7f33c123'
instance_uuid = 'dcf1fbc5-93fc-4596-9395-b80572f6267b'
sample = cls(uuid=node_uuid, instance_uuid=instance_uuid,
power_state=ir_states.POWER_ON,
target_power_state=ir_states.NOSTATE,
last_error=None, provision_state=ir_states.ACTIVE,
target_provision_state=ir_states.NOSTATE,
reservation=None, driver='fake', driver_info={}, extra={},
properties={'memory_mb': '1024', 'local_gb': '10',
'cpus': '1'}, updated_at=time, created_at=time)
# NOTE(matty_dubs): The chassis_uuid getter() is based on the
# _chassis_uuid variable:
sample._chassis_uuid = 'edcad704-b2da-41d5-96d9-afd580ecfa12'
return cls._convert_with_links(sample, 'http://localhost:6385', expand)
class NodeCollection(collection.Collection):
"""API representation of a collection of nodes."""
nodes = [Node]
"A list containing nodes objects"
def __init__(self, **kwargs):
self._type = 'nodes'
@classmethod
def convert_with_links(cls, nodes, limit, url=None,
expand=False, **kwargs):
collection = NodeCollection()
collection.nodes = [Node.convert_with_links(n, expand) for n in nodes]
collection.next = collection.get_next(limit, url=url, **kwargs)
return collection
@classmethod
def sample(cls):
sample = cls()
node = Node.sample(expand=False)
sample.nodes = [node]
return sample
class NodeVendorPassthruController(rest.RestController):
"""REST controller for VendorPassthru.
This controller allow vendors to expose a custom functionality in
the Ironic API. Ironic will merely relay the message from here to the
appropriate driver, no introspection will be made in the message body.
"""
@wsme_pecan.wsexpose(wtypes.text, types.uuid, wtypes.text,
body=wtypes.text,
status_code=202)
def post(self, node_uuid, method, data):
"""Call a vendor extension.
:param node_uuid: UUID of a node.
:param method: name of the method in vendor driver.
:param data: body of data to supply to the specified method.
"""
# Raise an exception if node is not found
rpc_node = objects.Node.get_by_uuid(pecan.request.context, node_uuid)
topic = pecan.request.rpcapi.get_topic_for(rpc_node)
# Raise an exception if method is not specified
if not method:
raise wsme.exc.ClientSideError(_("Method not specified"))
return pecan.request.rpcapi.vendor_passthru(
pecan.request.context, node_uuid, method, data, topic)
class NodesController(rest.RestController):
"""REST controller for Nodes."""
states = NodeStatesController()
"Expose the state controller action as a sub-element of nodes"
vendor_passthru = NodeVendorPassthruController()
"A resource used for vendors to expose a custom functionality in the API"
ports = port.PortsController(from_nodes=True)
"Expose ports as a sub-element of nodes"
_custom_actions = {
'detail': ['GET'],
'validate': ['GET'],
}
def __init__(self, from_chassis=False):
self._from_chassis = from_chassis
def _get_nodes_collection(self, chassis_uuid, instance_uuid, associated,
maintenance, marker, limit, sort_key, sort_dir,
expand=False, resource_url=None):
if self._from_chassis and not chassis_uuid:
raise exception.InvalidParameterValue(_(
"Chassis id not specified."))
limit = api_utils.validate_limit(limit)
sort_dir = api_utils.validate_sort_dir(sort_dir)
marker_obj = None
if marker:
marker_obj = objects.Node.get_by_uuid(pecan.request.context,
marker)
if instance_uuid:
nodes = self._get_nodes_by_instance(instance_uuid)
else:
filters = {}
if chassis_uuid:
filters['chassis_uuid'] = chassis_uuid
try:
if associated:
param = 'associated'
filters[param] = strutils.bool_from_string(associated,
strict=True)
if maintenance:
param = 'maintenance'
filters[param] = strutils.bool_from_string(maintenance,
strict=True)
except ValueError as e:
raise wsme.exc.ClientSideError(_(
"Invalid parameter '%(param)s' value: %(msg)s") %
{'param': param, 'msg': e})
nodes = pecan.request.dbapi.get_node_list(filters, limit,
marker_obj,
sort_key=sort_key,
sort_dir=sort_dir)
parameters = {'sort_key': sort_key, 'sort_dir': sort_dir}
if associated:
parameters['associated'] = associated.lower()
if maintenance:
parameters['maintenance'] = maintenance.lower()
return NodeCollection.convert_with_links(nodes, limit,
url=resource_url,
expand=expand,
**parameters)
def _get_nodes_by_instance(self, instance_uuid):
"""Retrieve a node by its instance uuid.
It returns a list with the node, or an empty list if no node is found.
"""
try:
node = pecan.request.dbapi.get_node_by_instance(instance_uuid)
return [node]
except exception.InstanceNotFound:
return []
@wsme_pecan.wsexpose(NodeCollection, types.uuid, types.uuid,
wtypes.text, wtypes.text, types.uuid, int, wtypes.text,
wtypes.text)
def get_all(self, chassis_uuid=None, instance_uuid=None, associated=None,
maintenance=None, marker=None, limit=None, sort_key='id',
sort_dir='asc'):
"""Retrieve a list of nodes.
:param chassis_uuid: Optional UUID of a chassis, to get only nodes for
that chassis.
:param instance_uuid: Optional UUID of an instance, to find the node
associated with that instance.
:param associated: Optional boolean whether to return a list of
associated or unassociated nodes. May be combined
with other parameters.
:param maintenance: Optional boolean value that indicates whether
to get nodes in maintenance mode ("True"), or not
in maintenance mode ("False").
:param marker: pagination marker for large data sets.
:param limit: maximum number of resources to return in a single result.
:param sort_key: column to sort results by. Default: id.
:param sort_dir: direction to sort. "asc" or "desc". Default: asc.
"""
return self._get_nodes_collection(chassis_uuid, instance_uuid,
associated, maintenance, marker,
limit, sort_key, sort_dir)
@wsme_pecan.wsexpose(NodeCollection, types.uuid, types.uuid,
wtypes.text, wtypes.text, types.uuid, int, wtypes.text,
wtypes.text)
def detail(self, chassis_uuid=None, instance_uuid=None, associated=None,
maintenance=None, marker=None, limit=None, sort_key='id',
sort_dir='asc'):
"""Retrieve a list of nodes with detail.
:param chassis_uuid: Optional UUID of a chassis, to get only nodes for
that chassis.
:param instance_uuid: Optional UUID of an instance, to find the node
associated with that instance.
:param associated: Optional boolean whether to return a list of
associated or unassociated nodes. May be combined
with other parameters.
:param maintenance: Optional boolean value that indicates whether
to get nodes in maintenance mode ("True"), or not
in maintenance mode ("False").
:param marker: pagination marker for large data sets.
:param limit: maximum number of resources to return in a single result.
:param sort_key: column to sort results by. Default: id.
:param sort_dir: direction to sort. "asc" or "desc". Default: asc.
"""
# /detail should only work agaist collections
parent = pecan.request.path.split('/')[:-1][-1]
if parent != "nodes":
raise exception.HTTPNotFound
expand = True
resource_url = '/'.join(['nodes', 'detail'])
return self._get_nodes_collection(chassis_uuid, instance_uuid,
associated, maintenance, marker,
limit, sort_key, sort_dir, expand,
resource_url)
@wsme_pecan.wsexpose(wtypes.text, types.uuid)
def validate(self, node_uuid):
"""Validate the driver interfaces."""
# check if node exists
rpc_node = objects.Node.get_by_uuid(pecan.request.context, node_uuid)
topic = pecan.request.rpcapi.get_topic_for(rpc_node)
return pecan.request.rpcapi.validate_driver_interfaces(
pecan.request.context, rpc_node.uuid, topic)
@wsme_pecan.wsexpose(Node, types.uuid)
def get_one(self, node_uuid):
"""Retrieve information about the given node.
:param node_uuid: UUID of a node.
"""
if self._from_chassis:
raise exception.OperationNotPermitted
rpc_node = objects.Node.get_by_uuid(pecan.request.context, node_uuid)
return Node.convert_with_links(rpc_node)
@wsme_pecan.wsexpose(Node, body=Node, status_code=201)
def post(self, node):
"""Create a new node.
:param node: a node within the request body.
"""
if self._from_chassis:
raise exception.OperationNotPermitted
try:
new_node = pecan.request.dbapi.create_node(node.as_dict())
except Exception as e:
with excutils.save_and_reraise_exception():
LOG.exception(e)
return Node.convert_with_links(new_node)
@wsme.validate(types.uuid, [NodePatchType])
@wsme_pecan.wsexpose(Node, types.uuid, body=[NodePatchType])
def patch(self, node_uuid, patch):
"""Update an existing node.
:param node_uuid: UUID of a node.
:param patch: a json PATCH document to apply to this node.
"""
if self._from_chassis:
raise exception.OperationNotPermitted
rpc_node = objects.Node.get_by_uuid(pecan.request.context, node_uuid)
topic = pecan.request.rpcapi.get_topic_for(rpc_node)
# Check if node is transitioning state
if rpc_node['target_power_state'] or \
rpc_node['target_provision_state']:
msg = _("Node %s can not be updated while a state transition"
"is in progress.")
raise wsme.exc.ClientSideError(msg % node_uuid, status_code=409)
try:
node = Node(**jsonpatch.apply_patch(rpc_node.as_dict(),
jsonpatch.JsonPatch(patch)))
except api_utils.JSONPATCH_EXCEPTIONS as e:
raise exception.PatchError(patch=patch, reason=e)
# Update only the fields that have changed
for field in objects.Node.fields:
if rpc_node[field] != getattr(node, field):
rpc_node[field] = getattr(node, field)
try:
new_node = pecan.request.rpcapi.update_node(
pecan.request.context, rpc_node, topic)
except Exception as e:
with excutils.save_and_reraise_exception():
LOG.exception(e)
return Node.convert_with_links(new_node)
@wsme_pecan.wsexpose(None, types.uuid, status_code=204)
def delete(self, node_uuid):
"""Delete a node.
:param node_uuid: UUID of a node.
"""
if self._from_chassis:
raise exception.OperationNotPermitted
pecan.request.dbapi.destroy_node(node_uuid)